Struct Real 

pub struct Real { /* private fields */ }

A validated finite f64 value.

Implementations

impl Real

pub const fn new(value: f64) -> Real

Creates a real value without validation.

pub const fn try_new(value: f64) -> Result<Real, RealError>

Creates a real value from a finite f64.

Errors

Returns RealError::NonFiniteValue when value is NaN or infinite.

Examples

use use_real::{Real, RealError};

let real = Real::try_new(2.5)?;
assert_eq!(real, Real::new(2.5));

assert!(matches!(
    Real::try_new(f64::INFINITY),
    Err(RealError::NonFiniteValue { .. })
));

pub const fn validate(self) -> Result<Real, RealError>

Validates that an existing real value remains finite.

Errors

Returns the same error variants as Self::try_new.

pub const fn value(&self) -> f64

Returns the stored f64 value.

pub const fn zero() -> Real

Returns 0.0 as a validated real value.

pub const fn one() -> Real

Returns 1.0 as a validated real value.

pub const fn abs(self) -> Real

Returns the absolute value.

Trait Implementations

impl Clone for Real

fn clone(&self) -> Real

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Real

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

Formats the value using the given formatter.

impl Default for Real

fn default() -> Real

Returns the “default value” for a type.

impl Display for Real

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

Formats the value using the given formatter.

impl PartialEq for Real

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

fn partial_cmp(&self, other: &Real) -> 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 Copy for Real

impl StructuralPartialEq for Real