Peroxide

https://docs.rs/peroxide/0.41.0
Admin
Peroxide is a Rust comprehensive scientific computation library featuring linear algebra, numerical...
Tokens:2,996
Snippets:39
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Peroxide with Single Feature

Source: https://docs.rs/peroxide

Example of adding Peroxide to a Cargo project with the 'plot' feature enabled.

```bash
cargo add peroxide --features "plot"

```

--------------------------------

### Install Peroxide with Multiple Features

Source: https://docs.rs/peroxide

Example of adding Peroxide to a Cargo project with multiple features like 'O3', 'plot', 'nc', 'csv', and 'parquet'.

```bash
cargo add peroxide --features "O3 plot nc csv parquet serde"

```

--------------------------------

### Matrix Construction and Operations in Peroxide

Source: https://docs.rs/peroxide

Demonstrates MATLAB-like and R-like matrix construction, basic operations like multiplication, and linear algebra functions such as determinant and inverse. Leverages BLAS for performance.

```rust
#[macro_use]
extern crate peroxide;
use peroxide::prelude::*;

fn main() {
    // MATLAB like matrix constructor
    let a = ml_matrix("1 2;3 4");

    // R like matrix constructor (default)
    let b = matrix(c!(1,2,3,4), 2, 2, Row);

    // Or use zeros
    let mut z = zeros(2, 2);
    z[(0,0)] = 1.0;
    z[(0,1)] = 2.0;
    z[(1,0)] = 3.0;
    z[(1,1)] = 4.0;

    // Simple but effective operations
    let c = a * b; // Matrix multiplication (BLAS integrated)

    // Easy to pretty print
    c.print();
    //       c[0] c[1]
    // r[0]     1    3
    // r[1]     2    4

    // Easy to do linear algebra
    c.det().print();
    c.inv().print();

    // and etc.
}

```

--------------------------------

### Vector Norm Calculation with Peroxide Prelude

Source: https://docs.rs/peroxide

Shows how to calculate the L2 norm of a vector using the default `prelude` module. This is the simplest way to access common vector operations.

```rust
#[macro_use]
extern crate peroxide;
use peroxide::prelude::*;

fn main() {
    let a = c!(1, 2, 3);
    let l2 = a.norm();      // L2 is default vector norm

    assert_eq!(l2, 14f64.sqrt());
}

```

--------------------------------

### Simulate Lorenz Attractor with Peroxide in Rust

Source: https://docs.rs/peroxide

Demonstrates simulating the Lorenz attractor using Peroxide's ODE solver and visualizing the results. Utilizes Rust's `?` operator for error handling and the `ODEProblem` trait for abstraction. Requires the `plot` feature to be enabled.

```rust
use peroxide::fuga::*;

fn main() -> Result<(), Box<dyn Error>> {
    let initial_conditions = vec![10f64, 1f64, 1f64];
    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,
        (0f64, 100f64),
        1e-2,
        &initial_conditions,
    )?;
    let y_mat = py_matrix(y_vec);
    let y0 = y_mat.col(0);
    let y2 = y_mat.col(2);

    let mut plt = Plot2D::new();
    plt
        .set_domain(y0)
        .insert_image(y2)
        .set_xlabel(r"$y_0$")
        .set_ylabel(r"$y_2$")
        .set_style(PlotStyle::Nature)
        .tight_layout()
        .set_dpi(600)
        .set_path("example_data/lorenz_rkf45.png")
        .savefig()?;

    Ok(())
}

struct Lorenz;

impl ODEProblem for Lorenz {
    fn rhs(&self, t: f64, y: &[f64], dy: &mut [f64]) -> anyhow::Result<()> {
        dy[0] = 10f64 * (y[1] - y[0]);
        dy[1] = 28f64 * y[0] - y[1] - y[0] * y[2];
        dy[2] = -8f64 / 3f64 * y[2] + y[0] * y[1];
        Ok(())
    }
}

```

--------------------------------

### Vector Norm Calculation with Peroxide Fuga

Source: https://docs.rs/peroxide

Demonstrates calculating various vector norms (L1, L2, L-infinity) by explicitly using the `fuga` module, which provides more control over numerical algorithms.

```rust
#[macro_use]
extern crate peroxide;
use peroxide::fuga::*;

fn main() {
    let a = c!(1, 2, 3);
    let l1 = a.norm(Norm::L1);
    let l2 = a.norm(Norm::L2);
    let l_inf = a.norm(Norm::LInf);
    assert_eq!(l1, 6f64);
    assert_eq!(l2, 14f64.sqrt());
    assert_eq!(l_inf, 3f64);
}

```

--------------------------------

### Add Peroxide with Features to Cargo Project

Source: https://docs.rs/peroxide

Command to add Peroxide with specific features enabled. Replace `<FEATURES>` with the desired feature flags.

```bash
cargo add peroxide --features "<FEATURES>"

```

--------------------------------

### Add Peroxide to Cargo Project

Source: https://docs.rs/peroxide

Basic command to add the Peroxide library to a Rust project using Cargo.

```bash
cargo add peroxide

```
Tokens:
Raw