Class Graph<TNodeSize, TNode>

constructor

• new Graph<TNodeSize, TNode>(data): Graph<TNodeSize, TNode>

• Type Parameters

  • TNodeSize extends number

  • TNode extends number = Node<TNodeSize>

  Parameters

  • data: GraphMetaData<TNodeSize, TNode>

  Returns Graph<TNodeSize, TNode>

Optional distances

Readonly length

Optional path

bfsPath

• bfsPath(target): (undefined | TNode)[]

• TODO: Greedy best-first search

  Does not take into account the distance from start to target.

  https://en.wikipedia.org/wiki/Best-first_search#Greedy_BFS

  Parameters

  • target: NonNullable<TNode>

  Returns (undefined | TNode)[]

  path from start to target

dfsPath

• dfsPath(start, target): (undefined | TNode)[]

• Depth-first search

  Parameters

  • start: NonNullable<TNode>

  • target: NonNullable<TNode>

  Returns (undefined | TNode)[]

  path from start to target

forEachEdge

• forEachEdge(callback, conditions): void

• Parameters

  • callback: ((edge, bidirectional, conditional) => void)

    • • (edge, bidirectional, conditional): void

      • Parameters

        • edge: [a: number, b: number]

        • bidirectional: boolean

        • conditional: boolean

        Returns void

  • conditions: string[]

  Returns void

forEachNode

• forEachNode(callback): void

• Parameters

  • callback: ((node) => void)

    • • (node): void

      • Parameters

        • node: number

        Returns void

  Returns void

generateDistancesAndPath

• generateDistancesAndPath(start?): {
      distances: NodeDistances<TNodeSize>;
      path: NodePath<TNode>;
  }

• Parameters

  • Optional start: TNode = ...

  Returns {
      distances: NodeDistances<TNodeSize>;
      path: NodePath<TNode>;
  }

  {{ distances: NodeDistances; path: NodePath; }}

  • distances: NodeDistances<TNodeSize>

  • path: NodePath<TNode>

  Memberof

  Graph

nodesWithinReach

• nodesWithinReach(reach): TNode[]

• Parameters

  • reach: TNode

  Returns TNode[]

walkPath

• walkPath(start, path, callback?): void

• Parameters

  • start: null | TNode

  • path: NodePath<TNode>

  • Optional callback: ((node) => void)

    • • (node): void

      • Parameters

        • node: null | TNode

        Returns void

  Returns void

walkPathToEnd

• walkPathToEnd(path, callback?): void

• Walk through linked list of Nodes representing the path to walk to target, where the last node is guaranteed to be the expected target.

  Parameters

  • path: (null | TNode)[]

  • Optional callback: ((node) => void)

    • • (node): void

      • Parameters

        • node: null | TNode

        Returns void

  Returns void

walkPathToTarget

• walkPathToTarget(path, target, callback?): boolean

• Walk through linked list of Nodes representing the path to walk to target, where the last node is guaranteed to be the expected target.

  Parameters

  • path: (null | TNode)[]

  • target: null | TNode

  • Optional callback: ((node) => void)

    • • (node): void

      • Parameters

        • node: null | TNode

        Returns void

  Returns boolean