Trait graphene::core::BaseGraph [−] [src]

pub trait BaseGraph where
    <Self::VertexIter as IntoIterator>::IntoIter: ExactSizeIterator,
    <Self::EdgeIter as IntoIterator>::IntoIter: ExactSizeIterator, {
    type Vertex: Vertex;
    type Weight: Weight;
    type VertexIter: VertexIter<Self::Vertex>;
    type EdgeIter: EdgeIter<Self::Vertex, Self::Weight>;
    fn empty_graph() -> Self;

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

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

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

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

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

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

    fn vertex_count(&self) -> usize { ... }

    fn edge_count(&self) -> usize { ... }

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

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

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

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

The basic graph interface.

This is the main trait for all types of graphs.

The vertices in a graph are identified by their value, and must therefore be unique in the graph.

The edges in a graph are identified by the vertices they are incident on and their weight. Edges do not have to be unique, but if there are duplicates (i.e. two or more edges incident on the same vertices with the same weights) then any operation intended for one of the edges may happen on any one of them. E.g. If one of the edges is to be removed, then any one of them will be so.

Associated Types

Type of the vertices in the graph.

Type of the weights in the graph.

Type of the collection returned with vertices.

Type of the collection returned with edges.

Required Methods

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

Properties:

  • empty().all_vertices().into_iter().next() == None
  • empty().all_edges().into_iter().next() == None
  • empty().add_vertex(v) == Ok(())
  • empty().add_edge(e) == Err(())
  • empty().remove_vertex(v) == Err(())
  • empty().remove_edge(e) == Err(())

Returns copies of all current vertices in the graph.

Returns copies of all current edges in the graph.

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.

###Returns:

  • Ok if the vertex is valid and has been added.
  • Err if the vertex is already present in the graph or the graph doesn't have capacity for it.

###Ok properties :

  • All vertices present before the call are also present after it.
  • All edges present before the call are also present after it.
  • No edge weights are changed.
  • No new edges are introduced.
  • Only the given vertex is added to the graph.

###Err properties :

  • The graph is unchanged.

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

###Returns:

  • Ok if the vertex was removed.
  • Err if the vertex was not present in the graph.

###Ok properties:

  • Only the given vertex is removed from the graph.
  • Any edge connecting to the removed vertex is also removed.
  • All other edges are unchanged.
  • No new vertices are introduced.
  • No new edges are introduced.
  • No edge weights are changed.

###Err properties:

  • The graph is unchanged.

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

###Returns

  • Ok if the edge connects to valid vertices and the edge was added successfully.
  • Err if the edge connects to invalid vertices or was not added.

###Ok properties:

  • Only the given edge is added to the graph.
  • Existing edges are unchanged.
  • No vertices are introduced or removed.

###Err properties:

  • The graph is unchanged.

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

###Returns

  • Ok if the edge was present before the call and was removed successfully.
  • Err if the edge was not found in the graph.

###Ok properties:

  • Only the given edge is removed.
  • No new edges are introduced.
  • No edge weights are changed.
  • No new vertices are introduced or removed.

###Err properties:

  • The graph is unchanged.

Provided Methods

Returns the number of vertices in the graph.

Returns the number of edges in the graph.

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

###Returns:

  • Ok: If the given graph description is valid, the created graph is returned.
  • Err: If the given graph description is invalid.

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

I.e. all edges where e == (v1,v2,) or e == (v2,v1,)

Returns all edges that are sourced in the given vertex.

I.e. all edges where e == (v,_,_)

Returns all edges that are sinked in the given vertex.

I.e. all edges where e == (_,v,_)

Implementors