Struct Steps2D 

pub struct Steps2D<T>(pub (T, T, usize), pub (T, T, usize));

Utility for creating evenly spaced steps between two endpoints in 2 dimensions

Example:

use spdcalc::utils::Steps2D;

let arr : Vec<(f64, f64)> = Steps2D((0., 1., 100), (0., 100., 100)).into_iter().collect();
assert_eq!(arr.len(), 100 * 100);
assert!((arr[0].0 - 0.).abs() < 1e-12);
assert!((arr[99].0 - 1.).abs() < 1e-12);
assert!((arr[0].1 - 0.).abs() < 1e-12);
assert!((arr[99].1 - 0.).abs() < 1e-12);
assert!((arr[9999].0 - 1.).abs() < 1e-12);
assert!((arr[9999].1 - 100.).abs() < 1e-12);

Tuple Fields

0: (T, T, usize)

1: (T, T, usize)

Implementations

impl<T> Steps2D<T>

where T: Div<f64, Output = T> + Sub<T, Output = T> + Mul<f64, Output = T> + Add<T, Output = T> + Copy,

pub fn new(x: (T, T, usize), y: (T, T, usize)) -> Self

Create a new instance

pub fn divisions(&self) -> (usize, usize)

Number of divisions for each axis

pub fn ranges(&self) -> ((T, T), (T, T))

Range of each axis

pub fn len(&self) -> usize

Total number of steps

pub fn is_empty(&self) -> bool

Is it empty?

pub fn is_square(&self) -> bool

Same number of steps for each axis?

pub fn value(&self, index: usize) -> (T, T)

Get the value at the given index

pub fn swapped(self) -> Steps2D<T>

Swap x and y

pub fn division_widths(&self) -> (T, T)

Get the width of the gap between each step.

Example:

use spdcalc::utils::Steps2D;

let steps = Steps2D((0., 4., 3), (0., 8., 3)); // 3 steps: |0| --- |2| --- |4| and |0| --- |4| --- |8|
let dx = 2.;
let dy = 4.;
assert!((steps.division_widths().0 - dx).abs() < 1e-12);
assert!((steps.division_widths().1 - dy).abs() < 1e-12);

Trait Implementations

impl<T: Clone> Clone for Steps2D<T>

fn clone(&self) -> Steps2D<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Steps2D<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Steps2D<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Steps2D<UCUM<f64, <TArr<Z0, TArr<Z0, TArr<Z0, TArr<PInt<UInt<UTerm, B1>>, TArr<Z0, TArr<Z0, TArr<Z0, ATerm>>>>>>> as Add<<TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, ATerm>>>>>>> as Sub<TArr<Z0, TArr<PInt<UInt<UTerm, B1>>, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, ATerm>>>>>>>>>::Output>>::Output>>> for FrequencySpace

fn from(steps: Steps2D<Frequency>) -> Self

Converts to this type from the input type.

impl From<Steps2D<UCUM<f64, <TArr<Z0, TArr<Z0, TArr<Z0, TArr<PInt<UInt<UTerm, B1>>, TArr<Z0, TArr<Z0, TArr<Z0, ATerm>>>>>>> as Add<<TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, ATerm>>>>>>> as Sub<TArr<Z0, TArr<PInt<UInt<UTerm, B1>>, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, ATerm>>>>>>>>>::Output>>::Output>>> for SumDiffFrequencySpace

fn from(steps: Steps2D<Frequency>) -> Self

Converts to this type from the input type.

impl From<Steps2D<UCUM<f64, TArr<PInt<UInt<UTerm, B1>>, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, TArr<Z0, ATerm>>>>>>>>>> for WavelengthSpace

fn from(steps: Steps2D<Wavelength>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Steps2D<T>

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<T> IntoIterator for Steps2D<T>

where T: Div<f64, Output = T> + Sub<T, Output = T> + Mul<f64, Output = T> + Add<T, Output = T> + Copy,

type Item = (T, T)

The type of the elements being iterated over.

type IntoIter = Iterator2D<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoParallelIterator for Steps2D<T>

where T: Send + Sync + Div<f64, Output = T> + Sub<T, Output = T> + Mul<f64, Output = T> + Add<T, Output = T> + Copy,

type Item = (T, T)

The type of item that the parallel iterator will produce.

type Iter = ParIterator2D<T>

The parallel iterator type that will be created.

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator.

impl<T> Serialize for Steps2D<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for Steps2D<T>