Struct graphs::simple_graph::SimpleGraph

pub struct SimpleGraph<N, E> { /* fields omitted */ }

A simple directed graph implementation.

• Nodes are represented with Vec<N>

• Edges are represented with Vec<Vec<Option<E>>>

• All IDs are opaque data structures

Please see the trait implementations for more details

Implementations

impl<N, E> SimpleGraph<N, E>

pub fn new() -> Self

Trait Implementations

impl<N: Clone, E: Clone> Clone for SimpleGraph<N, E>

pub fn clone(&self) -> SimpleGraph<N, E>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Debug, E: Debug> Debug for SimpleGraph<N, E>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<N, E> GraphBase for SimpleGraph<N, E>

type NodeID = NodeID

type EdgeID = EdgeID

impl<N, E> GraphEdgeAddable<E> for SimpleGraph<N, E> where
    E: Clone, 

pub fn add_edge(
    &mut self,
    a: Self::NodeID,
    b: Self::NodeID,
    data: E
) -> Self::EdgeID

Data added from node A to B will overwrite the data that was previously between those edges

impl<N, E> GraphEdgeEndpoints for SimpleGraph<N, E>

pub fn edge_endpoints(&self, id: Self::EdgeID) -> (Self::NodeID, Self::NodeID)

impl<N, E> GraphEdgeFrom for SimpleGraph<N, E>

pub fn edge_from(&self, EdgeID((id_a, _)): Self::EdgeID) -> Self::NodeID

Find the source of an edge

impl<N, E> GraphEdgeIndexable<E> for SimpleGraph<N, E>

pub fn edge(&self, EdgeID((id_a, id_b)): Self::EdgeID) -> &E

Get the data associated with an edge

Panics if the edge is not in the graph

impl<N, E> GraphEdgeMutIndexable<E> for SimpleGraph<N, E>

pub fn edge_mut(&mut self, EdgeID((id_a, id_b)): Self::EdgeID) -> &mut E

Get the data associated with an edge

Panics if the edge is not in the graph

impl<N, E> GraphEdgeRemovable<E> for SimpleGraph<N, E>

pub fn remove_edge(&mut self, EdgeID((id_a, id_b)): Self::EdgeID) -> E

Panics if the node is not in the graph

impl<N, E> GraphEdgeTo for SimpleGraph<N, E>

pub fn edge_to(&self, EdgeID((_, id_b)): Self::EdgeID) -> Self::NodeID

Find the destination of an edge

impl<N, E> GraphEdgesFrom for SimpleGraph<N, E>

type EdgesFromOutput = Vec<EdgeID>

pub fn edges_from(&self, NodeID(id): Self::NodeID) -> Self::EdgesFromOutput

Find all edges from a node

Return result in a Vec

impl<N, E> GraphNodeAddable<N> for SimpleGraph<N, E>

pub fn add_node(&mut self, data: N) -> Self::NodeID

Identical data added twice will return different node IDs

impl<N, E> GraphNodeIndexable<N> for SimpleGraph<N, E>

pub fn node(&self, NodeID(id): Self::NodeID) -> &N

Get the data associated with a node

Panics if the node is not in the graph

impl<N, E> GraphNodeMutIndexable<N> for SimpleGraph<N, E>

pub fn node_mut(&mut self, NodeID(id): Self::NodeID) -> &mut N

Get the data associated with a node

Panics if the node is not in the graph

impl<N, E> GraphNodeRemovable<N> for SimpleGraph<N, E>

pub fn remove_node(&mut self, NodeID(id): Self::NodeID) -> N

Panics if the node is not in the graph

Panics if any edges lead into or out of that edge