Struct calyx_utils::WeightGraph

pub struct WeightGraph<T> {
    pub index_map: HashMap<T, NodeIndex>,
    pub graph: UnMatrix<(), BoolIdx>,
}

Weight graph provides a wrapper over a Graph that allows adding edges using the NodeWeight type T (petgraph only allows adding edges using NodeIndex). Additionally, the edges are not allowed to have any weights.

The internal representation stores a mapping from NodeWeight T to a NodeIndex in the graph. The underlying petgraph::MatrixGraph stores () for node weights and a boolean to represent the edges.

Fields

index_map: HashMap<T, NodeIndex>

Mapping from T to a unique identifier.

graph: UnMatrix<(), BoolIdx>

Graph representating using identifier.

Implementations

impl<'a, T> WeightGraph<T>where
    T: 'a + Eq + Hash + Clone + Ord,

pub fn add_edge(&mut self, a: &T, b: &T)

Add an edge between a and b.

pub fn add_all_edges<C>(&mut self, items: C)where
    C: Iterator<Item = &'a T> + Clone,

Add edges between all given items.

pub fn contains_node(&self, node: &T) -> bool

Checks if the node has already been added to the graph.

pub fn add_node(&mut self, node: T)

Add a new node to the graph. Client code should ensure that duplicate edges are never added to graph. Instead of using this method, consider constructing the graph using From<Iterator<T>>.

Panics

(Debug build only) Panics if node is already present in the graph

pub fn reverse_index(&self) -> HashMap<NodeIndex, T>

Returns a Map from NodeIndex to T (the reverse of the index)

pub fn nodes(&self) -> impl Iterator<Item = &T>

Returns an iterator over references to nodes in the Graph.

pub fn degree(&self, node: &T) -> usize

Return the degree of a given node (number of edges connected).

Trait Implementations

impl<T: Eq + Hash + Clone + Ord> Default for WeightGraph<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T, C> From<C> for WeightGraph<T>where
    T: Eq + Hash + Ord,
    C: Iterator<Item = T>,

fn from(nodes: C) -> Self

Converts to this type from the input type.

impl<T: Eq + Hash + ToString + Clone + Ord> ToString for WeightGraph<T>

fn to_string(&self) -> String

Converts the given value to a String.