Struct Max

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

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>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Default for Max<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Display for Max<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> From<T> for Max<T>

where T: Copy + Ord,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for Max<T>

where T: Ord,

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 as FromStr>::Err

The associated error which can be returned from parsing.

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>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

fn cmp(&self, other: &Max<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,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Max<T>

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

fn partial_cmp(&self, other: &Max<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<T: Copy> Copy for Max<T>

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

impl<T> StructuralPartialEq for Max<T>