Crate crabsformer

Crabsformer is an easy-to-use fundamental library for scientific computing with Rust, highly inspired by NumPy.

Usage

Add this to your Cargo.toml:

[dependencies]
crabsformer = "2019.3.9"

and this to your crate root:

#[macro_use] extern crate crabsformer;
use crabsformer::prelude::*;

To get started using Crabsformer, read the quickstart tutorial below.

Quickstart Tutorial

Prerequisites

Before reading this quick tutorial you should know a bit of Rust. If you would like to refresh your memory, take a look at the Rust book.

The Basics

Crabsformer's main data structures are Vector<T> and [Matrix<T>].

Vector<T> is a fixed-length list of elements of the same numeric type. The vector! macro is provided to make initialization more convenient.

let v = vector![1, 10, 11, 314];

It can also initialize each element of a Vector<T> with a given value.

let v = vector![0; 5]; // vector![0, 0, 0, 0, 0]

uniform(len, low, high) function can be used to create a Vector<T> of the given length len and populate it with random samples from a uniform distribution over the half-open interval [low, high) (includes low, but excludes high).

let v = Vector::uniform(5, 0.0, 1.0);
// Vector([0.054709196, 0.86043775, 0.21187294, 0.6413728, 0.14186311]) (Random)

There are also other function such as zeros(len), ones(len), full(len, value), range(start, stop, step), linspace(len, start, stop) etc that can be used to create a Vector<T>.

You can perform arithmetic operations on a Vector<T>. For example, if you add the Vector<T>, the arithmetic operator will work element-wise. The output will be a Vector<T> of the same length.

let a = vector![0.5, 0.6, 0.9, 1.7] + vector![1.0, 0.4, 0.2, 0.1];
assert_eq!(a, vector![1.5, 1.0, 1.1, 1.8]);

If you try to add Vector<T> with a different number of elements, you will get an error. For example:

let x = vector![3, 1, 4, 1, 5] + vector![2, 10, 9];

thread 'guide::example::main' panicked at 'Vector addition with invalid length: 5 != 3' src/main.rs:12:13

You can run an arithmetic operation on the Vector<T> with a scalar value. For example, this code multiplies each element of the Vector<T> by 2.

let x = vector![3, 1, 4, 1] * 2;
assert_eq!(x, vector![6, 2, 8, 2]);

If you would like to square of the individual elements of the Vector<T>, or even higher up, use the power method. Here, each element of the Vector<T> is raised to the power 2.

let x = vector![3, 1, 4, 1];
let y = x.power(2);
assert_eq!(y, vector![9, 1, 16, 1]);

You can use filter to find the elements that match your criteria.

let x = vector![3, 1, 4, 1];
let y = x.filter(|x| x >= 2);
assert_eq!(y, vector![3, 4]);

Getting help

Feel free to start discussion at GitHub issues.

License

Crabsformer is licensed under the Apache-2.0 license.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Crabsformer by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.

Modules

prelude

Crabsformer's prelude

Macros

vector

Structs

Matrix	Matrix data structure
Vector	Vector elements structure