Struct FlowGraph 

pub struct FlowGraph<N>
where
    N: Clone + Eq + Hash,
{
    pub graph: SimpleDirectedGraph<N>,
    pub start_node: N,
}

A FlowGraph is a directed graph with a designated start node.

Any node in the graph can be the start node. There are no reachability requirements whatsoever: some nodes may be unreachable from the start node, the start node could have incoming edges, the graph could be disconnected, etc.

Fields

graph: SimpleDirectedGraph<N>

The graph.

start_node: N

The start node.

Implementations

impl<N> FlowGraph<N>

where N: Clone + Eq + Hash,

pub fn new(graph: SimpleDirectedGraph<N>, start_node: N) -> Self

Constructs a new FlowGraph.

pub fn create_value_flow_graph<'a, V>( &self, node_values: &'a HashMap<N, V>, ) -> FlowGraph<&'a V>

where V: Eq + Hash,

Creates a flow graph of values from a flow graph of nodes.

More precisely, let G be a FlowGraph of nodes with start node S. The value flow graph G’ is a FlowGraph derived from G. Let v(g) be the result of applying value_fn to g. The nodes of G’ are the set of values v(g), for all g in G. For each edge g1->g2 in G, there is a corresponding edge v(g1)->v(g2) in G’. The start node in G’ is v(S).

Returns an error if any value_fn invocation fails.

pub async fn find_dominator_value<V, VF, E>( &self, final_nodes: &[N], value_fn: VF, ) -> Result<V, FindDominatorValueError<E>>

where V: Hash + Eq + Clone, VF: AsyncFn(&N) -> Result<V, E>,

Constructs a value flow graph from the given flow graph and value function, and finds the closest common dominator value for the values of the final nodes. Returns an error if value_fn returns an error for any node in the flow graph. final_nodes must not be empty.

Trait Implementations

impl<N> Clone for FlowGraph<N>

where N: Clone + Eq + Hash + Clone,

fn clone(&self) -> FlowGraph<N>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N> Debug for FlowGraph<N>

where N: Clone + Eq + Hash + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<N> Eq for FlowGraph<N>

where N: Clone + Eq + Hash + Eq,

impl<N> PartialEq for FlowGraph<N>

where N: Clone + Eq + Hash + PartialEq,

fn eq(&self, other: &FlowGraph<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N> StructuralPartialEq for FlowGraph<N>

where N: Clone + Eq + Hash + PartialEq,