Struct DimensionalVariable 

pub struct DimensionalVariable {
    pub value: f64,
    pub unit: [f64; 8],
}

Fields

value: f64

unit: [f64; 8]

Implementations

impl DimensionalVariable

A struct representing a dimensional variable with a value and a unit.

pub fn new(value: f64, unit_str: &str) -> Result<Self, String>

Creates a new DimensionalVariable with the given value and unit.

Rules for writing the unit string:

• Use a single / as a delimiter between the numerator and denominator.
• Use - as a delimiter between individual units
• Exponents can be represented either by using ^ to indicate exponent (ex. m^2) or without the delimiter (ex. m2)
• Inverses can be represented either by negative exponents or in the denominator (ex. m^-2 or 1/m^2)

Returns an error if the unit string is invalid or contains unknown units.

pub fn value(&self) -> f64

Returns the value of this DimensionalVariable.

pub fn value_in(&self, unit_str: &str) -> Result<f64, String>

Converts the value of this DimensionalVariable to the specified unit. Returns an error if the unit string is invalid or incompatible.

pub fn check_compatibility(&self, other_unit: [f64; 8]) -> bool

pub fn unit(&self) -> [f64; 8]

Returns the base unit array of this DimensionalVariable.

pub fn is_unitless(&self) -> bool

Returns whether the variable is unitless (all base exponents are 0).

pub fn try_add( &self, other: &DimensionalVariable, ) -> Result<DimensionalVariable, String>

Fallible add with unit compatibility check.

pub fn try_sub( &self, other: &DimensionalVariable, ) -> Result<DimensionalVariable, String>

Fallible subtraction with unit compatibility check.

pub fn powi(&self, exp: i32) -> DimensionalVariable

Raise to integer power. Units exponents are multiplied by exp. Returns a new DimensionalVariable.

pub fn powf(&self, exp: f64) -> Result<DimensionalVariable, String>

Raise to floating power. Returns a new DimensionalVariable.

pub fn sqrt(&self) -> Result<DimensionalVariable, String>

Square root. Allowed only when all unit exponents are value >= 0 (no complex results). Returns a new DimensionalVariable.

pub fn ln(&self) -> Result<f64, String>

Natural logarithm. Requires unitless and value > 0.

pub fn log2(&self) -> Result<f64, String>

Base-2 logarithm. Requires unitless and value > 0.

pub fn log10(&self) -> Result<f64, String>

Base-10 logarithm. Requires unitless and value > 0.

pub fn sin(&self) -> Result<f64, String>

Sine function. Requires angle (radians).

pub fn cos(&self) -> Result<f64, String>

Cosine function. Requires angle (radians).

pub fn tan(&self) -> Result<f64, String>

Tangent function. Requires angle (radians).

pub fn asin(&self) -> Result<DimensionalVariable, String>

Arcsine function. Requires unitless value in [-1, 1]. Returns angle in radians.

pub fn acos(&self) -> Result<DimensionalVariable, String>

Arccosine function. Requires unitless value in [-1, 1]. Returns angle in radians.

pub fn atan(&self) -> Result<DimensionalVariable, String>

Arctangent function. Requires unitless value. Returns angle in radians.

pub fn neg(&self) -> DimensionalVariable

Negate the value, keeping the same unit.

pub fn abs(&self) -> DimensionalVariable

Returns the absolute value, keeping the same unit.

Trait Implementations

impl<'a, 'b> Add<&'b DimensionalVariable> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the + operator.

fn add(self, rhs: &'b DimensionalVariable) -> Self::Output

Performs the + operation.

impl<'b> Add<&'b DimensionalVariable> for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the + operator.

fn add(self, rhs: &'b DimensionalVariable) -> Self::Output

Performs the + operation.

impl<'a> Add<DimensionalVariable> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<&DimensionalVariable> for DimensionalVariable

fn add_assign(&mut self, rhs: &DimensionalVariable)

Performs the += operation.

impl Display for DimensionalVariable

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

Formats the DimensionalVariable as a string in the form “value unit”.

The unit is displayed in fraction style (e.g., “m/s^2”) with:

• Positive exponents in the numerator
• Negative exponents in the denominator (as positive values)
• Exponents of 1 are omitted
• Units with exponent 0 are omitted
• Unitless quantities show “(unitless)”

Examples:

• 9.81 m/s^2 for acceleration
• 100 kg*m^2/s^2 for energy
• 3.14 rad for angle
• 5 (unitless) for dimensionless quantities

impl<'a, 'b> Div<&'b DimensionalVariable> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the / operator.

fn div(self, rhs: &'b DimensionalVariable) -> Self::Output

Performs the / operation.

impl<'b> Div<&'b DimensionalVariable> for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the / operator.

fn div(self, rhs: &'b DimensionalVariable) -> Self::Output

Performs the / operation.

impl<'a> Div<&'a DimensionalVariable> for f64

type Output = DimensionalVariable

The resulting type after applying the / operator.

fn div(self, rhs: &'a DimensionalVariable) -> Self::Output

Performs the / operation.

impl<'a> Div<DimensionalVariable> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<DimensionalVariable> for f64

type Output = DimensionalVariable

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a> Div<f64> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<&DimensionalVariable> for DimensionalVariable

fn div_assign(&mut self, rhs: &DimensionalVariable)

Performs the /= operation.

impl DivAssign<f64> for DimensionalVariable

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl<'a, 'b> Mul<&'b DimensionalVariable> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the * operator.

fn mul(self, rhs: &'b DimensionalVariable) -> Self::Output

Performs the * operation.

impl<'b> Mul<&'b DimensionalVariable> for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the * operator.

fn mul(self, rhs: &'b DimensionalVariable) -> Self::Output

Performs the * operation.

impl<'a> Mul<&'a DimensionalVariable> for f64

type Output = DimensionalVariable

The resulting type after applying the * operator.

fn mul(self, rhs: &'a DimensionalVariable) -> Self::Output

Performs the * operation.

impl<'a> Mul<DimensionalVariable> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<DimensionalVariable> for f64

type Output = DimensionalVariable

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a> Mul<f64> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<&DimensionalVariable> for DimensionalVariable

fn mul_assign(&mut self, rhs: &DimensionalVariable)

Performs the *= operation.

impl MulAssign<f64> for DimensionalVariable

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl<'a> Neg for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for DimensionalVariable

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 PartialOrd for DimensionalVariable

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, 'b> Sub<&'b DimensionalVariable> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the - operator.

fn sub(self, rhs: &'b DimensionalVariable) -> Self::Output

Performs the - operation.

impl<'b> Sub<&'b DimensionalVariable> for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the - operator.

fn sub(self, rhs: &'b DimensionalVariable) -> Self::Output

Performs the - operation.

impl<'a> Sub<DimensionalVariable> for &'a DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for DimensionalVariable

type Output = DimensionalVariable

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&DimensionalVariable> for DimensionalVariable

fn sub_assign(&mut self, rhs: &DimensionalVariable)

Performs the -= operation.