Struct audio_processor_testing_helpers::charts::Linspace

pub struct Linspace<T, S, R>
where
    T: Ranged,
    S: Clone,
    R: LinspaceRoundingMethod<<T as Ranged>::ValueType>,
    <T as Ranged>::ValueType: Add<S, Output = <T as Ranged>::ValueType> + PartialOrd + Clone,
{ /* private fields */ }

The coordinate combinator that transform a continous coordinate to a discrete coordinate to a discrete coordinate by a giving step.

For example, range 0f32..100f32 is a continuous coordinate, thus this prevent us having a histogram on it since Plotters doesn’t know how to segment the range into buckets. In this case, to get a histogram, we need to split the original range to a set of discrete buckets (for example, 0.5 per bucket).

The linspace decorate abstracting this method. For example, we can have a discrete coordinate: (0f32..100f32).step(0.5).

Linspace also supports different types of bucket matching method - This configuration alters the behavior of DiscreteCoord::index_of for Linspace coord spec

• Flooring, the value falls into the nearst bucket smaller than it. See Linspace::use_floor
• Round, the value falls into the nearst bucket. See Linearspace::use_round
• Ceiling, the value falls into the nearst bucket larger than itself. See Linspace::use_ceil
• Exact Matchting, the value must be exactly same as the butcket value. See Linspace::use_exact

Implementations

impl<T, S, R> Linspace<T, S, R>

where T: Ranged, S: Clone, R: LinspaceRoundingMethod<<T as Ranged>::ValueType>, <T as Ranged>::ValueType: Add<S, Output = <T as Ranged>::ValueType> + PartialOrd + Clone,

pub fn use_ceil(self) -> Linspace<T, S, Ceil<<T as Ranged>::ValueType>>

Set the linspace use the round up method for value matching

• returns: The newly created linspace that uses new matching method

pub fn use_floor(self) -> Linspace<T, S, Floor<<T as Ranged>::ValueType>>

Set the linspace use the round down method for value matching

• returns: The newly created linspace that uses new matching method

pub fn use_round(self) -> Linspace<T, S, Round<<T as Ranged>::ValueType, S>>

where <T as Ranged>::ValueType: Sub<Output = S>, S: PartialOrd,

Set the linspace use the best match method for value matching

• returns: The newly created linspace that uses new matching method

pub fn use_exact(self) -> Linspace<T, S, Exact<<T as Ranged>::ValueType>>

where <T as Ranged>::ValueType: Sub<Output = S>, S: PartialOrd,

Set the linspace use the exact match method for value matching

• returns: The newly created linspace that uses new matching method

Trait Implementations

impl<T, S, R> Clone for Linspace<T, S, R>

where T: Clone + Ranged, S: Clone, R: Clone + LinspaceRoundingMethod<<T as Ranged>::ValueType>, <T as Ranged>::ValueType: Add<S, Output = <T as Ranged>::ValueType> + PartialOrd + Clone,

fn clone(&self) -> Linspace<T, S, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, S, R> DiscreteRanged for Linspace<T, S, R>

where T: Ranged, S: Clone, R: LinspaceRoundingMethod<<T as Ranged>::ValueType>, <T as Ranged>::ValueType: Add<S, Output = <T as Ranged>::ValueType> + PartialOrd + Clone,

fn size(&self) -> usize

Get the number of element in the range Note: we assume that all the ranged discrete coordinate has finite value

fn index_of(&self, value: &<T as Ranged>::ValueType) -> Option<usize>

Map a value to the index

fn from_index(&self, idx: usize) -> Option<<T as Ranged>::ValueType>

Reverse map the index to the value

fn values(&self) -> DiscreteValueIter<'_, Self>

where Self: Sized,

Return a iterator that iterates over the all possible values

fn previous(&self, value: &Self::ValueType) -> Option<Self::ValueType>

Returns the previous value in this range

fn next(&self, value: &Self::ValueType) -> Option<Self::ValueType>

Returns the next value in this range

impl<T, S, R> Ranged for Linspace<T, S, R>

where T: Ranged, S: Clone, R: LinspaceRoundingMethod<<T as Ranged>::ValueType>, <T as Ranged>::ValueType: Add<S, Output = <T as Ranged>::ValueType> + PartialOrd + Clone,

type FormatOption = NoDefaultFormatting

This marker decides if Plotters default ValueFormatter implementation should be used. This associated type can be one of the following two types:

type ValueType = <T as Ranged>::ValueType

The type of this value in this range specification

fn range(&self) -> Range<<T as Ranged>::ValueType>

Get the range of this value

fn map(&self, value: &<T as Ranged>::ValueType, limit: (i32, i32)) -> i32

This function maps the value to i32, which is the drawing coordinate

fn key_points<Hint>(&self, hint: Hint) -> Vec<<T as Ranged>::ValueType>

where Hint: KeyPointHint,

This function gives the key points that we can draw a grid based on this

fn axis_pixel_range(&self, limit: (i32, i32)) -> Range<i32>

This function provides the on-axis part of its range

impl<T, R, S, RM> ValueFormatter<T> for Linspace<R, S, RM>

where R: Ranged<ValueType = T> + ValueFormatter<T>, RM: LinspaceRoundingMethod<T>, T: Add<S, Output = T> + PartialOrd + Clone, S: Clone,

fn format(value: &T) -> String

Format the value

fn format_ext(&self, value: &V) -> String

Determine how we can format a value in a coordinate system by default