PathsResult

Represents all paths between two sets of nodes as computed by paths.

Inheritance Hierarchy

Remarks

When querying this result for a path or enumerating it, the paths are found on the fly. Enumerating all paths can be slow if the graph is large and startNodes or endNodes contain many nodes. Generally this should be used to find paths satisfying certain criteria and only enumerating until a suitable path is found to avoid walking the whole graph.

This class cannot be instantiated

Members

No filters for this type

Properties

paths

: ResultItemCollection<Path>

readonly

Gets a collection of all paths between the startNodes and endNodes.

This collection's enumerator calculates paths only when needed. This also means that accessing the size or via an index will cause all paths to be calculated immediately which can be slow.

readonlyfinal

Methods

getAllPathsBetween

(start: INode, end: INode): ResultItemCollection<Path>

Gets a collection of all paths between the given start and end nodes.

This collection's enumerator calculates paths only when needed. This also means that accessing the size or via an index will cause all paths to be calculated immediately, which can be slow.

final

Parameters

start: INode: The start node to get the paths for.
end: INode: The end node to get the paths for.

Return Value

ResultItemCollection<Path>: All paths between start and end.

getPathBetween

(start: INode, end: INode): Path

Returns a path between the given start and end node if one exists.

final

Parameters

start: INode: The start node to get the path for.
end: INode: The end node to get the path for.

Return Value

Path: A path between start and end or null if no path exists between the two nodes.

hasPathBetween

(start: INode, end: INode): boolean

Determines whether a path between start and end exists.

final

Parameters

start: INode: The start node.
end: INode: The end node.

Return Value

boolean: true if a path exists between start and end, false if not.