Enum microkelvin::Max

pub enum Max<K> {
    NegativeInfinity,
    Maximum(K),
}

Annotation to keep track of the largest element of a collection

Variants

NegativeInfinity

Identity of max, everything else is larger

Maximum(K)

Actual max value

Trait Implementations

impl<C, S, K> Annotation<C, S> for Max<K> where
    C: Compound<S>,
    S: Store,
    K: Ord + Clone,
    C::Leaf: Borrow<K>,
    C::Annotation: Borrow<Max<K>>, 

pub fn identity() -> Self

The empty annotation.

pub fn from_leaf(leaf: &C::Leaf) -> Self

Creates annotation from a leaf.

pub fn from_node(node: &C) -> Self

Creates annotation from a node.

impl<__S: Store, K: Canon<__S>> Canon<__S> for Max<K>

pub fn write(&self, sink: &mut impl Sink<__S>) -> Result<(), __S::Error>

Write the value as bytes to a Sink

pub fn read(source: &mut impl Source<__S>) -> Result<Self, __S::Error>

Read the value from bytes in a Source

pub fn encoded_len(&self) -> usize

Returns the number of bytes needed to encode this value

impl<K: Clone> Clone for Max<K>

pub fn clone(&self) -> Max<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Copy> Copy for Max<K>

impl<K: Debug> Debug for Max<K>

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

Formats the value using the given formatter.

impl<K: Eq> Eq for Max<K>

impl<K> Ord for Max<K> where
    K: Ord + Eq, 

pub fn cmp(&self, other: &Max<K>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<K> PartialEq<K> for Max<K> where
    K: PartialEq, 

pub fn eq(&self, k: &K) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<K: PartialEq> PartialEq<Max<K>> for Max<K>

pub fn eq(&self, other: &Max<K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Max<K>) -> bool

This method tests for !=.

impl<K> PartialOrd<K> for Max<K> where
    K: PartialOrd + Eq, 

pub fn partial_cmp(&self, k: &K) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<K> PartialOrd<Max<K>> for Max<K> where
    K: PartialOrd + Eq, 

pub fn partial_cmp(&self, other: &Max<K>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<K> StructuralEq for Max<K>

impl<K> StructuralPartialEq for Max<K>