Skip to main content

LaggedSamplePlan

Struct LaggedSamplePlan 

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

Reusable plan for gathering a fixed set of lagged columns.

Implementations§

Source§

impl LaggedSamplePlan

Source

pub fn new( series_len: usize, max_lag: u32, columns: impl Into<Arc<[LaggedColumn]>>, ) -> Result<Self, DataError>

Plan lagged columns for a series length / max lag (series-origin reference).

§Errors

Invalid lag map, empty column list, or a column lag exceeding max_lag.

Source

pub fn with_reference( series_len: usize, max_lag: u32, reference: ReferencePointPolicy, columns: impl Into<Arc<[LaggedColumn]>>, ) -> Result<Self, DataError>

Plan lagged columns under an explicit reference-point policy.

§Errors

Invalid lag map, empty column list, or a column lag exceeding max_lag.

Source

pub fn with_shared( lag_map: Arc<LagMap>, columns: Arc<[LaggedColumn]>, ) -> Result<Self, DataError>

Build a plan that reuses a shared lag map and column list (multi-env / panel).

§Errors

Empty column list, or a column lag exceeding the shared map’s max_lag.

Source

pub fn columns(&self) -> &[LaggedColumn]

Planned columns.

Source

pub fn columns_arc(&self) -> &Arc<[LaggedColumn]>

Shared column Arc (for multi-env plan reuse).

Source

pub fn lag_map(&self) -> &LagMap

Lag map.

Source

pub fn lag_map_arc(&self) -> &Arc<LagMap>

Shared lag-map Arc (identical lengths can share one map).

Source

pub fn n_effective(&self) -> usize

Effective sample size.

Source

pub fn prepare<'a>( &'a self, data: &TimeSeriesData, workspace: &'a mut LaggedSampleWorkspace, policy: &KernelPolicy, ) -> Result<LaggedPreparedSample<'a>, DataError>

Gather planned columns into workspace (grows once, then reuses capacity).

§Errors

Missing / non-float64 columns, series length mismatch, or incomplete series (missing values or a row-hiding analysis mask).

Trait Implementations§

Source§

impl Clone for LaggedSamplePlan

Source§

fn clone(&self) -> LaggedSamplePlan

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 LaggedSamplePlan

Source§

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

Formats the value using the given formatter. Read more

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<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.