Skip to main content

LagMap

Struct LagMap 

Source
pub struct LagMap { /* private fields */ }
Expand description

Lag-alignment cache for a regular series of length series_len.

For max_lag = τ_max under ReferencePointPolicy::SeriesOrigin, effective samples are times t = τ_max .. series_len-1 (n = series_len - τ_max). Sample i at lag τ reads raw row base_t + i - τ.

Implementations§

Source§

impl LagMap

Source

pub fn new(series_len: usize, max_lag: u32) -> Result<Self, DataError>

Build a lag map with the default series-origin reference policy.

§Errors

Empty series, or max_lag >= series_len.

Source

pub fn with_reference( series_len: usize, max_lag: u32, reference: ReferencePointPolicy, ) -> Result<Self, DataError>

Build a lag map under an explicit reference-point policy.

§Errors

Empty series, invalid lag, or origin out of range.

Source

pub const fn series_len(&self) -> usize

Series length.

Source

pub const fn max_lag(&self) -> u32

Configured maximum lag.

Source

pub const fn n_effective(&self) -> usize

Number of aligned samples.

Source

pub const fn reference(&self) -> ReferencePointPolicy

Reference-point policy used to build this map.

Source

pub fn row_index(&self, lag: Lag, sample_i: usize) -> usize

Raw row index for sample i at the given lag.

§Panics

Panics if i >= n_effective or lag.raw() > max_lag.

Source

pub fn fill_row_indexes( &self, lag: Lag, out: &mut [usize], ) -> Result<(), DataError>

Fill out with raw row indexes for lag (out.len() must equal n_effective).

§Errors

Length mismatch or lag exceeding max_lag.

Trait Implementations§

Source§

impl Clone for LagMap

Source§

fn clone(&self) -> LagMap

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 LagMap

Source§

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

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

impl Eq for LagMap

Source§

impl PartialEq for LagMap

Source§

fn eq(&self, other: &LagMap) -> 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 LagMap

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> ForeignBufferOwner for T
where T: Send + Sync + Debug + 'static,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.