.. _package-rst-graph:
===================
Package rst.graph
===================
*Not documented*
Messages
========
.. container:: mess4ge-multi
.. container:: mess4ge-graph
.. digraph:: message_graph
fontname="Arial";
fontsize=11;
stylesheet="../_static/graphs.css";
node [fontsize=11,fontname="Arial"]
edge [fontsize=11,fontname="Arial"]
"1" [label=< | EdgeListGraph |
|
| Node | nodes |
| Edge | edges |
>,shape=box,style=filled,fillcolor="white"];
"7" [label=< | Edge |
|
| UINT32 | head |
| UINT32 | tail |
| Value | data |
>,shape=box,style=filled,fillcolor="white"];
"2" [label=< | Node |
|
| Value | data |
>,shape=box,style=filled,fillcolor="white"];
"3" [label=< | Value |
|
| Type | type |
| INT64 | int |
| FLOAT64 | double |
| ASCII-STRING | string |
| BOOL | bool |
| OCTET-VECTOR | binary |
| Value | array |
>,shape=box,style=filled,fillcolor="white"];
"5" [label=< | Value |
|
| Type | type |
| INT64 | int |
| FLOAT64 | double |
| ASCII-STRING | string |
| BOOL | bool |
| OCTET-VECTOR | binary |
>,shape=box,style=filled,fillcolor="white"];
"6" [label=< | Type |
|
| VOID | 1 |
| INT | 2 |
| DOUBLE | 3 |
| STRING | 4 |
| BOOL | 5 |
| BINARY | 6 |
| ARRAY | 7 |
>,shape=box,style=filled,fillcolor="white"];
"4" [label=< | Type |
|
| VOID | 1 |
| INT | 2 |
| DOUBLE | 3 |
| STRING | 4 |
| BOOL | 5 |
| BINARY | 6 |
| ARRAY | 7 |
>,shape=box,style=filled,fillcolor="white"];
"1":edges -> "7" [];
"1":nodes -> "2" [];
"7":data -> "3" [];
"2":data -> "3" [];
"3" -> "4" [];
"3":array -> "5" [];
"3":type -> "4" [];
"5" -> "6" [];
"5":type -> "6" [];
.. container:: mess4ge-list
.. container:: messages
* :ref:`EdgeListGraph `
* :ref:`Node `
* :ref:`Edge `
.. container:: clearer
clearer: should be made invisible via css
.. _message-rst-graph-edgelistgraph:
Message EdgeListGraph
---------------------
.. container:: message-rst-graph-edgelistgraph-multi
.. container:: message-rst-graph-edgelistgraph-documentation
.. py:class:: rst.graph.EdgeListGraph
Holds information about an edge list graph data structure.
.. codeauthor:: Daniel Seidel
.. py:attribute:: nodes
:type: array of :py:class:`rst.graph.Node`
List of the nodes in the graph.
.. py:attribute:: edges
:type: array of :py:class:`rst.graph.Edge`
List of the edges in the graph.
.. container:: message-rst-graph-edgelistgraph-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.12/rst-manual/../rst-proto/proto/stable/rst/graph/EdgeListGraph.proto
:lines: 13-25
:language: protobuf
:emphasize-lines: 6-6,11-11
.. _message-rst-graph-node:
Message Node
------------
.. container:: message-rst-graph-node-multi
.. container:: message-rst-graph-node-documentation
.. py:class:: rst.graph.Node
Node with associated data in an edge-list graph.
.. codeauthor:: Daniel Seidel
.. py:attribute:: data
:type: array of :py:class:`rst.generic.Value`
Arbitrary data describing the node, e.g. location coordinates.
Specific to application creating the graph.
.. container:: message-rst-graph-node-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.12/rst-manual/../rst-proto/proto/stable/rst/graph/Node.proto
:lines: 12-21
:language: protobuf
:emphasize-lines: 8-8
.. _message-rst-graph-edge:
Message Edge
------------
.. container:: message-rst-graph-edge-multi
.. container:: message-rst-graph-edge-documentation
.. py:class:: rst.graph.Edge
Incident nodes and associated data of an edge in an edge-list
graph.
.. codeauthor:: Daniel Seidel
.. py:attribute:: head
:type: :py:class:`UINT32`
Index of the head node in the graph's node list.
.. py:attribute:: tail
:type: :py:class:`UINT32`
Index of the tail node in the graph's node list.
.. py:attribute:: data
:type: array of :py:class:`rst.generic.Value`
Arbitrary data describing the edge, e.g. traversal cost.
Specific to application creating the graph.
.. container:: message-rst-graph-edge-source
:download:`Download this file `
.. literalinclude:: //home/jenkins/workspace/rst-manual-0.12/rst-manual/../rst-proto/proto/stable/rst/graph/Edge.proto
:lines: 13-32
:language: protobuf
:emphasize-lines: 6-6,11-11,18-18