Enum BinInterval

pub enum BinInterval<T> {
    Underflow {
        end: T,
    },
    Overflow {
        start: T,
    },
    Bin {
        start: T,
        end: T,
    },
}

BinInterval represents a single bin interval in a 1D axis.

Variants

Underflow

The underflow bin covers all values from (-inf, end]. The interval excludes end.

Fields

end: T

End of the interval.

Overflow

The overflow bin covers all values from [start, inf). The interval includes start.

Fields

start: T

Start of the interval.

Bin

A finite bin interval from [start, end). The interval includes start but excludes end.

Fields

start: T

Start of the interval

end: T

End of the interval

Implementations

impl<T> BinInterval<T>

pub fn underflow(end: T) -> Self

Factory method to create new underflow bin interval.

pub fn overflow(start: T) -> Self

Factory method to create new overflow bin interval.

pub fn new(start: T, end: T) -> Self

Factory method to create new finite bin interval.

impl<T: Copy> BinInterval<T>

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

Get start of the interval if it exists for this interval variant.

The underflow bin returns None.

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

Get end of the interval if it exists for this interval variant.

The overflow bin returns None.

Trait Implementations

impl<T: Clone> Clone for BinInterval<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BinInterval<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for BinInterval<T>

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

Formats the value using the given formatter.

impl<T> From<Range<T>> for BinInterval<T>

fn from(other: Range<T>) -> Self

Converts to this type from the input type.

impl<T> From<RangeFrom<T>> for BinInterval<T>

fn from(other: RangeFrom<T>) -> Self

Converts to this type from the input type.

impl<T> From<RangeTo<T>> for BinInterval<T>

fn from(other: RangeTo<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for BinInterval<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: LowerExp> LowerExp for BinInterval<T>

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

Formats the value using the given formatter.

impl<T: Ord> Ord for BinInterval<T>

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

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

fn partial_cmp(&self, other: &BinInterval<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> TryFrom<BinInterval<T>> for Range<T>

type Error = BinIntervalConversionError

The type returned in the event of a conversion error.

fn try_from(value: BinInterval<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<BinInterval<T>> for RangeFrom<T>

type Error = BinIntervalConversionError

The type returned in the event of a conversion error.

fn try_from(value: BinInterval<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<BinInterval<T>> for RangeTo<T>

type Error = BinIntervalConversionError

The type returned in the event of a conversion error.

fn try_from(value: BinInterval<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: UpperExp> UpperExp for BinInterval<T>

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

Formats the value using the given formatter.

impl<T: Copy> Copy for BinInterval<T>

impl<T: Eq> Eq for BinInterval<T>

impl<T> StructuralPartialEq for BinInterval<T>