Struct XAxis 

pub struct XAxis(/* private fields */);

The x axis of RealData and ComplexData: time steps, frequency bins, or any other strictly increasing positions.

A uniform axis stores only start, step and the length, and computes values on demand. An explicit axis stores every value. Both kinds are strictly increasing, which the constructors check.

Implementations

impl XAxis

pub fn uniform(start: f64, step: f64, len: usize) -> Result<Self, DataError>

A uniform axis x[i] = start + i * step with len points.

start must be finite and step must be finite and positive.

pub fn explicit(values: Array1<f64>) -> Result<Self, DataError>

An axis with the given values, which must be strictly increasing.

pub fn indices(len: usize) -> Self

The axis 0, 1, 2, …, len - 1.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn as_uniform(&self) -> Option<(f64, f64)>

Some((start, step)) if the axis is uniform.

pub fn get(&self, index: usize) -> f64

The value at index.

Panics

Panics if index >= self.len().

pub fn iter(&self) -> impl ExactSizeIterator<Item = f64> + '_

pub fn to_cow_array(&self) -> CowArray<'_, f64, Ix1>

The values as an array. Borrowed for an explicit axis, computed for a uniform one.

pub fn to_array(&self) -> Array1<f64>

The values as an owned array.

pub fn nearest_index(&self, x: f64) -> usize

Index of the value closest to x. On a tie the lower index wins. Returns 0 for an empty axis or a NaN x.

Trait Implementations

impl AbsDiffEq for XAxis

type Epsilon = f64

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Clone for XAxis

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XAxis

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for XAxis

Available on crate feature serde only.

Deserialized values go through the same checks as the constructors, so an edited or corrupted file cannot produce an unordered axis.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for XAxis

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for XAxis

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

where __S: Serializer,

Serialize this value into the given Serde serializer.