Struct otter_api_tests::shapelib::OrderedFloat

#[repr(transparent)]
pub struct OrderedFloat<T>(pub T);

A wrapper around Floats providing an implementation of Ord and Hash.

NaN is sorted as greater than all other values and equal to itself, in contradiction with the IEEE standard.

Implementations

impl<T> OrderedFloat<T> where
    T: Float, 

pub fn into_inner(self) -> T

Get the value out.

Trait Implementations

impl<T> Add<OrderedFloat<T>> for OrderedFloat<T> where
    T: Add<T>, 

type Output = OrderedFloat<<T as Add<T>>::Output>

The resulting type after applying the + operator.

pub fn add(
    self,
    other: OrderedFloat<T>
) -> <OrderedFloat<T> as Add<OrderedFloat<T>>>::Output

Performs the + operation.

impl<T> Add<T> for OrderedFloat<T> where
    T: Add<T>, 

type Output = OrderedFloat<<T as Add<T>>::Output>

The resulting type after applying the + operator.

pub fn add(self, other: T) -> <OrderedFloat<T> as Add<T>>::Output

Performs the + operation.

impl<T> AsMut<T> for OrderedFloat<T> where
    T: Float, 

pub fn as_mut(&mut self) -> &mut T

Performs the conversion.

impl<T> AsRef<T> for OrderedFloat<T> where
    T: Float, 

pub fn as_ref(&self) -> &T

Performs the conversion.

impl<T> Bounded for OrderedFloat<T> where
    T: Bounded, 

pub fn min_value() -> OrderedFloat<T>

returns the smallest finite number this type can represent

pub fn max_value() -> OrderedFloat<T>

returns the largest finite number this type can represent

impl<T> Clone for OrderedFloat<T> where
    T: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for OrderedFloat<T> where
    T: Copy, 

impl<T> Debug for OrderedFloat<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Default for OrderedFloat<T> where
    T: Default, 

pub fn default() -> OrderedFloat<T>

Returns the “default value” for a type.

impl<T> Deref for OrderedFloat<T> where
    T: Float, 

type Target = T

The resulting type after dereferencing.

pub fn deref(&self) -> &<OrderedFloat<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for OrderedFloat<T> where
    T: Float, 

pub fn deref_mut(&mut self) -> &mut <OrderedFloat<T> as Deref>::Target

Mutably dereferences the value.

impl<T> Display for OrderedFloat<T> where
    T: Float + Display, 

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

Formats the value using the given formatter.

impl<T> Div<OrderedFloat<T>> for OrderedFloat<T> where
    T: Div<T>, 

type Output = OrderedFloat<<T as Div<T>>::Output>

The resulting type after applying the / operator.

pub fn div(
    self,
    other: OrderedFloat<T>
) -> <OrderedFloat<T> as Div<OrderedFloat<T>>>::Output

Performs the / operation.

impl<T> Div<T> for OrderedFloat<T> where
    T: Div<T>, 

type Output = OrderedFloat<<T as Div<T>>::Output>

The resulting type after applying the / operator.

pub fn div(self, other: T) -> <OrderedFloat<T> as Div<T>>::Output

Performs the / operation.

impl<T> Eq for OrderedFloat<T> where
    T: Float, 

impl<T> Float for OrderedFloat<T> where
    T: Float, 

pub fn nan() -> OrderedFloat<T>

Returns the NaN value.

pub fn infinity() -> OrderedFloat<T>

Returns the infinite value.

pub fn neg_infinity() -> OrderedFloat<T>

Returns the negative infinite value.

pub fn neg_zero() -> OrderedFloat<T>

Returns -0.0.

pub fn min_value() -> OrderedFloat<T>

Returns the smallest finite value that this type can represent.

pub fn min_positive_value() -> OrderedFloat<T>

Returns the smallest positive, normalized value that this type can represent.

pub fn max_value() -> OrderedFloat<T>

Returns the largest finite value that this type can represent.

pub fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

pub fn is_infinite(self) -> bool

Returns true if this value is positive infinity or negative infinity and false otherwise.

pub fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

pub fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal, or NaN.

pub fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

pub fn floor(self) -> OrderedFloat<T>

Returns the largest integer less than or equal to a number.

pub fn ceil(self) -> OrderedFloat<T>

Returns the smallest integer greater than or equal to a number.

pub fn round(self) -> OrderedFloat<T>

Returns the nearest integer to a number. Round half-way cases away from 0.0.

pub fn trunc(self) -> OrderedFloat<T>

Return the integer part of a number.

pub fn fract(self) -> OrderedFloat<T>

Returns the fractional part of a number.

pub fn abs(self) -> OrderedFloat<T>

Computes the absolute value of self. Returns Float::nan() if the number is Float::nan().

pub fn signum(self) -> OrderedFloat<T>

Returns a number that represents the sign of self.

pub fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0, Float::infinity(), and since Rust 1.20 also Float::nan().

pub fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0, Float::neg_infinity(), and since Rust 1.20 also -Float::nan().

pub fn mul_add(self, a: OrderedFloat<T>, b: OrderedFloat<T>) -> OrderedFloat<T>

Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add.

pub fn recip(self) -> OrderedFloat<T>

Take the reciprocal (inverse) of a number, 1/x.

pub fn powi(self, n: i32) -> OrderedFloat<T>

Raise a number to an integer power.

pub fn powf(self, n: OrderedFloat<T>) -> OrderedFloat<T>

Raise a number to a floating point power.

pub fn sqrt(self) -> OrderedFloat<T>

Take the square root of a number.

pub fn exp(self) -> OrderedFloat<T>

Returns e^(self), (the exponential function).

pub fn exp2(self) -> OrderedFloat<T>

Returns 2^(self).

pub fn ln(self) -> OrderedFloat<T>

Returns the natural logarithm of the number.

pub fn log(self, base: OrderedFloat<T>) -> OrderedFloat<T>

Returns the logarithm of the number with respect to an arbitrary base.

pub fn log2(self) -> OrderedFloat<T>

Returns the base 2 logarithm of the number.

pub fn log10(self) -> OrderedFloat<T>

Returns the base 10 logarithm of the number.

pub fn max(self, other: OrderedFloat<T>) -> OrderedFloat<T>

Returns the maximum of the two numbers.

pub fn min(self, other: OrderedFloat<T>) -> OrderedFloat<T>

Returns the minimum of the two numbers.

pub fn abs_sub(self, other: OrderedFloat<T>) -> OrderedFloat<T>

The positive difference of two numbers.

pub fn cbrt(self) -> OrderedFloat<T>

Take the cubic root of a number.

pub fn hypot(self, other: OrderedFloat<T>) -> OrderedFloat<T>

Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y.

pub fn sin(self) -> OrderedFloat<T>

Computes the sine of a number (in radians).

pub fn cos(self) -> OrderedFloat<T>

Computes the cosine of a number (in radians).

pub fn tan(self) -> OrderedFloat<T>

Computes the tangent of a number (in radians).

pub fn asin(self) -> OrderedFloat<T>

Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

pub fn acos(self) -> OrderedFloat<T>

Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

pub fn atan(self) -> OrderedFloat<T>

Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2];

pub fn atan2(self, other: OrderedFloat<T>) -> OrderedFloat<T>

Computes the four quadrant arctangent of self (y) and other (x).

pub fn sin_cos(self) -> (OrderedFloat<T>, OrderedFloat<T>)

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

pub fn exp_m1(self) -> OrderedFloat<T>

Returns e^(self) - 1 in a way that is accurate even if the number is close to zero.

pub fn ln_1p(self) -> OrderedFloat<T>

Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately.

pub fn sinh(self) -> OrderedFloat<T>

Hyperbolic sine function.

pub fn cosh(self) -> OrderedFloat<T>

Hyperbolic cosine function.

pub fn tanh(self) -> OrderedFloat<T>

Hyperbolic tangent function.

pub fn asinh(self) -> OrderedFloat<T>

Inverse hyperbolic sine function.

pub fn acosh(self) -> OrderedFloat<T>

Inverse hyperbolic cosine function.

pub fn atanh(self) -> OrderedFloat<T>

Inverse hyperbolic tangent function.

pub fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

pub fn epsilon() -> OrderedFloat<T>

Returns epsilon, a small positive value.

pub fn to_degrees(self) -> OrderedFloat<T>

Converts radians to degrees.

pub fn to_radians(self) -> OrderedFloat<T>

Converts degrees to radians.

impl<T> FloatCore for OrderedFloat<T> where
    T: Float, 

pub fn nan() -> OrderedFloat<T>

Returns NaN.

pub fn infinity() -> OrderedFloat<T>

Returns positive infinity.

pub fn neg_infinity() -> OrderedFloat<T>

Returns negative infinity.

pub fn neg_zero() -> OrderedFloat<T>

Returns -0.0.

pub fn min_value() -> OrderedFloat<T>

Returns the smallest finite value that this type can represent.

pub fn min_positive_value() -> OrderedFloat<T>

Returns the smallest positive, normalized value that this type can represent.

pub fn max_value() -> OrderedFloat<T>

Returns the largest finite value that this type can represent.

pub fn is_nan(self) -> bool

Returns true if the number is NaN.

pub fn is_infinite(self) -> bool

Returns true if the number is infinite.

pub fn is_finite(self) -> bool

Returns true if the number is neither infinite or NaN.

pub fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal or NaN.

pub fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

pub fn floor(self) -> OrderedFloat<T>

Returns the largest integer less than or equal to a number.

pub fn ceil(self) -> OrderedFloat<T>

Returns the smallest integer greater than or equal to a number.

pub fn round(self) -> OrderedFloat<T>

Returns the nearest integer to a number. Round half-way cases away from 0.0.

pub fn trunc(self) -> OrderedFloat<T>

Return the integer part of a number.

pub fn fract(self) -> OrderedFloat<T>

Returns the fractional part of a number.

pub fn abs(self) -> OrderedFloat<T>

Computes the absolute value of self. Returns FloatCore::nan() if the number is FloatCore::nan().

pub fn signum(self) -> OrderedFloat<T>

Returns a number that represents the sign of self.

pub fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0 and FloatCore::infinity(), and since Rust 1.20 also FloatCore::nan().

pub fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0 and FloatCore::neg_infinity(), and since Rust 1.20 also -FloatCore::nan().

pub fn recip(self) -> OrderedFloat<T>

Returns the reciprocal (multiplicative inverse) of the number.

pub fn powi(self, n: i32) -> OrderedFloat<T>

Raise a number to an integer power.

pub fn integer_decode(self) -> (u64, i16, i8)

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

pub fn epsilon() -> OrderedFloat<T>

Returns epsilon, a small positive value.

pub fn to_degrees(self) -> OrderedFloat<T>

Converts to degrees, assuming the number is in radians.

pub fn to_radians(self) -> OrderedFloat<T>

Converts to radians, assuming the number is in degrees.

pub fn min(self, other: Self) -> Self

Returns the minimum of the two numbers.

pub fn max(self, other: Self) -> Self

Returns the maximum of the two numbers.

impl<'a, T> From<&'a T> for &'a OrderedFloat<T> where
    T: Float, 

pub fn from(t: &'a T) -> &'a OrderedFloat<T>

Performs the conversion.

impl<'a, T> From<&'a mut T> for &'a mut OrderedFloat<T> where
    T: Float, 

pub fn from(t: &'a mut T) -> &'a mut OrderedFloat<T>

Performs the conversion.

impl<T> From<T> for OrderedFloat<T> where
    T: Float, 

pub fn from(val: T) -> OrderedFloat<T>

Performs the conversion.

impl<T> FromPrimitive for OrderedFloat<T> where
    T: FromPrimitive, 

pub fn from_i64(n: i64) -> Option<OrderedFloat<T>>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u64(n: u64) -> Option<OrderedFloat<T>>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_isize(n: isize) -> Option<OrderedFloat<T>>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_i8(n: i8) -> Option<OrderedFloat<T>>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_i16(n: i16) -> Option<OrderedFloat<T>>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_i32(n: i32) -> Option<OrderedFloat<T>>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_usize(n: usize) -> Option<OrderedFloat<T>>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u8(n: u8) -> Option<OrderedFloat<T>>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u16(n: u16) -> Option<OrderedFloat<T>>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u32(n: u32) -> Option<OrderedFloat<T>>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_f32(n: f32) -> Option<OrderedFloat<T>>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_f64(n: f64) -> Option<OrderedFloat<T>>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

pub fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl<T> FromStr for OrderedFloat<T> where
    T: FromStr, 

type Err = <T as FromStr>::Err

The associated error which can be returned from parsing.

pub fn from_str(
    s: &str
) -> Result<OrderedFloat<T>, <OrderedFloat<T> as FromStr>::Err>

Convert a &str to OrderedFloat. Returns an error if the string fails to parse.

use ordered_float::OrderedFloat;

assert!("-10".parse::<OrderedFloat<f32>>().is_ok());
assert!("abc".parse::<OrderedFloat<f32>>().is_err());
assert!("NaN".parse::<OrderedFloat<f32>>().is_ok());

impl<T> Hash for OrderedFloat<T> where
    T: Float, 

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

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 Into<f32> for OrderedFloat<f32>

pub fn into(self) -> f32

Performs the conversion.

impl Into<f64> for OrderedFloat<f64>

pub fn into(self) -> f64

Performs the conversion.

impl<T> Mul<OrderedFloat<T>> for OrderedFloat<T> where
    T: Mul<T>, 

type Output = OrderedFloat<<T as Mul<T>>::Output>

The resulting type after applying the * operator.

pub fn mul(
    self,
    other: OrderedFloat<T>
) -> <OrderedFloat<T> as Mul<OrderedFloat<T>>>::Output

Performs the * operation.

impl<T> Mul<T> for OrderedFloat<T> where
    T: Mul<T>, 

type Output = OrderedFloat<<T as Mul<T>>::Output>

The resulting type after applying the * operator.

pub fn mul(self, other: T) -> <OrderedFloat<T> as Mul<T>>::Output

Performs the * operation.

impl<T> Neg for OrderedFloat<T> where
    T: Neg, 

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

The resulting type after applying the - operator.

pub fn neg(self) -> <OrderedFloat<T> as Neg>::Output

Performs the unary - operation.

impl<T> Num for OrderedFloat<T> where
    T: Float + Num, 

type FromStrRadixErr = <T as Num>::FromStrRadixErr

pub fn from_str_radix(
    str: &str,
    radix: u32
) -> Result<OrderedFloat<T>, <OrderedFloat<T> as Num>::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl<T> NumCast for OrderedFloat<T> where
    T: NumCast, 

pub fn from<F>(n: F) -> Option<OrderedFloat<T>> where
    F: ToPrimitive, 

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl<T> One for OrderedFloat<T> where
    T: One, 

pub fn one() -> OrderedFloat<T>

Returns the multiplicative identity element of Self, 1.

pub fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

pub fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<T> Ord for OrderedFloat<T> where
    T: Float, 

pub fn cmp(&self, other: &OrderedFloat<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<OrderedFloat<T>> for OrderedFloat<T> where
    T: Float, 

pub fn eq(&self, other: &OrderedFloat<T>) -> 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<T> PartialEq<T> for OrderedFloat<T> where
    T: Float, 

pub fn eq(&self, other: &T) -> 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<T> PartialOrd<OrderedFloat<T>> for OrderedFloat<T> where
    T: Float, 

pub fn partial_cmp(&self, other: &OrderedFloat<T>) -> 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<T> Rem<OrderedFloat<T>> for OrderedFloat<T> where
    T: Rem<T>, 

type Output = OrderedFloat<<T as Rem<T>>::Output>

The resulting type after applying the % operator.

pub fn rem(
    self,
    other: OrderedFloat<T>
) -> <OrderedFloat<T> as Rem<OrderedFloat<T>>>::Output

Performs the % operation.

impl<T> Rem<T> for OrderedFloat<T> where
    T: Rem<T>, 

type Output = OrderedFloat<<T as Rem<T>>::Output>

The resulting type after applying the % operator.

pub fn rem(self, other: T) -> <OrderedFloat<T> as Rem<T>>::Output

Performs the % operation.

impl<T> Sub<OrderedFloat<T>> for OrderedFloat<T> where
    T: Sub<T>, 

type Output = OrderedFloat<<T as Sub<T>>::Output>

The resulting type after applying the - operator.

pub fn sub(
    self,
    other: OrderedFloat<T>
) -> <OrderedFloat<T> as Sub<OrderedFloat<T>>>::Output

Performs the - operation.

impl<T> Sub<T> for OrderedFloat<T> where
    T: Sub<T>, 

type Output = OrderedFloat<<T as Sub<T>>::Output>

The resulting type after applying the - operator.

pub fn sub(self, other: T) -> <OrderedFloat<T> as Sub<T>>::Output

Performs the - operation.

impl<T> ToPrimitive for OrderedFloat<T> where
    T: ToPrimitive, 

pub fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

pub fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

pub fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

pub fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

pub fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

pub fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

pub fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

pub fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

pub fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

pub fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

pub fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

pub fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

pub fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

pub fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

impl<T> Zero for OrderedFloat<T> where
    T: Zero, 

pub fn zero() -> OrderedFloat<T>

Returns the additive identity element of Self, 0.

pub fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

pub fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.