rustebra 0.4.0

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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use alloc::vec;
use alloc::vec::Vec;

use crate::scalar::Scalar;

use super::{CscMatrix, CsrMatrix};

/// Multiplies every stored value of a CSR sparse matrix by `scalar`, returning a new matrix
/// with the same sparsity pattern and shape.
///
/// The `row_ptr` and `col_indices` arrays are preserved unchanged; only `values` changes.
///
/// # Examples
///
/// ```
/// use rustebra::sparse::{CsrMatrix, scale_csr};
///
/// let m = CsrMatrix::new(
///     2, 2,
///     vec![0, 1, 2],
///     vec![0, 1],
///     vec![4.0_f64, 6.0],
/// )
/// .unwrap();
///
/// let scaled = scale_csr(m, 0.5);
/// assert_eq!(scaled.values(),      &[2.0, 3.0]);
/// assert_eq!(scaled.row_ptr(),     &[0, 1, 2]);
/// assert_eq!(scaled.col_indices(), &[0, 1]);
/// ```
pub fn scale_csr<T: Scalar>(m: CsrMatrix<T>, scalar: T) -> CsrMatrix<T> {
    if scalar == T::zero() {
        let (rows, cols, _, _, _) = m.into_raw_parts();
        return CsrMatrix::new_raw(rows, cols, vec![0; rows + 1], Vec::new(), Vec::new());
    }
    let (rows, cols, row_ptr, col_indices, values) = m.into_raw_parts();
    let scaled: Vec<T> = values.into_iter().map(|v| v.mul(scalar)).collect();
    CsrMatrix::new_raw(rows, cols, row_ptr, col_indices, scaled)
}

/// Multiplies every stored value of a CSC sparse matrix by `scalar`, returning a new matrix
/// with the same sparsity pattern and shape.
///
/// The `col_ptr` and `row_indices` arrays are preserved unchanged; only `values` changes.
///
/// # Examples
///
/// ```
/// use rustebra::sparse::{CscMatrix, scale_csc};
///
/// let m = CscMatrix::new(
///     2, 2,
///     vec![0, 1, 2],
///     vec![0, 1],
///     vec![4.0_f64, 6.0],
/// )
/// .unwrap();
///
/// let scaled = scale_csc(m, 0.5);
/// assert_eq!(scaled.values(),      &[2.0, 3.0]);
/// assert_eq!(scaled.col_ptr(),     &[0, 1, 2]);
/// assert_eq!(scaled.row_indices(), &[0, 1]);
/// ```
pub fn scale_csc<T: Scalar>(m: CscMatrix<T>, scalar: T) -> CscMatrix<T> {
    if scalar == T::zero() {
        let (rows, cols, _, _, _) = m.into_raw_parts();
        return CscMatrix::new_raw(rows, cols, vec![0; cols + 1], Vec::new(), Vec::new());
    }
    let (rows, cols, col_ptr, row_indices, values) = m.into_raw_parts();
    let scaled: Vec<T> = values.into_iter().map(|v| v.mul(scalar)).collect();
    CscMatrix::new_raw(rows, cols, col_ptr, row_indices, scaled)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn scale_csr_scales_values_and_preserves_structure() {
        let m = CsrMatrix::new(2, 2, vec![0, 1, 2], vec![0, 1], vec![4.0_f64, 6.0]).unwrap();
        let scaled = scale_csr(m, 0.5);
        assert_eq!(scaled.values(), &[2.0, 3.0]);
        assert_eq!(scaled.row_ptr(), &[0, 1, 2]);
        assert_eq!(scaled.col_indices(), &[0, 1]);
    }

    #[test]
    fn scale_csc_scales_values_and_preserves_structure() {
        let m = CscMatrix::new(2, 2, vec![0, 1, 2], vec![0, 1], vec![4.0_f64, 6.0]).unwrap();
        let scaled = scale_csc(m, 0.5);
        assert_eq!(scaled.values(), &[2.0, 3.0]);
        assert_eq!(scaled.col_ptr(), &[0, 1, 2]);
        assert_eq!(scaled.row_indices(), &[0, 1]);
    }

    #[test]
    fn scale_csc_by_zero() {
        let m = CscMatrix::new(
            3,
            3,
            vec![0, 1, 2, 3],
            vec![0, 1, 2],
            vec![1.0_f64, 2.0, 3.0],
        )
        .unwrap();
        let scaled = scale_csc(m, 0.0);
        assert_eq!(scaled.nnz(), 0);
        assert_eq!(scaled.values(), &[]);
    }

    #[test]
    fn scale_csc_negative_scalar() {
        let m = CscMatrix::new(2, 2, vec![0, 1, 2], vec![0, 1], vec![4.0_f64, 6.0]).unwrap();
        let scaled = scale_csc(m, -2.0);
        assert_eq!(scaled.values(), &[-8.0, -12.0]);
    }

    #[test]
    fn s3_scale_csr_by_zero() {
        let m = CsrMatrix::new(2, 2, vec![0, 1, 2], vec![0, 1], vec![3.0_f64, 7.0]).unwrap();
        let scaled = scale_csr(m, 0.0);
        assert_eq!(scaled.nnz(), 0);
    }

    #[test]
    fn s3_scale_csc_by_zero() {
        let m = CscMatrix::new(
            3,
            3,
            vec![0, 1, 2, 3],
            vec![0, 1, 2],
            vec![1.0_f64, 2.0, 3.0],
        )
        .unwrap();
        let scaled = scale_csc(m, 0.0);
        assert_eq!(scaled.nnz(), 0);
    }
}