Struct Quantity 

pub struct Quantity { /* private fields */ }

Represents a physical quantity consisting of a scalar value and a Dimension.

Example

use dimensional_analyser::{quantity::Quantity, dimensions::le_systeme_international_d_unites::{JOULE, base_units::{KILOGRAM, METER, SECOND}}};

let mass = Quantity::new(5, &KILOGRAM);
let velocity = Quantity::new(10, &(&*METER / &*SECOND));
let kinetic_energy = (&mass * &velocity.power(2)) / 2;
assert_eq!(kinetic_energy, Quantity::new(250, &JOULE));

Implementations

impl Quantity

pub fn new<T: Into<f64>>(value: T, dimension: &Dimension) -> Self

Creates a new Quantity with the given value and Dimension.

pub fn power<T: Into<f64> + Copy>(&self, exponent: T) -> Self

Raises the quantity to the specified power.

pub fn convert_to( &self, other: &Dimension, ) -> Result<Self, UnconvertableQuantityError>

Attempts to convert the quantity to another compatible dimension.

Errors

UnconvertableQuantityError when the base Quantity can’t be converted to the target Dimension

Example

use dimensional_analyser::{dimension::Prefix::Centi, quantity::Quantity, dimensions::le_systeme_international_d_unites::base_units::METER};

let one_square_centimeter = Quantity::new(1, &METER.prefix(&Centi).square());
let area_in_square_meters = one_square_centimeter.convert_to(&METER.square()).unwrap();
assert_eq!(area_in_square_meters, Quantity::new(0.0001, &METER.square()));

pub fn get_equality_with(&self, other: &Self) -> Equality

Returns the relationship between both Quantity’s.

Panics

Not enough data is known after converting self to the other.dimension so an expect is used

Example

use dimensional_analyser::{quantity::Quantity, dimensions::le_systeme_international_d_unites::{MINUTE, base_units::SECOND}, quantity::Equality};

let one_minute = Quantity::new(1, &MINUTE);
let sixty_seconds = Quantity::new(60, &SECOND);
match one_minute.get_equality_with(&sixty_seconds) {
    Equality::ScalarMultiple(factor) => assert_eq!(factor, 60.0),
    _ => panic!("1 min and 60 s should be scalar multiples"),
}

pub fn show_comparizon_results_with(&self, other: &Self)

Helper function to print how both Quantity’s are related.

Trait Implementations

impl Add for &Quantity

type Output = Result<Quantity, DifferentDimensionError>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Quantity

fn clone(&self) -> Quantity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Quantity

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

Formats the value using the given formatter.

impl Display for Quantity

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

Formats the value using the given formatter.

impl<T: Into<f64>> Div<T> for Quantity

type Output = Quantity

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl Div for &Quantity

type Output = Quantity

The resulting type after applying the / operator.

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

Performs the / operation.

impl LowerExp for Quantity

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

Formats the value using the given formatter.

impl<T: Into<f64>> Mul<T> for Quantity

type Output = Quantity

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for &Quantity

type Output = Quantity

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Quantity

fn eq(&self, other: &Self) -> 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 Product for Quantity

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl Sub for &Quantity

type Output = Result<Quantity, DifferentDimensionError>

The resulting type after applying the - operator.

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

Performs the - operation.