Ver 0.36.4

- More generic Butcher tableau - More ODE integrators
Axect · Apr 11, 2024 · 39a103b · 39a103b
2 parents c8750f9 + b34c6fc
commit 39a103b
Show file tree

Hide file tree

Showing 4 changed files with 307 additions and 171 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "peroxide"
-version = "0.36.3"
+version = "0.36.4"
 authors = ["axect <axect@outlook.kr>"]
 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
@@ -1,3 +1,10 @@
+# Release 0.36.4 (2024-04-11)
+
+- More generic Butcher tableau
+  - Now, you can use `ButcherTableau` for non-embedded methods too
+- More ODE integrators
+  - `RALS3, RALS4, RK5, BS23`
+
 # Release 0.36.3 (2024-04-10)
 
 - Hotfix : Fix `GL4` algorithm

diff --git a/src/lib.rs b/src/lib.rs
@@ -4,79 +4,84 @@
 //!
 //! `peroxide` has various components for scientific computation.
 //!
-//! * Linear Algebra (with BLAS & LAPACK)
-//!     * [Matrix](structure/matrix/index.html) operations
-//!         * `+,-,*,/`
-//!         * LU Decomposition, Determinant, Inverse
-//!         * QR Decomposition (`O3` feature needed)
-//!         * Singular Value Decomposition (`O3` feature needed)
-//!         * Cholesky Decomposition (`O3` feature needed)
-//!         * Reduced Row Echelon Form
-//!     * [Vector](structure/vector/index.html) operations
-//!     * [Eigenvalue, Eigenvector](numerical/eigen/index.html) algorithms
-//! * Statistics
-//!     * [Statistical operations](statistics/stat/index.html)
-//!         * `mean, var, sd`
-//!         * `factorial, P, C, H`
-//!         * Confusion Matrix & metrics
-//!     * [Distributions](statistics/dist/index.html)
-//!         * Bernoulli
-//!         * Uniform
-//!         * Binomial
-//!         * Normal
-//!         * Gamma
-//!         * Beta
-//!         * Student's t
-//! * [Special functions](special/function/index.html) (Using `puruspe` crate)
-//!     * Gaussian
-//!     * Gamma
-//!     * Beta
-//!     * Error
-//!     * Incomplete Gamma
-//!     * Incomplete Beta
-//! * Automatic Differentiation
-//!     * [Taylor mode forward AD](structure/ad/index.html)
-//! * Numerical Utils
-//!     * [Interpolation](numerical/interp/index.html)
-//!     * [Spline](numerical/spline/index.html)
-//!     * [Polynomial](structure/polynomial/index.html)
-//!     * [Lanczos Approximation](special/lanczos/index.html)
-//!     * [Numerical Integrations](numerical/integral/index.html)
-//! * [Optimization](numerical/optimize/index.html)
-//!     * Gradient Descent
-//!     * Levenberg-Marquardt
-//! * [Root Finding](numerical/root/index.html)
-//!     * Bisection
-//!     * False Position (Regula falsi)
-//!     * Secant
-//!     * Newton
-//! * [Differential Equations](numerical/ode/index.html)
-//!     * Explicit
-//!         * Runge-Kutta 4th order
-//!         * Euler methods
-//!     * Implicit
-//!         * Backward Euler
-//!         * Gauss-Legendre 4th order
-//! * Communication with Python
-//!     * [Plot with `matplotlib`](util/plot/index.html)
-//! * [DataFrame](structure/dataframe/index.html)
-//!     * Read & Write with `parquet` or `netcdf` or `csv` format
-//! * Macros
-//!     * [R macros](macros/r_macro/index.html)
-//!     * [Matlab macros](macros/matlab_macro/index.html)
-//!     * [Julia macros](macros/julia_macro/index.html)
+//! - Linear Algebra (with BLAS & LAPACK)
+//!   - [Matrix](structure/matrix/index.html) operations
+//!     - `+,-,*,/`
+//!     - LU Decomposition, Determinant, Inverse
+//!     - QR Decomposition (`O3` feature needed)
+//!     - Singular Value Decomposition (`O3` feature needed)
+//!     - Cholesky Decomposition (`O3` feature needed)
+//!     - Reduced Row Echelon Form
+//!   - [Vector](structure/vector/index.html) operations
+//!   - [Eigenvalue, Eigenvector](numerical/eigen/index.html) algorithms
+//! - Statistics
+//!   - [Statistical operations](statistics/stat/index.html)
+//!     - `mean, var, sd`
+//!     - `factorial, P, C, H`
+//!     - Confusion Matrix & metrics
+//!   - [Distributions](statistics/dist/index.html)
+//!     - Bernoulli
+//!     - Uniform
+//!     - Binomial
+//!     - Normal
+//!     - Gamma
+//!     - Beta
+//!     - Student's t
+//! - [Special functions](special/function/index.html) (Using `puruspe` crate)
+//!   - Gaussian
+//!   - Gamma
+//!   - Beta
+//!   - Error
+//!   - Incomplete Gamma
+//!   - Incomplete Beta
+//! - Automatic Differentiation
+//!   - [Taylor mode forward AD](structure/ad/index.html)
+//! - Numerical Utils
+//!   - [Interpolation](numerical/interp/index.html)
+//!   - [Spline](numerical/spline/index.html)
+//!   - [Polynomial](structure/polynomial/index.html)
+//!   - [Lanczos Approximation](special/lanczos/index.html)
+//!   - [Numerical Integrations](numerical/integral/index.html)
+//! - [Optimization](numerical/optimize/index.html)
+//!   - Gradient Descent
+//!   - Levenberg-Marquardt
+//! - [Root Finding](numerical/root/index.html)
+//!   - Bisection
+//!   - False Position (Regula falsi)
+//!   - Secant
+//!   - Newton
+//! - [Ordinary Differential Equations](numerical/ode/index.html)
+//!   - Explicit
+//!     - Ralston's 3rd order
+//!     - Runge-Kutta 4th order
+//!     - Ralston's 4th order
+//!     - Runge-Kutta 5th order
+//!   - Embedded
+//!     - Bogacki-Shampine 3(2)
+//!     - Runge-Kutta-Fehlberg 4(5)
+//!     - Dormand-Prince 5(4)
+//!     - Tsitouras 5(4)
+//!   - Implicit
+//!     - Gauss-Legendre 4th order
+//! - Communication with Python
+//!   - [Plot with `matplotlib`](util/plot/index.html)
+//! - [DataFrame](structure/dataframe/index.html)
+//!   - Read & Write with `parquet` or `netcdf` or `csv` format
+//! - Macros
+//!   - [R macros](macros/r_macro/index.html)
+//!   - [Matlab macros](macros/matlab_macro/index.html)
+//!   - [Julia macros](macros/julia_macro/index.html)
 //!
 //! And all these things are built on mathematical traits.
 //!
-//! * Traits
-//!     * [Functional Programming tools](traits/fp/index.html)
-//!     * [General algorithms](traits/general/index.html)
-//!     * [Mathematics](traits/math/index.html)
-//!     * [Mutable tools](traits/mutable/index.html)
-//!     * [Number & Real](traits/num/index.html)
-//!     * [Pointer](traits/pointer/index.html)
-//!     * [Stable](traits/stable/index.html)
-//!
+//! - Traits
+//!   - [Functional Programming tools](traits/fp/index.html)
+//!   - [General algorithms](traits/general/index.html)
+//!   - [Mathematics](traits/math/index.html)
+//!   - [Mutable tools](traits/mutable/index.html)
+//!   - [Number & Real](traits/num/index.html)
+//!   - [Pointer](traits/pointer/index.html)
+//!   - [Stable](traits/stable/index.html)
 //! ## Quick Start
 //!
 //! ### Cargo.toml