loeres-backend-std 0.13.3

Loeres dynamic dense/sparse storage and server numerical adapters. std, heap-backed; server-only.
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! Tests for the dynamic sparse adapters (RFC 007).

use super::{SparseIngestOptions, SparseMatrix};
use loeres::{DimensionKind, MatrixAccess, SolverError};

fn sample() -> SparseMatrix<f64> {
    // 3x3 with stored entries at (0,0)=1, (0,2)=2, (2,1)=3, plus an explicit
    // stored zero at (1,1)=0 to exercise stored-vs-implicit.
    SparseMatrix::from_triplets(
        3,
        3,
        &[(0, 0, 1.0), (0, 2, 2.0), (2, 1, 3.0), (1, 1, 0.0)],
        SparseIngestOptions::default(),
    )
    .unwrap()
}

#[test]
fn sparse_dims_nnz_and_kind() {
    let m = sample();
    assert_eq!(m.dims().rows, 3);
    assert_eq!(m.dims().cols, 3);
    assert_eq!(m.nnz(), 4);
    assert_eq!(m.dimension_kind(), DimensionKind::Dynamic);
}

#[test]
fn sparse_get_stored_and_implicit_zero() {
    let m = sample();
    assert_eq!(m.get(0, 0).unwrap(), 1.0);
    assert_eq!(m.get(0, 2).unwrap(), 2.0);
    assert_eq!(m.get(2, 1).unwrap(), 3.0);
    // absent in-bounds entry reads as implicit zero
    assert_eq!(m.get(1, 0).unwrap(), 0.0);
    assert_eq!(m.get(2, 2).unwrap(), 0.0);
}

#[test]
fn sparse_get_out_of_bounds() {
    let m = sample();
    assert_eq!(
        m.get(3, 0).unwrap_err(),
        SolverError::DimensionMismatch { lhs: 3, rhs: 3 }
    );
    assert_eq!(
        m.get(0, 7).unwrap_err(),
        SolverError::DimensionMismatch { lhs: 7, rhs: 3 }
    );
}

#[test]
fn sparse_try_get_stored_distinguishes_stored_zero() {
    let m = sample();
    // explicitly stored zero at (1,1)
    assert_eq!(m.try_get_stored(1, 1).unwrap(), Some(0.0));
    // absent (implicit zero) at (1,0)
    assert_eq!(m.try_get_stored(1, 0).unwrap(), None);
    // stored nonzero
    assert_eq!(m.try_get_stored(0, 0).unwrap(), Some(1.0));
    // out-of-bounds
    assert_eq!(
        m.try_get_stored(9, 0).unwrap_err(),
        SolverError::DimensionMismatch { lhs: 9, rhs: 3 }
    );
}

#[test]
fn sparse_rejects_duplicates() {
    let err = SparseMatrix::from_triplets(
        2,
        2,
        &[(0, 0, 1.0), (0, 0, 2.0)],
        SparseIngestOptions::default(),
    )
    .unwrap_err();
    assert_eq!(err, SolverError::InvalidInput);
}

#[test]
fn sparse_rejects_out_of_bounds_triplet() {
    let err = SparseMatrix::from_triplets(
        2,
        2,
        &[(0, 0, 1.0), (5, 0, 2.0)],
        SparseIngestOptions::default(),
    )
    .unwrap_err();
    assert_eq!(err, SolverError::DimensionMismatch { lhs: 5, rhs: 2 });
}

#[test]
fn sparse_rejects_zero_dimensions() {
    assert_eq!(
        SparseMatrix::<f64>::from_triplets(0, 2, &[], SparseIngestOptions::default()).unwrap_err(),
        SolverError::InvalidDimension
    );
}

#[test]
fn sparse_rejects_overflow_rows() {
    // `rows + 1` would overflow `usize`; rejected before any allocation.
    assert_eq!(
        SparseMatrix::<f64>::from_triplets(usize::MAX, 1, &[], SparseIngestOptions::default())
            .unwrap_err(),
        SolverError::InvalidDimension
    );
}

#[test]
fn sparse_max_rows_limit() {
    let opts = SparseIngestOptions {
        max_entries: None,
        max_rows: Some(3),
    };
    // rows = 5 exceeds max_rows = 3 -> rejected before allocation
    let err = SparseMatrix::from_triplets(5, 2, &[(0, 0, 1.0)], opts).unwrap_err();
    assert_eq!(err, SolverError::InvalidInput);
    // rows = 3 is within the cap
    assert!(SparseMatrix::from_triplets(3, 2, &[(0, 0, 1.0)], opts).is_ok());
}

#[test]
fn sparse_memory_limit() {
    let opts = SparseIngestOptions {
        max_entries: Some(1),
        max_rows: None,
    };
    let err = SparseMatrix::from_triplets(2, 2, &[(0, 0, 1.0), (1, 1, 2.0)], opts).unwrap_err();
    assert_eq!(err, SolverError::InvalidInput);
    assert!(SparseMatrix::from_triplets(2, 2, &[(0, 0, 1.0)], opts).is_ok());
}

#[test]
fn sparse_validate_finite_scans_stored_only() {
    let ok = sample();
    assert!(ok.validate_finite().is_ok());
    let bad =
        SparseMatrix::from_triplets(2, 2, &[(0, 0, f64::NAN)], SparseIngestOptions::default())
            .unwrap();
    assert_eq!(
        bad.validate_finite().unwrap_err(),
        SolverError::NonFiniteInput
    );
}