Struct graphene::core::constraint::UniqueGraph

pub struct UniqueGraph<G> where
    G: ConstrainedGraph,
    <G as BaseGraph>::Vertex: Vertex,
    <G as BaseGraph>::Weight: Weight,
    <<G as BaseGraph>::VertexIter as IntoIterator>::IntoIter: ExactSizeIterator,
    <<G as BaseGraph>::EdgeIter as IntoIterator>::IntoIter: ExactSizeIterator,  { /* fields omitted */ }

A graph wrapper that enforces the Unique constraint on any graph its given.

See <INSERT LINK TO Unique> for a complete description.

Trait Implementations

impl<G: Debug> Debug for UniqueGraph<G> where
    G: ConstrainedGraph,
    <G as BaseGraph>::Vertex: Vertex,
    <G as BaseGraph>::Weight: Weight,
    <<G as BaseGraph>::VertexIter as IntoIterator>::IntoIter: ExactSizeIterator,
    <<G as BaseGraph>::EdgeIter as IntoIterator>::IntoIter: ExactSizeIterator, 

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<G: Clone> Clone for UniqueGraph<G> where
    G: ConstrainedGraph,
    <G as BaseGraph>::Vertex: Vertex,
    <G as BaseGraph>::Weight: Weight,
    <<G as BaseGraph>::VertexIter as IntoIterator>::IntoIter: ExactSizeIterator,
    <<G as BaseGraph>::EdgeIter as IntoIterator>::IntoIter: ExactSizeIterator, 

fn clone(&self) -> UniqueGraph<G>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G> GraphWrapper for UniqueGraph<G> where
    G: ConstrainedGraph,
    <G as BaseGraph>::Vertex: Vertex,
    <G as BaseGraph>::Weight: Weight,
    <<G as BaseGraph>::VertexIter as IntoIterator>::IntoIter: ExactSizeIterator,
    <<G as BaseGraph>::EdgeIter as IntoIterator>::IntoIter: ExactSizeIterator, 

type Wrapped = G

fn wrap(g: Self::Wrapped) -> Self

fn wrapped(&self) -> &Self::Wrapped

fn wrapped_mut(&mut self) -> &mut Self::Wrapped

fn unwrap(self) -> Self::Wrapped

impl<G> Unique for UniqueGraph<G> where
    G: ConstrainedGraph,
    <G as BaseGraph>::Vertex: Vertex,
    <G as BaseGraph>::Weight: Weight,
    <<G as BaseGraph>::VertexIter as IntoIterator>::IntoIter: ExactSizeIterator,
    <<G as BaseGraph>::EdgeIter as IntoIterator>::IntoIter: ExactSizeIterator, 

impl<G> BaseGraph for UniqueGraph<G> where
    G: ConstrainedGraph,
    <G as BaseGraph>::Vertex: Vertex,
    <G as BaseGraph>::Weight: Weight,
    <<G as BaseGraph>::VertexIter as IntoIterator>::IntoIter: ExactSizeIterator,
    <<G as BaseGraph>::EdgeIter as IntoIterator>::IntoIter: ExactSizeIterator, 

type Vertex = <G as BaseGraph>::Vertex

Type of the vertices in the graph.

type Weight = <G as BaseGraph>::Weight

Type of the weights in the graph.

type VertexIter = <G as BaseGraph>::VertexIter

Type of the collection returned with vertices.

type EdgeIter = <G as BaseGraph>::EdgeIter

Type of the collection returned with edges.

fn empty_graph() -> Self

Creates an empty graph. I.e a graph with no vertices and no edges.

fn all_vertices(&self) -> Self::VertexIter

Returns copies of all current vertices in the graph.

fn all_edges(&self) -> Self::EdgeIter

Returns copies of all current edges in the graph.

fn add_vertex(&mut self, v: Self::Vertex) -> Result<(), ()>

Adds the given vertex to graph as long as no equal vertex is already present i the graph and the graph is capable of storing it.

fn remove_vertex(&mut self, v: Self::Vertex) -> Result<(), ()>

Removes the given vertex from the graph, assuming it is present.

fn add_edge(
    &mut self,
    e: BaseEdge<Self::Vertex, Self::Weight>
) -> Result<(), ()>

Adds the given edge to the graph assuming it connects to valid vertices.

fn remove_edge(
    &mut self,
    e: BaseEdge<Self::Vertex, Self::Weight>
) -> Result<(), ()>

Removes the given edge from the graph, assuming it is already present.

fn vertex_count(&self) -> usize

Returns the number of vertices in the graph.

fn edge_count(&self) -> usize

Returns the number of edges in the graph.

fn graph(
    vertices: Vec<Self::Vertex>,
    edges: Vec<(Self::Vertex, Self::Vertex, Self::Weight)>
) -> Result<Self, ()> where
    Self: Sized, 

Creates a graph containing the given vertices and edges. There can be no duplicate vertices and all edges must connect to the given vertices.

fn edges_between(&self, v1: Self::Vertex, v2: Self::Vertex) -> Self::EdgeIter

Returns all edges that are connect to both the given vertices.

fn edges_sourced_in(&self, v: Self::Vertex) -> Self::EdgeIter

Returns all edges that are sourced in the given vertex.

fn edges_sinked_in(&self, v: Self::Vertex) -> Self::EdgeIter

Returns all edges that are sinked in the given vertex.

impl<G> ConstrainedGraph for UniqueGraph<G> where
    G: ConstrainedGraph,
    <G as BaseGraph>::Vertex: Vertex,
    <G as BaseGraph>::Weight: Weight,
    <<G as BaseGraph>::VertexIter as IntoIterator>::IntoIter: ExactSizeIterator,
    <<G as BaseGraph>::EdgeIter as IntoIterator>::IntoIter: ExactSizeIterator, 

fn invariant_holds(&self) -> bool

Checks whether the current state of the graph upholds the constraint invariant.

unsafe fn uncon_add_vertex(&mut self, v: Self::Vertex) -> Result<(), ()>

Adds the given vertex to the graph without upholding the constraint invariant.

unsafe fn uncon_remove_vertex(&mut self, v: Self::Vertex) -> Result<(), ()>

Removes the given vertex from the graph without upholding the constraint invariant.

unsafe fn uncon_add_edge(
    &mut self,
    e: BaseEdge<Self::Vertex, Self::Weight>
) -> Result<(), ()>

Adds the given edge to the graph without upholding the constraint invariant.

unsafe fn uncon_remove_edge(
    &mut self,
    e: BaseEdge<Self::Vertex, Self::Weight>
) -> Result<(), ()>

Removes the given edge from the graph without upholding the constraint invariant.

fn unconstrained<'a>(
    &'a mut self
) -> Unconstrainer<Self::Vertex, Self::Weight, Self::VertexIter, Self::EdgeIter, Self>

Returns an Unconstrainer connected to the graph.