Expand description
Library-owned causal data views and storage.
Arrow adapters are optional (arrow feature) and never leak Arrow types
into the public causal API (ADR 0004).
§Building tabular data
use antecedent_data::{TableView, TabularData};
let data = TabularData::from_f64_columns([
("x", &[1.0_f64, 2.0, 3.0][..]),
]).unwrap();
assert_eq!(data.row_count(), 3);SPDX-License-Identifier: MIT OR Apache-2.0
Re-exports§
pub use aligned_buffer::AlignedBuffer;pub use arrow_adapter::ArrowLoadResult;pub use arrow_adapter::tabular_from_arrow_c_columns;pub use arrow_adapter::tabular_from_record_batch;pub use arrow_ffi::ArrowCColumn;pub use buffer::F64Buffer;pub use buffer::ForeignBufferOwner;pub use buffer::ForeignF64Buffer;pub use categorical::CategoricalColumn;pub use categorical::CategoricalView;pub use categorical::CategoryCode;pub use categorical::CategoryDomain;pub use categorical::CategoryLevel;pub use categorical::Contrast;pub use categorical::ContrastMatrix;pub use categorical::UnknownCategoryPolicy;pub use categorical::compile_contrast_matrix;pub use column::BooleanColumn;pub use column::ColumnView;pub use column::FixedVectorColumn;pub use column::Float64Column;pub use column::Int64Column;pub use column::OwnedColumn;pub use column::TimestampColumn;pub use column::ValidityBitmap;pub use dataset::TabularData;pub use dataset::TimeSeriesData;pub use error::DataError;pub use event::EventData;pub use lagged_frame::LaggedFrame;pub use lagged_frame::LaggedFrameOptions;pub use materialize::MaterializationReason;pub use materialize::materialization_diagnostic;pub use multi_env::MultiEnvironmentData;pub use multi_env_plan::MultiEnvSamplePlan;pub use multi_env_plan::PanelSamplePlan;pub use multi_env_plan::plans_for_series_lengths;pub use panel::PanelData;pub use panel::PanelUnit;pub use panel::PanelUnitView;pub use pooled_frame::DEFAULT_MAX_TIME_ONE_HOT_LEVELS;pub use pooled_frame::DummyOptions;pub use pooled_frame::PooledLaggedFrame;pub use pooled_frame::TimeDummyEncoding;pub use pooled_frame::pool_multi_env_lagged_frame;pub use project::IdRemap;pub use project::dedupe_variable_ids;pub use reference::ReferencePointPolicy;pub use resample::PermutationScheme;pub use resample::ResamplingPlan;pub use resample::fill_resample_index_batch;pub use resample::fill_resample_indexes;pub use resample::fill_resample_indexes_grouped;pub use resample::fill_resample_weight_batch;pub use resample::fill_resample_weights;pub use resample::resample_timeseries;pub use resample::resample_timeseries_grouped;pub use sample::DropSummary;pub use sample::LagMap;pub use sample::LaggedColumn;pub use sample::LaggedPreparedSample;pub use sample::LaggedSamplePlan;pub use sample::LaggedSampleWorkspace;pub use sample_policy::MaskPolicy;pub use sample_policy::MissingPolicy;pub use sample_policy::WeightPolicy;pub use sample_request::MatrixRef;pub use sample_request::PreparedColumn;pub use sample_request::PreparedRowSelector;pub use sample_request::PreparedSample;pub use sample_request::RowSelectionRef;pub use sample_request::SampleCacheKey;pub use sample_request::SampleLayout;pub use sample_request::SamplePartitions;pub use sample_request::SamplePlan;pub use sample_request::SampleRequest;pub use sample_request::SampleWorkspace;pub use sim::KnownLaggedParent;pub use sim::LaggedLinearPair;pub use split::BlockedTemporalSplit;pub use split::ClusterSplit;pub use split::DiscoveryEstimationSplit;pub use split::EnvHoldoutSplit;pub use split::GroupedSplit;pub use split::RandomIidSplit;pub use split::RegimeHoldoutSplit;pub use split::RollingOriginSplit;pub use split::RowSplit;pub use split::TemporalFold;pub use split::TemporalRandomPolicy;pub use split::TimeRange;pub use split::ensure_random_allowed_on_temporal;pub use storage::OwnedColumnarStorage;pub use surrogate::surrogate_permute_columns;pub use surrogate::surrogate_phase_randomize;pub use table::TableView;pub use temporal::SamplingRegularity;pub use temporal::TimeIndex;pub use transforms::equal_width_bin;pub use transforms::moving_average;pub use transforms::ordinal_patterns;pub use vector_vars::VectorVariableGroups;pub use vector_vars::column_blocks_for_frame;pub use vector_vars::expand_fixed_vector_columns;
Modules§
- aligned_
buffer - Growable aligned f64 scratch buffers.
- arrow_
adapter - Arrow-backed adapters. Arrow types stay inside this module (ADR 0004).
- arrow_
ffi - Isolated Arrow C Data Interface FFI.
- buffer
- Contiguous f64 column buffers — owned or foreign-backed.
- categorical
- Dictionary categoricals and explicit contrasts (ADR 0003).
- column
- Columnar storage and typed column views.
- dataset
- Concrete tabular and time-series dataset types.
- error
- Data-layer errors.
- event
- Irregular event-indexed datasets.
- lagged_
frame - Pre-materialized lagged columns for temporal discovery.
- materialize
- Explicit materialization / copy diagnostics.
- multi_
env - Multi-environment / multi-dataset container.
- multi_
env_ plan - Multi-environment / panel sample planning without per-env full series clones.
- panel
- Panel data: unit partitions with per-unit time indexes.
- pooled_
frame - Pooled multi-environment lagged frames with space/time dummies (J-PCMCI+).
- project
- Column projection: narrow a table to the variables needed after identification.
- reference
- Reference-point policies for temporal sample alignment.
- resample
- Temporal bootstrap / resampling index plans.
- sample
- Lag-aligned sample planning for temporal discovery.
- sample_
policy - Sample construction policies.
- sample_
request - General sample request → plan → prepare path.
- selection
- Row selection and column transform helpers shared by estimators / refuters.
- sim
- Structural process generators for conformance / toys .
- split
- Split strategies for discovery / estimation.
- storage
- Owned tabular storage implementing
TableView. - surrogate
- Surrogate null transforms for discovery false-positive checks.
- table
TableViewtrait — public causal table API (ADR 0004).- temporal
- Temporal sampling metadata (series length / regularity).
- transforms
- Column transforms for discovery / symbolic CI .
- vector_
vars - pinned baseline-style vector variable groups.
Structs§
- FfiArrow
Array - Re-export FFI types for the Python / foreign boundary only. ABI-compatible struct for ArrowArray from C Data Interface See https://arrow.apache.org/docs/format/CDataInterface.html#structure-definitions
- FfiArrow
Schema - ABI-compatible struct for
ArrowSchemafrom C Data Interface See https://arrow.apache.org/docs/format/CDataInterface.html#structure-definitions - Temporal
Indexer - Finite unfolding indexer: time-major dense layout.
- Temporal
Node Key - Stable unfolded temporal node identity (serializable).