1
0
Fork 0
arangodb/Documentation/DocuBlocks/JSF_general_graph_paths.md

46 lines
1.5 KiB
Markdown

@brief The _paths function returns all paths of a graph.
`graph._paths(options)`
This function determines all available paths in a graph.
The complexity of this method is **O(n\*n\*m)** with *n* being the amount of vertices in
the graph and *m* the average amount of connected edges;
@PARAMS
@PARAM{options, object, optional}
An object containing options, see below:
* *direction* : The direction of the edges. Possible values are *any*,
*inbound* and *outbound* (default).
* *followCycles* (optional) : If set to *true* the query follows cycles in the graph,
default is false.
* *minLength* (optional) : Defines the minimal length a path must
have to be returned (default is 0).
* *maxLength* (optional) : Defines the maximal length a path must
have to be returned (default is 10).
@EXAMPLES
Return all paths of the graph "social":
@EXAMPLE_ARANGOSH_OUTPUT{generalGraphModulePaths}
var examples = require("@arangodb/graph-examples/example-graph.js");
var g = examples.loadGraph("social");
g._paths();
~ examples.dropGraph("social");
@END_EXAMPLE_ARANGOSH_OUTPUT
Return all inbound paths of the graph "social" with a maximal
length of 1 and a minimal length of 2:
@EXAMPLE_ARANGOSH_OUTPUT{generalGraphModulePaths2}
var examples = require("@arangodb/graph-examples/example-graph.js");
var g = examples.loadGraph("social");
g._paths({direction : 'inbound', minLength : 1, maxLength : 2});
~ examples.dropGraph("social");
@END_EXAMPLE_ARANGOSH_OUTPUT