Struct LengthArray

pub struct LengthArray<const N: usize> { /* private fields */ }

Array storage for a series of values and LengthUnit.

Implementations

impl<const D: usize> LengthArray<D>

pub fn new(values: [f64; D], unit: LengthUnit) -> Self

Create a new vector of LengthUnit.

pub fn values(&self) -> &[f64; D]

Retrieve values associated with this [LengthSlice].

pub fn values_mut(&mut self) -> &mut [f64; D]

Retrieve the mutable values associated with this [LengthSlice].

pub fn yottameter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::yottameter.

pub fn zettameter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::zettameter.

pub fn exameter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::exameter.

pub fn petameter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::petameter.

pub fn terameter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::terameter.

pub fn gigameter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::gigameter.

pub fn megameter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::megameter.

pub fn kilometer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::kilometer.

pub fn hectometer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::hectometer.

pub fn decameter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::decameter.

pub fn meter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::meter.

pub fn decimeter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::decimeter.

pub fn centimeter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::centimeter.

pub fn millimeter(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::millimeter.

pub fn micrometer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::micrometer.

pub fn nanometer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::nanometer.

pub fn picometer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::picometer.

pub fn femtometer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::femtometer.

pub fn attometer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::attometer.

pub fn zeptometer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::zeptometer.

pub fn yoctometer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::yoctometer.

pub fn angstrom(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::angstrom.

pub fn bohr_radius(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::bohr_radius.

pub fn atomic_unit_of_length(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::atomic_unit_of_length.

pub fn astronomical_unit(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::astronomical_unit.

pub fn chain(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::chain.

pub fn fathom(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::fathom.

pub fn fermi(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::fermi.

pub fn foot(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::foot.

pub fn kilofoot(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::kilofoot.

pub fn foot_survey(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::foot_survey.

pub fn inch(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::inch.

pub fn light_year(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::light_year.

pub fn microinch(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::microinch.

pub fn micron(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::micron.

pub fn mil(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::mil.

pub fn mile(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::mile.

pub fn mile_survey(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::mile_survey.

pub fn nautical_mile(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::nautical_mile.

pub fn parsec(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::parsec.

pub fn pica_computer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::pica_computer.

pub fn pica_printers(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::pica_printers.

pub fn point_computer(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::point_computer.

pub fn point_printers(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::point_printers.

pub fn rod(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::rod.

pub fn yard(values: [f64; D]) -> Self

Create a new Length with units of LengthUnit::yard.

pub fn to_yottameter(&self) -> Self

Convert to LengthUnit::yottameter.

pub fn to_zettameter(&self) -> Self

Convert to LengthUnit::zettameter.

pub fn to_exameter(&self) -> Self

Convert to LengthUnit::exameter.

pub fn to_petameter(&self) -> Self

Convert to LengthUnit::petameter.

pub fn to_terameter(&self) -> Self

Convert to LengthUnit::terameter.

pub fn to_gigameter(&self) -> Self

Convert to LengthUnit::gigameter.

pub fn to_megameter(&self) -> Self

Convert to LengthUnit::megameter.

pub fn to_kilometer(&self) -> Self

Convert to LengthUnit::kilometer.

pub fn to_hectometer(&self) -> Self

Convert to LengthUnit::hectometer.

pub fn to_decameter(&self) -> Self

Convert to LengthUnit::decameter.

pub fn to_meter(&self) -> Self

Convert to LengthUnit::meter.

pub fn to_decimeter(&self) -> Self

Convert to LengthUnit::decimeter.

pub fn to_centimeter(&self) -> Self

Convert to LengthUnit::centimeter.

pub fn to_millimeter(&self) -> Self

Convert to LengthUnit::millimeter.

pub fn to_micrometer(&self) -> Self

Convert to LengthUnit::micrometer.

pub fn to_nanometer(&self) -> Self

Convert to LengthUnit::nanometer.

pub fn to_picometer(&self) -> Self

Convert to LengthUnit::picometer.

pub fn to_femtometer(&self) -> Self

Convert to LengthUnit::femtometer.

pub fn to_attometer(&self) -> Self

Convert to LengthUnit::attometer.

pub fn to_zeptometer(&self) -> Self

Convert to LengthUnit::zeptometer.

pub fn to_yoctometer(&self) -> Self

Convert to LengthUnit::yoctometer.

pub fn to_angstrom(&self) -> Self

Convert to LengthUnit::angstrom.

pub fn to_bohr_radius(&self) -> Self

Convert to LengthUnit::bohr_radius.

pub fn to_atomic_unit_of_length(&self) -> Self

Convert to LengthUnit::atomic_unit_of_length.

pub fn to_astronomical_unit(&self) -> Self

Convert to LengthUnit::astronomical_unit.

pub fn to_chain(&self) -> Self

Convert to LengthUnit::chain.

pub fn to_fathom(&self) -> Self

Convert to LengthUnit::fathom.

pub fn to_fermi(&self) -> Self

Convert to LengthUnit::fermi.

pub fn to_foot(&self) -> Self

Convert to LengthUnit::foot.

pub fn to_kilofoot(&self) -> Self

Convert to LengthUnit::kilofoot.

pub fn to_foot_survey(&self) -> Self

Convert to LengthUnit::foot_survey.

pub fn to_inch(&self) -> Self

Convert to LengthUnit::inch.

pub fn to_light_year(&self) -> Self

Convert to LengthUnit::light_year.

pub fn to_microinch(&self) -> Self

Convert to LengthUnit::microinch.

pub fn to_micron(&self) -> Self

Convert to LengthUnit::micron.

pub fn to_mil(&self) -> Self

Convert to LengthUnit::mil.

pub fn to_mile(&self) -> Self

Convert to LengthUnit::mile.

pub fn to_mile_survey(&self) -> Self

Convert to LengthUnit::mile_survey.

pub fn to_nautical_mile(&self) -> Self

Convert to LengthUnit::nautical_mile.

pub fn to_parsec(&self) -> Self

Convert to LengthUnit::parsec.

pub fn to_pica_computer(&self) -> Self

Convert to LengthUnit::pica_computer.

pub fn to_pica_printers(&self) -> Self

Convert to LengthUnit::pica_printers.

pub fn to_point_computer(&self) -> Self

Convert to LengthUnit::point_computer.

pub fn to_point_printers(&self) -> Self

Convert to LengthUnit::point_printers.

pub fn to_rod(&self) -> Self

Convert to LengthUnit::rod.

pub fn to_yard(&self) -> Self

Convert to LengthUnit::yard.

pub fn at(&self, index: usize) -> Length

Methods from Deref<Target = [f64; N]>

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

Borrows each element and returns an array of references with the same size as self.

Example

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

Trait Implementations

impl<const N: usize> Add for LengthArray<N>

type Output = LengthArray<N>

The resulting type after applying the + operator.

fn add(self, rhs: LengthArray<N>) -> Self

Performs the + operation.

impl<const N: usize> AddAssign for LengthArray<N>

fn add_assign(&mut self, rhs: LengthArray<N>)

Performs the += operation.

impl<const N: usize> Clone for LengthArray<N>

fn clone(&self) -> LengthArray<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for LengthArray<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for LengthArray<N>

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Deref for LengthArray<N>

type Target = [f64; N]

The resulting type after dereferencing.

fn deref(&self) -> &[f64; N]

Dereferences the value.

impl<const N: usize> DerefMut for LengthArray<N>

fn deref_mut(&mut self) -> &mut [f64; N]

Mutably dereferences the value.

impl<const N: usize> Div<f64> for LengthArray<N>

type Output = LengthArray<N>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const N: usize> DivAssign<f64> for LengthArray<N>

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl<const N: usize> FixedSliceQuantity<LengthUnit, f64> for LengthArray<N>

fn unit(&self) -> LengthUnit

Return unit associated with this quantity

fn values(&self) -> &[f64]

Return values in quantity

fn values_mut(&mut self) -> &mut [f64]

Return mutable values in quantity

fn len(&self) -> usize

Return number of values in quantity

fn convert(&self, unit: LengthUnit) -> Self

Convert a unit of one UnitType to another of the same type. No validation of base unit is made.

fn convert_mut(&mut self, unit: LengthUnit)

Mutate current quantity, convering a unit of one UnitType to another of the same type. No validation of base unit is made.

fn try_convert(&self, unit: Units) -> Result<Self, RuntimeUnitError>

where Self: Sized,

Attempt to convert the unit given in unit to a UnitType. Base unit validation is made here.

impl<const N: usize> Mul<f64> for LengthArray<N>

type Output = LengthArray<N>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const N: usize> MulAssign<f64> for LengthArray<N>

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl<const N: usize> PartialEq for LengthArray<N>

fn eq(&self, other: &LengthArray<N>) -> 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<const N: usize> Sub for LengthArray<N>

type Output = LengthArray<N>

The resulting type after applying the - operator.

fn sub(self, rhs: LengthArray<N>) -> Self

Performs the - operation.

impl<const N: usize> SubAssign for LengthArray<N>

fn sub_assign(&mut self, rhs: LengthArray<N>)

Performs the -= operation.

impl<const N: usize> Copy for LengthArray<N>

impl<const N: usize> StructuralPartialEq for LengthArray<N>