Class InterUnitGraph<UnitId, VertexIndex, EdgeProps>

Type Parameters

Hierarchy

Constructors

Properties

edgeCount: number

Number of inter-unit edges

edgeKeyIndex: any
edges: readonly <internal>.InterUnitGraph.Edge<UnitId, VertexIndex, EdgeProps>[]

Array of inter-unit edges

map: Map<number, <internal>.InterUnitGraph.UnitPairEdges<UnitId, VertexIndex, EdgeProps>[]>
vertexKeyIndex: any

Methods

  • Get an array of unit-pair-edges that are connected to the given unit

    Parameters

    • unit: UnitId

    Returns readonly <internal>.InterUnitGraph.UnitPairEdges<UnitId, VertexIndex, EdgeProps>[]

  • Get inter-unit edge given a pair of indices and units

    Parameters

    • indexA: VertexIndex
    • unitA: UnitId
    • indexB: VertexIndex
    • unitB: UnitId

    Returns undefined | <internal>.InterUnitGraph.Edge<UnitId, VertexIndex, EdgeProps>

  • Index into this.edges

    Parameters

    • indexA: VertexIndex
    • unitA: UnitId
    • indexB: VertexIndex
    • unitB: UnitId

    Returns number

  • Indices into this.edges

    Parameters

    • index: VertexIndex
    • unit: UnitId

    Returns readonly number[]

  • Check if edge exists

    Parameters

    • indexA: VertexIndex
    • unitA: UnitId
    • indexB: VertexIndex
    • unitB: UnitId

    Returns boolean

Generated using TypeDoc