Struct bevy::utils::petgraph::algo::dominators::Dominators

pub struct Dominators<N>
where
    N: Copy + Eq + Hash,
{ /* private fields */ }

The dominance relation for some graph and root.

Implementations

impl<N> Dominators<N>

where N: Copy + Eq + Hash,

pub fn root(&self) -> N

Get the root node used to construct these dominance relations.

pub fn immediate_dominator(&self, node: N) -> Option<N>

Get the immediate dominator of the given node.

Returns None for any node that is not reachable from the root, and for the root itself.

pub fn strict_dominators(&self, node: N) -> Option<DominatorsIter<'_, N>>

Iterate over the given node’s strict dominators.

If the given node is not reachable from the root, then None is returned.

pub fn dominators(&self, node: N) -> Option<DominatorsIter<'_, N>>

Iterate over all of the given node’s dominators (including the given node itself).

If the given node is not reachable from the root, then None is returned.

pub fn immediately_dominated_by(&self, node: N) -> DominatedByIter<'_, N>

Iterate over all nodes immediately dominated by the given node (not including the given node itself).

Trait Implementations

impl<N> Clone for Dominators<N>

where N: Clone + Copy + Eq + Hash,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Dominators<N>

where N: Debug + Copy + Eq + Hash,

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

Formats the value using the given formatter.