Skip to main content

solow_tsa/
lib.rs

1//! # solow-tsa
2//!
3//! Time-series analysis primitives and models for the Solow statistical stack,
4//! validated against an authoritative reference.
5//!
6//! The crate provides:
7//!
8//! - Sample second-moment estimators: [`acovf`], [`acf`], [`pacf`], [`ccf`].
9//! - The Ljung-Box [`q_stat`] portmanteau statistic.
10//! - Design helpers [`lagmat`] and [`add_trend`].
11//! - The augmented Dickey-Fuller unit-root test [`adfuller`].
12//! - The autoregressive estimator [`AutoReg`].
13//!
14//! ```
15//! use ndarray::Array1;
16//! use solow_tsa::{acf, AutoReg, Trend};
17//!
18//! // A short AR(1)-like series.
19//! let y = Array1::from_vec(vec![
20//!     0.0, 0.4, 0.1, 0.5, 0.2, 0.6, 0.3, 0.7, 0.35, 0.75, 0.4, 0.8,
21//! ]);
22//! let a = acf(&y, 3, false).unwrap();
23//! assert!((a[0] - 1.0).abs() < 1e-12);
24//!
25//! let res = AutoReg::new(y, 1, Trend::C).unwrap().fit().unwrap();
26//! assert_eq!(res.params.len(), 2); // const + 1 lag
27//! ```
28
29mod ar_model;
30mod ar_select;
31mod arma_process;
32mod change_point;
33mod coint;
34mod deterministic;
35mod ewma;
36mod filters;
37mod garch;
38mod granger;
39mod holtwinters;
40mod innovations;
41mod kpss;
42mod order_select;
43mod seasonal;
44mod stattools;
45mod stattools_ext;
46mod stl;
47mod tsatools;
48
49pub use ar_model::{AutoReg, AutoRegResults};
50pub use ar_select::{ar_select_order, ArIc, ArSelectResult};
51pub use arma_process::{arma_acf, arma_acovf, arma_impulse_response, arma_pacf};
52pub use change_point::{binary_segmentation, cusum, pelt, CusumAlarm};
53pub use coint::{coint, CointResult, CointTrend};
54pub use deterministic::DeterministicProcess;
55pub use ewma::{ewma, EwmaAlarm, EwmaResult};
56pub use filters::{bkfilter, cffilter, hpfilter};
57pub use garch::Garch11;
58pub use granger::{grangercausalitytests, GrangerLagResult};
59pub use holtwinters::{ExponentialSmoothing, Holt, Seasonal, SimpleExpSmoothing, SmoothingResult};
60pub use innovations::{innovations_algo, InnovationsResult};
61pub use kpss::{kpss, KpssLags, KpssRegression, KpssResult};
62pub use order_select::{arma_order_select_ic, ArmaOrderSelectResult, InfoCriterion};
63pub use seasonal::{seasonal_decompose, DecomposeResult, SeasonalModel};
64pub use stattools::{
65    acf, acf_qstat, acovf, adfuller, ccf, pacf, q_stat, AdfRegression, AdfResult, AutoLag,
66    PacfMethod,
67};
68pub use stattools_ext::{
69    breakvar_heteroskedasticity_test, range_unit_root_test, zivot_andrews, BreakvarAlternative,
70    RangeUnitRootResult, SubsetLength, ZaRegression, ZivotAndrewsResult,
71};
72pub use stl::{Stl, StlResult};
73pub use tsatools::{add_trend, lagmat, lagmat1d, Original, Trend, Trim};