Trait graph_types::GraphEngine

source · 
pub trait GraphEngine<'a>where
    Self: Sized,{
    type NeighborIterator: DoubleEndedIterator<Item = NodeID>;
    type BridgeIterator: DoubleEndedIterator<Item = IndeterminateEdge>;
    type NodeTraverser: DoubleEndedIterator<Item = NodeID>;
    type EdgeTraverser: DoubleEndedIterator<Item = EdgeID>;
    type BridgeTraverser: DoubleEndedIterator<Item = IndeterminateEdge>;


Show 15 methods    // Required methods
    fn graph_kind(&self) -> GraphKind;
    fn get_node(&self, node: NodeID) -> Result<NodeID, GraphError>;
    fn all_nodes(&'a self) -> Self::NodeTraverser;
    fn all_neighbors(&'a self, node: NodeID) -> Self::NeighborIterator;
    fn get_edge(&self, edge: EdgeID) -> Result<EdgeID, GraphError>;
    fn all_edges(&'a self) -> Self::EdgeTraverser;
    fn get_bridge(&self, edge: EdgeID) -> Result<IndeterminateEdge, GraphError>;
    fn get_bridges(&'a self, from: NodeID, goto: NodeID) -> Self::BridgeIterator;
    fn all_bridges(&'a self) -> Self::BridgeTraverser;

    // Provided methods
    fn count_nodes(&'a self) -> usize { ... }
    fn get_outgoing(&'a self, node: NodeID) -> Self::NeighborIterator { ... }
    fn get_incoming(&'a self, node: NodeID) -> Self::NeighborIterator { ... }
    fn count_degree(&'a self, node: NodeID) -> NodeDegree { ... }
    fn count_edges(&'a self) -> usize { ... }
    fn size_hint(&self) -> usize { ... }

}
Expand description

Represent a graph storage, with a set of nodes and edges.

Examples

use graph_theory::GraphEngine;

Required Associated Types§

source

type NeighborIterator: DoubleEndedIterator<Item = NodeID>

According to a given vertex, find all neighbor nodes

source

type BridgeIterator: DoubleEndedIterator<Item = IndeterminateEdge>

An iterator over the edges.

source

type NodeTraverser: DoubleEndedIterator<Item = NodeID>

An iterator over the nodes.

source

type EdgeTraverser: DoubleEndedIterator<Item = EdgeID>

An iterator over the edges.

source

type BridgeTraverser: DoubleEndedIterator<Item = IndeterminateEdge>

An iterator over the edges.

Required Methods§

source

fn graph_kind(&self) -> GraphKind

Check the graph kind, it can be directed or undirected.

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
assert_eq!(CompleteGraph::one_way(5).get_node(5), true);
assert_eq!(CompleteGraph::one_way(5).get_node(6), false);
source

fn get_node(&self, node: NodeID) -> Result<NodeID, GraphError>

Check if the node exists, return the node id if exists.

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
assert_eq!(CompleteGraph::one_way(5).get_node(5), true);
assert_eq!(CompleteGraph::one_way(5).get_node(6), false);
source

fn all_nodes(&'a self) -> Self::NodeTraverser

Traverse all nodes in the graph.

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
let mut graph = CompleteGraph::one_way(5);
assert_eq!(graph.all_nodes().count(), 20)
source

fn all_neighbors(&'a self, node: NodeID) -> Self::NeighborIterator

Check if the node exists, return the node id if exists.

Return None if the node does not exist.

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
assert_eq!(CompleteGraph::one_way(5).count_nodes(), 5);
source

fn get_edge(&self, edge: EdgeID) -> Result<EdgeID, GraphError>

Check if the edge exists, return the node id if exists.

At most one element will be returned, even if there are multiple edges with the same starting point and ending point.

If you need to return all eligible edges, use Self::get_bridges.

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
assert_eq!(CompleteGraph::one_way(5).get_node(5), true);
assert_eq!(CompleteGraph::one_way(5).get_node(6), false);
source

fn all_edges(&'a self) -> Self::EdgeTraverser

Get the edges of the graph.

use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
let mut graph = CompleteGraph::one_way(5);
assert_eq!(graph.all_nodes().count(), 20)
source

fn get_bridge(&self, edge: EdgeID) -> Result<IndeterminateEdge, GraphError>

source

fn get_bridges(&'a self, from: NodeID, goto: NodeID) -> Self::BridgeIterator

Give all edges matching the start and end points

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
assert_eq!(CompleteGraph::one_way(5).get_node(5), true);
assert_eq!(CompleteGraph::one_way(5).get_node(6), false);
source

fn all_bridges(&'a self) -> Self::BridgeTraverser

Get the edges of the graph.

use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
let mut graph = CompleteGraph::one_way(5);
assert_eq!(graph.all_nodes().count(), 20)

Provided Methods§

source

fn count_nodes(&'a self) -> usize

Count the number of nodes in the graph.

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
assert_eq!(CompleteGraph::one_way(5).count_nodes(), 5);
source

fn get_outgoing(&'a self, node: NodeID) -> Self::NeighborIterator

Find all vertices ending at a given point

Return None if the node does not exist.

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
assert_eq!(CompleteGraph::one_way(5).count_nodes(), 5);
source

fn get_incoming(&'a self, node: NodeID) -> Self::NeighborIterator

Check if the node exists, return the node id if exists.

Return None if the node does not exist.

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
assert_eq!(CompleteGraph::one_way(5).count_nodes(), 5);
source

fn count_degree(&'a self, node: NodeID) -> NodeDegree

Check if the node exists, return the node id if exists.

Return None if the node does not exist.

Examples
use graph_theory::{graph_engines::CompleteGraph, GraphEngine};
assert_eq!(CompleteGraph::one_way(5).count_nodes(), 5);
source

fn count_edges(&'a self) -> usize

Count the number of edges in the graph.

Examples
assert_eq!(CycleGraph::one_way(5).count_edges(), 5);
assert_eq!(CycleGraph::two_way(5).count_edges(), 10);
assert_eq!(StarGraph::one_way(5).count_edges(), 5);
assert_eq!(StarGraph::two_way(5).count_edges(), 10);
assert_eq!(CompleteGraph::one_way(5).count_edges(), 5);
assert_eq!(CompleteGraph::one_way(5).count_edges(), 10);
source

fn size_hint(&self) -> usize

Query the total space occupied by the structure, return 0 if failed to query

Note that this volume contains garbage data, call [GraphEngine::shrink] at the right time to perform garbage collection.

Implementors§