Struct rs_graph::attributed::Attributed

pub struct Attributed<G, Gx = (), Nx = (), Ex = ()> { /* fields omitted */ }

Deprecated since 0.17.0:

use rs-graph-derive crate instead

Wrapper to attach attributes with a graph.

This is a wrapper struct that adds additional attributes to an arbitrary graph. The type parameters are

• 'Gx` the type of graph attributes.
• 'Nx` the type of node attributes.
• 'Ex` the type of edge attributes.
• 'Ax` the type of biedge attributes.

The attributed graph implements Graph, Digraph and Network if the the wrapped graph does.

Example

use rs_graph::{LinkedListGraph, classes, traits::*};
use rs_graph::attributed::{Attributes, Attributed, AttributedGraph};

#[derive(Default)]
struct NodeAttr {
    balance: f64,
}

#[derive(Default)]
struct EdgeAttr {
    flow: f64,
}

type MyGraph = Attributed<LinkedListGraph, (), NodeAttr, EdgeAttr>;
let mut g: MyGraph = classes::complete_bipartite(3,4);

{
    let (g, mut attr) = g.split();
    for u in g.nodes() {
        attr.node_mut(u).balance = 42.0;
    }
    for e in g.edges() {
        attr.edge_mut(e).flow = 1.5;
    }
}

assert!(g.nodes().all(|u| g.node(u).balance == 42.0));
assert!(g.edges().all(|e| g.edge(e).flow == 1.5));

Trait Implementations

impl<'a, G, Gx, Nx, Ex> AttributedGraph<'a> for Attributed<G, Gx, Nx, Ex> where
    G: 'a + IndexGraph<'a>,
    Gx: 'a + Default,
    Nx: 'a + Default,
    Ex: 'a + Default, 

type Graph = G

Deprecated since 0.17.0:

use rs-graph-derive crate instead

type Attributes = GraphAttrs<'a, G, Gx, Nx, Ex>

Deprecated since 0.17.0:

use rs-graph-derive crate instead

fn split(&'a mut self) -> (&G, Self::Attributes)

Deprecated since 0.17.0:

use rs-graph-derive crate instead

Return a read-only graph reference and a mutable attributes reference.

fn attr(&self) -> &Gx

Deprecated since 0.17.0:

use rs-graph-derive crate instead

Return the graph attributes.

fn attr_mut(&mut self) -> &mut Gx

Deprecated since 0.17.0:

use rs-graph-derive crate instead

Return the graph attributes.

fn node(&self, u: G::Node) -> &Nx

Deprecated since 0.17.0:

use rs-graph-derive crate instead

Return the attributes of a node.

fn node_mut(&mut self, u: G::Node) -> &mut Nx

Deprecated since 0.17.0:

use rs-graph-derive crate instead

Return the attributes of a node.

fn edge(&self, e: G::Edge) -> &Ex

Deprecated since 0.17.0:

use rs-graph-derive crate instead

Return the attributes of an edge.

fn edge_mut(&mut self, e: G::Edge) -> &mut Ex

Deprecated since 0.17.0:

use rs-graph-derive crate instead

Return the attributes of an edge.

impl<'a, G, Gx, Nx, Ex> Buildable for Attributed<G, Gx, Nx, Ex> where
    G: GraphSize<'a> + Buildable,
    Gx: 'a + Default,
    Nx: 'a + Default,
    Ex: 'a + Default, 

type Builder = AttributedBuilder<G::Builder, Gx, Nx, Ex>

fn new_builder() -> Self::Builder

Create a new builder for this graph type.

fn new_with<F>(f: F) -> Self where
    F: FnOnce(&mut Self::Builder), 

Create a new graph by passing the builder to the callback f.

impl<'a, G, Gx, Nx, Ex> Directed<'a> for Attributed<G, Gx, Nx, Ex> where
    G: Directed<'a>,
    Gx: Default,
    Nx: Default,
    Ex: Default, 

type OutEdge = G::OutEdge

Type of a graph iterator over edges leaving a node.

type InEdge = G::InEdge

Type of a graph iterator over edges entering a node.

type IncidentEdge = G::IncidentEdge

Type of an iterator over all incident edges.

type DirectedEdge = G::DirectedEdge

Type of a directed edge.

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

Return the source node of an edge.

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

Return the sink node of an edge.

fn first_out(&'a self, u: Self::Node) -> Option<Self::OutEdge>

Return an iterator over the edges leaving a node.

fn next_out(&'a self, it: Self::OutEdge) -> Option<Self::OutEdge>

Advance the iterator to the next outgoing edge.

fn get_out(&'a self, it: &Self::OutEdge) -> (Self::Edge, Self::Node)

Return the edge and sink node of an outgoing edge iterator.

fn first_in(&'a self, u: Self::Node) -> Option<Self::InEdge>

Return an iterator over the edges entering a node.

fn next_in(&'a self, it: Self::InEdge) -> Option<Self::InEdge>

Advance the iterator to the next incoming edge.

fn get_in(&'a self, it: &Self::InEdge) -> (Self::Edge, Self::Node)

Return the edge and sink node of an incoming edge iterator.

fn first_incident(&'a self, u: Self::Node) -> Option<Self::IncidentEdge>

Return an iterator over the edges entering a node.

fn next_incident(&'a self, it: Self::IncidentEdge) -> Option<Self::IncidentEdge>

Advance the iterator to the next incoming edge.

fn get_incident(
    &'a self,
    it: &Self::IncidentEdge
) -> (Self::DirectedEdge, Self::Node)

Return the edge and sink node of an incoming edge iterator.

Important traits for OutEdgeIter<'a, G>

impl<'a, G> Iterator for OutEdgeIter<'a, G> where
    G: Directed<'a>,  type Item = (G::Edge, G::Node);

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

Return an iterator over the outgoing edges of a node.

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

Return access to the outgoing arcs via an Adjacencies trait.

Important traits for InEdgeIter<'a, G>

impl<'a, G> Iterator for InEdgeIter<'a, G> where
    G: Directed<'a>,  type Item = (G::Edge, G::Node);

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

Return an iterator over the incoming edges of a node.

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

Return access to the incoming arcs via an Adjacencies trait.

Important traits for IncidentEdgeIter<'a, G>

impl<'a, G> Iterator for IncidentEdgeIter<'a, G> where
    G: Directed<'a>,  type Item = (G::DirectedEdge, G::Node);

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

Return access to all incident edges of a node.

impl<'a, G, Gx, Nx, Ex> GraphSize<'a> for Attributed<G, Gx, Nx, Ex> where
    G: GraphSize<'a>,
    Gx: Default,
    Nx: Default,
    Ex: Default, 

type NodeIter = G::NodeIter

Type of an iterator over all nodes.

type EdgeIter = G::EdgeIter

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(&'a self) -> Self::NodeIter

Return an iterator over all nodes.

fn edges(&'a self) -> Self::EdgeIter

Return an iterator over all edges.

impl<'a, G, Gx, Nx, Ex> GraphType<'a> for Attributed<G, Gx, Nx, Ex> where
    G: GraphType<'a>,
    Gx: Default,
    Nx: Default,
    Ex: Default, 

type Node = G::Node

Type of a node.

type Edge = G::Edge

Type of an edge.

impl<'a, G, Gx, Nx, Ex> IndexGraph<'a> for Attributed<G, Gx, Nx, Ex> where
    G: IndexGraph<'a>,
    Gx: Default,
    Nx: Default,
    Ex: Default, 

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

Return a unique id associated with a node.

fn id2node(&'a 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(&'a self, id: usize) -> Self::Edge

Return the edge associated with the given id.

impl<'a, G, Gx, Nx, Ex> Undirected<'a> for Attributed<G, Gx, Nx, Ex> where
    G: Undirected<'a>,
    Gx: Default,
    Nx: Default,
    Ex: Default, 

type Neigh = G::Neigh

Type of a graph iterator over all incident edges.

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

Return the nodes connected by an edge.

fn first_neigh(&'a self, u: Self::Node) -> Option<Self::Neigh>

Return an iterator over the edges adjacent to some node.

fn next_neigh(&'a self, it: Self::Neigh) -> Option<Self::Neigh>

Advance the iterator to the next adjacent edge.

fn get_neigh(&'a self, it: &Self::Neigh) -> (Self::Edge, Self::Node)

Return the edge and neighboring node of an iterator.

Important traits for NeighIter<'a, G>

impl<'a, G> Iterator for NeighIter<'a, G> where
    G: Undirected<'a>,  type Item = (G::Edge, G::Node);

fn neighs(&'a self, u: Self::Node) -> NeighIter<Self> 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.