Struct petgraph::stable_graph::StableGraph [] [src]

pub struct StableGraph<N, E, Ty = Directed, Ix = DefaultIx> { /* fields omitted */ }

StableGraph<N, E, Ty, Ix> is a graph datastructure using an adjacency list representation.

The graph does not invalidate any unrelated node or edge indices when items are removed.

StableGraph is parameterized over:

The graph uses O(|V| + |E|) space, and allows fast node and edge insert and efficient graph search.

It implements O(e') edge lookup and edge and node removals, where e' is some local measure of edge count.

Depends on crate feature stable_graph (default). Stable Graph is still missing a few methods compared to Graph. You can contribute to help it achieve parity.

Methods

impl<N, E> StableGraph<N, E, Directed>
[src]

[src]

Create a new StableGraph with directed edges.

This is a convenience method. See StableGraph::with_capacity or StableGraph::default for a constructor that is generic in all the type parameters of StableGraph.

impl<N, E, Ty, Ix> StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

Create a new StableGraph with estimated capacity.

[src]

Return the current node and edge capacity of the graph.

[src]

Remove all nodes and edges

[src]

Remove all edges

[src]

Return the number of nodes (vertices) in the graph.

Computes in O(1) time.

[src]

Return the number of edges in the graph.

Computes in O(1) time.

[src]

Whether the graph has directed edges or not.

[src]

Add a node (also called vertex) with associated data weight to the graph.

Computes in O(1) time.

Return the index of the new node.

Panics if the StableGraph is at the maximum number of nodes for its index type.

[src]

Remove a from the graph if it exists, and return its weight. If it doesn't exist in the graph, return None.

The node index a is invalidated, but none other. Edge indices are invalidated as they would be following the removal of each edge with an endpoint in a.

Computes in O(e') time, where e' is the number of affected edges, including n calls to .remove_edge() where n is the number of edges with an endpoint in a.

[src]

[src]

Add an edge from a to b to the graph, with its associated data weight.

Return the index of the new edge.

Computes in O(1) time.

Panics if any of the nodes don't exist.
Panics if the StableGraph is at the maximum number of edges for its index type.

Note: StableGraph allows adding parallel (“duplicate”) edges.

[src]

Add or update an edge from a to b. If the edge already exists, its weight is updated.

Return the index of the affected edge.

Computes in O(e') time, where e' is the number of edges connected to a (and b, if the graph edges are undirected).

Panics if any of the nodes don't exist.

[src]

Remove an edge and return its edge weight, or None if it didn't exist.

Invalidates the edge index e but no other.

Computes in O(e') time, where e' is the number of edges conneced to the same endpoints as e.

[src]

Access the weight for node a.

Also available with indexing syntax: &graph[a].

[src]

Access the weight for node a, mutably.

Also available with indexing syntax: &mut graph[a].

Important traits for NodeIndices<'a, N, Ix>
[src]

Return an iterator over the node indices of the graph

[src]

Access the weight for edge e.

Also available with indexing syntax: &graph[e].

[src]

Access the weight for edge e, mutably

Also available with indexing syntax: &mut graph[e].

[src]

Access the source and target nodes for e.

Important traits for EdgeIndices<'a, E, Ix>
[src]

Return an iterator over the node indices of the graph

[src]

Lookup an edge from a to b.

Computes in O(e') time, where e' is the number of edges connected to a (and b, if the graph edges are undirected).

[src]

Lookup an edge between a and b, in either direction.

If the graph is undirected, then this is equivalent to .find_edge().

Return the edge index and its directionality, with Outgoing meaning from a to b and Incoming the reverse, or None if the edge does not exist.

Important traits for Neighbors<'a, E, Ix>
[src]

Return an iterator of all nodes with an edge starting from a.

  • Directed: Outgoing edges from a.
  • Undirected: All edges connected to a.

Produces an empty iterator if the node doesn't exist.
Iterator element type is NodeIndex<Ix>.

Use .neighbors(a).detach() to get a neighbor walker that does not borrow from the graph.

Important traits for Neighbors<'a, E, Ix>
[src]

Return an iterator of all neighbors that have an edge between them and a, in the specified direction. If the graph's edges are undirected, this is equivalent to .neighbors(a).

  • Directed, Outgoing: All edges from a.
  • Directed, Incoming: All edges to a.
  • Undirected: All edges connected to a.

Produces an empty iterator if the node doesn't exist.
Iterator element type is NodeIndex<Ix>.

Use .neighbors_directed(a, dir).detach() to get a neighbor walker that does not borrow from the graph.

Important traits for Neighbors<'a, E, Ix>
[src]

Return an iterator of all neighbors that have an edge between them and a, in either direction. If the graph's edges are undirected, this is equivalent to .neighbors(a).

  • Directed and Undirected: All edges connected to a.

Produces an empty iterator if the node doesn't exist.
Iterator element type is NodeIndex<Ix>.

Use .neighbors_undirected(a).detach() to get a neighbor walker that does not borrow from the graph.

Important traits for Edges<'a, E, Ty, Ix>
[src]

Return an iterator of all edges of a.

  • Directed: Outgoing edges from a.
  • Undirected: All edges connected to a.

Produces an empty iterator if the node doesn't exist.
Iterator element type is EdgeReference<E, Ix>.

Important traits for Edges<'a, E, Ty, Ix>
[src]

Return an iterator of all edges of a, in the specified direction.

  • Directed, Outgoing: All edges from a.
  • Directed, Incoming: All edges to a.
  • Undirected: All edges connected to a.

Produces an empty iterator if the node a doesn't exist.
Iterator element type is EdgeReference<E, Ix>.

[src]

Index the StableGraph by two indices, any combination of node or edge indices is fine.

Panics if the indices are equal or if they are out of bounds.

[src]

Keep all nodes that return true from the visit closure, remove the others.

visit is provided a proxy reference to the graph, so that the graph can be walked and associated data modified.

The order nodes are visited is not specified.

The node indices of the removed nodes are invalidated, but none other. Edge indices are invalidated as they would be following the removal of each edge with an endpoint in a removed node.

Computes in O(n + e') time, where n is the number of node indices and e' is the number of affected edges, including n calls to .remove_edge() where n is the number of edges with an endpoint in a removed node.

[src]

Keep all edges that return true from the visit closure, remove the others.

visit is provided a proxy reference to the graph, so that the graph can be walked and associated data modified.

The order edges are visited is not specified.

The edge indices of the removed edes are invalidated, but none other.

Computes in O(e'') time, e' is the number of affected edges, including the calls to .remove_edge() for each removed edge.

[src]

Create a new StableGraph from an iterable of edges.

Node weights N are set to default values. Edge weights E may either be specified in the list, or they are filled with default values.

Nodes are inserted automatically to match the edges.

use petgraph::stable_graph::StableGraph;

let gr = StableGraph::<(), i32>::from_edges(&[
    (0, 1), (0, 2), (0, 3),
    (1, 2), (1, 3),
    (2, 3),
]);

[src]

Create a new StableGraph by mapping node and edge weights to new values.

The resulting graph has the same structure and the same graph indices as self.

[src]

Create a new StableGraph by mapping nodes and edges. A node or edge may be mapped to None to exclude it from the resulting graph.

Nodes are mapped first with the node_map closure, then edge_map is called for the edges that have not had any endpoint removed.

The resulting graph has the structure of a subgraph of the original graph. Nodes and edges that are not removed maintain their old node or edge indices.

[src]

Extend the graph from an iterable of edges.

Node weights N are set to default values. Edge weights E may either be specified in the list, or they are filled with default values.

Nodes are inserted automatically to match the edges.

Trait Implementations

impl<'a, N, E: 'a, Ty, Ix> IntoNeighbors for &'a StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

Return an iterator of the neighbors of node a.

impl<'a, N, E: 'a, Ty, Ix> IntoNeighborsDirected for &'a StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

impl<'a, N, E: 'a, Ty, Ix> IntoNodeIdentifiers for &'a StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

impl<N, E, Ty, Ix> NodeCount for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

impl<N, E, Ty, Ix> GraphProp for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

The kind edges in the graph.

[src]

impl<N, E, Ty, Ix> GraphBase for StableGraph<N, E, Ty, Ix> where
    Ix: IndexType
[src]

node identifier

edge identifier

impl<N, E, Ty, Ix> Visitable for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

The associated map type

[src]

Create a new visitor map

[src]

Reset the visitor map (and resize to new size of graph if needed)

impl<N, E, Ty, Ix> Data for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

impl<N, E, Ty, Ix> DataMap for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

[src]

impl<N, E, Ty, Ix> DataMapMut for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

[src]

impl<N, E, Ty, Ix> Build for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

[src]

Add a new edge. If parallel edges (duplicate) are not allowed and the edge already exists, return None. Read more

[src]

Add or update the edge from a to b. Return the id of the affected edge. Read more

impl<N, E, Ty, Ix> Create for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

impl<N, E, Ty, Ix> FromElements for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

impl<N, E, Ty, Ix> Debug for StableGraph<N, E, Ty, Ix> where
    N: Debug,
    E: Debug,
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

Formats the value using the given formatter. Read more

impl<N, E, Ty, Ix: IndexType> Clone for StableGraph<N, E, Ty, Ix> where
    N: Clone,
    E: Clone
[src]

The resulting cloned graph has the same graph indices as self.

[src]

Returns a copy of the value. Read more

[src]

Performs copy-assignment from source. Read more

impl<N, E, Ty, Ix> Index<NodeIndex<Ix>> for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

Index the StableGraph by NodeIndex to access node weights.

Panics if the node doesn't exist.

The returned type after indexing.

[src]

Performs the indexing (container[index]) operation.

impl<N, E, Ty, Ix> IndexMut<NodeIndex<Ix>> for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

Index the StableGraph by NodeIndex to access node weights.

Panics if the node doesn't exist.

[src]

Performs the mutable indexing (container[index]) operation.

impl<N, E, Ty, Ix> Index<EdgeIndex<Ix>> for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

Index the StableGraph by EdgeIndex to access edge weights.

Panics if the edge doesn't exist.

The returned type after indexing.

[src]

Performs the indexing (container[index]) operation.

impl<N, E, Ty, Ix> IndexMut<EdgeIndex<Ix>> for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

Index the StableGraph by EdgeIndex to access edge weights.

Panics if the edge doesn't exist.

[src]

Performs the mutable indexing (container[index]) operation.

impl<N, E, Ty, Ix> Default for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

Create a new empty StableGraph.

[src]

Returns the "default value" for a type. Read more

impl<N, E, Ty, Ix> From<Graph<N, E, Ty, Ix>> for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

Convert a Graph into a StableGraph

Computes in O(|V| + |E|) time.

The resulting graph has the same node and edge indices as the original graph.

[src]

Performs the conversion.

impl<N, E, Ty, Ix> From<StableGraph<N, E, Ty, Ix>> for Graph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

Convert a StableGraph into a Graph

Computes in O(|V| + |E|) time.

This translates the stable graph into a graph with node and edge indices in a compact interval without holes (like Graphs always are).

Only if the stable graph had no vacancies after deletions (if node bound was equal to node count, and the same for edges), would the resulting graph have the same node and edge indices as the input.

[src]

Performs the conversion.

impl<'a, N, E, Ty, Ix> IntoNodeReferences for &'a StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

impl<'a, N, E, Ty, Ix> IntoEdges for &'a StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

impl<'a, N, E, Ty, Ix> IntoEdgesDirected for &'a StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

impl<'a, N: 'a, E: 'a, Ty, Ix> IntoEdgeReferences for &'a StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

Create an iterator over all edges in the graph, in indexed order.

Iterator element type is EdgeReference<E, Ix>.

impl<N, E, Ty, Ix> NodeIndexable for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

[src]

Return an upper bound of the node indices in the graph

[src]

Convert a to an integer index.

[src]

Convert i to a node index

impl<N, E, Ty, Ix> GetAdjacencyMatrix for StableGraph<N, E, Ty, Ix> where
    Ty: EdgeType,
    Ix: IndexType
[src]

The adjacency matrix for Graph is a bitmap that's computed by .adjacency_matrix().

The associated adjacency matrix type

[src]

Create the adjacency matrix

[src]

Return true if there is an edge from a to b, false otherwise. Read more