custos-math 0.2.1

Matrix operations with custos
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# custos-math

[![Crates.io version](https://img.shields.io/crates/v/custos-math.svg)](https://crates.io/crates/custos-math)
[![Docs](https://docs.rs/custos-math/badge.svg?version=0.2.1)](https://docs.rs/custos-math/0.2.1/custos-math/)

This crate provides CUDA, OpenCL and CPU based matrix operations using [custos].

[custos]: https://github.com/elftausend/custos

## Installation

Add "custos-math" as a dependency:
You will also need [custos], if you want to run an example.
```toml
[dependencies]
custos-math = "0.2.1"
custos = "0.4.1"

# to disable the default features (cuda, opencl) and use an own set of features:
#custos-math = {version = "0.2.1", default-features=false, features=["opencl"]}
#custos = { version="0.4.1", default-features = false, features=["opencl"]}
```

## Example

```rust
use custos::CPU;
use custos_math::Matrix;

fn main() {
    let device = CPU::new();

    let a = Matrix::from((&device, (2, 3), [1., 2., 3., 4., 5., 6.,]));
    let b = Matrix::from((&device, (3, 2), [6., 5., 4., 3., 2., 1.,]));

    let c = a.gemm(&b);

    assert_eq!(c.read(), vec![20., 14., 56., 41.,]);
}
```

Many more examples can be found in the tests and examples folder.