Peroxide

travis

Rust numeric library with R Syntax.

Latest README version

Corresponds with 0.5.0.

Usage

Initial Import

rust extern crate peroxide; use peroxide::*;

Vec\
```R

R

a = c(1,2,3,4) b = seq(1,5,2) # (=c(1,3,5)) ```

`rust // Peroxide let a = c!(1,2,3,4); let b = seq!(1,5,2); // (=c!(1,3,5))`

Matrix Declaration

```R

R

a = matrix(1:4, 2, 2, T) ```

```rust // Peroxide (All belows are same) // matrix function let a = matrix(vec![1,2,3,4], 2, 2, Row); let b = matrix(c!(1,2,3,4), 2, 2, Row); let c = matrix(seq!(1,4,1), 2, 2, Row);

// matrix macro (More convenient) let c = matrix!(1;4;1, 2, 2, Row); ```

Print

```R

R

a = matrix(1:4, 2, 2, T) print(a)

[,1] [,2]

[1,] 1 2

[2,] 3 4

```

`rust // Peroxide let a = matrix!(1;4;1, 2, 2, Row); println!("{}", a); // c[0] c[1] // r[0] 1 2 // r[1] 3 4`

Concatenate

1. Vector + Vector => Vector ```R

R

a = c(1,2,3) b = c(4,5,6)

c = c(a, b) # c(1,2,3,4,5,6) ```

`rust // Peroxide let a = c!(1,2,3); let b = c!(4,5,6); let c = c!(a; b); // Must use semi-colon btw vectors`

2. Matrix + Matrix => Matrix ```R

R

cbind

a = matrix(1:4, 2, 2, F) b = matrix(c(5,6), 2, 1, F) c = cbind(a, b)

[,1] [,2] [,3]

[1,] 1 3 5

[2,] 2 4 6

rbind

a = matrix(1:4, 2, 2, T) b = matrix(c(5,6), 1, 2, T) c = rbind(a,b)

[,1] [,2]

[1,] 1 2

[2,] 3 4

[3,] 5 6

```

```rust // Peroxide // cbind let a = matrix!(1;4;1, 2, 2, Col); let b = matrix(c!(5,6), 2, 1, Col); let c = cbind!(a, b); // c[0] c[1] c[2] // r[0] 1 3 5 // r[1] 2 4 6

// rbind let a = matrix!(1;4;1, 2, 2, Row); let b = matrix(c!(5,6),1, 2, Row); let c = rbind!(a, b); // c[0] c[1] // r[0] 1 2 // r[1] 3 4 // r[2] 5 6 ```

Matrix operation

If you want to do multiple operations on same matrix, then you should use `clone` because Rust `std::ops` consume value.

```R

R

a = matrix(1:4, 2, 2, T) b = matrix(1:4, 2, 2, F) print(a + b) print(a - b) print(a * b) print(a %% b) ```

`rust // Peroxide let a = matrix!(1;4;1, 2, 2, Row); let b = matrix!(1;4;1, 2, 2, Col); println!("{}", a.clone() + b.clone()); println!("{}", a.clone() - b.clone()); println!("{}", a.clone() b.clone()); // Element-wise multiplication println!("{}", a % b); // Matrix multiplication // Consume -> You can't use a,b anymore.`

LU Decomposition

Peroxide uses complete pivoting LU decomposition. - Very stable.

Also there are lots of error handling for LU, so, you should use `Option`

`rust // Peroxide let a = matrix(c!(1,2,3,4), 2, 2, Row); let pqlu = a.lu().unwrap(); // for singular matrix, returns None let (p,q,l,u) = (pqlu.p, pqlu.q, pqlu.l, pqlu.u); assert_eq!(p, vec![(0,1)]); // swap 0 & 1 (Row) assert_eq!(q, vec![(0,1)]); // swap 0 & 1 (Col) assert_eq!(l, matrix(c!(1,0,0.5,1),2,2,Row)); assert_eq!(u, matrix(c!(4,3,0,-0.5),2,2,Row));`

Determinant

Determinant is implemented using by LU decomposition (O(n^3))

`rust // Peroxide let a = matrix(c!(1,2,3,4), 2, 2, Row); assert_eq!(a.det(), -2f64);`

Inverse

Inverse is also implemented using by LU decomposition

To handle singularity, output type is `Option<Matrix>`

To obtain inverse, you should use `unwrap` or pattern matching

```rust // Peroxide

// Non-singular let a = matrix!(1;4;1, 2, 2, Row); assert_eq!(a.inv().unwrap(), matrix(c!(-2,1,1.5,-0.5),2,2,Row));

// Singular let b = matrix!(1;9;1, 3, 3, Row); assert_eq!(b.inv(), None); ```

Extract Column or Row

```R

R

a = matrix(1:4, 2, 2, T) print(a[,1]) print(a[,2]) print(a[1,]) print(a[2,]) ```

`rust //Peroxide let a = matrix!(1;4;1, 2, 2, Row); println!("{}", a.col(0)); println!("{}", a.col(1)); println!("{}", a.row(0)); println!("{}", a.row(1));`

Functional Programming

```rust // Peroxide let a = matrix!(1;4;1, 2, 2, Row); println!("{}", a.fmap(|x| x + 1.0)); println!("{}", a.fmap(|x| x - 1.0)); println!("{}", a.fmap(|x| x * 2.0));

// Results // // c[0] c[1] // r[0] 2 3 // r[1] 4 5 // // c[0] c[1] // r[0] 0 1 // r[1] 2 3 // // c[0] c[1] // r[0] 2 4 // r[1] 6 8 ```

Write to CSV

You can write matrix to csv by two ways.

Just write `rust // Peroxide let a = matrix!(1;4;1, 2, 2, Row); a.write("test.csv"); // It will save a to test.csv`

Error Handling ```rust // Peroxide extern crate peroxide; use peroxide:: *; use std::process; // You must type this

let a = matrix!(1;4;1, 2, 2, Row); if let Err(err) = a.write("test.csv") { println!("{}", err); process::exit(1); } ```

Version Info

To see Release.md