Skip to main content

Dim

Struct Dim 

Source
pub struct Dim(/* private fields */);
Expand description

A dimension: integer exponents of kilogram, metre, second, ampere, kelvin, mole and candela, in that order.

The mass base is the kilogram, not the gram. Plane angle is dimensionless (see ADR-007). All arithmetic is checked: exponent overflow is reported as Error::Overflow.

§Examples

use dimvexa_core::Dim;

let velocity = Dim::M.checked_sub(Dim::S)?;
assert_eq!(velocity.exponents(), [0, 1, -1, 0, 0, 0, 0]);
let accel = velocity.checked_sub(Dim::S)?;
let force = Dim::KG.checked_add(accel)?;
assert_eq!(force.to_string(), "kg m s^-2");

Implementations§

Source§

impl Dim

Source

pub const NONE: Self

The dimensionless vector (all exponents zero).

Source

pub const KG: Self

Mass (kilogram).

Source

pub const M: Self

Length (metre).

Source

pub const S: Self

Time (second).

Source

pub const A: Self

Electric current (ampere).

Source

pub const K: Self

Thermodynamic temperature (kelvin).

Source

pub const MOL: Self

Amount of substance (mole).

Source

pub const CD: Self

Luminous intensity (candela).

Source

pub const fn new(exponents: [i8; 7]) -> Self

Builds a dimension from exponents of [kg, m, s, A, K, mol, cd].

Source

pub const fn exponents(self) -> [i8; 7]

The exponents of [kg, m, s, A, K, mol, cd].

Source

pub fn is_dimensionless(self) -> bool

True if every exponent is zero.

Source

pub fn checked_add(self, other: Self) -> Result<Self>

Dimension of a product: exponents add.

§Errors

Error::Overflow if an exponent leaves the i8 range.

Source

pub fn checked_sub(self, other: Self) -> Result<Self>

Dimension of a quotient: exponents subtract.

§Errors

Error::Overflow if an exponent leaves the i8 range.

Source

pub fn checked_scale(self, n: i32) -> Result<Self>

Dimension of a power: every exponent is multiplied by n.

§Errors

Error::Overflow if an exponent leaves the i8 range.

Source

pub fn checked_neg(self) -> Result<Self>

Dimension of the reciprocal: every exponent is negated.

§Errors

Error::Overflow if an exponent is i8::MIN.

Trait Implementations§

Source§

impl Clone for Dim

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Dim

Source§

impl Debug for Dim

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Dim

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for Dim

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Dim

Source§

impl Hash for Dim

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Dim

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Dim

Auto Trait Implementations§

§

impl Forget for Dim

§

impl Freeze for Dim

§

impl RefUnwindSafe for Dim

§

impl Send for Dim

§

impl Sync for Dim

§

impl Unpin for Dim

§

impl UnsafeUnpin for Dim

§

impl UnwindSafe for Dim

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.