Type Definition uom::si::ratio::Ratio

pub type Ratio<U, V> = Quantity<Dimension, U, V>;

Ratio (dimensionless quantity).

Generic Parameters

• U: Base units.
• V: Underlying storage type.

Implementations

impl<U, V> Ratio<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V>, 

pub fn new<N>(v: V) -> Self where
    N: Unit + Conversion<V, T = V::T>, 

Create a new quantity from the given value and measurement unit.

Generic Parameters

• N: Unit.

pub fn get<N>(&self) -> V where
    N: Unit + Conversion<V, T = V::T>, 

Retrieve the value of the quantity in the given measurement unit.

Generic Parameters

• N: Unit.

pub fn floor<N>(self) -> Self where
    V: Float,
    N: Unit + Conversion<V, T = V::T>, 

Returns the largest integer less than or equal to a number in the given measurement unit.

Generic Parameters

• N: Unit.

pub fn ceil<N>(self) -> Self where
    V: Float,
    N: Unit + Conversion<V, T = V::T>, 

Returns the smallest integer less than or equal to a number in the given measurement unit.

Generic Parameters

• N: Unit.

pub fn round<N>(self) -> Self where
    V: Float,
    N: Unit + Conversion<V, T = V::T>, 

Returns the nearest integer to a number in the in given measurement unit. Round half-way cases away from 0.0.

Generic Parameters

• N: Unit.

pub fn trunc<N>(self) -> Self where
    V: Float,
    N: Unit + Conversion<V, T = V::T>, 

Returns the integer part of a number in the given measurement unit.

Generic Parameters

• N: Unit.

pub fn fract<N>(self) -> Self where
    V: Float,
    N: Unit + Conversion<V, T = V::T>, 

Returns the fractional part of a number in the given measurement unit.

Generic Parameters

• N: Unit.

pub fn format_args<N>(unit: N, style: DisplayStyle) -> Arguments<Dimension, N> where
    N: Unit, 

Creates a struct that can be used to format a compatible quantity for display.

Notes

The return value of this method cannot be used to print directly, but is instead used to format quantities and can be reused; see Arguments::with and the examples below.

If you do not need to format multiple quantities, consider using into_format_args instead.

Examples

let t1 = Time::new::<femtosecond>(1.0_E-1);
let t2 = Time::new::<picosecond>(1.0_E-1);
let a = Time::format_args(femtosecond, Description);

assert_eq!("0.1 femtoseconds", format!("{}", a.with(t1)));
assert_eq!("100 femtoseconds", format!("{}", a.with(t2)));

Generic Parameters

• N: Unit.

pub fn into_format_args<N>(
    self,
    unit: N,
    style: DisplayStyle
) -> QuantityArguments<Dimension, U, V, N> where
    N: Unit, 

Creates a struct that formats self for display.

Notes

Unlike format_args, the return value of this method can be used directly for display. It will format the value of self for the quantity on which it is called and nothing else.

If you wish to reuse the return value to format multiple quantities, use format_args instead.

Examples

let t = Time::new::<picosecond>(1.0_E-1);
let a = t.into_format_args(femtosecond, Description);

assert_eq!("100 femtoseconds", format!("{}", a));

Generic Parameters

• N: Unit.

impl<U, V> Ratio<U, V> where
    U: Units<V> + ?Sized,
    V: Float + Conversion<V>,
    radian: Conversion<V, T = V::T>, 

Implementation of various stdlib inverse trigonometric functions

pub fn acos(self) -> Angle<U, V>

Computes the value of the inverse cosine of the ratio.

pub fn acosh(self) -> Angle<U, V>

Computes the value of the inverse hyperbolic cosine of the ratio.

pub fn asin(self) -> Angle<U, V>

Computes the value of the inverse sine of the ratio.

pub fn asinh(self) -> Angle<U, V>

Computes the value of the inverse hyperbolic sine of the ratio.

pub fn atan(self) -> Angle<U, V>

Computes the value of the inverse tangent of the ratio.

pub fn atanh(self) -> Angle<U, V>

Computes the value of the inverse hyperbolic tangent of the ratio.

Trait Implementations

impl<U, V> From<V> for Ratio<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V>, 

fn from(t: V) -> Self

Performs the conversion.

impl<U> FromStr for Ratio<U, usize> where
    U: Units<usize> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, u32> where
    U: Units<u32> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, Rational64> where
    U: Units<Rational64> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, BigRational> where
    U: Units<BigRational> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, f32> where
    U: Units<f32> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, f64> where
    U: Units<f64> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, u64> where
    U: Units<u64> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, isize> where
    U: Units<isize> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, i32> where
    U: Units<i32> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, i64> where
    U: Units<i64> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, BigInt> where
    U: Units<BigInt> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, BigUint> where
    U: Units<BigUint> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, Rational> where
    U: Units<Rational> + ?Sized, 

type Err = ParseQuantityError

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<U> FromStr for Ratio<U, Rational32> where
    U: Units<Rational32> + ?Sized, 

type Err = ParseQuantityError

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.