Struct kurobako_core::num::FiniteF64

pub struct FiniteF64(_);

An floating point number that is neither infinite nor NaN.

Methods

impl FiniteF64

pub const unsafe fn new_unchecked(n: f64) -> FiniteF64

Creates a FiniteF64 instance without checking the value.

Safety

The value must not be NaN or infinite.

pub fn new(n: f64) -> Result<FiniteF64, Error>

Creates a finite number.

Error

If the given value is NaN or infinite, an ErrorKind::InvalidInput error will be returned.

pub const fn get(self) -> f64

Returns the value as a primitive type.

Trait Implementations

impl PartialOrd<FiniteF64> for FiniteF64

fn partial_cmp(&self, other: &FiniteF64) -> Option<Ordering>

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

fn lt(&self, other: &FiniteF64) -> bool

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

fn le(&self, other: &FiniteF64) -> bool

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

fn gt(&self, other: &FiniteF64) -> bool

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

fn ge(&self, other: &FiniteF64) -> bool

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

impl MulAssign<FiniteF64> for FiniteF64

fn mul_assign(&mut self, other: FiniteF64)

Performs the *= operation.

impl<'de> Deserialize<'de> for FiniteF64

fn deserialize<__D>(
    __deserializer: __D
) -> Result<FiniteF64, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Add<FiniteF64> for FiniteF64

type Output = FiniteF64

The resulting type after applying the + operator.

fn add(self, other: FiniteF64) -> <FiniteF64 as Add<FiniteF64>>::Output

Performs the + operation.

impl Sub<FiniteF64> for FiniteF64

type Output = FiniteF64

The resulting type after applying the - operator.

fn sub(self, other: FiniteF64) -> <FiniteF64 as Sub<FiniteF64>>::Output

Performs the - operation.

impl Eq for FiniteF64

impl Default for FiniteF64

fn default() -> FiniteF64

Returns the "default value" for a type.

impl Mul<FiniteF64> for FiniteF64

type Output = FiniteF64

The resulting type after applying the * operator.

fn mul(self, other: FiniteF64) -> <FiniteF64 as Mul<FiniteF64>>::Output

Performs the * operation.

impl Clone for FiniteF64

fn clone(&self) -> FiniteF64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<FiniteF64> for FiniteF64

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

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

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

This method tests for !=.

impl Div<FiniteF64> for FiniteF64

type Output = FiniteF64

The resulting type after applying the / operator.

fn div(self, other: FiniteF64) -> <FiniteF64 as Div<FiniteF64>>::Output

Performs the / operation.

impl SubAssign<FiniteF64> for FiniteF64

fn sub_assign(&mut self, other: FiniteF64)

Performs the -= operation.

impl Debug for FiniteF64

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

Formats the value using the given formatter.

impl Display for FiniteF64

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

Formats the value using the given formatter.

impl DivAssign<FiniteF64> for FiniteF64

fn div_assign(&mut self, other: FiniteF64)

Performs the /= operation.

impl Serialize for FiniteF64

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Ord for FiniteF64

fn cmp(&self, other: &FiniteF64) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Copy for FiniteF64

impl AddAssign<FiniteF64> for FiniteF64

fn add_assign(&mut self, other: FiniteF64)

Performs the += operation.