[][src]Crate peroxide

peroxide is comprehensive numerical library for Rust.

Components

peroxide has various components for scientific computation.

Quick Start

Cargo.toml

  • To use peroxide, you should edit Cargo.toml
  • Current document version is corresponding to 0.21.4
  1. Default
    [dependencies]
    peroxide = "0.21"
    
  2. OpenBLAS & SIMD
    [dependencies.peroxide]
    version = "0.21"
    default-features = false
    features = ["O3"]
    
  3. Plot
    [dependencies.peroxide]
    version = "0.21"
    default-features = false
    features = ["plot"]
    
  4. DataFrame
    [dependencies.peroxide]
    version = "0.21"
    default-features = false
    features = ["dataframe"]
    
  5. Together
    [dependencies.peroxide]
    version = "0.21"
    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...
    }

Useful tips for features

  • After 0.21.4, if size of matrix is smaller than 1000 x 1000, default is more effective than O3 feature.
  • To plot, use dataframe to export data as netcdf format and use python to draw plot.
    • plot feature has limited plot abilities.
    • There is a template of python code. - Socialst

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 redox::redoxable::*;
pub use util::low_level::*;
pub use numerical::eigen::*;
pub use operation::raw_ops::*;
pub use util::wrapper::*;
pub use numerical::integral::*;

Modules

macros

Useful macros

ml

Machine learning tools

numerical

Differential equations & Numerical Analysis tools

operation

Useful missing operations & comprehensive traits

redox

Smart pointer of Vec<f64>

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