Struct Scalar

pub struct Scalar(/* private fields */);

A 64-bit float that implements Eq, Ord and Hash.

Panics if it’s NaN during any of those operations.

Implementations

impl Scalar

pub const ZERO: Self = _

The scalar containing 0.0.

pub const ONE: Self = _

The scalar containing 1.0.

pub const INFINITY: Self = _

The scalar containing f64::INFINITY.

pub const fn new(x: f64) -> Self

Creates a Scalar with the given value.

If the value is NaN, then it is set to 0.0 in the result.

pub const fn get(self) -> f64

Gets the value of this Scalar.

Trait Implementations

impl<T: Into<Self>> Add<T> for Scalar

type Output = Scalar

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T: Into<Self>> AddAssign<T> for Scalar

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scalar

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

Formats the value using the given formatter.

impl Default for Scalar

fn default() -> Scalar

Returns the “default value” for a type.

impl<T: Into<Self>> Div<T> for Scalar

type Output = Scalar

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T: Into<Self>> DivAssign<T> for Scalar

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<Scalar> for f64

fn from(scalar: Scalar) -> Self

Converts to this type from the input type.

impl From<f64> for Scalar

fn from(float: f64) -> Self

Converts to this type from the input type.

impl Hash for Scalar

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: Into<Self>> Mul<T> for Scalar

type Output = Scalar

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T: Into<Self>> MulAssign<T> for Scalar

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Neg for Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Numeric for Scalar

fn zero() -> Self

The identity element for addition.

fn is_finite(self) -> bool

Whether self consists only of finite parts.

fn is_zero(self) -> bool

Whether self is zero.

impl Ord for Scalar

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.

impl PartialEq<f64> for Scalar

fn eq(&self, other: &f64) -> 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 PartialEq for Scalar

fn eq(&self, other: &Self) -> 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 PartialOrd for Scalar

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: Into<Self>> Rem<T> for Scalar

type Output = Scalar

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<T: Into<Self>> RemAssign<T> for Scalar

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T: Into<Self>> Sub<T> for Scalar

type Output = Scalar

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T: Into<Self>> SubAssign<T> for Scalar

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<'a> Sum<&'a Scalar> for Scalar

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for Scalar

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Scalar

impl Eq for Scalar