Enhance documentation with usage examples for statistical routines and utilities

This commit is contained in:
Palash Tyagi
2025-08-03 16:48:02 +01:00
parent d1dd7ea6d2
commit e6964795e3
6 changed files with 75 additions and 0 deletions

View File

@@ -1,3 +1,16 @@
//! Probability distribution functions applied element-wise to matrices.
//!
//! Includes approximations for the normal, uniform and gamma distributions as
//! well as the error function.
//!
//! ```
//! use rustframe::compute::stats::distributions;
//! use rustframe::matrix::Matrix;
//!
//! let x = Matrix::from_vec(vec![0.0], 1, 1);
//! let pdf = distributions::normal_pdf(x.clone(), 0.0, 1.0);
//! assert!((pdf.get(0,0) - 0.3989).abs() < 1e-3);
//! ```
use crate::matrix::{Matrix, SeriesOps};
use std::f64::consts::PI;