Struct plotters::coord::ranged1d::SegmentedCoord

source ·
pub struct SegmentedCoord<D: DiscreteRanged>(/* private fields */);
Expand description

A SegmentedCoord is a decorator on any discrete coordinate specification. This decorator will convert the discrete coordinate in two ways:

  • Add an extra dummy element after all the values in original discrete coordinate
  • Logically each value v from original coordinate system is mapped into an segment [v, v+1) where v+1 denotes the successor of the v
  • Introduce two types of values SegmentValue::Exact(value) which denotes the left end of value’s segment and SegmentValue::CenterOf(value) which refers the center of the segment. This is used in histogram types, which uses a discrete coordinate as the buckets. The segmented coord always emits CenterOf(value) key points, thus it allows all the label and tick marks of the coordinate rendered in the middle of each segment. The corresponding trait IntoSegmentedCoord is used to apply this decorator to coordinates.

Trait Implementations§

source§

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

source§

fn clone(&self) -> SegmentedCoord<D>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

fn size(&self) -> usize

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

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

Map a value to the index Read more
source§

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

Reverse map the index to the value Read more
source§

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

Return a iterator that iterates over the all possible values Read more
source§

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

Returns the previous value in this range Read more
source§

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

Returns the next value in this range Read more
source§

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

source§

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: Read more
source§

type ValueType = SegmentValue<<D as Ranged>::ValueType>

The type of this value in this range specification
source§

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

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

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

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

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

Get the range of this value
source§

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

This function provides the on-axis part of its range
source§

impl<T, D> ValueFormatter<SegmentValue<T>> for SegmentedCoord<D>
where D: ValueFormatter<T> + DiscreteRanged + Ranged<ValueType = T>,

source§

fn format(value: &SegmentValue<T>) -> String

Format the value
source§

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

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

Auto Trait Implementations§

§

impl<D> Freeze for SegmentedCoord<D>
where D: Freeze,

§

impl<D> RefUnwindSafe for SegmentedCoord<D>
where D: RefUnwindSafe,

§

impl<D> Send for SegmentedCoord<D>
where D: Send,

§

impl<D> Sync for SegmentedCoord<D>
where D: Sync,

§

impl<D> Unpin for SegmentedCoord<D>
where D: Unpin,

§

impl<D> UnwindSafe for SegmentedCoord<D>
where D: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AsRangedCoord for T
where T: Ranged,

source§

type CoordDescType = T

Type to describe a coordinate system
source§

type Value = <T as Ranged>::ValueType

Type for values in the given coordinate system
source§

impl<T> BindKeyPointMethod for T
where T: AsRangedCoord,

source§

fn with_key_point_func<F: Fn(usize) -> Vec<Self::Value> + 'static>( self, func: F, ) -> WithKeyPointMethod<Self::CoordDescType>

Bind a existing coordinate spec with a given key points algorithm. See WithKeyPointMethod for more details. Example: Read more
source§

impl<T> BindKeyPoints for T
where T: AsRangedCoord,

source§

fn with_key_points( self, points: Vec<Self::Value>, ) -> WithKeyPoints<Self::CoordDescType>

Bind a existing coordinate spec with a given key points vector. See WithKeyPoints for more details. Example: Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoLinspace for T
where T: AsRangedCoord,

source§

fn step<S: Clone>( self, val: S, ) -> Linspace<Self::CoordDescType, S, Exact<Self::Value>>
where Self::Value: Add<S, Output = Self::Value> + PartialOrd + Clone,

Set the step value, make a linspace coordinate from the given range. By default the matching method use the exact match Read more
source§

impl<R> IntoPartialAxis for R
where R: AsRangedCoord,

source§

fn partial_axis( self, axis_range: Range<<Self::CoordDescType as Ranged>::ValueType>, ) -> PartialAxis<Self::CoordDescType>

Make the partial axis Read more
source§

impl<DC> ReversibleRanged for DC
where DC: DiscreteRanged,

source§

fn unmap( &self, input: i32, limit: (i32, i32), ) -> Option<<DC as Ranged>::ValueType>

Perform the reverse mapping
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.