@graphty/algorithms / index / BfsOptions
Interface: BfsOptions ​
Defined in: indexed/bfs.ts:72
Options of the index-based BFS.
Extends ​
Properties ​
arcOrder? ​
readonlyoptionalarcOrder?:U32
Defined in: indexed/bfs.ts:68
A permutation of the arc indices, arcCount long, whose slice [rowPtr[u], rowPtr[u + 1]) lists node u's arcs in the order to try them. The default is row order (ascending neighbour index). A caller that must reproduce a traversal over another neighbour order -- a legacy Graph hands out neighbours in insertion order -- passes that order here.
Inherited from ​
maxDepth? ​
readonlyoptionalmaxDepth?:number
Defined in: indexed/bfs.ts:74
Stop expanding at this depth; unbounded when omitted.
target? ​
readonlyoptionaltarget?:NodeRef
Defined in: indexed/bfs.ts:81
Stop when this node (an index, or { id }) is taken off the queue, before its neighbours are expanded. Every node discovered by then stays in order; the target's own position in order ends the prefix of nodes that were expanded.
Throws ​
RangeError when it is not a node index