jkroll20 / graphcore Goto Github PK

commands:

• help
• add-arcs
• remove-arcs
• replace-predecessors
• replace-successors
• traverse-predecessors
• traverse-successors
• traverse-neighbors
• list-predecessors
• list-successors
• find-path
• find-root
• list-roots
• list-leaves
• stats
• clear
• shutdown
• quit
• protocol-version
• set-meta
• get-meta
• remove-meta
• list-meta

help

syntax: help [COMMAND] / help operators
help: list commands
help COMMAND: get help on COMMAND
help operators: print help on operators

add-arcs

syntax: add-arcs {:|<}
read a data set of arcs and add them to the graph. empty line terminates the set.

remove-arcs

syntax: remove-arcs {:|<}
read a data set of arcs and remove them from the graph. empty line terminates the set.

replace-predecessors

syntax: replace-predecessors NODE {:|<}
read data set of nodes and replace predecessors of NODE with given set.

replace-successors

syntax: replace-successors NODE {:|<}
read data set of nodes and replace successors of NODE with given set.

traverse-predecessors

syntax: traverse-predecessors NODE DEPTH
list NODE and its predecessors recursively up to DEPTH.

traverse-successors

syntax: traverse-successors NODE DEPTH
list NODE and its successors recursively up to DEPTH.

traverse-neighbors

syntax: traverse-neighbors NODE DEPTH
list NODE and its neighbors recursively up to DEPTH.

list-predecessors

syntax: list-predecessors NODE
list direct predecessors of NODE.

list-successors

syntax: list-successors NODE
list direct successors of NODE.

find-path

syntax: find-path X Y
find the shortest path from node X to node Y. return data set of arcs representing the path.

find-root

syntax: find-root X
find the path from X to nearest root node. return data set of arcs representing the path.

list-roots

syntax: list-roots
list root nodes (nodes without predecessors).

list-leaves

syntax: list-leaves
list leaf nodes (nodes without successors).

stats

syntax: stats
print some statistics about the graph in the form of a name,value data set.
names and their meanings:
ArcCount        number of arcs
ArcRamKiB       total RAM consumed by arc data, in KiB
DataInvalid     nonzero if any obvious errors were found in graph data
MaxNodeID       greatest node ID
MinNodeID       lowest node ID
NumDups number of duplicates found (must be zero)

clear

syntax: clear
clear the graph model.

shutdown

syntax: shutdown
shutdown the graph processor.

quit

syntax: quit
shutdown the graph processor.

protocol-version

syntax: protocol-version
print PROTOCOL_VERSION. for internal use only.

set-meta

syntax: set-meta NAME VALUE
add or set an arbitrary text variable.
variable names may contain alphabetic characters (a-z A-Z), digits (0-9), hyphens (-) and underscores (_),
and must start with an alphabetic character, a hyphen or an underscore.

get-meta

syntax: get-meta NAME
read a named text variable.

remove-meta

syntax: remove-meta NAME
remove the named variable.

list-meta

syntax: list-meta
list all variables in this graph.