## BalancedFlowGraph

# Struct BalancedFlowGraph

Source

    pub(crate) struct BalancedFlowGraph<G: DirectedGraph> {
        graph: G,
        sink_edge_nodes: DenseBitSet<G::Node>,
        pub(crate) sink: G::Node,
    }

Expand description

A view of an underlying graph that has been augmented to have “balanced flow”. This means that the flow (execution count) of each node is equal to the sum of its in-edge flows, and also equal to the sum of its out-edge flows.

To achieve this, a synthetic “sink” node is non-destructively added to the graph, with synthetic in-edges from these nodes:

- Any node that has no out-edges.
- Any node that explicitly requires a sink edge, as indicated by a caller-supplied `force_sink_edge` function.
- Any node that would otherwise be unable to reach the sink, because it is part of an inescapable loop.

To make the graph fully balanced, there is also a synthetic edge from the sink node back to the start node.

The benefit of having a balanced-flow graph is that it can be subsequently transformed in ways that are guaranteed to preserve balanced flow (e.g. merging nodes together), which is useful for discovering relationships between the node flows of different nodes in the graph.

## Fields§

§`graph: G`§`sink_edge_nodes: DenseBitSet<G::Node>`§`sink: G::Node`

## Implementations§

Source§

### impl<G: DirectedGraph> BalancedFlowGraph<G>

Source

#### pub(crate) fn for_graph( graph: G, force_sink_edge: impl Fn(G::Node) -> bool, ) -> Self
where G: ControlFlowGraph,

Creates a balanced view of an underlying graph, by adding a synthetic sink node that has in-edges from nodes that need or request such an edge, and a single out-edge to the start node.

Assumes that all nodes in the underlying graph are reachable from the start node.

## Trait Implementations§

Source§

### impl<G> DirectedGraph for BalancedFlowGraph<G>
where G: DirectedGraph,

Source§

#### fn num_nodes(&self) -> usize

Returns the number of nodes in this balanced-flow graph, which is 1 more than the number of nodes in the underlying graph, to account for the synthetic sink node.

Source§

#### type Node = <G as DirectedGraph>::Node

§

#### fn iter_nodes( &self, ) -> impl Iterator<Item = Self::Node> + DoubleEndedIterator + ExactSizeIterator

Iterates over all nodes of a graph in ascending numeric order. Read more
Source§

### impl<G> StartNode for BalancedFlowGraph<G>
where G: StartNode,

Source§

#### fn start_node(&self) -> Self::Node

Source§

### impl<G> Successors for BalancedFlowGraph<G>
where G: StartNode + Successors,

Source§

#### fn successors(&self, node: Self::Node) -> impl Iterator<Item = Self::Node>

## Auto Trait Implementations§

§

### impl<G> DynSend for BalancedFlowGraph<G>
where G: DynSend, <G as DirectedGraph>::Node: DynSend,

§

### impl<G> DynSync for BalancedFlowGraph<G>
where G: DynSync, <G as DirectedGraph>::Node: DynSync,

§

### impl<G> Freeze for BalancedFlowGraph<G>
where G: Freeze, <G as DirectedGraph>::Node: Freeze,

§

### impl<G> RefUnwindSafe for BalancedFlowGraph<G>
where G: RefUnwindSafe, <G as DirectedGraph>::Node: RefUnwindSafe,

§

### impl<G> Send for BalancedFlowGraph<G>
where G: Send, <G as DirectedGraph>::Node: Send,

§

### impl<G> Sync for BalancedFlowGraph<G>
where G: Sync, <G as DirectedGraph>::Node: Sync,

§

### impl<G> Unpin for BalancedFlowGraph<G>
where G: Unpin, <G as DirectedGraph>::Node: Unpin,

§

### impl<G> UnwindSafe for BalancedFlowGraph<G>
where G: UnwindSafe, <G as DirectedGraph>::Node: UnwindSafe,

## Blanket Implementations§

§

### impl<T> Aligned for T

§

#### const ALIGN: Alignment

Alignment of `Self`.
§

### impl<T> Any for T
where T: 'static + ?Sized,

§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
§

### impl<T> Borrow<T> for T
where T: ?Sized,

§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

### impl<T, R> CollectAndApply<T, R> for T

§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

§

#### type Output = R

§

### impl<T> From<T> for T

§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
§

### impl<T, U> Into<U> for T
where U: From<T>,

§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

§

### impl<T> IntoEither for T

§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
§

### impl<P> IntoQueryParam<P> for P

§

#### fn into_query_param(self) -> P

§

### impl<T> MaybeResult<T> for T

§

#### type Error = !

§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

§

### impl<T> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

§

#### fn upcast(self, interner: I) -> U

§

### impl<I, T> UpcastFrom<I, T> for T

§

#### fn upcast_from(from: T, _tcx: I) -> T

§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<Tcx, T> Value<Tcx> for T
where Tcx: DepContext,

§

#### default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> T

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
§

### impl<'a, T> Captures<'a> for T
where T: ?Sized,

§

### impl<T> ErasedDestructor for T
where T: 'static,

## Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.