Skip to main content

solow_core/
lib.rs

1//! # solow-core
2//!
3//! Foundational types shared across the Solow statistical computing stack:
4//! a common [`Error`] type, numeric aliases, and shared data-handling tools.
5
6pub mod error;
7pub mod numeric;
8pub mod tools;
9
10pub use error::{Error, Result};
11pub use numeric::{
12    compensated_dot, compensated_mean, compensated_mean_and_var, kahan_sum, neumaier_sum, KahanSum,
13    NeumaierSum,
14};
15
16use ndarray::{Array1, Array2};
17
18/// A dense column of `f64` observations.
19pub type Vector = Array1<f64>;
20/// A dense `f64` matrix (rows = observations, columns = variables).
21pub type Matrix = Array2<f64>;
22
23/// Commonly used imports.
24pub mod prelude {
25    pub use crate::error::{Error, Result};
26    pub use crate::numeric::{
27        compensated_dot, compensated_mean, compensated_mean_and_var, kahan_sum, neumaier_sum,
28        KahanSum, NeumaierSum,
29    };
30    pub use crate::tools::{
31        add_constant, add_constant_default, ensure_all_finite, ensure_all_finite_2d, HasConstant,
32    };
33    pub use crate::{Matrix, Vector};
34}