Trait rs_graph::builder::Builder
[−]
[src]
pub trait Builder where
Self: Sized, { type Graph; type Node: Node; type Edge: Edge; fn with_capacities(nnodes: usize, nedges: usize) -> Self; fn reserve(&mut self, nnodes: usize, nedges: usize); fn add_node(&mut self) -> Self::Node; fn add_edge(&mut self, u: Self::Node, v: Self::Node) -> Self::Edge; fn node2id(&self, u: Self::Node) -> usize; fn edge2id(&self, e: Self::Edge) -> usize; fn to_graph(self) -> Self::Graph; fn new() -> Self { ... } fn add_nodes(&mut self, n: usize) -> Vec<Self::Node> { ... } }
A trait to construct graphs.
In general graphs are static objects. In order to build a graph, one should use a graph builder and, once the construction is complete, convert it into a graph.
This 2-level approach is used because some graph implementations be unstable if the graph is modified (e.g., the node numbers might change). The builder approach allows to separate construction and use of a graph.
Associated Types
type Graph
The graph type produced by this builder.
type Node: Node
The type of a nodes.
type Edge: Edge
The type of an edge.
Required Methods
fn with_capacities(nnodes: usize, nedges: usize) -> Self
Create a new, empty builder.
The builder might be passed a guess of the number of nodes and edges. This might be used to reserve the appropriate internal memory, but is no strict requirement for the number of nodes and edges to be added to the graph.
fn reserve(&mut self, nnodes: usize, nedges: usize)
Reserve memory for a certain number of nodes and edges.
fn add_node(&mut self) -> Self::Node
Add a new node.
fn add_edge(&mut self, u: Self::Node, v: Self::Node) -> Self::Edge
Add a new edge.
fn node2id(&self, u: Self::Node) -> usize
Return a unique id of a node.
fn edge2id(&self, e: Self::Edge) -> usize
Return a unique id of an edge.
fn to_graph(self) -> Self::Graph
Turn the builder into a graph.
Provided Methods
fn new() -> Self
Create a new, empty builder.
fn add_nodes(&mut self, n: usize) -> Vec<Self::Node>
Add n
new nodes.
Implementors
impl<B> Builder for ReverseDigraphBuilder<B> where
B: Builder, type Graph = ReverseDigraph<B::Graph>; type Node = B::Node; type Edge = B::Edge;impl<'b, B, G, Gx, Nx, Ex, Ax> Builder for AttributedBuilder<B, Gx, Nx, Ex, Ax> where
B: Builder<Graph = G>,
G: Graph<'b>,
Gx: Default,
Nx: Default,
Ex: Default,
Ax: Default, type Graph = Attributed<G, Gx, Nx, Ex, Ax>; type Node = B::Node; type Edge = B::Edge;impl<ID> Builder for LinkedListGraph<ID> where
ID: PrimInt + Unsigned, type Graph = Self; type Node = Node<ID>; type Edge = Edge<ID>;