[−][src]Type Definition uom::si::ratio::Ratio

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

Ratio (dimensionless).

Methods

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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)));

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

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));

Trait Implementations

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

impl<U: ?Sized> FromStr for Ratio<U, usize> where
    U: Units<usize>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, u8> where
    U: Units<u8>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, u16> where
    U: Units<u16>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, u32> where
    U: Units<u32>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, u64> where
    U: Units<u64>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, isize> where
    U: Units<isize>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, i8> where
    U: Units<i8>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, i16> where
    U: Units<i16>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, i32> where
    U: Units<i32>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, i64> where
    U: Units<i64>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, BigInt> where
    U: Units<BigInt>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, BigUint> where
    U: Units<BigUint>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, Rational> where
    U: Units<Rational>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, Rational32> where
    U: Units<Rational32>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, Rational64> where
    U: Units<Rational64>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, BigRational> where
    U: Units<BigRational>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, f32> where
    U: Units<f32>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.

impl<U: ?Sized> FromStr for Ratio<U, f64> where
    U: Units<f64>, 
[src]

type Err = ParseQuantityError

The associated error which can be returned from parsing.