Struct rink_core::number::Number

pub struct Number {
    pub value: Numeric,
    pub unit: Quantity,
}

The basic representation of a number with a unit.

Fields

value: Numeric

unit: Quantity

Implementations

impl Number

pub fn one() -> Number

pub fn one_unit(unit: Dimension) -> Number

pub fn zero() -> Number

pub fn new(num: Numeric) -> Number

Creates a dimensionless value.

pub fn new_unit(num: Numeric, unit: Dimension) -> Number

Creates a value with a single dimension.

pub fn from_parts(
    integer: &str,
    frac: Option<&str>,
    exp: Option<&str>
) -> Result<Numeric, String>

pub fn invert(&self) -> Number

Computes the reciprocal (1/x) of the value.

pub fn powi(&self, exp: i32) -> Number

Raises a value to a dimensionless integer power.

pub fn root(&self, exp: i32) -> Result<Number, String>

Computes the nth root of a value iff all of its units have powers divisible by n.

pub fn pow(&self, exp: &Number) -> Result<Number, String>

pub fn numeric_value(
    &self,
    base: u8,
    digits: Digits
) -> (Option<String>, Option<String>)

pub fn to_parts_simple(&self) -> NumberParts

pub fn prettify(&self, context: &Context) -> Number

Convert the units of the number from base units to display units, and possibly apply SI prefixes.

pub fn to_parts(&self, context: &Context) -> NumberParts

pub fn unit_to_string(unit: &Quantity) -> String

pub fn complexity_score(&self) -> i64

pub fn dimless(&self) -> bool

Trait Implementations

impl<'a, 'b> Add<&'b Number> for &'a Number

type Output = Option<Number>

The resulting type after applying the + operator.

fn add(self, other: &Number) -> Self::Output

Performs the + operation.

impl Clone for Number

fn clone(&self) -> Number

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Number

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

Formats the value using the given formatter.

impl<'a, 'b> Div<&'b Number> for &'a Number

type Output = Option<Number>

The resulting type after applying the / operator.

fn div(self, other: &Number) -> Self::Output

Performs the / operation.

impl<'a, 'b> Div<&'b Number> for &'a Substance

type Output = Result<Substance, String>

The resulting type after applying the / operator.

fn div(self, other: &'b Number) -> Self::Output

Performs the / operation.

impl<'a, 'b> Mul<&'b Number> for &'a Number

type Output = Option<Number>

The resulting type after applying the * operator.

fn mul(self, other: &Number) -> Self::Output

Performs the * operation.

impl<'a, 'b> Mul<&'b Number> for &'a Substance

type Output = Result<Substance, String>

The resulting type after applying the * operator.

fn mul(self, other: &'b Number) -> Self::Output

Performs the * operation.

impl<'a> Neg for &'a Number

type Output = Option<Number>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<Number> for Number

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

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

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

This method tests for !=.

impl Show for Number

fn show(&self, context: &Context) -> String

Provides a string representation of something, using information contained in a Context.

impl StructuralPartialEq for Number

impl<'a, 'b> Sub<&'b Number> for &'a Number

type Output = Option<Number>

The resulting type after applying the - operator.

fn sub(self, other: &Number) -> Self::Output

Performs the - operation.