Struct misc_utils::Max

pub struct Max<T> { /* fields omitted */ }

Helper type to ensure to calculate a maximal value

Implementations

impl<T> Max<T> where
    T: Copy + Ord, 

pub fn new() -> Self

Create a new instance

pub fn with_initial(initial: T) -> Self

Create a new instance with an initial value to compare to

pub fn get_max(&self) -> Option<T>

Return the maximal value found so far

Returns None if neither an initial value exists nor update was called. Returns Some(T) if at least one value exists.

pub fn get_max_extreme(&self) -> T where
    T: Bounded, 

Return the maximal value found so far

This method falls back to the minimal value for type T, if no other value exists.

pub fn update<V: Into<Self>>(&mut self, value: V)

Update the value by replacing it with a higher value

If value is greater than self, then self is replaced with value. This method can be called with type T or type Max<T>.

Trait Implementations

impl<T: Clone> Clone for Max<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Max<T>

impl<T: Debug> Debug for Max<T>

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

Formats the value using the given formatter.

impl<T> Default for Max<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T> Display for Max<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Max<T>

impl<T> From<T> for Max<T> where
    T: Copy + Ord, 

pub fn from(value: T) -> Self

Performs the conversion.

impl<T> FromIterator<T> for Max<T> where
    T: Ord, 

pub fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> FromStr for Max<T> where
    T: Copy + FromStr + Ord, 

type Err = T::Err

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T: Hash> Hash for Max<T>

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Max<T>

pub fn cmp(&self, other: &Max<T>) -> 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<T: PartialEq> PartialEq<Max<T>> for Max<T>

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

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

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Max<T>> for Max<T>

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

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

pub fn lt(&self, other: &Max<T>) -> bool

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

pub fn le(&self, other: &Max<T>) -> bool

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

pub fn gt(&self, other: &Max<T>) -> bool

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

pub fn ge(&self, other: &Max<T>) -> bool

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

impl<T> StructuralEq for Max<T>

impl<T> StructuralPartialEq for Max<T>