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

added documentation for ahuacatl

This commit is contained in:
scottashton 2014-06-16 16:33:40 +02:00
parent 252d320795
commit cc3eff2a1e
3 changed files with 1770 additions and 1634 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3309
Documentation/Books/Users/Aql/GraphOperations.mdpp
View File

File diff suppressed because it is too large Load Diff

88
Documentation/Books/Users/Aql/GraphOperations.mdpp.orig Normal file
View File

@ -0,0 +1,88 @@
!CHAPTER Graph operations
This chapter describe graph related aql functions.
!SUBSECTION Edges and Vertices related functions.
This section describes various AQL functions which can be used to recieve information about the graph's vertices, edges, neighbor relationship and shared properties.
!SUBSUBSECTION GRAPH_EDGES
<!-- @startDocuBlock JSF_ahuacatl_general_graph_edges -->
!SUBSUBSECTION GRAPH_VERTICES
<!-- @startDocuBlock JSF_ahuacatl_general_graph_vertices -->
!SUBSUBSECTION GRAPH_COMMON_NEIGHBORS
<!-- @startDocuBlock JSF_ahuacatl_general_graph_common_neighbors -->
!SUBSUBSECTION GRAPH_COMMON_PROPERTIES
<!-- @startDocuBlock JSF_ahuacatl_general_graph_common_properties -->
!SUBSUBSECTION GRAPH_NEIGHBORS
<!-- @startDocuBlock JSF_ahuacatl_general_graph_neighbors -->
!SUBSECTION Shortest Paths, distances and traversals.
This section describes AQL functions, that calculate pathes from a subset of vertices in a graph to another subset of vertices.
!SUBSUBSECTION GRAPH_PATHS
<!-- @startDocuBlock JSF_ahuacatl_general_graph_paths -->
!SUBSUBSECTION GRAPH_SHORTEST_PATH
<!-- @startDocuBlock JSF_ahuacatl_general_graph_shortest_paths -->
!SUBSUBSECTION GRAPH_TRAVERSAL
<!-- @startDocuBlock JSF_ahuacatl_general_graph_traversal -->
!SUBSUBSECTION GRAPH_TRAVERSAL_TREE
<!-- @startDocuBlock JSF_ahuacatl_general_graph_traversal_tree -->
!SUBSUBSECTION GRAPH_DISTANCE_TO
<!-- @startDocuBlock JSF_ahuacatl_general_graph_distance -->
!SUBSECTION Graph measurements.
This section describes AQL functions to calculate various graph related measurements as defined in the mathematical graph theory.
!SUBSUBSECTION GRAPH_ABSOLUTE_ECCENTRICITY
<!-- @startDocuBlock JSF_ahuacatl_general_graph_absolute_eccentricity -->
!SUBSUBSECTION GRAPH_ECCENTRICITY
<!-- @startDocuBlock JSF_ahuacatl_general_graph_eccentricity -->
!SUBSUBSECTION GRAPH_ABSOLUTE_CLOSENESS
<!-- @startDocuBlock JSF_ahuacatl_general_graph_absolute_closeness -->
!SUBSUBSECTION GRAPH_CLOSENESS
<!-- @startDocuBlock JSF_ahuacatl_general_graph_closeness -->
!SUBSUBSECTION GRAPH_ABSOLUTE_BETWEENNESS
<!-- @startDocuBlock JSF_ahuacatl_general_graph_absolute_betweenness -->
!SUBSUBSECTION GRAPH_BETWEENNESS
<!-- @startDocuBlock JSF_ahuacatl_general_graph_betweenness -->
!SUBSUBSECTION GRAPH_RADIUS
<!-- @startDocuBlock JSF_ahuacatl_general_graph_radius -->
!SUBSUBSECTION GRAPH_DIAMETER
<!-- @startDocuBlock JSF_ahuacatl_general_graph_diameter -->

7
js/server/modules/org/arangodb/ahuacatl.js
View File

@ -5281,11 +5281,12 @@ function GRAPH_TRAVERSAL_TREE (vertexCollection,
////////////////////////////////////////////////////////////////////////////////
/// @startDocuBlock JSF_ahuacatl_general_graph_distance
///
/// `GENERAL_GRAPH_DISTANCE_TO (graphName, startVertexExample, endVertexExample, options)`
/// `GRAPH_DISTANCE_TO (graphName, startVertexExample, endVertexExample, options)`
/// *The GRAPH\_DISTANCE\_TO function returns all paths and there distance within a graph.*
///
/// This function is a wrapper of [GRAPH\_SHORTEST\_PATH](#SUBSECTION GRAPH_SHORTEST_PATH).
/// It does not return the actual path but only the distance between two vertices.
/// @endDocuBlock
///
////////////////////////////////////////////////////////////////////////////////
function GENERAL_GRAPH_DISTANCE_TO (graphName,
@ -5823,7 +5824,7 @@ function TRANSFER_GENERAL_GRAPH_NEIGHBORS_RESULT (result) {
///
/// A route planner example, all common neighbors of capitals.
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphVertices1}
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphCommonNeighbors1}
/// ~ var db = require("internal").db;
/// var examples = require("org/arangodb/graph-examples/example-graph.js");
/// var g = examples.loadGraph("routeplanner");
@ -5835,7 +5836,7 @@ function TRANSFER_GENERAL_GRAPH_NEIGHBORS_RESULT (result) {
/// A route planner example, all common outbound neighbors of munich with any other location
/// which have a maximal depth of 2 :
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphVertices2}
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphCommonNeighbors2}
/// ~ var db = require("internal").db;
/// var examples = require("org/arangodb/graph-examples/example-graph.js");
/// var g = examples.loadGraph("routeplanner");