beaumont 0.1.2

Algorithmic trading for quantitative financial applications
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
43
44
45
46
47
48

# beaumont
Algorithmic trading for quantitative financial applications in [Rust](https://rust-lang.org/) language.

> [!WARNING]  
> This crate is in an early stage of development and **not** production ready yet.<br>
> Use with caution!

This project has been built and published are reusable create to both [crates.io](https://crates.io/crates/beaumont) and [docs.rs](https://docs.rs/crate/beaumont/latest), and it provides basic implementations for numbers, linear algebra, and financial algorithms. 

## numbers
A basic implementation of decimal numbers in fixed-point arithmetic.

## linear algebra
A basic implementation of linear algebra common operations.


### vectors
```rust
use beaumont::*;
    
let v1 = vector![1, 2, 3];                  

// Comparing for equality                     
assert_eq!(v1, vector![1, 2, 3]);             
                                              
// Negation                                   
let negated = v1.neg();                       
assert_eq!(negated, vector![-1, -2, -3]);     
                                              
// Scalar multiplication                      
let v2 = v1.scale_by(2);                      
assert_eq!(v2, vector![2, 4, 6]);             
                                              
// Addition                                   
let v3 = Vector::from([1, 2, 3]);             
let v4 = v1.add(&v2);                         
assert_eq!(v4, vector![3, 6, 9]);             
                                              
// Dot product                                
let s = v1.dot(&v2);                          
assert_eq!(s, 28);                            
```

### matrices
...

## algorithms
...