Struct scientific::Scientific

pub struct Scientific { /* private fields */ }

Arbitrary precision scientific number

See the module-level documentation for more details.

Implementations

impl Scientific

pub const ZERO: Scientific = _

A value of zero.

pub const ONE: Scientific = _

A value of one.

pub fn from_string(source: String) -> Result<Scientific, ConversionError>

Convert an String into a value.

This does consume the String and does not require allocation.

Errors

Will return ConversionError::ParseError if the string is invalid.

pub fn to_bytes(&self) -> Vec<u8>

Convert a value into a compressed binary format.

pub fn from_bytes(bytes: &[u8]) -> Result<Scientific, ConversionError>

Convert a compressed binary format into a value.

pub fn as_raw_mantissa(&self) -> &[u8]

Return a reference to the mantissa.

pub fn from_raw_parts( negative: bool, mantissa: Vec<u8>, exponent: isize ) -> Result<Scientific, ConversionError>

Convert raw parts into an value.

Errors

Will return ConversionError::ParseError if the mantissa contains values other than 0..=9.

pub fn sqrt_truncate(&self, precision: Precision) -> Result<Scientific, Error>

Returns the square root of an number, truncating.

The square root will be calculated up to a given precision.

pub fn sqrt_rpsp(&self, precision: Precision) -> Result<Scientific, Error>

Returns the square root of an number, rounding.

The square root will be calculated up to a given precision, but correctly rounded.

As all RPSP functions it calculates one more digit than requested for simpler usage of the final rounding.

pub fn abs(&self) -> Scientific

Computes the absolute value.

pub fn abs_assign(&mut self)

Computes the absolute value, storing it in self.

pub fn neg_assign(&mut self)

Negating the value, storing it in self.

pub fn div_truncate( &self, rhs: &Scientific, precision: Precision ) -> Result<Scientific, Error>

Calculate division, truncating.

Please be aware that div_truncate is only calculating digits up to the specified precision.

For example 509/100 with a precision of 2 digits or 1 decimals will calculate 5.0 and not 5.1 as it’s may be expected with rounding in mind.

pub fn div_rem( &self, rhs: &Scientific ) -> Result<(Scientific, Scientific), Error>

Calculate division and remainder at the same time.

This will be faster than calculating them separately.

pub fn div_rpsp( &self, rhs: &Scientific, precision: Precision ) -> Result<Scientific, Error>

Calculate division with included rpsp (Rounding to Prepare for Shorter Precision)

Use rpsp (Rounding to Prepare for Shorter Precision) only during internal calculations and do one “proper” round at the end of all calculations.

pub fn truncate_assign(&mut self, precision: Precision)

Truncate the value and store it in self.

pub fn truncate(&self, precision: Precision) -> Scientific

Truncate the value.

pub fn round_assign(&mut self, precision: Precision, rounding: Rounding)

Round the value and store it in self.

pub fn round(&self, precision: Precision, rounding: Rounding) -> Scientific

Round the value.

pub fn round_rpsp_assign(&mut self, precision: Precision)

Round the value with RPSP and store it in self.

pub fn round_rpsp(&self, precision: Precision) -> Scientific

Round the value with RPSP.

pub fn len(&self) -> isize

Returns the length of the mantissa.

Will return length zero for the value zero.

pub fn decimals(&self) -> isize

Returns the number of decimals.

0.001/1e-3 will return 3, 1000/1e3 will return -3.

pub fn exponent0(&self) -> isize

Returns the exponent if the mantissa is written directly behind the decimal dot.

123 will return 3 (because it was interpreted as 0.123e3).

pub fn exponent1(&self) -> isize

Returns the exponent if the mantissa is written with one digit in front ot the decimal dot.

123 will return 2 (because it was interpreted as 1.23e3).

pub fn exponent(&self) -> isize

Returns the exponent if the mantissa is written directly in front ot the decimal dot.

1.23 will return -2 (because it was interpreted as 123e-2).

pub fn powi(&self, exponent: usize) -> Scientific

Raise a number to an integer power.

pub fn is_zero(&self) -> bool

Returns true if the number is zero.

pub fn is_sign_positive(&self) -> bool

Returns true if the number is positive and not zero.

pub fn is_sign_negative(&self) -> bool

Returns true if the number is negative and not zero.

Trait Implementations

impl Add for &Scientific

type Output = Scientific

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Scientific

fn clone(&self) -> Scientific

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scientific

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scientific

Available on crate feature serde only.

fn deserialize<D>( deserializer: D ) -> Result<Self, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Scientific

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

Formats the value using the given formatter.

impl From<&Scientific> for f32

fn from(value: &Scientific) -> Self

Converts to this type from the input type.

impl From<&Scientific> for f64

fn from(value: &Scientific) -> Self

Converts to this type from the input type.

impl From<i128> for Scientific

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Scientific

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Scientific

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Scientific

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Scientific

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Scientific

fn from(val: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Scientific

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Scientific

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Scientific

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Scientific

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Scientific

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Scientific

fn from(val: usize) -> Self

Converts to this type from the input type.

impl FromStr for Scientific

type Err = ConversionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for &Scientific

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 Mul for &Scientific

type Output = Scientific

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for &Scientific

type Output = Scientific

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Scientific

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Scientific

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Scientific

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

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

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

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

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

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

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 Serialize for Scientific

Available on crate feature serde only.

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 Shl<isize> for &Scientific

type Output = Scientific

The resulting type after applying the << operator.

fn shl(self, rhs: isize) -> Self::Output

Performs the << operation.

impl ShlAssign<isize> for Scientific

fn shl_assign(&mut self, rhs: isize)

Performs the <<= operation.

impl Shr<isize> for &Scientific

type Output = Scientific

The resulting type after applying the >> operator.

fn shr(self, rhs: isize) -> Self::Output

Performs the >> operation.

impl ShrAssign<isize> for Scientific

fn shr_assign(&mut self, rhs: isize)

Performs the >>= operation.

impl Sub for &Scientific

type Output = Scientific

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<&Scientific> for i128

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for i16

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for i32

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for i64

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for i8

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for isize

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for u128

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for u16

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for u32

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for u64

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for u8

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Scientific> for usize

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Scientific) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f32> for Scientific

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for Scientific

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Scientific

impl Send for Scientific

Available on crate feature arc only.

impl Sync for Scientific

Available on crate feature arc only.