Crate graph_types

Design

graph-types divides the graph into adjacency storage engine and entry storage engine.

Adjacency Storage Engine

The core property of a graph is nodes and edges.

There are many different ways to represent a graph.

Such as adjacency matrix, adjacency list, adjacency set, etc.

The most common one is adjacency list.

Entry Storage Engine

Other properties of the graph are stored in the entry storage engine.

For example weights, labels, colors, etc.

Each of the entry can be stored in different data structures.

For example, weights can be stored in a vector, labels can be stored in a hash map, some complex structures can even be stored in disk or a database.

Structs

• DirectedEdge
  DirectedEdge represents an bidirectional edge between two nodes.
• DynamicEdge
  DynamicEdge represents an bidirectional edge between two nodes.
• EdgesVisitor
  Arguments
• GraphError
  The error type of a graph operation, see GraphErrorKind for more.
• NodesVisitor
  A double-ended iterator over the nodes of a graph.
• UndirectedEdge
  UndirectedEdge represents an bidirectional edge between two nodes.

Enums

• EdgeDirection
  Determines the direction between two nodes
• EdgeInsertID
  Arguments
• EdgeQuery
  Arguments
• GraphEntry
  Arguments
• GraphErrorKind
  The real error type of a graph operation, it will not be exposed to the user, see GraphError for more.
• GraphKind
  Mark the graph as directed or undirected.
• NodeQuery
  Represents a node in a graph
• Query
  Arguments

Traits

• Edge
  Marker trait for edges
• EntryEngine
  A graph that has extra data associated with each node and edge.
• GraphEngine
  Represent a graph storage, with a set of nodes and edges.
• MutableGraph
  Mark a graph engine that can add and delete edges or points
• Node
  Represents a node in a graph
• ValueProvider
  Extend the ability to get a value from a graph

Type Definitions

• GraphResult
  The result type alias of a graph operation, see GraphError & GraphErrorKind for more.