Struct Unit

pub struct Unit { /* private fields */ }

Implementations

impl Unit

pub fn new() -> Unit

Return an Unit with an empty set of BaseUnit

pub fn from_vec(list: Vec<(BaseUnit, i32)>) -> Unit

Create a Unit from a vector of BaseUnit and their power

Examples

use ndarray_unit::Unit;
use ndarray_unit::BaseUnit;

let candela_square_divided_by_ampere_cube = Unit::from_vec(vec![(BaseUnit::CANDELA, 2), (BaseUnit::AMPERE, -3)]);
println!("{}", candela_square_divided_by_ampere_cube)

Output

// cd²·A⁻³

pub fn get_base_units(&self) -> &HashMap<BaseUnit, i32>

pub fn get_inverse(&self) -> Unit

Given an Unit, return the inverse of this unit. It inverse the sign of the power of every BaseUnit of the given input Struct

Exemples

use ndarray_unit::Unit;
use ndarray_unit::BaseUnit;

let unit = Unit::from_vec(vec![(BaseUnit::KELVIN, 2), (BaseUnit::MOLE, -3)]);
let inverse = Unit::from_vec(vec![(BaseUnit::KELVIN, -2), (BaseUnit::MOLE, 3)]);

assert_eq!(inverse, unit.get_inverse());

pub fn add_single_unit(&mut self, unit: BaseUnit, n: i32)

Add a BaseUnit (and its power) to an existing mut Unit

Examples

use ndarray_unit::Unit;
use ndarray_unit::BaseUnit;

let mut meter = Unit::new();
meter.add_single_unit(BaseUnit::METER, 1);

let mut meter_per_second = meter.clone();
meter_per_second.add_single_unit(BaseUnit::SECOND, -1);
println!("{}", meter_per_second);

Output

// m·s⁻¹

Trait Implementations

impl Clone for Unit

fn clone(&self) -> Unit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Unit

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

Formats the value using the given formatter.

impl Display for Unit

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

Formats the value using the given formatter.

impl Div for &Unit

Given two Units, perform a division between them and return a new Unit. It substracts the base_units of the two given Struct

Exemples

use ndarray_unit::Unit;
use ndarray_unit::BaseUnit;

let meter = Unit::from_vec(vec![(BaseUnit::METER, 1)]);
let second_square = Unit::from_vec(vec![(BaseUnit::SECOND, 2)]);

let acceleration = &meter / &second_square;
// acceleration = Unit { base_units: {METER : 1, SECOND: -2} }

type Output = Unit

The resulting type after applying the / operator.

fn div(self, other: &Unit) -> Unit

Performs the / operation.

impl Mul for &Unit

Given two Units, perform a multiplication between them and return a new Unit. It adds the base_units of the two given Struct

Exemples

use ndarray_unit::Unit;
use ndarray_unit::BaseUnit;

let meter = Unit::from_vec(vec![(BaseUnit::METER, 1)]);
let square_meter = Unit::from_vec(vec![(BaseUnit::METER, 2)]);

let cube_meter = &meter * &square_meter;
// cube_meter = Unit { base_units: {METER : 3} }

type Output = Unit

The resulting type after applying the * operator.

fn mul(self, other: &Unit) -> Unit

Performs the * operation.

impl PartialEq for Unit

fn eq(&self, other: &Unit) -> 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.