Skip to main content

Dimension

Struct Dimension 

Source
pub struct Dimension(pub [i8; 7]);
Expand description

A dimensional exponent vector over the seven UCUM base quantities.

The exponent order is fixed and documented:

indexquantitybase unit
0lengthm
1times
2massg
3plane anglerad
4temperatureK
5electric chargeC
6luminous intensitycd

All arithmetic saturates at the i8 bounds rather than overflowing, so the type can never panic, even on absurd inputs such as m120.m120.

use ucum::Dimension;
let area = Dimension::DIMENSIONLESS.mul(Dimension([2, 0, 0, 0, 0, 0, 0]));
assert_eq!(area, Dimension([2, 0, 0, 0, 0, 0, 0]));

Tuple Fields§

§0: [i8; 7]

Implementations§

Source§

impl Dimension

Source

pub const DIMENSIONLESS: Dimension

The dimensionless dimension (all exponents zero).

Source

pub fn is_dimensionless(&self) -> bool

Returns true when every exponent is zero.

Source

pub fn mul(self, other: Dimension) -> Dimension

Multiplies two dimensions by adding their exponents (saturating).

Named mul per the public UCUM API contract; it intentionally does not implement std::ops::Mul, to keep the type’s surface explicit.

Source

pub fn inv(self) -> Dimension

Inverts a dimension by negating its exponents (saturating).

Source

pub fn powi(self, n: i8) -> Dimension

Raises a dimension to an integer power (saturating).

Trait Implementations§

Source§

impl Clone for Dimension

Source§

fn clone(&self) -> Dimension

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 Dimension

Source§

impl Debug for Dimension

Source§

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

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

impl Display for Dimension

Source§

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

Renders a dimension in UCUM base-unit syntax, e.g. m3.s-1.

The dimensionless dimension renders as 1.

Source§

impl Eq for Dimension

Source§

impl Hash for Dimension

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 Dimension

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Dimension

Auto Trait Implementations§

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.