Skip to main content

BipartiteMatching

Struct BipartiteMatching 

Source
pub struct BipartiteMatching { /* private fields */ }
Expand description

A reusable Hopcroft–Karp matcher.

Built to be reset and refilled each frame: the internal vectors keep their capacity across reset, so a caller with a stable graph shape pays one set of allocations on the first frame and none after.

Implementations§

Source§

impl BipartiteMatching

Source

pub const fn new() -> Self

An empty matcher. Shape it with reset.

Source

pub fn with_shape(n_left: usize, n_right: usize) -> Self

A matcher shaped for n_left layers and n_right planes.

Source

pub fn reset(&mut self, n_left: usize, n_right: usize)

Re-shape and clear, keeping allocated capacity.

Every per-node container is reset, so a fresh call sees exactly the state a freshly constructed matcher would.

Source

pub fn add_edge(&mut self, left: usize, right: usize)

Add an unscored edge: layer left could use plane right.

Out-of-range endpoints are ignored rather than panicking — a caller filtering candidates should not have to re-check bounds the matcher already knows.

Source

pub fn add_scored_edge(&mut self, left: usize, right: usize, score: i32)

Add an edge with a preference score. Higher is tried first.

The score cannot change how many layers get placed — see the module documentation.

Source

pub fn solve(&mut self) -> usize

Compute the maximum-cardinality matching, returning how many pairs it found.

Source

pub fn match_for_left(&self, left: usize) -> Option<usize>

The plane matched to a layer, after solve.

Source

pub fn match_for_right(&self, right: usize) -> Option<usize>

The layer matched to a plane, after solve.

Source

pub const fn matched_count(&self) -> usize

How many pairs the last solve found.

Source

pub const fn left_len(&self) -> usize

The number of left nodes.

Source

pub const fn right_len(&self) -> usize

The number of right nodes.

Trait Implementations§

Source§

impl Clone for BipartiteMatching

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BipartiteMatching

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BipartiteMatching

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.