Enum Extended 

pub enum Extended<T> {
    NegInf,
    Finite(T),
    PosInf,
}

A value of T or one of the two infinities: the extended line.

Ordered NegInf < Finite(a) < Finite(b) < PosInf (with a < b); the two infinities compare equal to themselves.

use symplex::{Extended, Interval};

let ray = Interval::right_open(Extended::Finite(0), Extended::PosInf); // [0, ∞)
assert!(ray.contains(&Extended::Finite(7)));
assert!(!ray.contains(&Extended::Finite(-1)) && !ray.contains(&Extended::PosInf));
assert!(!ray.is_bounded());
assert_eq!(ray.to_string(), "[0, ∞)");

assert!(Extended::NegInf < Extended::Finite(i32::MIN));
assert_eq!(-Extended::<i32>::PosInf, Extended::NegInf);
assert_eq!(Extended::from_f64(f64::INFINITY), Extended::PosInf);
assert_eq!(Extended::from(2.5).finite(), Some(&2.5));

Variants

NegInf

-∞.

Finite(T)

A finite value.

PosInf

+∞.

Implementations

impl<T> Extended<T>

pub const fn is_finite(&self) -> bool

Is this a finite value (not ±∞)?

pub const fn finite(&self) -> Option<&T>

The finite value, if any.

pub fn into_finite(self) -> Option<T>

The finite value, if any, by value.

pub fn map<U>(self, f: impl FnOnce(T) -> U) -> Extended<U>

Apply f to a finite value; the infinities pass through.

pub const fn as_ref(&self) -> Extended<&T>

Borrow the finite value.

impl<T: Clone + Neg<Output = T>> Extended<T>

pub fn neg(&self) -> Self

-self: negates a finite value and swaps the infinities. The same as the - operator, for call chains and non-Copy T.

impl Extended<f64>

pub fn from_f64(x: f64) -> Self

f64::INFINITY and f64::NEG_INFINITY become the infinities; every other value — including NaN — is Finite. NaN is not a point of the extended line, but it is not an infinity either, so it stays where f64’s own comparisons treat it: unordered against every Finite value, and Finite(NaN) != Finite(NaN). The infinities still bound it (NegInf < Finite(NaN) < PosInf), since they compare before the finite payload is looked at.

Trait Implementations

impl<T: Clone> Clone for Extended<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Extended<T>

impl<T: Debug> Debug for Extended<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Extended<T>

-∞, ∞, or the finite value’s own Display (the spelling Bounds uses for its absent sides).

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Extended<T>

impl<T> From<T> for Extended<T>

A T is a finite point of the extended line.

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Extended<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: Neg> Neg for Extended<T>

-(+∞) = -∞, -(-∞) = +∞, and T’s own negation in between.

type Output = Extended<<T as Neg>::Output>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: Ord> Ord for Extended<T>

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<T: PartialEq> PartialEq for Extended<T>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Extended<T>

fn partial_cmp(&self, other: &Self) -> 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: PartialEq> StructuralPartialEq for Extended<T>