rustebra 0.3.1

A hybrid no_std/alloc linear algebra crate for Rust, scaling from embedded targets to dynamic Krylov subspace solvers.
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use rustebra::sparse::{CsrError, CsrMatrix};

#[test]
fn csr_construction_and_accessors() {
    let m = CsrMatrix::new(
        3,
        3,
        vec![0, 1, 2, 3],
        vec![0, 1, 2],
        vec![1.0_f64, 2.0, 3.0],
    )
    .unwrap();

    assert_eq!(m.rows(), 3);
    assert_eq!(m.cols(), 3);
    assert_eq!(m.nnz(), 3);
    assert_eq!(m.row_ptr(), &[0, 1, 2, 3]);
    assert_eq!(m.col_indices(), &[0, 1, 2]);
    assert_eq!(m.values(), &[1.0, 2.0, 3.0]);
}

#[test]
fn csr_empty_matrix_is_valid() {
    let m = CsrMatrix::<f64>::new(100, 200, vec![0; 101], vec![], vec![]).unwrap();
    assert_eq!(m.rows(), 100);
    assert_eq!(m.cols(), 200);
    assert_eq!(m.nnz(), 0);
}

#[test]
fn csr_row_range_returns_correct_slices() {
    // Row 0: empty, row 1: one entry, row 2: two entries.
    let m = CsrMatrix::new(
        3,
        3,
        vec![0, 0, 1, 3],
        vec![2, 0, 1],
        vec![5.0_f64, 3.0, 9.0],
    )
    .unwrap();
    assert_eq!(m.row_range(0), Some(0..0));
    assert_eq!(m.row_range(1), Some(0..1));
    assert_eq!(m.row_range(2), Some(1..3));
    assert_eq!(m.row_range(3), None);
}

#[test]
fn csr_length_mismatch_is_an_error_not_a_panic() {
    assert_eq!(
        CsrMatrix::<f64>::new(2, 2, vec![0, 1, 2], vec![0, 1], vec![1.0]),
        Err(CsrError::LengthMismatch),
    );
}

#[test]
fn csr_row_ptr_length_mismatch_is_an_error_not_a_panic() {
    assert_eq!(
        CsrMatrix::<f64>::new(3, 3, vec![0, 1], vec![], vec![]),
        Err(CsrError::RowPtrLengthMismatch),
    );
}

#[test]
fn csr_row_ptr_invalid_start_is_an_error_not_a_panic() {
    assert_eq!(
        CsrMatrix::<f64>::new(2, 2, vec![1, 1, 1], vec![], vec![]),
        Err(CsrError::RowPtrInvalid),
    );
}

#[test]
fn csr_row_ptr_not_monotone_is_an_error_not_a_panic() {
    assert_eq!(
        CsrMatrix::<f64>::new(3, 3, vec![0, 2, 1, 3], vec![0, 1, 2], vec![1.0, 2.0, 3.0]),
        Err(CsrError::RowPtrInvalid),
    );
}

#[test]
fn csr_row_ptr_last_entry_mismatch_is_an_error_not_a_panic() {
    assert_eq!(
        CsrMatrix::<f64>::new(2, 2, vec![0, 1, 99], vec![0, 1], vec![1.0, 2.0]),
        Err(CsrError::RowPtrInvalid),
    );
}

#[test]
fn csr_col_index_out_of_bounds_is_an_error_not_a_panic() {
    assert_eq!(
        CsrMatrix::<f64>::new(2, 2, vec![0, 1, 2], vec![0, 5], vec![1.0, 2.0]),
        Err(CsrError::ColIndexOutOfBounds),
    );
}

#[test]
fn csr_partial_eq_holds_for_identical_data() {
    let a = CsrMatrix::new(2, 3, vec![0, 1, 2], vec![2, 0], vec![7.0_f64, 4.0]).unwrap();
    let b = CsrMatrix::new(2, 3, vec![0, 1, 2], vec![2, 0], vec![7.0_f64, 4.0]).unwrap();
    assert_eq!(a, b);
}

#[test]
fn csr_partial_eq_distinguishes_different_values() {
    let a = CsrMatrix::new(2, 2, vec![0, 1, 2], vec![0, 1], vec![1.0_f64, 2.0]).unwrap();
    let b = CsrMatrix::new(2, 2, vec![0, 1, 2], vec![0, 1], vec![1.0_f64, 9.0]).unwrap();
    assert_ne!(a, b);
}

#[test]
fn csr_partial_eq_distinguishes_different_shapes() {
    let a = CsrMatrix::<f64>::new(2, 3, vec![0, 0, 0], vec![], vec![]).unwrap();
    let b = CsrMatrix::<f64>::new(3, 2, vec![0, 0, 0, 0], vec![], vec![]).unwrap();
    assert_ne!(a, b);
}

#[test]
fn csr_zero_row_matrix_is_valid() {
    let m = CsrMatrix::<f64>::new(0, 5, vec![0], vec![], vec![]).unwrap();
    assert_eq!(m.rows(), 0);
    assert_eq!(m.nnz(), 0);
    assert_eq!(m.row_range(0), None);
}