Struct UniformNestedRange

pub struct UniformNestedRange<Primary: DiscreteRanged, Secondary: Ranged> { /* private fields */ }

Like plotters::coord::combinators::NestedRange, except the nested coordinate system is the same for every item in the outer coordinate system.

That is, each value in the discrete ranged coordinate system has an associated secondary coordinate system. The value type is UniformNestedValue - most of the time, you just want UniformNestedValue::Value - and a From implementation for tuples is provided as such.

Because of this uniformity, this can be used very efficiently, even recursively, and even with large Primary coordinate systems - including both as a primary coordinate system itself, or as a secondary coordinate system. This is because it lacks the need to scan all the potentially-variadic coordinate systems when doing discrete value indexing.

Important to note here - The coordinate ranges produced by coordinate systems are typically [inclusive, exclusive) style - they include the lower value and exclude the upper value. This remains true for this coordinate system. However, when working with both UniformNestedRange and plotters::coord::combinators::NestedRange, typically the final value of the primary coordinate system is actually included, and it’s only the last value of the secondary coordinate systems that is excluded. This means that it may extend one-further within the primary coordinate system than is expected.

Trait Implementations

impl<Primary: DiscreteRanged, Secondary: DiscreteRanged> DiscreteRanged for UniformNestedRange<Primary, Secondary>

Efficient implementation of uniformly-nested DiscreteRanged. Even in uses which require very large amounts of indexing operations, this should be significantly more efficient than plotters::coord::combinators::NestedRange, because of the lack of a need to traverse linearly through dynamic secondary coordinate systems.

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: &Self::ValueType) -> Option<usize>

Map a value to the index

fn from_index(&self, index: usize) -> Option<Self::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<P: DiscreteRanged, S: Ranged> Ranged for UniformNestedRange<P, S>

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 = UniformNestedValue<<P as Ranged>::ValueType, <S as Ranged>::ValueType>

The type of this value in this range specification

fn map(&self, value: &Self::ValueType, limit: (i32, i32)) -> i32

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

fn key_points<Hint: KeyPointHint>(&self, hint: Hint) -> Vec<Self::ValueType>

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

fn range(&self) -> Range<Self::ValueType>

Get the range of this value

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

This function provides the on-axis part of its range

impl<PCoordType, SCoordType, P, S> ValueFormatter<NestedValue<PCoordType, SCoordType>> for UniformNestedRange<P, S>

where P: Ranged<ValueType = PCoordType> + DiscreteRanged + ValueFormatter<PCoordType>, S: Ranged<ValueType = SCoordType> + ValueFormatter<SCoordType>,

fn format(value: &NestedValue<PCoordType, SCoordType>) -> String

Format the value

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

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