solow_multivariate/lib.rs
1//! # solow-multivariate
2//!
3//! Multivariate statistical analysis for the Solow stack. This crate provides
4//! [`Pca`] (principal component analysis), [`Factor`] (principal-axis factor
5//! analysis), [`Manova`] (multivariate analysis of variance with the four
6//! classical test statistics) and [`CanCorr`] (canonical correlation analysis),
7//! all matching the conventions of the reference implementation
8//! (`multivariate.pca`, `.factor`, `.manova`, `.cancorr`).
9//!
10//! ```
11//! use ndarray::array;
12//! use solow_multivariate::Pca;
13//!
14//! let data = array![
15//! [1.0, 2.0, 0.5],
16//! [2.0, 1.0, 1.5],
17//! [3.0, 0.0, 2.5],
18//! [4.0, 1.0, 0.0],
19//! ];
20//! let pca = Pca::new(data).fit().unwrap();
21//! assert_eq!(pca.eigenvals.len(), 3);
22//! // Eigenvalues are sorted in descending order.
23//! assert!(pca.eigenvals[0] >= pca.eigenvals[1]);
24//! ```
25
26mod cancorr;
27mod factor;
28mod manova;
29mod mvstats;
30mod pca;
31mod rotation;
32
33pub use cancorr::{CanCorr, CanCorrTestRow};
34pub use factor::{Factor, FactorResults};
35pub use manova::{Manova, ManovaTest};
36pub use mvstats::{multivariate_stats, MultivariateStats, MvStat};
37pub use pca::{Pca, PcaResults};
38pub use rotation::{rotate_factors, rotate_with, Rotation, RotationMethod};