Struct CompilationResult

Source

pub struct CompilationResult<O>(pub StableGraph<NodeInfo<O>, EdgeInfo>)
where
    O: Operation;

Expand description

The result of a frontend compiler.

Tuple Fields§

§0: StableGraph<NodeInfo<O>, EdgeInfo>

Implementations§

Source §

impl<O> CompilationResult<O>
where O: Operation,

Source

pub fn new() -> Self

Create a new CompilationResult

Methods from Deref<Target = StableGraph<NodeInfo<O>, EdgeInfo>>§

Source

pub fn capacity(&self) -> (usize, usize)

Return the current node and edge capacity of the graph.

Source

pub fn reverse(&mut self)

Reverse the direction of all edges

Source

pub fn clear(&mut self)

Remove all nodes and edges

Source

pub fn clear_edges(&mut self)

Remove all edges

Source

pub fn node_count(&self) -> usize

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

Computes in O(1) time.

Source

pub fn edge_count(&self) -> usize

Return the number of edges in the graph.

Computes in O(1) time.

Source

pub fn is_directed(&self) -> bool

Whether the graph has directed edges or not.

Source

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.

Source

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.

Source

pub fn contains_node(&self, a: NodeIndex<Ix>) -> bool

Source

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.

Source

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.

Source

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.

Source

pub fn node_weight(&self, a: NodeIndex<Ix>) -> Option<&N>

Access the weight for node a.

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

Source

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].

Source

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.

Source

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.

Source

pub fn node_indices(&self) -> NodeIndices<'_, N, Ix>

Return an iterator over the node indices of the graph

Source

pub fn edge_weight(&self, e: EdgeIndex<Ix>) -> Option<&E>

Access the weight for edge e.

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

Source

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].

Source

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.

Source

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.

Source

pub fn edge_endpoints( &self, e: EdgeIndex<Ix>, ) -> Option<(NodeIndex<Ix>, NodeIndex<Ix>)>

Access the source and target nodes for e.

Source

pub fn edge_indices(&self) -> EdgeIndices<'_, E, Ix>

Return an iterator over the edge indices of the graph

Source

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 from a.
Undirected: All edges connected to a.

Iterator element type is EdgeReference<E, Ix>.

Source

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).

Source

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).

Source

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.

Source

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 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.

Source

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 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.

Source

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 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.

Source

pub fn edges(&self, a: NodeIndex<Ix>) -> Edges<'_, E, Ty, Ix>

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>.

Source

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 from a.
Directed, Incoming: All edges to a.
Undirected, Outgoing: All edges connected to a, with a being the source of each edge.
Undirected, Incoming: All edges connected to a, with a being the target of each edge.

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

Source

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.

Source

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>::Output)
where StableGraph<N, E, Ty, Ix>: IndexMut<T> + IndexMut, 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.

Source

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.

Source

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.

Source

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.

Source

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.

Source