Merge branch 'hotfix' into dev

Author: Axect

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "peroxide"
-version = "0.36.4"
+version = "0.37.0"
 authors = ["axect <[email protected]>"]
 edition = "2018"
 description = "Rust comprehensive scientific computation library contains linear algebra, numerical analysis, statistics and machine learning tools with farmiliar syntax"

README.md

@@ -256,7 +256,7 @@ The example code demonstrates how Peroxide can be used to simulate the Lorenz at
 use peroxide::fuga::*;
 
 fn main() -> Result<(), Box<dyn Error>> {
-    let rkf45 = RKF45::new(1e-4, 0.9, 1e-6, 1e-1, 100);
+    let rkf45 = RKF45::new(1e-4, 0.9, 1e-6, 1e-2, 100);
     let basic_ode_solver = BasicODESolver::new(rkf45);
     let (_, y_vec) = basic_ode_solver.solve(
         &Lorenz,
@@ -309,7 +309,7 @@ How's that? Let me know if there's anything else you'd like me to improve!
 
 ## Latest README version
 
-Corresponding to `0.36.0`
+Corresponding to `0.37.0`
 
 ## Pre-requisite
 
@@ -456,11 +456,13 @@ Corresponding to `0.36.0`
 
 - In [examples](./examples) directory, there are some examples.
 
+- In [tests](./tests) directory, there are some useful tests.
+
 - More examples are in [Peroxide Gallery](https://github.com/Axect/Peroxide_Gallery).
 
 ## Release Info
 
-To see [RELEASES.md](RELEASES.md)
+To see [RELEASES.md](./RELEASES.md)
 
 ## Contributes Guide
 
@@ -473,3 +475,18 @@ Peroxide is licensed under dual licenses - Apache License 2.0 and MIT License.
 ## TODO
 
 To see [TODO.md](./TODO.md)
+
+## Cite Peroxide
+
+Hey there!
+If you're using Peroxide in your research or project, you're not required to cite us.
+But if you do, we'd be really grateful! 😊
+
+To make citing Peroxide easy, we've created a DOI through Zenodo. Just click on this badge:
+
+[![DOI](https://zenodo.org/badge/130400565.svg)](https://zenodo.org/doi/10.5281/zenodo.10815823)
+
+This will take you to the Zenodo page for Peroxide.
+At the bottom, you'll find the citation information in various formats like BibTeX, RIS, and APA.
+
+So, if you want to acknowledge the work we've put into Peroxide, citing us would be a great way to do it! Thanks for considering it, we appreciate your support! 👍

TODO.md

@@ -1,20 +1,16 @@
 # TODO
 
-## 2021.01.14
+## 2024.04.14
 
 ### Primary
 
+- [ ] Whole new Optimize (Trait based)
+
 - [ ] Pure Rust implementation of Linear Algebra
     - [x] LU (Completely Pivoting)
     - [x] LU (Partial Pivoting)
     - [ ] QR
     - [ ] SVD
-- [ ] Add more IO options for DataFrame
-    - [x] CSV (`csv` feature)
-    - [x] NetCDF (`nc` feature)
-    - [ ] JSON
-    - [ ] Arrow IPC
-    - [ ] Parquet
 
 ### Subs
 
@@ -30,30 +26,16 @@
     - [x] Student's t
     - [x] Uniform
     - [ ] Wishart
+    - [x] Weighted Uniform
 - [ ] Implement special polynomial
     - [x] Legendre
     - [ ] Bessel
     - [ ] Hermite
 - [ ] Implement convenient structure of Neural Network
-- [ ] Documentized
-    - [x] Vector
-    - [x] Matrix
-    - [x] Linear Algebra
-    - [x] Functional Programming
-    - [x] Statistics
-    - [ ] Interpolation & Spline
-    - [x] ODE
-    - [ ] Macros
-    - [ ] Machine Learning
-    - [x] Optimize
-    - [x] Automatic Differentiation
-    - [x] DataFrame
 - [ ] Add Statistical regression
     - [ ] Gaussian Kernel
     - [ ] Logistic Kernel
-- [ ] Make or Use pure Rust plot library
 - [ ] Implement more Eigenvalue algorithms
-- [ ] Implement more spline algorithms
 - [ ] Complex matrix
 
 ## Complete
@@ -75,3 +57,22 @@
   - [x] Replace `proc_macro` for `AD` with ordinary macro or Enum
 - [x] Make `csv` optional
 - [x] Remove `dual`, `hyperdual` and modify `Real`, `Number` (How to bind `f64` & `AD` effectively?)
+- [x] Add more IO options for DataFrame
+    - [x] CSV (`csv` feature)
+    - [x] NetCDF (`nc` feature)
+    - [x] Parquet
+- [x] Documentized
+    - [x] Vector
+    - [x] Matrix
+    - [x] Linear Algebra
+    - [x] Functional Programming
+    - [x] Statistics
+    - [x] Interpolation & Spline
+    - [x] ODE
+    - [x] Macros
+    - [x] Optimize
+    - [x] Automatic Differentiation
+    - [x] DataFrame
+- [x] Implement more spline algorithms
+- [x] Whole new ODE (trait based)
+- [x] Whole new root finding (trait based)

example_data/lorenz_rkf45.png

@@ -2,7 +2,7 @@ use peroxide::fuga::*;
 
 #[allow(unused_variables)]
 fn main() -> Result<(), Box<dyn Error>> {
-    let rkf45 = RKF45::new(1e-4, 0.9, 1e-6, 1e-1, 100);
+    let rkf45 = RKF45::new(1e-4, 0.9, 1e-6, 1e-2, 100);
     let basic_ode_solver = BasicODESolver::new(rkf45);
     let (_, y_vec) = basic_ode_solver.solve(
         &Lorenz,

example_data/rkf45_test.png

@@ -21,8 +21,9 @@
 //!     let y1 = x.fmap(|t| t.powi(2));
 //!     let y2 = x.fmap(|t| t.powi(3));
 //!
+//!     let mut rng = SmallRng::seed_from_u64(42);
 //!     let normal = Normal(0f64, 0.1);
-//!     let eps = normal.sample(100);
+//!     let eps = normal.sample_with_rng(&mut rng, x.len());
 //!     let y3 = y2.add_v(&eps);
 //!
 //!     let mut plt = Plot2D::new();