petgraph::algo::dominators

Struct Dominators

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

The dominance relation for some graph and root.

Implementations§

source§

impl<N> Dominators<N>
where N: Copy + Eq + Hash,

source

pub fn root(&self) -> N

Get the root node used to construct these dominance relations.

source

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.

source

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.

source

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.

source

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§

source§

impl<N> Clone for Dominators<N>
where N: Copy + Eq + Hash + Clone,

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<N> Debug for Dominators<N>
where N: Copy + Eq + Hash + Debug,

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<N> Freeze for Dominators<N>
where N: Freeze,

§

impl<N> RefUnwindSafe for Dominators<N>
where N: RefUnwindSafe,

§

impl<N> Send for Dominators<N>
where N: Send,

§

impl<N> Sync for Dominators<N>
where N: Sync,

§

impl<N> Unpin for Dominators<N>
where N: Unpin,

§

impl<N> UnwindSafe for Dominators<N>
where N: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

source§

type Error = Infallible

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

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

Performs the conversion.
source§

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

source§

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

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

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

Performs the conversion.