Struct Dimension 

pub struct Dimension { /* private fields */ }

A physical dimension represented as a sparse vector of rational exponents over base dimensions.

For example, Velocity = Length^1 * Time^-1 is represented as {BaseDimId::Prelude("Length"): 1, BaseDimId::Prelude("Time"): -1}.

Only non-zero exponents are stored. An empty map represents the dimensionless dimension.

Implementations

impl Dimension

pub const fn dimensionless() -> Self

The dimensionless dimension (empty exponent map).

pub fn base(id: BaseDimId) -> Self

A dimension with a single base dimension at exponent 1.

pub fn is_dimensionless(&self) -> bool

pub fn get_exponent(&self, id: &BaseDimId) -> Rational

Get the exponent for a specific base dimension (zero if absent).

pub fn iter(&self) -> impl Iterator<Item = (&BaseDimId, &Rational)>

Returns an iterator over the non-zero (BaseDimId, Rational) pairs.

pub fn pow(&self, exp: Rational) -> Result<Self, RationalError>

Raise a dimension to a rational power (multiply all exponents).

Returns Err(RationalError::Overflow) if any exponent multiplication produces a reduced value outside the i32 range.

pub fn pow_int(&self, n: i32) -> Result<Self, RationalError>

Raise a dimension to an integer power.

Returns Err(RationalError::Overflow) if any exponent multiplication overflows i32.

pub const fn display_with<'a>( &'a self, names: &'a BTreeMap<BaseDimId, String>, ) -> DimensionDisplay<'a>

Format this dimension using named base dimensions for display.

The names map provides BaseDimId → name mappings. Unknown IDs are displayed as D{id}.

Trait Implementations

impl Clone for Dimension

fn clone(&self) -> Dimension

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dimension

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

Formats the value using the given formatter.

impl Div for Dimension

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

Divide two dimensions (subtract exponents).

type Output = Result<Dimension, RationalError>

The resulting type after applying the / operator.

impl Div for &Dimension

type Output = Result<Dimension, RationalError>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Eq for Dimension

impl Hash for Dimension

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul for Dimension

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

Multiply two dimensions (add exponents).

type Output = Result<Dimension, RationalError>

The resulting type after applying the * operator.

impl Mul for &Dimension

type Output = Result<Dimension, RationalError>

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Dimension

fn eq(&self, other: &Dimension) -> 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 StructuralPartialEq for Dimension