Struct bevy::utils::petgraph::stable_graph::StableGraph
source · pub struct StableGraph<N, E, Ty = Directed, Ix = u32> { /* private fields */ }
Expand description
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:
 Associated data
N
for nodes andE
for edges, also called weights. The associated data can be of arbitrary type.  Edge type
Ty
that determines whether the graph edges are directed or undirected.  Index type
Ix
, which determines the maximum size of the graph.
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.

Nodes and edges are each numbered in an interval from 0 to some number m, but not all indices in the range are valid, since gaps are formed by deletions.

You can select graph index integer type after the size of the graph. A smaller size may have better performance.

Using indices allows mutation while traversing the graph, see
Dfs
. 
The
StableGraph
is a regular rust collection and isSend
andSync
(as long as associated dataN
andE
are). 
Indices don’t allow as much compile time checking as references.
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.
Implementations§
source§impl<N, E> StableGraph<N, E, Directed, u32>
impl<N, E> StableGraph<N, E, Directed, u32>
sourcepub fn new() > StableGraph<N, E, Directed, u32>
pub fn new() > StableGraph<N, E, Directed, u32>
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
.
source§impl<N, E, Ty, Ix> StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
sourcepub fn with_capacity(nodes: usize, edges: usize) > StableGraph<N, E, Ty, Ix>
pub fn with_capacity(nodes: usize, edges: usize) > StableGraph<N, E, Ty, Ix>
Create a new StableGraph
with estimated capacity.
sourcepub fn capacity(&self) > (usize, usize)
pub fn capacity(&self) > (usize, usize)
Return the current node and edge capacity of the graph.
sourcepub fn clear_edges(&mut self)
pub fn clear_edges(&mut self)
Remove all edges
sourcepub fn node_count(&self) > usize
pub fn node_count(&self) > usize
Return the number of nodes (vertices) in the graph.
Computes in O(1) time.
sourcepub fn edge_count(&self) > usize
pub fn edge_count(&self) > usize
Return the number of edges in the graph.
Computes in O(1) time.
sourcepub fn is_directed(&self) > bool
pub fn is_directed(&self) > bool
Whether the graph has directed edges or not.
sourcepub fn add_node(&mut self, weight: N) > NodeIndex<Ix>
pub fn add_node(&mut self, weight: N) > NodeIndex<Ix>
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.
sourcepub fn remove_node(&mut self, a: NodeIndex<Ix>) > Option<N>
pub fn remove_node(&mut self, a: NodeIndex<Ix>) > Option<N>
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
.
pub fn contains_node(&self, a: NodeIndex<Ix>) > bool
sourcepub fn add_edge(
&mut self,
a: NodeIndex<Ix>,
b: NodeIndex<Ix>,
weight: E
) > EdgeIndex<Ix>
pub fn add_edge( &mut self, a: NodeIndex<Ix>, b: NodeIndex<Ix>, weight: E ) > EdgeIndex<Ix>
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.
sourcepub fn update_edge(
&mut self,
a: NodeIndex<Ix>,
b: NodeIndex<Ix>,
weight: E
) > EdgeIndex<Ix>
pub fn update_edge( &mut self, a: NodeIndex<Ix>, b: NodeIndex<Ix>, weight: E ) > EdgeIndex<Ix>
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.
sourcepub fn remove_edge(&mut self, e: EdgeIndex<Ix>) > Option<E>
pub fn remove_edge(&mut self, e: EdgeIndex<Ix>) > Option<E>
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
connected to the same endpoints as e
.
sourcepub fn node_weight(&self, a: NodeIndex<Ix>) > Option<&N>
pub fn node_weight(&self, a: NodeIndex<Ix>) > Option<&N>
Access the weight for node a
.
Also available with indexing syntax: &graph[a]
.
sourcepub fn node_weight_mut(&mut self, a: NodeIndex<Ix>) > Option<&mut N>
pub fn node_weight_mut(&mut self, a: NodeIndex<Ix>) > Option<&mut N>
Access the weight for node a
, mutably.
Also available with indexing syntax: &mut graph[a]
.
sourcepub fn node_weights(&self) > impl Iterator<Item = &N>
pub fn node_weights(&self) > impl Iterator<Item = &N>
Return an iterator yielding immutable access to all node weights.
The order in which weights are yielded matches the order of their node indices.
sourcepub fn node_weights_mut(&mut self) > impl Iterator<Item = &mut N>
pub fn node_weights_mut(&mut self) > impl Iterator<Item = &mut N>
Return an iterator yielding mutable access to all node weights.
The order in which weights are yielded matches the order of their node indices.
sourcepub fn node_indices(&self) > NodeIndices<'_, N, Ix> ⓘ
pub fn node_indices(&self) > NodeIndices<'_, N, Ix> ⓘ
Return an iterator over the node indices of the graph
sourcepub fn edge_weight(&self, e: EdgeIndex<Ix>) > Option<&E>
pub fn edge_weight(&self, e: EdgeIndex<Ix>) > Option<&E>
Access the weight for edge e
.
Also available with indexing syntax: &graph[e]
.
sourcepub fn edge_weight_mut(&mut self, e: EdgeIndex<Ix>) > Option<&mut E>
pub fn edge_weight_mut(&mut self, e: EdgeIndex<Ix>) > Option<&mut E>
Access the weight for edge e
, mutably
Also available with indexing syntax: &mut graph[e]
.
sourcepub fn edge_weights(&self) > impl Iterator<Item = &E>
pub fn edge_weights(&self) > impl Iterator<Item = &E>
Return an iterator yielding immutable access to all edge weights.
The order in which weights are yielded matches the order of their edge indices.
sourcepub fn edge_weights_mut(&mut self) > impl Iterator<Item = &mut E>
pub fn edge_weights_mut(&mut self) > impl Iterator<Item = &mut E>
Return an iterator yielding mutable access to all edge weights.
The order in which weights are yielded matches the order of their edge indices.
sourcepub fn edge_endpoints(
&self,
e: EdgeIndex<Ix>
) > Option<(NodeIndex<Ix>, NodeIndex<Ix>)>
pub fn edge_endpoints( &self, e: EdgeIndex<Ix> ) > Option<(NodeIndex<Ix>, NodeIndex<Ix>)>
Access the source and target nodes for e
.
sourcepub fn edge_indices(&self) > EdgeIndices<'_, E, Ix> ⓘ
pub fn edge_indices(&self) > EdgeIndices<'_, E, Ix> ⓘ
Return an iterator over the edge indices of the graph
sourcepub fn edges_connecting(
&self,
a: NodeIndex<Ix>,
b: NodeIndex<Ix>
) > EdgesConnecting<'_, E, Ty, Ix> ⓘ
pub fn edges_connecting( &self, a: NodeIndex<Ix>, b: NodeIndex<Ix> ) > EdgesConnecting<'_, E, Ty, Ix> ⓘ
Return an iterator over all the edges connecting a
and b
.
Directed
: Outgoing edges froma
.Undirected
: All edges connected toa
.
Iterator element type is EdgeReference<E, Ix>
.
sourcepub fn contains_edge(&self, a: NodeIndex<Ix>, b: NodeIndex<Ix>) > bool
pub fn contains_edge(&self, a: NodeIndex<Ix>, b: NodeIndex<Ix>) > bool
Lookup if there is 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).
sourcepub fn find_edge(
&self,
a: NodeIndex<Ix>,
b: NodeIndex<Ix>
) > Option<EdgeIndex<Ix>>
pub fn find_edge( &self, a: NodeIndex<Ix>, b: NodeIndex<Ix> ) > Option<EdgeIndex<Ix>>
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).
sourcepub fn find_edge_undirected(
&self,
a: NodeIndex<Ix>,
b: NodeIndex<Ix>
) > Option<(EdgeIndex<Ix>, Direction)>
pub fn find_edge_undirected( &self, a: NodeIndex<Ix>, b: NodeIndex<Ix> ) > Option<(EdgeIndex<Ix>, Direction)>
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.
sourcepub fn neighbors(&self, a: NodeIndex<Ix>) > Neighbors<'_, E, Ix> ⓘ
pub fn neighbors(&self, a: NodeIndex<Ix>) > Neighbors<'_, E, Ix> ⓘ
Return an iterator of all nodes with an edge starting from a
.
Directed
: Outgoing edges froma
.Undirected
: All edges connected toa
.
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.
sourcepub fn neighbors_directed(
&self,
a: NodeIndex<Ix>,
dir: Direction
) > Neighbors<'_, E, Ix> ⓘ
pub fn neighbors_directed( &self, a: NodeIndex<Ix>, dir: Direction ) > Neighbors<'_, E, Ix> ⓘ
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 froma
.Directed
,Incoming
: All edges toa
.Undirected
: All edges connected toa
.
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.
sourcepub fn neighbors_undirected(&self, a: NodeIndex<Ix>) > Neighbors<'_, E, Ix> ⓘ
pub fn neighbors_undirected(&self, a: NodeIndex<Ix>) > Neighbors<'_, E, Ix> ⓘ
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
andUndirected
: All edges connected toa
.
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.
sourcepub fn edges(&self, a: NodeIndex<Ix>) > Edges<'_, E, Ty, Ix> ⓘ
pub fn edges(&self, a: NodeIndex<Ix>) > Edges<'_, E, Ty, Ix> ⓘ
Return an iterator of all edges of a
.
Directed
: Outgoing edges froma
.Undirected
: All edges connected toa
.
Produces an empty iterator if the node doesn’t exist.
Iterator element type is EdgeReference<E, Ix>
.
sourcepub fn edges_directed(
&self,
a: NodeIndex<Ix>,
dir: Direction
) > Edges<'_, E, Ty, Ix> ⓘ
pub fn edges_directed( &self, a: NodeIndex<Ix>, dir: Direction ) > Edges<'_, E, Ty, Ix> ⓘ
Return an iterator of all edges of a
, in the specified direction.
Directed
,Outgoing
: All edges froma
.Directed
,Incoming
: All edges toa
.Undirected
,Outgoing
: All edges connected toa
, witha
being the source of each edge.Undirected
,Incoming
: All edges connected toa
, witha
being the target of each edge.
Produces an empty iterator if the node a
doesn’t exist.
Iterator element type is EdgeReference<E, Ix>
.
sourcepub fn externals(&self, dir: Direction) > Externals<'_, N, Ty, Ix> ⓘ
pub fn externals(&self, dir: Direction) > Externals<'_, N, Ty, Ix> ⓘ
Return an iterator over either the nodes without edges to them
(Incoming
) or from them (Outgoing
).
An internal node has both incoming and outgoing edges.
The nodes in .externals(Incoming)
are the source nodes and
.externals(Outgoing)
are the sinks of the graph.
For a graph with undirected edges, both the sinks and the sources are just the nodes without edges.
The whole iteration computes in O(V) time.
sourcepub fn index_twice_mut<T, U>(
&mut self,
i: T,
j: U
) > (&mut <StableGraph<N, E, Ty, Ix> as Index<T>>::Output, &mut <StableGraph<N, E, Ty, Ix> as Index<U>>::Output)where
StableGraph<N, E, Ty, Ix>: IndexMut<T> + IndexMut<U>,
T: GraphIndex,
U: GraphIndex,
pub fn index_twice_mut<T, U>( &mut self, i: T, j: U ) > (&mut <StableGraph<N, E, Ty, Ix> as Index<T>>::Output, &mut <StableGraph<N, E, Ty, Ix> as Index<U>>::Output)where StableGraph<N, E, Ty, Ix>: IndexMut<T> + IndexMut<U>, T: GraphIndex, U: GraphIndex,
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.
sourcepub fn retain_nodes<F>(&mut self, visit: F)where
F: FnMut(Frozen<'_, StableGraph<N, E, Ty, Ix>>, NodeIndex<Ix>) > bool,
pub fn retain_nodes<F>(&mut self, visit: F)where F: FnMut(Frozen<'_, StableGraph<N, E, Ty, Ix>>, NodeIndex<Ix>) > bool,
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.
sourcepub fn retain_edges<F>(&mut self, visit: F)where
F: FnMut(Frozen<'_, StableGraph<N, E, Ty, Ix>>, EdgeIndex<Ix>) > bool,
pub fn retain_edges<F>(&mut self, visit: F)where F: FnMut(Frozen<'_, StableGraph<N, E, Ty, Ix>>, EdgeIndex<Ix>) > bool,
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.
sourcepub fn from_edges<I>(iterable: I) > StableGraph<N, E, Ty, Ix>where
I: IntoIterator,
<I as IntoIterator>::Item: IntoWeightedEdge<E>,
<<I as IntoIterator>::Item as IntoWeightedEdge<E>>::NodeId: Into<NodeIndex<Ix>>,
N: Default,
pub fn from_edges<I>(iterable: I) > StableGraph<N, E, Ty, Ix>where I: IntoIterator, <I as IntoIterator>::Item: IntoWeightedEdge<E>, <<I as IntoIterator>::Item as IntoWeightedEdge<E>>::NodeId: Into<NodeIndex<Ix>>, N: Default,
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),
]);
sourcepub fn map<'a, F, G, N2, E2>(
&'a self,
node_map: F,
edge_map: G
) > StableGraph<N2, E2, Ty, Ix>where
F: FnMut(NodeIndex<Ix>, &'a N) > N2,
G: FnMut(EdgeIndex<Ix>, &'a E) > E2,
pub fn map<'a, F, G, N2, E2>( &'a self, node_map: F, edge_map: G ) > StableGraph<N2, E2, Ty, Ix>where F: FnMut(NodeIndex<Ix>, &'a N) > N2, G: FnMut(EdgeIndex<Ix>, &'a E) > E2,
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
.
sourcepub fn filter_map<'a, F, G, N2, E2>(
&'a self,
node_map: F,
edge_map: G
) > StableGraph<N2, E2, Ty, Ix>where
F: FnMut(NodeIndex<Ix>, &'a N) > Option<N2>,
G: FnMut(EdgeIndex<Ix>, &'a E) > Option<E2>,
pub fn filter_map<'a, F, G, N2, E2>( &'a self, node_map: F, edge_map: G ) > StableGraph<N2, E2, Ty, Ix>where F: FnMut(NodeIndex<Ix>, &'a N) > Option<N2>, G: FnMut(EdgeIndex<Ix>, &'a E) > Option<E2>,
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.
sourcepub fn extend_with_edges<I>(&mut self, iterable: I)where
I: IntoIterator,
<I as IntoIterator>::Item: IntoWeightedEdge<E>,
<<I as IntoIterator>::Item as IntoWeightedEdge<E>>::NodeId: Into<NodeIndex<Ix>>,
N: Default,
pub fn extend_with_edges<I>(&mut self, iterable: I)where I: IntoIterator, <I as IntoIterator>::Item: IntoWeightedEdge<E>, <<I as IntoIterator>::Item as IntoWeightedEdge<E>>::NodeId: Into<NodeIndex<Ix>>, N: Default,
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§
source§impl<N, E, Ty, Ix> Build for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> Build for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
fn add_node( &mut self, weight: <StableGraph<N, E, Ty, Ix> as Data>::NodeWeight ) > <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId
source§fn add_edge(
&mut self,
a: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId,
b: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId,
weight: <StableGraph<N, E, Ty, Ix> as Data>::EdgeWeight
) > Option<<StableGraph<N, E, Ty, Ix> as GraphBase>::EdgeId>
fn add_edge( &mut self, a: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId, b: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId, weight: <StableGraph<N, E, Ty, Ix> as Data>::EdgeWeight ) > Option<<StableGraph<N, E, Ty, Ix> as GraphBase>::EdgeId>
None
.source§fn update_edge(
&mut self,
a: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId,
b: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId,
weight: <StableGraph<N, E, Ty, Ix> as Data>::EdgeWeight
) > <StableGraph<N, E, Ty, Ix> as GraphBase>::EdgeId
fn update_edge( &mut self, a: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId, b: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId, weight: <StableGraph<N, E, Ty, Ix> as Data>::EdgeWeight ) > <StableGraph<N, E, Ty, Ix> as GraphBase>::EdgeId
a
to b
. Return the id of the affected
edge.source§impl<N, E, Ty, Ix> Clone for StableGraph<N, E, Ty, Ix>where
Ix: IndexType,
N: Clone,
E: Clone,
impl<N, E, Ty, Ix> Clone for StableGraph<N, E, Ty, Ix>where Ix: IndexType, N: Clone, E: Clone,
The resulting cloned graph has the same graph indices as self
.
source§fn clone(&self) > StableGraph<N, E, Ty, Ix>
fn clone(&self) > StableGraph<N, E, Ty, Ix>
source§fn clone_from(&mut self, rhs: &StableGraph<N, E, Ty, Ix>)
fn clone_from(&mut self, rhs: &StableGraph<N, E, Ty, Ix>)
source
. Read moresource§impl<N, E, Ty, Ix> Create for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> Create for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
fn with_capacity(nodes: usize, edges: usize) > StableGraph<N, E, Ty, Ix>
source§impl<N, E, Ty, Ix> Data for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> Data for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
type NodeWeight = N
type EdgeWeight = E
source§impl<N, E, Ty, Ix> DataMap for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> DataMap for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
fn node_weight( &self, id: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId ) > Option<&<StableGraph<N, E, Ty, Ix> as Data>::NodeWeight>
fn edge_weight( &self, id: <StableGraph<N, E, Ty, Ix> as GraphBase>::EdgeId ) > Option<&<StableGraph<N, E, Ty, Ix> as Data>::EdgeWeight>
source§impl<N, E, Ty, Ix> DataMapMut for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> DataMapMut for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
fn node_weight_mut( &mut self, id: <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId ) > Option<&mut <StableGraph<N, E, Ty, Ix> as Data>::NodeWeight>
fn edge_weight_mut( &mut self, id: <StableGraph<N, E, Ty, Ix> as GraphBase>::EdgeId ) > Option<&mut <StableGraph<N, E, Ty, Ix> as Data>::EdgeWeight>
source§impl<N, E, Ty, Ix> Debug for StableGraph<N, E, Ty, Ix>where
N: Debug,
E: Debug,
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> Debug for StableGraph<N, E, Ty, Ix>where N: Debug, E: Debug, Ty: EdgeType, Ix: IndexType,
source§impl<N, E, Ty, Ix> Default for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> Default for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
Create a new empty StableGraph
.
source§fn default() > StableGraph<N, E, Ty, Ix>
fn default() > StableGraph<N, E, Ty, Ix>
source§impl<N, E, Ty, Ix> EdgeCount for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> EdgeCount for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
source§fn edge_count(&self) > usize
fn edge_count(&self) > usize
source§impl<N, E, Ty, Ix> EdgeIndexable for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> EdgeIndexable for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
source§fn edge_bound(&self) > usize
fn edge_bound(&self) > usize
source§fn from_index(
&self,
ix: usize
) > <StableGraph<N, E, Ty, Ix> as GraphBase>::EdgeId
fn from_index( &self, ix: usize ) > <StableGraph<N, E, Ty, Ix> as GraphBase>::EdgeId
i
to an edge index. i
must be a valid value in the graph.source§impl<N, E, Ty, Ix> From<Graph<N, E, Ty, Ix>> for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> From<Graph<N, E, Ty, Ix>> for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
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.
source§fn from(g: Graph<N, E, Ty, Ix>) > StableGraph<N, E, Ty, Ix>
fn from(g: Graph<N, E, Ty, Ix>) > StableGraph<N, E, Ty, Ix>
source§impl<N, E, Ty, Ix> From<StableGraph<N, E, Ty, Ix>> for Graph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> From<StableGraph<N, E, Ty, Ix>> for Graph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
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 Graph
s 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.
source§fn from(graph: StableGraph<N, E, Ty, Ix>) > Graph<N, E, Ty, Ix>
fn from(graph: StableGraph<N, E, Ty, Ix>) > Graph<N, E, Ty, Ix>
source§impl<N, E, Ty, Ix> FromElements for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> FromElements for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
fn from_elements<I>(iterable: I) > StableGraph<N, E, Ty, Ix>where StableGraph<N, E, Ty, Ix>: Sized, I: IntoIterator<Item = Element<<StableGraph<N, E, Ty, Ix> as Data>::NodeWeight, <StableGraph<N, E, Ty, Ix> as Data>::EdgeWeight>>,
source§impl<N, E, Ty, Ix> GetAdjacencyMatrix for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> GetAdjacencyMatrix for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
The adjacency matrix for Graph is a bitmap that’s computed by
.adjacency_matrix()
.
§type AdjMatrix = FixedBitSet
type AdjMatrix = FixedBitSet
source§fn adjacency_matrix(&self) > FixedBitSet
fn adjacency_matrix(&self) > FixedBitSet
source§fn is_adjacent(
&self,
matrix: &FixedBitSet,
a: NodeIndex<Ix>,
b: NodeIndex<Ix>
) > bool
fn is_adjacent( &self, matrix: &FixedBitSet, a: NodeIndex<Ix>, b: NodeIndex<Ix> ) > bool
source§impl<N, E, Ty, Ix> GraphBase for StableGraph<N, E, Ty, Ix>where
Ix: IndexType,
impl<N, E, Ty, Ix> GraphBase for StableGraph<N, E, Ty, Ix>where Ix: IndexType,
source§impl<N, E, Ty, Ix> Index<EdgeIndex<Ix>> for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> Index<EdgeIndex<Ix>> for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
Index the StableGraph
by EdgeIndex
to access edge weights.
Panics if the edge doesn’t exist.
source§impl<N, E, Ty, Ix> Index<NodeIndex<Ix>> for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> Index<NodeIndex<Ix>> for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
Index the StableGraph
by NodeIndex
to access node weights.
Panics if the node doesn’t exist.
source§impl<N, E, Ty, Ix> IndexMut<EdgeIndex<Ix>> for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> IndexMut<EdgeIndex<Ix>> for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
Index the StableGraph
by EdgeIndex
to access edge weights.
Panics if the edge doesn’t exist.
source§impl<N, E, Ty, Ix> IndexMut<NodeIndex<Ix>> for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> IndexMut<NodeIndex<Ix>> for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
Index the StableGraph
by NodeIndex
to access node weights.
Panics if the node doesn’t exist.
source§impl<'a, N, E, Ty, Ix> IntoEdgeReferences for &'a StableGraph<N, E, Ty, Ix>where
N: 'a,
E: 'a,
Ty: EdgeType,
Ix: IndexType,
impl<'a, N, E, Ty, Ix> IntoEdgeReferences for &'a StableGraph<N, E, Ty, Ix>where N: 'a, E: 'a, Ty: EdgeType, Ix: IndexType,
source§fn edge_references(
self
) > <&'a StableGraph<N, E, Ty, Ix> as IntoEdgeReferences>::EdgeReferences
fn edge_references( self ) > <&'a StableGraph<N, E, Ty, Ix> as IntoEdgeReferences>::EdgeReferences
Create an iterator over all edges in the graph, in indexed order.
Iterator element type is EdgeReference<E, Ix>
.
type EdgeRef = EdgeReference<'a, E, Ix>
type EdgeReferences = EdgeReferences<'a, E, Ix>
source§impl<'a, N, E, Ty, Ix> IntoEdges for &'a StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<'a, N, E, Ty, Ix> IntoEdges for &'a StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
source§impl<'a, N, E, Ty, Ix> IntoEdgesDirected for &'a StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<'a, N, E, Ty, Ix> IntoEdgesDirected for &'a StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
type EdgesDirected = Edges<'a, E, Ty, Ix>
fn edges_directed( self, a: <&'a StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId, dir: Direction ) > <&'a StableGraph<N, E, Ty, Ix> as IntoEdgesDirected>::EdgesDirected
source§impl<'a, N, E, Ty, Ix> IntoNeighbors for &'a StableGraph<N, E, Ty, Ix>where
E: 'a,
Ty: EdgeType,
Ix: IndexType,
impl<'a, N, E, Ty, Ix> IntoNeighbors for &'a StableGraph<N, E, Ty, Ix>where E: 'a, Ty: EdgeType, Ix: IndexType,
type Neighbors = Neighbors<'a, E, Ix>
source§fn neighbors(
self,
n: <&'a StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId
) > <&'a StableGraph<N, E, Ty, Ix> as IntoNeighbors>::Neighbors
fn neighbors( self, n: <&'a StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId ) > <&'a StableGraph<N, E, Ty, Ix> as IntoNeighbors>::Neighbors
a
.source§impl<'a, N, E, Ty, Ix> IntoNeighborsDirected for &'a StableGraph<N, E, Ty, Ix>where
E: 'a,
Ty: EdgeType,
Ix: IndexType,
impl<'a, N, E, Ty, Ix> IntoNeighborsDirected for &'a StableGraph<N, E, Ty, Ix>where E: 'a, Ty: EdgeType, Ix: IndexType,
type NeighborsDirected = Neighbors<'a, E, Ix>
fn neighbors_directed( self, n: NodeIndex<Ix>, d: Direction ) > <&'a StableGraph<N, E, Ty, Ix> as IntoNeighborsDirected>::NeighborsDirected
source§impl<'a, N, E, Ty, Ix> IntoNodeIdentifiers for &'a StableGraph<N, E, Ty, Ix>where
E: 'a,
Ty: EdgeType,
Ix: IndexType,
impl<'a, N, E, Ty, Ix> IntoNodeIdentifiers for &'a StableGraph<N, E, Ty, Ix>where E: 'a, Ty: EdgeType, Ix: IndexType,
type NodeIdentifiers = NodeIndices<'a, N, Ix>
fn node_identifiers( self ) > <&'a StableGraph<N, E, Ty, Ix> as IntoNodeIdentifiers>::NodeIdentifiers
source§impl<'a, N, E, Ty, Ix> IntoNodeReferences for &'a StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<'a, N, E, Ty, Ix> IntoNodeReferences for &'a StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
type NodeRef = (NodeIndex<Ix>, &'a N)
type NodeReferences = NodeReferences<'a, N, Ix>
fn node_references( self ) > <&'a StableGraph<N, E, Ty, Ix> as IntoNodeReferences>::NodeReferences
source§impl<N, E, Ty, Ix> NodeCount for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> NodeCount for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
fn node_count(&self) > usize
source§impl<N, E, Ty, Ix> NodeIndexable for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> NodeIndexable for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
source§fn node_bound(&self) > usize
fn node_bound(&self) > usize
Return an upper bound of the node indices in the graph
source§fn from_index(
&self,
ix: usize
) > <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId
fn from_index( &self, ix: usize ) > <StableGraph<N, E, Ty, Ix> as GraphBase>::NodeId
i
to a node index. i
must be a valid value in the graph.source§impl<N, E, Ty, Ix> Visitable for StableGraph<N, E, Ty, Ix>where
Ty: EdgeType,
Ix: IndexType,
impl<N, E, Ty, Ix> Visitable for StableGraph<N, E, Ty, Ix>where Ty: EdgeType, Ix: IndexType,
§type Map = FixedBitSet
type Map = FixedBitSet
source§fn visit_map(&self) > FixedBitSet
fn visit_map(&self) > FixedBitSet
Auto Trait Implementations§
impl<N, E, Ty, Ix> RefUnwindSafe for StableGraph<N, E, Ty, Ix>where E: RefUnwindSafe, Ix: RefUnwindSafe, N: RefUnwindSafe, Ty: RefUnwindSafe,
impl<N, E, Ty, Ix> Send for StableGraph<N, E, Ty, Ix>where E: Send, Ix: Send, N: Send, Ty: Send,
impl<N, E, Ty, Ix> Sync for StableGraph<N, E, Ty, Ix>where E: Sync, Ix: Sync, N: Sync, Ty: Sync,
impl<N, E, Ty, Ix> Unpin for StableGraph<N, E, Ty, Ix>where E: Unpin, Ix: Unpin, N: Unpin, Ty: Unpin,
impl<N, E, Ty, Ix> UnwindSafe for StableGraph<N, E, Ty, Ix>where E: UnwindSafe, Ix: UnwindSafe, N: UnwindSafe, Ty: UnwindSafe,
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) > U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) > U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) > &mut T
fn borrow_mut(&mut self) > &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) > Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) > Box<dyn Any, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T, Global>) > Rc<dyn Any, Global>
fn into_any_rc(self: Rc<T, Global>) > Rc<dyn Any, Global>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) > &(dyn Any + 'static)
fn as_any(&self) > &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) > &mut (dyn Any + 'static)
fn as_any_mut(&mut self) > &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) > S
§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere T: Default,
§fn from_world(_world: &mut World) > T
fn from_world(_world: &mut World) > T
Self
using data from the given World
.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) > Instrumented<Self> ⓘ
fn instrument(self, span: Span) > Instrumented<Self> ⓘ
§fn in_current_span(self) > Instrumented<Self> ⓘ
fn in_current_span(self) > Instrumented<Self> ⓘ
§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere T: FromSample<F>,
fn into_sample(self) > T
§impl<T> NoneValue for Twhere
T: Default,
impl<T> NoneValue for Twhere T: Default,
type NoneType = T
§fn null_value() > T
fn null_value() > T
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for Pwhere
R: Read + ReadEndian<P>,
P: Default,
impl<R, P> ReadPrimitive<R> for Pwhere R: Read + ReadEndian<P>, P: Default,
source§fn read_from_little_endian(read: &mut R) > Result<Self, Error>
fn read_from_little_endian(read: &mut R) > Result<Self, Error>
ReadEndian::read_from_little_endian()
.