Skip to main content

SamplePlan

Struct SamplePlan 

Source
pub struct SamplePlan {
    pub columns: Vec<PreparedColumn>,
    pub row_selector: PreparedRowSelector,
    pub output_layout: SampleLayout,
    pub cache_key: SampleCacheKey,
    pub partitions: SamplePartitions,
    /* private fields */
}
Expand description

Reusable compiled sample plan.

Fields§

§columns: Vec<PreparedColumn>

Prepared column descriptors in matrix order (X then Y then Z).

§row_selector: PreparedRowSelector

Row selector recipe.

§output_layout: SampleLayout

Output layout.

§cache_key: SampleCacheKey

Cache key.

§partitions: SamplePartitions

Partitions.

Implementations§

Source§

impl SamplePlan

Source

pub fn compile_tabular( data: &TabularData, request: &SampleRequest<'_>, ) -> Result<Self, DataError>

Compile a plan against tabular (IID) data. Lagged nodes are rejected.

§Errors

Empty request, lagged nodes, unknown variables, or empty selection.

Source

pub fn compile_timeseries( data: &TimeSeriesData, request: &SampleRequest<'_>, ) -> Result<Self, DataError>

Compile a plan against a regular time series (supports lagged nodes).

§Errors

Irregular series, empty request, unknown variables, or invalid lags.

Source

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

Planned columns.

Source

pub fn cache_key(&self) -> &SampleCacheKey

Cache key.

Source

pub fn prepare<'a>( &'a self, data: &impl TableView, storage_mask: Option<&ValidityBitmap>, storage_weights: Option<&[f64]>, workspace: &'a mut SampleWorkspace, policy: &KernelPolicy, ) -> Result<PreparedSample<'a>, DataError>

Materialize into workspace.

§Errors

Missing columns, empty selection after policies, or type mismatches.

Source

pub fn prepare_tabular<'a>( &'a self, data: &TabularData, workspace: &'a mut SampleWorkspace, policy: &KernelPolicy, ) -> Result<PreparedSample<'a>, DataError>

Prepare from TabularData.

§Errors

Propagates Self::prepare errors.

Source

pub fn prepare_timeseries<'a>( &'a self, data: &TimeSeriesData, workspace: &'a mut SampleWorkspace, policy: &KernelPolicy, ) -> Result<PreparedSample<'a>, DataError>

Prepare from TimeSeriesData.

§Errors

Propagates Self::prepare errors.

Trait Implementations§

Source§

impl Clone for SamplePlan

Source§

fn clone(&self) -> SamplePlan

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 SamplePlan

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.