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

Merge branch 'devel' of github.com:triAGENS/ArangoDB into devel

This commit is contained in:
Frank Celler 2013-10-20 18:46:52 +02:00
parent d620386a7b 3b18804ec6
commit 219655312b
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
js/server/modules/org/arangodb/graph/algorithms.js
View File

@ -432,8 +432,16 @@ Vertex.prototype.measurement = function (measurement) {
////////////////////////////////////////////////////////////////////////////////
/// @brief return all shortest paths
///
/// @FUN{@FA{graph}.geodesics()}
/// @FUN{@FA{graph}.geodesics(@FA{options})}
///
/// Return all shortest paths
/// An optional `options` JSON object can be specified to control the result.
/// `options` can have the following sub-attributes:
/// - `grouped`: if not specified or set to `false`, the result will be a flat
/// list. If set to `true`, the result will be a list containing list of
/// paths, grouped for each combination of source and target.
/// - `threshold`: if not specified, all paths will be returned. If `threshold`
/// is `true`, only paths with a minimum length of 3 will be returned
////////////////////////////////////////////////////////////////////////////////
Graph.prototype.geodesics = function (options) {
@ -476,7 +484,10 @@ Graph.prototype.geodesics = function (options) {
///
/// @FUN{@FA{graph}.measurement(@FA{measurement})}
///
/// Calculates the diameter or radius of a graph
/// Calculates the diameter or radius of a graph.
/// `measurement` can either be:
/// - `diameter`: to calculate the diameter
/// - `radius`: to calculate the radius
///
////////////////////////////////////////////////////////////////////////////////