From 2b251f557bf235ecd3dfcc2c7dc0d3676b8b5596 Mon Sep 17 00:00:00 2001 From: Axect Date: Wed, 31 Jul 2024 07:52:11 +0900 Subject: [PATCH 1/2] DOC: Write a doc string for special/mod.rs --- src/special/mod.rs | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/src/special/mod.rs b/src/special/mod.rs index bfb944a3..8fa1312a 100644 --- a/src/special/mod.rs +++ b/src/special/mod.rs @@ -1,4 +1,31 @@ -//! Special function module +//! Special functions module +//! +//! This module provides implementations of various special mathematical functions +//! commonly used in statistical and scientific computing. It includes: +//! +//! - Basic special functions: +//! - Gaussian (Normal) function +//! - Gamma function and its logarithm +//! - Pochhammer symbol (rising factorial) +//! +//! - Incomplete special functions: +//! - Regularized incomplete gamma function and its inverse +//! - Regularized incomplete beta function and its inverse +//! +//! - Error functions: +//! - Error function (erf) and its complement (erfc) +//! - Inverse error function and inverse complementary error function +//! +//! - Other functions: +//! - Beta function +//! - Phi function (CDF of the standard normal distribution) +//! - Lambert W function (principal branch W₀ and secondary branch W₋₁) +//! +//! Many of these functions are implemented using efficient numerical approximations +//! or by wrapping functions from other crates (e.g., `puruspe`, `lambert_w`). +//! +//! The module also includes an enum `LambertWAccuracyMode` to control the +//! accuracy-speed trade-off for Lambert W function calculations. pub mod function; pub mod lanczos; From 686d81d2143cc31144909b93b454ddc35cc31338 Mon Sep 17 00:00:00 2001 From: Axect Date: Wed, 31 Jul 2024 07:53:33 +0900 Subject: [PATCH 2/2] RLSE: Ver 0.37.9 - Fix inconsistent lambert w in prelude (#65) - Write a doc string for special/mod.rs --- Cargo.toml | 2 +- RELEASES.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 26bc9d99..89ef53a9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "peroxide" -version = "0.37.8" +version = "0.37.9" authors = ["axect "] edition = "2018" description = "Rust comprehensive scientific computation library contains linear algebra, numerical analysis, statistics and machine learning tools with farmiliar syntax" diff --git a/RELEASES.md b/RELEASES.md index 8bc5a2dd..430c0af4 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -1,3 +1,7 @@ +# Release 0.37.9 (2024-07-31) + +- Fix inconsistent lambert w function name [#65](https://github.com/Axect/Peroxide/issues/65) (Thanks to [@JSorngard](https://github.com/JSorngard)) + # Release 0.37.8 (2024-07-30) - Integrate with [lambert_w](https://crates.io/crates/lambert_w) crate ([#63](https://github.com/Axect/Peroxide/pull/63)) (Thanks to [@JSorngard](https://github.com/JSorngard))