Traversal functions for graphology.
npm install graphology-traversalMiscellaneous traversal functions to be used with graphology.
```
npm install graphology-traversal
- bfs
- bfsFromNode
- dfs
- dfsFromNode
Perform a BFS (Breadth-First Search) over the given graph using a callback.
`js
import {bfs} from 'graphology-traversal';
// Alternatively, to only load the relevant code
import {bfs} from 'graphology-traversal/bfs';
bfs(graph, function (node, attr, depth) {
console.log(node, attr, depth);
});
// Stopping at depth 3
bfs(graph, function (node, attr, depth) {
return depth >= 3;
});
`
_Arguments_
- graph _Graph_: a graphology instance.
- callback _function_: iteration callback taking the traversed node, its attributes and the traversal's depth. Returning true will prevent the traversal from following the next neighbors.outbound
- options _?object_: traversal options:
- mode _?string_ []: type of neighbors to traverse.
Perform a BFS (Breadth-First Search) over the given graph, starting from the given node, using a callback.
`js
import {bfsFromNode} from 'graphology-traversal';
// Alternatively, to only load the relevant code
import {bfsFromNode} from 'graphology-traversal/bfs';
bfsFromNode(graph, 'node1', function (node, attr, depth) {
console.log(node, attr, depth);
});
// Stopping at depth 3
bfsFromNode(graph, 'node1', function (node, attr, depth) {
return depth >= 3;
});
`
_Arguments_
- graph _Graph_: a graphology instance.
- node _string\|number_: starting node.
- callback _function_: iteration callback taking the traversed node, its attributes and the traversal's depth. Returning true will prevent the traversal from following the next neighbors.outbound
- options _?object_: traversal options:
- mode _?string_ []: type of neighbors to traverse.
Perform a DFS (Depth-First Search) over the given graph using a callback.
`js
import {dfs} from 'graphology-traversal';
// Alternatively, to only load the relevant code
import {dfs} from 'graphology-traversal/dfs';
dfs(graph, function (node, attr, depth) {
console.log(node, attr, depth);
});
// Stopping at depth 3
dfs(graph, function (node, attr, depth) {
return depth >= 3;
});
`
_Arguments_
- graph _Graph_: a graphology instance.
- callback _function_: iteration callback taking the traversed node, its attributes and the traversal's depth. Returning true will prevent the traversal from following the next neighbors.outbound
- options _?object_: traversal options:
- mode _?string_ []: type of neighbors to traverse.
Perform a DFS (Depth-First Search) over the given graph, starting from the given node, using a callback.
`js
import {dfsFromNode} from 'graphology-traversal';
// Alternatively, to only load the relevant code
import {dfsFromNode} from 'graphology-traversal/dfs';
dfsFromNode(graph, 'node1', function (node, attr, depth) {
console.log(node, attr, depth);
});
// Stopping at depth 3
dfsFromNode(graph, 'node1', function (node, attr, depth) {
return depth >= 3;
});
`
_Arguments_
- graph _Graph_: a graphology instance.
- node _string\|number_: starting node.
- callback _function_: iteration callback taking the traversed node, its attributes and the traversal's depth. Returning true will prevent the traversal from following the next neighbors.outbound`]: type of neighbors to traverse.
- options _?object_: traversal options:
- mode _?string_ [