plskit 0.1.0

PLS regression with modern inference. Rust implementation; the same engine drives the Python, R, and Julia wrappers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! plskit — PLS regression with modern inference.
//!
//! Single Rust crate; the same engine is consumed by the Python, R, and Julia
//! wrappers (which call into this crate through their respective FFI layers).

#![deny(missing_docs)]
#![deny(clippy::all)]
#![warn(clippy::pedantic)]
#![forbid(unsafe_code)]
#![allow(clippy::cast_precision_loss)] // sample-size usize → f64 casts are routine in math kernels

/// Error types for plskit.
pub mod error;
/// K selection (CV / BIC / sequence).
pub mod find_k;
/// PLS1 model fitting (NIPALS loop).
pub mod fit;
/// Low-level linear algebra helpers (standardize, row-subset, etc.).
pub mod linalg;
/// Permutation-null engine for signed per-voxel z statistics.
/// Powers the TFCE / cluster-mass / max-stat downstream pipeline.
pub mod perm_null;
/// PLS1 prediction from a fitted model.
pub mod predict;
/// Public preprocess helper: validates/normalizes weights and standardizes (X, y).
pub mod preprocess;
/// Resampling utilities (permutation indices, split-half indices).
pub mod resample;
/// Seeded RNG construction.
pub mod rng;
/// Simple-structure rotation of PLS weights (varimax in v0.1.1).
pub mod rotate;
/// Rotation-stability diagnostic for PLS1.
pub mod rotation_stability;
/// Sequential component tests (step-down inference). Crate-internal helper
/// used by `pls1_find_k_sequence` and the diagnostic path of `pls1_find_k_optimal`.
pub(crate) mod sequential;
/// Confirmatory PLS1 omnibus test at fixed K.
pub mod signal_test;
/// Subsampling engine (Politis–Romano). Public for the engines that drive
/// the `CI` path of `pls1_confirmatory_test` and `pls1_rotation_stability`,
/// but the engine entry points themselves are not on the public surface.
pub(crate) mod subsample;

pub use error::{PlsKitError, PlsKitResult};
pub use find_k::{
    pls1_find_k_optimal, pls1_find_k_sequence, FindKOptimalOpts, FindKOptimalOutput,
    FindKSequenceOpts, FindKSequenceOutput, Selector,
};
pub use fit::{pls1_fit, FitOpts, KSpec, Pls1Model};
pub use perm_null::{pls1_perm_null, PermNullOpts, PermNullOutput};
pub use predict::pls1_predict;
pub use preprocess::{preprocess, PreprocessInput, PreprocessResult};
pub use rotate::{rotate, RotateOutput, RotationMethod, VarimaxArgs};
pub use rotation_stability::{
    pls1_rotation_stability, RotationStabilityMethod, RotationStabilityOpts,
    RotationStabilityOutput,
};
pub use signal_test::{
    pls1_confirmatory_test, CIOpts, ConfirmatoryArgs, ConfirmatoryMethod, ConfirmatoryTestInput,
    ConfirmatoryTestOpts, ConfirmatoryTestOutput,
};
pub use subsample::{CIScalar, ConfirmatoryCI};

/// Returns the `CARGO_PKG_VERSION` string (e.g. `"0.0.1"`).
#[must_use]
pub fn version() -> &'static str {
    env!("CARGO_PKG_VERSION")
}