Crate peroxide

peroxide is comprehensive numerical library for Rust.

Components

peroxide has various components for scientific computation.

• Linear Algebra (with BLAS & LAPACK)
  • Matrix operations
    • +,-,*,/
    • LU, Determinant, Inverse
  • Vector operations
• Statistics
  • Statistical operations
    • mean, var, sd
    • factorial, P, C, H
  • Distributions
    • Bernoulli
    • Uniform
    • Normal
    • Gamma
    • Beta
• Special functions (Using special crate)
  • Gaussian
  • Gamma
  • Beta
  • Error
• Automatic Differentiation
  • Dual number system
  • Hyper dual number system
• Numerical Utils
  • Interpolation
  • Spline
  • Polynomial
  • Gauss-Legendre Quadrature
• Optimization
  • Gradient Descent
  • Levenberg-Marquardt
• Differential Equations
  • Explicit
    • Runge-Kutta 4th order
    • Euler methods
  • Implicit
    • Backward Euler
    • Gauss-Legendre 4th order
• Communication with Python
  • Plot with matplotlib
• DataFrame
  • Read & Write with netcdf or csv format
• Macros
  • R macros
  • Matlab macros
  • Julia macros

Quick Start

Cargo.toml

• To use peroxide, you should edit Cargo.toml
• Current document version is corresponding to 0.20.1

1. Default

   [dependencies]
   peroxide = "0.20"
   

2. OpenBLAS & SIMD

   [dependencies.peroxide]
   version = "0.20"
   default-features = false
   features = ["O3"]
   

3. Plot

   [dependencies.peroxide]
   version = "0.20"
   default-features = false
   features = ["plot"]
   

4. DataFrame

   [dependencies.peroxide]
   version = "0.20"
   default-features = false
   features = ["dataframe"]
   

5. Together

   [dependencies.peroxide]
   version = "0.20"
   default-features = false
   features = ["O3", "plot", "dataframe"]
   

Import all at once

• You can import all functions & structures at once

  extern crate peroxide;
  use peroxide::*;
  
  fn main() {
      //Some codes...
  }

Re-exports

pub use macros::julia_macro::*;

pub use macros::matlab_macro::*;

pub use macros::r_macro::*;

pub use structure::matrix::*;

pub use structure::vector::*;

pub use statistics::stat::*;

pub use macros::r_macro::*;

pub use macros::matlab_macro::*;

pub use macros::julia_macro::*;

pub use statistics::rand::*;

pub use util::print::*;

pub use util::non_macro::*;

pub use structure::polynomial::*;

pub use numerical::interp::*;

pub use numerical::spline::*;

pub use ml::reg::*;

pub use structure::dual::*;

pub use operation::extra_ops::*;

pub use util::useful::*;

pub use structure::multinomial::*;

pub use numerical::utils::*;

pub use util::api::*;

pub use statistics::dist::*;

pub use special::function::*;

pub use statistics::ops::*;

pub use structure::hyper_dual::*;

pub use util::writer::*;

pub use operation::mut_ops::*;

pub use numerical::ode::*;

pub use operation::number::*;

pub use numerical::optimize::*;

pub use special::legendre::*;

pub use redox::redoxable::*;

pub use util::low_level::*;

Modules

macros	Useful macros
ml	Machine learning tools
numerical	Differential equations & Numerical Analysis tools
operation	Useful missing operations & comprehensive traits
redox
special	Special function module
statistics	Statistical Modules
structure	Main structures for peroxide
util	Utility - plot, print, pickle and etc.

Macros

c	R like concatenate (Type: Vec<f64>)
cbind	R like cbind
dnorm	R like dnorm
dt	R like dt
eye	MATLAB like eye - identity matrix
hstack
linspace	MATLAB like linspace
lm	R like lm
matrix	More R like Matrix constructor (Macro)
pnorm	R like pnorm
pt	R like pt
rand	MATLAB like rand - random matrix
rbind	R like rbind
rnorm	R like random normal
rt	R like random Student's t
runif	R like random uniform
seq	R like seq macro
vstack
zeros	MATLAB like zeros - zero matrix