Struct rs_graph::adapters::network::Network

pub struct Network<'a, G>(_);

The network graph adaptor.

It is meant to be used by borrowing the underlying graph.

let g = classes::cycle::<LinkedListGraph>(5);
let n = Network::new(&g);

The network inherits all trait implementations from the underlying graph. In particular, if the underlying graph implements IndexGraph then nodes and edges of the network are numbered, too:

• The node_id is the same as in the underlying graph,
• the edge with id i is mapped to the edges 2*i (forward edge) and 2*i+1 (backward edge).

Implementations

impl<'a, G> Network<'a, G> where
    G: Digraph<'a>, 

pub fn new(g: &'a G) -> Self

Create a new network adapter wrapping g.

pub fn as_graph(&self) -> &'a G

Return a reference to the underlying graph.

pub fn from_edge(&self, e: G::Edge) -> NetworkEdge<G::Edge>

Return the forward edge corresponding the edge e in the underlying graph.

Trait Implementations

impl<'a, G> Clone for Network<'a, G>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, G: Copy> Copy for Network<'a, G>

impl<'a, 'g: 'a, G> Directed<'a> for Network<'g, G> where
    G: Digraph<'g>, 

type OutIt = NetworkOutIt<G::IncidentIt>

Type of a graph iterator over edges leaving a node.

type InIt = NetworkInIt<G::IncidentIt>

Type of a graph iterator over edges entering a node.

type IncidentIt = NetworkIncidentIt<G::IncidentIt, (G::DirectedEdge, G::Node)>

Type of an iterator over all incident edges.

type DirectedEdge = NetworkDirectedEdge<Self::Edge>

Type of a directed edge.

fn src(&self, e: Self::Edge) -> Self::Node

Return the source node of an edge.

fn snk(&self, e: Self::Edge) -> Self::Node

Return the sink node of an edge.

fn out_iter(&self, u: Self::Node) -> Self::OutIt

Return a graph iterator over the edges leaving a node.

fn in_iter(&self, u: Self::Node) -> Self::InIt

Return a graph iterator over the edges leaving a node.

fn incident_iter(&self, u: Self::Node) -> Self::IncidentIt

Return an iterator over all directed edges incident with a node.

fn outedges(&'a self, u: Self::Node) -> GraphIter<'a, Self, Self::OutIt> where
    Self: Sized, 

Return an iterator over the edges leaving a node.

fn outgoing(&'a self) -> OutEdges<'a, Self> where
    Self: Sized, 

Return access to the outgoing arcs via an Adjacencies trait.

fn inedges(&'a self, u: Self::Node) -> GraphIter<'a, Self, Self::InIt> where
    Self: Sized, 

Return an iterator over the edges leaving a node.

fn incoming(&'a self) -> InEdges<'a, Self> where
    Self: Sized, 

Return access to the incoming arcs via an Adjacencies trait.

fn incident_edges(
    &'a self,
    u: Self::Node
) -> GraphIter<'a, Self, Self::IncidentIt> where
    Self: Sized, 

Return an iterator over all directed edges incident with a node.

impl<'a, G> DirectedRef<'a> for Network<'a, G> where
    G: 'a + Directed<'a>, 

fn src(&self, e: Self::Edge) -> Self::Node

fn snk(&self, e: Self::Edge) -> Self::Node

fn out_iter(&self, u: Self::Node) -> Self::OutIt

fn in_iter(&self, u: Self::Node) -> Self::InIt

fn incident_iter(&self, u: Self::Node) -> Self::IncidentIt

impl<'a, G, I> GraphIterator<Network<'a, G>> for NetworkNodeIt<I> where
    I: GraphIterator<G>, 

type Item = I::Item

fn next(&mut self, net: &Network<'a, G>) -> Option<Self::Item>

fn size_hint(&self, net: &Network<'a, G>) -> (usize, Option<usize>)

fn count(self, net: &Network<'a, G>) -> usize

fn iter<'a>(self, g: &'a G) -> GraphIter<'a, G, Self> where
    G: Sized, 

impl<'a, G, I> GraphIterator<Network<'a, G>> for NetworkEdgeIt<G, I> where
    I: GraphIterator<G>,
    I::Item: Clone, 

type Item = NetworkEdge<I::Item>

fn next(&mut self, net: &Network<'a, G>) -> Option<Self::Item>

fn size_hint(&self, net: &Network<'a, G>) -> (usize, Option<usize>)

fn count(self, net: &Network<'a, G>) -> usize

fn iter<'a>(self, g: &'a G) -> GraphIter<'a, G, Self> where
    G: Sized, 

impl<'a, G, I, N, E> GraphIterator<Network<'a, G>> for NetworkNeighIt<G, I> where
    N: Clone,
    E: Clone,
    I: GraphIterator<G, Item = (E, N)>, 

type Item = (NetworkEdge<E>, N)

fn next(&mut self, net: &Network<'a, G>) -> Option<Self::Item>

fn size_hint(&self, net: &Network<'a, G>) -> (usize, Option<usize>)

fn count(self, net: &Network<'a, G>) -> usize

fn iter<'a>(self, g: &'a G) -> GraphIter<'a, G, Self> where
    G: Sized, 

impl<'a, G, I, N, D> GraphIterator<Network<'a, G>> for NetworkOutIt<I> where
    I: GraphIterator<G, Item = (D, N)>,
    D: DirectedEdge, 

type Item = (NetworkEdge<D::Edge>, N)

fn next(&mut self, net: &Network<'a, G>) -> Option<Self::Item>

fn size_hint(&self, net: &Network<'a, G>) -> (usize, Option<usize>)

fn count(self, net: &Network<'a, G>) -> usize

fn iter<'a>(self, g: &'a G) -> GraphIter<'a, G, Self> where
    G: Sized, 

impl<'a, G, I, N, D> GraphIterator<Network<'a, G>> for NetworkInIt<I> where
    I: GraphIterator<G, Item = (D, N)>,
    D: DirectedEdge, 

type Item = (NetworkEdge<D::Edge>, N)

fn next(&mut self, net: &Network<'a, G>) -> Option<Self::Item>

fn size_hint(&self, net: &Network<'a, G>) -> (usize, Option<usize>)

fn count(self, net: &Network<'a, G>) -> usize

fn iter<'a>(self, g: &'a G) -> GraphIter<'a, G, Self> where
    G: Sized, 

impl<'a, G, I, N, D> GraphIterator<Network<'a, G>> for NetworkIncidentIt<I, I::Item> where
    I: GraphIterator<G, Item = (D, N)>,
    N: Clone,
    D: DirectedEdge + Clone, 

type Item = (NetworkDirectedEdge<NetworkEdge<D::Edge>>, N)

fn next(&mut self, net: &Network<'a, G>) -> Option<Self::Item>

fn size_hint(&self, net: &Network<'a, G>) -> (usize, Option<usize>)

fn count(self, net: &Network<'a, G>) -> usize

fn iter<'a>(self, g: &'a G) -> GraphIter<'a, G, Self> where
    G: Sized, 

impl<'a, 'g: 'a, G> GraphSize<'a> for Network<'g, G> where
    G: Digraph<'g>, 

type NodeIt = NetworkNodeIt<G::NodeIt>

Type of an iterator over all nodes.

type EdgeIt = NetworkEdgeIt<G, G::EdgeIt>

Type of an iterator over all edges.

fn num_nodes(&self) -> usize

Return the number of nodes in the graph.

fn num_edges(&self) -> usize

Return the number of edges in the graph.

fn nodes_iter(&self) -> Self::NodeIt

Return a graph iterator over all nodes.

fn edges_iter(&self) -> Self::EdgeIt

Return a graph iterator over all edges.

fn nodes(&'a self) -> NodeIterator<'a, Self> where
    Self: Sized, 

Return an iterator over all nodes.

fn edges(&'a self) -> EdgeIterator<'a, Self> where
    Self: Sized, 

Return an iterator over all edges.

impl<'a, G> GraphSizeRef<'a> for Network<'a, G> where
    G: Directed<'a>, 

fn nodes_iter(&self) -> Self::NodeIt

fn edges_iter(&self) -> Self::EdgeIt

fn nodes<'b>(&'b self) -> GraphIter<'b, Self, Self::NodeIt> where
    Self: Sized,
    'a: 'b, 

fn edges<'b>(&'b self) -> GraphIter<'b, Self, Self::EdgeIt> where
    Self: Sized,
    'a: 'b, 

impl<'a, 'g: 'a, G> GraphType<'a> for Network<'g, G> where
    G: Digraph<'g>, 

type Node = G::Node

Type of a node.

type Edge = NetworkEdge<G::Edge>

Type of an edge.

impl<'a, 'g: 'a, G> IndexGraph<'a> for Network<'g, G> where
    G: Digraph<'g> + IndexGraph<'g>, 

fn node_id(&self, u: Self::Node) -> usize

Return a unique id associated with a node.

fn id2node(&self, id: usize) -> Self::Node

Return the node associated with the given id.

fn edge_id(&self, e: Self::Edge) -> usize

Return a unique id associated with an edge.

fn id2edge(&self, id: usize) -> Self::Edge

Return the edge associated with the given id.

impl<'a, G> IndexGraphRef<'a> for Network<'a, G> where
    G: Directed<'a> + IndexGraph<'a>, 

fn id2node(&self, id: usize) -> Self::Node

fn id2edge(&self, id: usize) -> Self::Edge

impl<'a, 'g: 'a, G> Undirected<'a> for Network<'g, G> where
    G: Digraph<'g>, 

type NeighIt = NetworkNeighIt<G, G::NeighIt>

Type of a graph iterator over all incident edges.

fn enodes(&self, e: Self::Edge) -> (Self::Node, Self::Node)

Return the nodes connected by an edge.

fn neigh_iter(&self, u: Self::Node) -> Self::NeighIt

Return a graph iterator over the edges adjacent to some node.

fn neighs(&'a self, u: Self::Node) -> GraphIter<'a, Self, Self::NeighIt> where
    Self: Sized, 

Return an iterator over the edges adjacent to some node.

fn neighbors(&'a self) -> Neighbors<'a, Self> where
    Self: Sized, 

Return access to the neighbors via an Adjacencies trait.

impl<'a, G> UndirectedRef<'a> for Network<'a, G> where
    G: Directed<'a>, 

fn enodes(&self, e: Self::Edge) -> (Self::Node, Self::Node)

fn neigh_iter(&self, u: Self::Node) -> Self::NeighIt