solow_copula/lib.rs
1//! # solow-copula
2//!
3//! Bivariate copulas for the Solow statistical library.
4//!
5//! Two families are provided:
6//!
7//! * **Archimedean** copulas in closed form: [`ClaytonCopula`],
8//! [`FrankCopula`], and [`GumbelCopula`]. Each exposes `cdf(u, v)`,
9//! `pdf(u, v)`, and the Kendall's-tau mapping `tau()`.
10//! * **Elliptical** copulas: [`GaussianCopula`] (with closed-form `pdf`
11//! via the normal-quantile transform, an analytic `tau`/`spearmans_rho`,
12//! and a `cdf` built on a bivariate-normal CDF) and an optional
13//! [`StudentTCopula`] `pdf`.
14//!
15//! The free functions [`kendalls_tau`] and [`spearmans_rho`] compute the
16//! sample rank correlations for paired data.
17//!
18//! All quantities are cross-validated against the canonical Python
19//! reference (`distributions.copula.api`) in `tests/reference.rs`.
20
21mod archimedean;
22mod bvn;
23mod elliptical;
24mod rank;
25
26pub use archimedean::{ClaytonCopula, FrankCopula, GumbelCopula};
27pub use bvn::bvn_cdf;
28pub use elliptical::{GaussianCopula, StudentTCopula};
29pub use rank::{kendalls_tau, spearmans_rho};