Skip to main content

SeriesMapping

Enum SeriesMapping 

Source
pub enum SeriesMapping {
    Aligned {
        first: i64,
    },
    Mapped {
        first: i64,
        offsets: Vec<u32>,
    },
}
Expand description

How the points of one series map to logical indices of the TimeIndex.

§Examples

use ferrochart_core::data::{SeriesMapping, TimeIndex};

let index = TimeIndex::from_times(vec![10, 20, 30, 40])?;

// A contiguous run of the index (e.g. an indicator computed from the main series).
let aligned = index.map_series(&[20, 30, 40])?;
assert_eq!(aligned, Some(SeriesMapping::Aligned { first: 1 }));

// A sparse subset needs a lookup table.
let mapped = index.map_series(&[10, 40])?.unwrap();
assert!(!mapped.is_aligned());
assert_eq!(mapped.logical_index(1), Some(3));

// Not a subset: the caller has to merge.
assert_eq!(index.map_series(&[15])?, None);

Variants§

§

Aligned

Fast path: point i of the series is at logical index first + i. No per-point memory.

Fields

§first: i64

Logical index of the series’ first point.

§

Mapped

General path: point i is at logical index first + offsets[i]. offsets is strictly increasing and starts at 0. 4 bytes per point.

Fields

§first: i64

Logical index of the series’ first point.

§offsets: Vec<u32>

Offset of each point from first.

Implementations§

Source§

impl SeriesMapping

Source

pub fn is_aligned(&self) -> bool

Whether this is the Aligned fast path.

§Examples
use ferrochart_core::data::SeriesMapping;

assert!(SeriesMapping::Aligned { first: 0 }.is_aligned());
Source

pub fn logical_index(&self, i: usize) -> Option<i64>

Logical index of point i of the series. For Mapped, None if i is out of range; for Aligned, None only if the index overflows i64.

§Examples
use ferrochart_core::data::SeriesMapping;

let m = SeriesMapping::Mapped { first: -5, offsets: vec![0, 2, 7] };
assert_eq!(m.logical_index(1), Some(-3));
assert_eq!(m.logical_index(3), None);

Trait Implementations§

Source§

impl Clone for SeriesMapping

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SeriesMapping

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for SeriesMapping

Source§

impl PartialEq for SeriesMapping

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SeriesMapping

Auto Trait Implementations§

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> 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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.