Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InterUnitGraph<UnitId, VertexIndex, EdgeProps>

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly edgeCount

edgeCount: number

Number of inter-unit edges

Private Readonly edgeKeyIndex

edgeKeyIndex: any

Readonly edges

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

Array of inter-unit edges

Protected Readonly map

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

Private Readonly vertexKeyIndex

vertexKeyIndex: any

Methods

getConnectedUnits

  • 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>[]

getEdge

  • getEdge(indexA: VertexIndex, unitA: UnitId, indexB: VertexIndex, unitB: UnitId): undefined | <internal>.InterUnitGraph.Edge<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>

getEdgeIndex

  • getEdgeIndex(indexA: VertexIndex, unitA: UnitId, indexB: VertexIndex, unitB: UnitId): number

  • Index into this.edges

    Parameters

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

    Returns number

getEdgeIndices

  • getEdgeIndices(index: VertexIndex, unit: UnitId): readonly number[]

  • Indices into this.edges

    Parameters

    • index: VertexIndex
    • unit: UnitId

    Returns readonly number[]

hasEdge

  • hasEdge(indexA: VertexIndex, unitA: UnitId, indexB: VertexIndex, unitB: UnitId): boolean

  • Check if edge exists

    Parameters

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

    Returns boolean

Generated using TypeDoc