Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Removed GeneralGraphs function documentation which is not available since v 3.0 any more. #2372

This commit is contained in:
Michael Hackstein 2017-03-17 17:32:14 +01:00
parent 67c1770f3e
commit e734120887
1 changed files with 1 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Documentation/Books/Manual/Graphs/GeneralGraphs/Functions.mdpp
View File

@ -396,19 +396,11 @@ The _shortestPath function returns all shortest paths of a graph.
This function determines all shortest paths in a graph. This function determines all shortest paths in a graph.
The function accepts an id, an example, a list of examples The function accepts an id, an example, a list of examples
or even an empty example as parameter for or even an empty example as parameter for
start and end vertex. If one wants to call this function to receive nearly all start and end vertex.
shortest paths for a graph the option *algorithm* should be set to
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm)
to increase performance.
If no algorithm is provided in the options the function chooses the appropriate
one (either [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm)
or [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm)) according to its parameters.
The length of a path is by default the amount of edges from one start vertex to The length of a path is by default the amount of edges from one start vertex to
an end vertex. The option weight allows the user to define an edge attribute an end vertex. The option weight allows the user to define an edge attribute
representing the length. representing the length.
<!-- TODO mchacki: das hier ist geloescht, wollen wir darueber etwas schreiben? The complexity of the function is described [here] (../../../AQL/Graphs/Operations.html#the-complexity-of-the-shortest-path-algorithms). -->
**Parameters** **Parameters**
@ -426,13 +418,6 @@ representing the length.
- *endVertexCollectionRestriction*: One or multiple vertex - *endVertexCollectionRestriction*: One or multiple vertex
collection names. Only vertices from these collections will be considered as collection names. Only vertices from these collections will be considered as
end vertex of a path. end vertex of a path.
- *edgeExamples*: A filter example for the
edges in the shortest paths
(see [example](#definition-of-examples)).
- *algorithm*: The algorithm to calculate
the shortest paths. If both start and end vertex examples are empty
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) is
used, otherwise the default is [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm)
- *weight*: The name of the attribute of - *weight*: The name of the attribute of
the edges containing the length as a string. the edges containing the length as a string.
- *defaultWeight*: Only used with the option *weight*. - *defaultWeight*: Only used with the option *weight*.
@ -527,8 +512,6 @@ of the vertices defined by the examples.
The function accepts an id, an example, a list of examples or even an empty The function accepts an id, an example, a list of examples or even an empty
example as parameter for vertexExample. example as parameter for vertexExample.
<!-- TODO mchacki: das hier ist geloescht, wollen wir darueber etwas schreiben? The complexity of the function is described [here] (../../../AQL/Graphs/Operations.html#the-complexity-of-the-shortest-path-algorithms). -->
**Parameters** **Parameters**
@ -541,10 +524,6 @@ example as parameter for vertexExample.
considered for source vertices. considered for source vertices.
- *endVertexCollectionRestriction* : One or a list of vertex-collection names that should be - *endVertexCollectionRestriction* : One or a list of vertex-collection names that should be
considered for target vertices. considered for target vertices.
- *edgeExamples*: Filter the edges to be followed, see [Definition of examples](#definition-of-examples)
- *algorithm*: The algorithm to calculate the shortest paths, possible values are
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) and
[Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
- *weight*: The name of the attribute of the edges containing the weight. - *weight*: The name of the attribute of the edges containing the weight.
- *defaultWeight*: Only used with the option *weight*. - *defaultWeight*: Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default If an edge does not have the attribute named as defined in option *weight* this default
@ -607,8 +586,6 @@ of the vertices defined by the examples.
Similar to [_absoluteEccentricity](#absoluteeccentricity) but returns a normalized result. Similar to [_absoluteEccentricity](#absoluteeccentricity) but returns a normalized result.
<!-- TODO mchacki: das hier ist geloescht, wollen wir darueber etwas schreiben? The complexity of the function is described [here] (../../../AQL/Graphs/Operations.html#the-complexity-of-the-shortest-path-algorithms). -->
**Examples** **Examples**
@ -651,9 +628,6 @@ of the vertices defined by the examples.
The function accepts an id, an example, a list of examples or even an empty The function accepts an id, an example, a list of examples or even an empty
example as parameter for *vertexExample*. example as parameter for *vertexExample*.
<!-- TODO mchacki: das hier ist geloescht, wollen wir darueber etwas schreiben? The complexity of the function is described [here] (../../../AQL/Graphs/Operations.html#the-complexity-of-the-shortest-path-algorithms).-->
**Parameters** **Parameters**
- vertexExample (optional) Filter the vertices, see [Definition of examples](#definition-of-examples) - vertexExample (optional) Filter the vertices, see [Definition of examples](#definition-of-examples)
@ -665,10 +639,6 @@ example as parameter for *vertexExample*.
considered for source vertices. considered for source vertices.
- *endVertexCollectionRestriction* : One or a list of vertex-collection names that should be - *endVertexCollectionRestriction* : One or a list of vertex-collection names that should be
considered for target vertices. considered for target vertices.
- *edgeExamples*: Filter the edges to be followed, see [Definition of examples](#definition-of-examples)
- *algorithm*: The algorithm to calculate the shortest paths, possible values are
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) and
[Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
- *weight*: The name of the attribute of the edges containing the weight. - *weight*: The name of the attribute of the edges containing the weight.
- *defaultWeight*: Only used with the option *weight*. - *defaultWeight*: Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default If an edge does not have the attribute named as defined in option *weight* this default
@ -731,8 +701,6 @@ of graphs vertices.
Similar to [_absoluteCloseness](#absolutecloseness) but returns a normalized value. Similar to [_absoluteCloseness](#absolutecloseness) but returns a normalized value.
<!-- TODO mchacki: das hier ist geloescht, wollen wir darueber etwas schreiben? The complexity of the function is described [here] (../../../AQL/Graphs/Operations.html#the-complexity-of-the-shortest-path-algorithms). -->
**Examples** **Examples**
@ -906,16 +874,11 @@ of a graph.
` `
<!-- TODO mchacki: das hier ist geloescht, wollen wir darueber etwas schreiben? The complexity of the function is described [here] (../../../AQL/Graphs/Operations.html#the-complexity-of-the-shortest-path-algorithms).-->
**Parameters** **Parameters**
- options (optional) An object defining further options. Can have the following values: - options (optional) An object defining further options. Can have the following values:
- *direction*: The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default). - *direction*: The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default).
- *algorithm*: The algorithm to calculate the shortest paths, possible values are
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) and
[Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
- *weight*: The name of the attribute of the edges containing the weight. - *weight*: The name of the attribute of the edges containing the weight.
- *defaultWeight*: Only used with the option *weight*. - *defaultWeight*: Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default If an edge does not have the attribute named as defined in option *weight* this default
@ -975,16 +938,11 @@ of a graph.
`graph._diameter(graphName, options)` `graph._diameter(graphName, options)`
<!-- TODO mchacki: das hier ist geloescht, wollen wir darueber etwas schreiben? The complexity of the function is described [here] (../../../AQL/Graphs/Operations.html#the-complexity-of-the-shortest-path-algorithms).-->
**Parameters** **Parameters**
- options (optional) An object defining further options. Can have the following values: - options (optional) An object defining further options. Can have the following values:
- *direction*: The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default). - *direction*: The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default).
- *algorithm*: The algorithm to calculate the shortest paths, possible values are
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) and
[Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
- *weight*: The name of the attribute of the edges containing the weight. - *weight*: The name of the attribute of the edges containing the weight.
- *defaultWeight*: Only used with the option *weight*. - *defaultWeight*: Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default If an edge does not have the attribute named as defined in option *weight* this default