Skip to main content

fastcit_core/
lib.rs

1//! Core conditional-independence tests for causal discovery.
2//!
3//! Provides statistical tests for whether two variables X and Y are independent
4//! given a conditioning set Z (X ⊥ Y | Z). Data is held in a [`dataset::Dataset`]
5//! built once from named, typed columns; tests refer to variables by column
6//! index and return a numeric [`strategy::CIResult`].
7//!
8//! # Tests
9//!
10//! | Test | Data type | Module |
11//! |------|-----------|--------|
12//! | Chi-squared (λ = 1) | Discrete | [`ci_tests::ChiSquared`] |
13//! | Log-likelihood / G-test (λ = 0) | Discrete | [`ci_tests::LogLikelihood`] |
14//! | Cressie-Read (λ = 2/3) | Discrete | [`ci_tests::CressieRead`] |
15//! | Freeman-Tukey (λ = −1/2) | Discrete | [`ci_tests::FreemanTukey`] |
16//! | Modified log-likelihood (λ = −1) | Discrete | [`ci_tests::ModifiedLikelihood`] |
17//! | Pearson correlation | Continuous | [`ci_tests::PearsonCorrelation`] |
18//! | Fisher-z | Continuous | [`ci_tests::FisherZ`] |
19//! | Pearson equivalence (TOST) | Continuous | [`ci_tests::PearsonEquivalence`] |
20//! | HSIC | Continuous | [`ci_tests::Hsic`] |
21//! | KCI | Continuous | [`ci_tests::Kci`] |
22//! | GCM (linear residuals) | Continuous | [`ci_tests::Gcm`] |
23//! | Pillai's trace (linear residuals) | Discrete, continuous, mixed | [`ci_tests::Pillai`] |
24//!
25//! [`registry`] enumerates all twelve and constructs a default-configured one by
26//! name.
27//!
28//! # Usage
29//!
30//! ```rust
31//! use fastcit_core::ci_tests::ChiSquared;
32//! use fastcit_core::dataset::{ColumnKind, Dataset};
33//! use fastcit_core::strategy::CITest;
34//!
35//! let data = Dataset::from_columns(vec![
36//!     ("x".into(), ColumnKind::Discrete, vec![1., 1., 2., 2.]),
37//!     ("y".into(), ColumnKind::Discrete, vec![1., 2., 1., 2.]),
38//! ])
39//! .unwrap();
40//!
41//! let x = data.index_of("x").unwrap();
42//! let y = data.index_of("y").unwrap();
43//! let result = ChiSquared::new().test(&data, x, y, &[]).unwrap();
44//! assert!(result.p_value > 0.0);
45//! ```
46
47pub mod ci_tests;
48mod correlation;
49pub mod dataset;
50pub mod discrete;
51pub mod error;
52pub(crate) mod gram;
53pub mod kernel;
54pub mod registry;
55mod residual;
56mod rng;
57mod strata;
58pub mod strategy;
59
60// Compiles the extension template, so it stays correct. Test builds only: it adds no public API
61// and the registry does not list it.
62#[cfg(test)]
63#[path = "../../../devtools/extension_templates/_ci_test.rs"]
64mod extension_template;
65
66pub use dataset::{ColumnKind, Dataset};
67pub use error::CIError;
68pub use registry::{all_metas, make_default};
69pub use strategy::{validate_query, CIResult, CITest, DataType, IndependenceRule, TestMeta};