Struct TimeArray

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

Array storage for a series of values and TimeUnit.

Implementations

impl<const D: usize> TimeArray<D>

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

Create a new vector of TimeUnit.

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

Retrieve values associated with this [TimeSlice].

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

Retrieve the mutable values associated with this [TimeSlice].

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

Create a new Time with units of TimeUnit::yottasecond.

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

Create a new Time with units of TimeUnit::zettasecond.

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

Create a new Time with units of TimeUnit::exasecond.

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

Create a new Time with units of TimeUnit::petasecond.

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

Create a new Time with units of TimeUnit::terasecond.

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

Create a new Time with units of TimeUnit::gigasecond.

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

Create a new Time with units of TimeUnit::megasecond.

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

Create a new Time with units of TimeUnit::kilosecond.

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

Create a new Time with units of TimeUnit::hectosecond.

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

Create a new Time with units of TimeUnit::decasecond.

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

Create a new Time with units of TimeUnit::second.

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

Create a new Time with units of TimeUnit::decisecond.

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

Create a new Time with units of TimeUnit::centisecond.

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

Create a new Time with units of TimeUnit::millisecond.

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

Create a new Time with units of TimeUnit::microsecond.

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

Create a new Time with units of TimeUnit::nanosecond.

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

Create a new Time with units of TimeUnit::picosecond.

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

Create a new Time with units of TimeUnit::femtosecond.

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

Create a new Time with units of TimeUnit::attosecond.

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

Create a new Time with units of TimeUnit::zeptosecond.

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

Create a new Time with units of TimeUnit::yoctosecond.

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

Create a new Time with units of TimeUnit::second_sidereal.

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

Create a new Time with units of TimeUnit::day.

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

Create a new Time with units of TimeUnit::day_sidereal.

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

Create a new Time with units of TimeUnit::hour.

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

Create a new Time with units of TimeUnit::hour_sidereal.

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

Create a new Time with units of TimeUnit::minute.

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

Create a new Time with units of TimeUnit::shake.

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

Create a new Time with units of TimeUnit::year.

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

Create a new Time with units of TimeUnit::year_sidereal.

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

Create a new Time with units of TimeUnit::year_tropical.

pub fn to_yottasecond(&self) -> Self

Convert to TimeUnit::yottasecond.

pub fn to_zettasecond(&self) -> Self

Convert to TimeUnit::zettasecond.

pub fn to_exasecond(&self) -> Self

Convert to TimeUnit::exasecond.

pub fn to_petasecond(&self) -> Self

Convert to TimeUnit::petasecond.

pub fn to_terasecond(&self) -> Self

Convert to TimeUnit::terasecond.

pub fn to_gigasecond(&self) -> Self

Convert to TimeUnit::gigasecond.

pub fn to_megasecond(&self) -> Self

Convert to TimeUnit::megasecond.

pub fn to_kilosecond(&self) -> Self

Convert to TimeUnit::kilosecond.

pub fn to_hectosecond(&self) -> Self

Convert to TimeUnit::hectosecond.

pub fn to_decasecond(&self) -> Self

Convert to TimeUnit::decasecond.

pub fn to_second(&self) -> Self

Convert to TimeUnit::second.

pub fn to_decisecond(&self) -> Self

Convert to TimeUnit::decisecond.

pub fn to_centisecond(&self) -> Self

Convert to TimeUnit::centisecond.

pub fn to_millisecond(&self) -> Self

Convert to TimeUnit::millisecond.

pub fn to_microsecond(&self) -> Self

Convert to TimeUnit::microsecond.

pub fn to_nanosecond(&self) -> Self

Convert to TimeUnit::nanosecond.

pub fn to_picosecond(&self) -> Self

Convert to TimeUnit::picosecond.

pub fn to_femtosecond(&self) -> Self

Convert to TimeUnit::femtosecond.

pub fn to_attosecond(&self) -> Self

Convert to TimeUnit::attosecond.

pub fn to_zeptosecond(&self) -> Self

Convert to TimeUnit::zeptosecond.

pub fn to_yoctosecond(&self) -> Self

Convert to TimeUnit::yoctosecond.

pub fn to_second_sidereal(&self) -> Self

Convert to TimeUnit::second_sidereal.

pub fn to_day(&self) -> Self

Convert to TimeUnit::day.

pub fn to_day_sidereal(&self) -> Self

Convert to TimeUnit::day_sidereal.

pub fn to_hour(&self) -> Self

Convert to TimeUnit::hour.

pub fn to_hour_sidereal(&self) -> Self

Convert to TimeUnit::hour_sidereal.

pub fn to_minute(&self) -> Self

Convert to TimeUnit::minute.

pub fn to_shake(&self) -> Self

Convert to TimeUnit::shake.

pub fn to_year(&self) -> Self

Convert to TimeUnit::year.

pub fn to_year_sidereal(&self) -> Self

Convert to TimeUnit::year_sidereal.

pub fn to_year_tropical(&self) -> Self

Convert to TimeUnit::year_tropical.

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

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 TimeArray<N>

type Output = TimeArray<N>

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

type Target = [f64; N]

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

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

type Output = TimeArray<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 TimeArray<N>

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl<const N: usize> FixedSliceQuantity<TimeUnit, f64> for TimeArray<N>

fn unit(&self) -> TimeUnit

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: TimeUnit) -> 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: TimeUnit)

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 TimeArray<N>

type Output = TimeArray<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 TimeArray<N>

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

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

fn eq(&self, other: &TimeArray<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 TimeArray<N>

type Output = TimeArray<N>

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

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

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