1
0
Fork 0
arangodb/Documentation/DocuBlocks/JSF_aql_general_graph_betwe...

60 lines
2.1 KiB
Markdown

`GRAPH_BETWEENNESS (graphName, options)`
The GRAPH\_BETWEENNESS function returns the
[betweenness](http://en.wikipedia.org/wiki/Betweenness_centrality)
of graphs vertices.
The complexity of the function is described
[here](#the-complexity-of-the-shortest-path-algorithms).
*Parameters*
* *graphName* : The name of the graph as a string.
* *options* : An object containing the following options:
* *direction* : The direction of the edges.
Possible values are *outbound*, *inbound* and *any* (default).
* *weight* : The name of the attribute of
the edges containing the length.
* *defaultWeight* : Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default
is used as length.
If no default is supplied the default would be positive Infinity so the path and
hence the eccentricity can not be calculated.
@EXAMPLES
A route planner example, the betweenness of all locations.
@EXAMPLE_ARANGOSH_OUTPUT{generalGraphBetweenness1}
var examples = require("@arangodb/graph-examples/example-graph.js");
var g = examples.loadGraph("routeplanner");
db._query("RETURN GRAPH_BETWEENNESS('routeplanner')").toArray();
~ examples.dropGraph("routeplanner");
@END_EXAMPLE_ARANGOSH_OUTPUT
A route planner example, the betweenness of all locations.
This considers the actual distances.
@EXAMPLE_ARANGOSH_OUTPUT{generalGraphBetweenness2}
var examples = require("@arangodb/graph-examples/example-graph.js");
var g = examples.loadGraph("routeplanner");
db._query("RETURN GRAPH_BETWEENNESS('routeplanner', {weight : 'distance'})").toArray();
~ examples.dropGraph("routeplanner");
@END_EXAMPLE_ARANGOSH_OUTPUT
A route planner example, the betweenness regarding only
outbound paths.
@EXAMPLE_ARANGOSH_OUTPUT{generalGraphBetweenness3}
var examples = require("@arangodb/graph-examples/example-graph.js");
var g = examples.loadGraph("routeplanner");
| db._query("RETURN GRAPH_BETWEENNESS("
+ "'routeplanner', {direction : 'outbound', weight : 'distance'})").toArray();
~ examples.dropGraph("routeplanner");
@END_EXAMPLE_ARANGOSH_OUTPUT