Trait plotters::coord::ranged1d::DiscreteRanged

pub trait DiscreteRanged where
    Self: Ranged, {
    fn size(&self) -> usize;
    fn index_of(&self, value: &Self::ValueType) -> Option<usize>;
    fn from_index(&self, index: usize) -> Option<Self::ValueType>;

    fn values(&self) -> DiscreteValueIter<'_, Self>
    where
        Self: Sized,
    { ... }
    fn previous(&self, value: &Self::ValueType) -> Option<Self::ValueType> { ... }
    fn next(&self, value: &Self::ValueType) -> Option<Self::ValueType> { ... }
}

The trait indicates the coordinate is discrete This means we can bidirectionally map the range value to 0 to N in which N is the number of distinct values of the range.

This is useful since for a histgoram, this is an abstraction of bucket.

Required methods

fn size(&self) -> usize

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

• returns The number of values in the range

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

Map a value to the index

Note: This function doesn’t guareentee return None when the value is out of range. The only way to confirm the value is in the range is to examing the return value isn’t larger than self.size.

• value: The value to map
• returns The index of the value

fn from_index(&self, index: usize) -> Option<Self::ValueType>

Reverse map the index to the value

Note: This function doesn’t guareentee returning None when the index is out of range.

• value: The index to map
• returns The value

Provided methods

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

Return a iterator that iterates over the all possible values

• returns The value iterator

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

Returns the previous value in this range

Normally, it’s based on the from_index and index_of function. But for some of the coord spec, it’s possible that we value faster implementation. If this is the case, we can impelemnet the type specific impl for the previous and next.

• value: The current value
• returns: The value piror to current value

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

Returns the next value in this range

Normally, it’s based on the from_index and index_of function. But for some of the coord spec, it’s possible that we value faster implementation. If this is the case, we can impelemnet the type specific impl for the previous and next.

• value: The current value
• returns: The value next to current value

Implementors

impl DiscreteRanged for RangedCoordi32

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl DiscreteRanged for RangedCoordi64

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl DiscreteRanged for RangedCoordi128

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl DiscreteRanged for RangedCoordu32

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl DiscreteRanged for RangedCoordu64

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl DiscreteRanged for RangedCoordu128

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl DiscreteRanged for RangedCoordusize

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl<'a, T: PartialEq> DiscreteRanged for RangedSlice<'a, T>

fn size(&self) -> usize

fn index_of(&self, value: &&'a T) -> Option<usize>

fn from_index(&self, index: usize) -> Option<&'a T>

impl<D> DiscreteRanged for RangedDate<D> where
    D: Datelike + TimeValue + Sub<D, Output = Duration> + Add<Duration, Output = D> + Clone, 

fn size(&self) -> usize

fn index_of(&self, value: &D) -> Option<usize>

fn from_index(&self, index: usize) -> Option<D>

impl<D: DiscreteRanged> DiscreteRanged for SegmentedCoord<D>

fn size(&self) -> usize

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

fn from_index(&self, idx: usize) -> Option<Self::ValueType>

impl<P: DiscreteRanged, S: DiscreteRanged> DiscreteRanged for NestedRange<P, S>

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl<R: DiscreteRanged> DiscreteRanged for WithKeyPointMethod<R>

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl<R: DiscreteRanged> DiscreteRanged for WithKeyPoints<R> where
    R::ValueType: Clone, 

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl<T: DiscreteRanged> DiscreteRanged for GroupBy<T>

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<Self::ValueType>

impl<T: Ranged, S: Clone, R: LinspaceRoundingMethod<T::ValueType>> DiscreteRanged for Linspace<T, S, R> where
    T::ValueType: Add<S, Output = T::ValueType> + PartialOrd + Clone, 

fn size(&self) -> usize

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

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

impl<T: TimeValue + Clone> DiscreteRanged for Monthly<T> where
    Range<T>: AsRangedCoord<Value = T>, 

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<T>

impl<T: TimeValue + Clone> DiscreteRanged for Yearly<T> where
    Range<T>: AsRangedCoord<Value = T>, 

fn size(&self) -> usize

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

fn from_index(&self, index: usize) -> Option<T>