Struct petgraph :: algo :: matching :: Matching Copy item path

impl<G> Matching<G>
where G: NodeIndexable,

pub fn mate(&self, node: G::NodeId) -> Option<G::NodeId>

Gets the matched counterpart of given node, if there is any.

Returns None if the node is not matched or does not exist.

pub fn edges(&self) -> MatchedEdges<'_, G> ⓘ

Iterates over all edges from the matching.

An edge is represented by its endpoints. The graph is considered undirected and every pair of matched nodes is reported only once.

pub fn nodes(&self) -> MatchedNodes<'_, G> ⓘ

Iterates over all nodes from the matching.

pub fn contains_edge(&self, a: G::NodeId, b: G::NodeId) -> bool

Returns true if given edge is in the matching, or false otherwise.

If any of the nodes does not exist, false is returned.

pub fn contains_node(&self, node: G::NodeId) -> bool

Returns true if given node is in the matching, or false otherwise.

If the node does not exist, false is returned.

pub fn len(&self) -> usize

Gets the number of matched edges.

pub fn is_empty(&self) -> bool

Returns true if the number of matched edges is 0.

impl<G> Matching<G>
where G: NodeCount,

pub fn is_perfect(&self) -> bool

Returns true if the matching is perfect.

A matching is perfect if every node in the graph is incident to an edge from the matching.

Auto Trait Implementations§

impl<G> Freeze for Matching<G>
where G: Freeze,

impl<G> RefUnwindSafe for Matching<G>
where G: RefUnwindSafe, <G as GraphBase>::NodeId: RefUnwindSafe,

impl<G> UnwindSafe for Matching<G>
where G: UnwindSafe, <G as GraphBase>::NodeId: UnwindSafe,

Blanket Implementations§

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> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into 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<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, U> TryFrom 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>::Error>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.