Struct gamma::graph::HashGraph

pub struct HashGraph { /* fields omitted */ }

A Graph backed by an adjacency map. Nodes will not necessarily be iterated in numerical order, but all iteration orders are stable. As such, HashGraph works well when extracting subgraphs from other graphs.

use gamma::graph::{ Graph, HashGraph, Error, Step };
 
fn main() -> Result<(), Error> {
    let c3 = HashGraph::from_traversal(0, vec![
        Step::new(0, 1, false),
        Step::new(1, 2, false),
        Step::new(2, 0, true)
    ])?;
 
    assert_eq!(c3.nodes().to_vec(), vec![ 0, 1, 2 ]);
 
    let result = HashGraph::from_traversal(0, vec![
        Step::new(0, 1, false),
        Step::new(1, 0, false)
    ]);
 
    assert_eq!(result, Err(Error::DuplicateEdge(1, 0)));
 
    Ok(())
}

Implementations

impl HashGraph

pub fn from_traversal(root: usize, steps: Vec<Step>) -> Result<Self, Error>

Builds from a traversal. Returns an error given:

• a Step source has not been seen before
• duplicate edge forward or reversed

pub fn from_edges(
    edges: Vec<(usize, usize)>,
    singletons: Vec<usize>
) -> Result<Self, Error>

Builds a node-induced subgraph from edges. Returns error given:

• duplicate edge forward or reversed

Trait Implementations

impl Debug for HashGraph

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Graph for HashGraph

fn is_empty(&self) -> bool

Returns true if there are no nodes, or false otherwise.

fn order(&self) -> usize

Returns the number of nodes in this graph.

fn size(&self) -> usize

Returns the number of edges in this graph.

fn nodes(&self) -> &[usize]

Returns the nodes of this graph.

fn neighbors(&self, id: usize) -> Result<&[usize], Error>

Iterates the neighbors of the node. Returns an error if id not found.

fn has_node(&self, id: usize) -> bool

Returns true if node is a member, or false otherwise.

fn degree(&self, id: usize) -> Result<usize, Error>

Returns the count of neighbors at node. REturns an error if id not found.

fn edges(&self) -> &[(usize, usize)]

Returns the edges of this graph.

fn has_edge(&self, sid: usize, tid: usize) -> Result<bool, Error>

Returns true if the edge (sid, tid) exists, or false otherwise. Returns MissingNode if either sid or tid are not members.

impl PartialEq<HashGraph> for HashGraph

fn eq(&self, other: &HashGraph) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HashGraph) -> bool

This method tests for !=.

impl StructuralPartialEq for HashGraph