BFS(graph, source, target)

Implementation of Breadth-first Search.

new BFS(graph, source, target)
graph/search/BFS.js, line 17

Constructs a BFS algorithm object.

Parameters:
Name Type Default Description
graph Graph null

The graph.
source Number

The node index of the source node.
target Number

The node index of the target node.
Author:

Members

found :Boolean
graph/search/BFS.js, line 45

Whether the search was successful or not.

Default Value:
  • false

nullable graph :Graph
graph/search/BFS.js, line 24

The graph.

Default Value:
  • null

source :Number
graph/search/BFS.js, line 31

The node index of the source node.

Default Value:
  • - 1

target :Number
graph/search/BFS.js, line 38

The node index of the target node.

Default Value:
  • - 1

Methods

clear() → {BFS}
graph/search/BFS.js, line 195

Clears the internal state of the object. A new search is now possible.

Returns:
BFS -

A reference to this BFS object.

getPath() → {Array.<Number>}
graph/search/BFS.js, line 145

Returns the shortest path from the source to the target node as an array of node indices.

Returns:
Array.<Number> -

The shortest path.

getSearchTree() → {Array.<Edge>}
graph/search/BFS.js, line 184

Returns the search tree of the algorithm as an array of edges.

Returns:
Array.<Edge> -

The search tree.

Executes the graph search. If the search was successful, BFS#found is set to true.

Returns:
BFS -

A reference to this BFS object.