Struct petgraph::scored::MinScored

pub struct MinScored<K, T>(pub K, pub T);

MinScored<K, T> holds a score K and a scored object T in a pair for use with a BinaryHeap.

MinScored compares in reverse order by the score, so that we can use BinaryHeap as a min-heap to extract the score-value pair with the least score.

Note: MinScored implements a total order (Ord), so that it is possible to use float types as scores.

Tuple Fields

0: K

1: T

Trait Implementations

impl<K: Clone, T: Clone> Clone for MinScored<K, T>

fn clone(&self) -> MinScored<K, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, T: Debug> Debug for MinScored<K, T>

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

Formats the value using the given formatter.

impl<K: PartialOrd, T> Ord for MinScored<K, T>

fn cmp(&self, other: &MinScored<K, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<K: PartialOrd, T> PartialEq for MinScored<K, T>

fn eq(&self, other: &MinScored<K, T>) -> 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<K: PartialOrd, T> PartialOrd for MinScored<K, T>

fn partial_cmp(&self, other: &MinScored<K, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K: Copy, T: Copy> Copy for MinScored<K, T>

impl<K: PartialOrd, T> Eq for MinScored<K, T>