sundials 0.3.2

Suite of nonlinear and differential/algebraic equation 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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

use crate::check::check_is_success;
use crate::context::Context;
use crate::nvector::NVector;

use anyhow::Result;
use std::os::raw::c_int;
use std::slice::{from_raw_parts, from_raw_parts_mut};
use sundials_sys::{
    sunindextype, sunrealtype, SUNMatDestroy_Sparse, SUNMatMatvec_Sparse, SUNMatZero, SUNMatrix,
    SUNSparseMatrix, SUNSparseMatrix_Columns, SUNSparseMatrix_Data, SUNSparseMatrix_IndexPointers,
    SUNSparseMatrix_IndexValues, SUNSparseMatrix_NNZ, SUNSparseMatrix_Reallocate,
    SUNSparseMatrix_Rows, SUNSparseMatrix_SparseType,
};

pub enum SparseType {
    CSC = 0,
    CSR = 1,
}

pub struct SparseMatrix {
    pub(crate) sunmatrix: SUNMatrix,
    raw: bool,
}

impl SparseMatrix {
    pub fn new(
        m: impl Into<sunindextype>,
        n: impl Into<sunindextype>,
        nnz: impl Into<sunindextype>,
        sparse_type: SparseType,
        context: &Context,
    ) -> Self {
        Self {
            sunmatrix: unsafe {
                SUNSparseMatrix(
                    m.into(),
                    n.into(),
                    nnz.into(),
                    sparse_type as c_int,
                    context.sunctx,
                )
            },
            raw: false,
        }
    }

    pub fn from_raw(sunmatrix: SUNMatrix) -> Self {
        Self {
            sunmatrix,
            raw: true,
        }
    }

    pub fn rows(&self) -> usize {
        unsafe { SUNSparseMatrix_Rows(self.sunmatrix) as usize }
    }

    pub fn columns(&self) -> usize {
        unsafe { SUNSparseMatrix_Columns(self.sunmatrix) as usize }
    }

    pub fn nnz(&self) -> usize {
        unsafe { SUNSparseMatrix_NNZ(self.sunmatrix) as usize }
    }

    pub fn sparse_type(&self) -> SparseType {
        match unsafe { SUNSparseMatrix_SparseType(self.sunmatrix) } {
            0 => SparseType::CSC,
            1 => SparseType::CSR,
            t => {
                panic!("sparse matrix type ({}) must be CSC or CSR", t);
            }
        }
    }

    pub fn index_pointers(&self) -> &[sunindextype] {
        let indptr = unsafe { SUNSparseMatrix_IndexPointers(self.sunmatrix) };
        match self.sparse_type() {
            SparseType::CSC => {
                let columns = self.columns();
                unsafe { from_raw_parts(indptr, columns + 1) }
            }
            SparseType::CSR => {
                let rows = self.rows();
                unsafe { from_raw_parts(indptr, rows + 1) }
            }
        }
    }

    pub fn index_values(&self) -> &[sunindextype] {
        let indval = unsafe { SUNSparseMatrix_IndexValues(self.sunmatrix) };
        let nnz = self.nnz();
        unsafe { from_raw_parts(indval, nnz) }
    }

    pub fn data(&self) -> &[sunrealtype] {
        let indval = unsafe { SUNSparseMatrix_Data(self.sunmatrix) };
        let nnz = self.nnz();
        unsafe { from_raw_parts(indval, nnz) }
    }

    pub fn index_pointers_mut(&mut self) -> &mut [sunindextype] {
        let indptr = unsafe { SUNSparseMatrix_IndexPointers(self.sunmatrix) };
        match self.sparse_type() {
            SparseType::CSC => {
                let columns = self.columns();
                unsafe { from_raw_parts_mut(indptr, columns + 1) }
            }
            SparseType::CSR => {
                let rows = self.rows();
                unsafe { from_raw_parts_mut(indptr, rows + 1) }
            }
        }
    }

    pub fn index_values_mut(&mut self) -> &mut [sunindextype] {
        let indval = unsafe { SUNSparseMatrix_IndexValues(self.sunmatrix) };
        let nnz = self.nnz();
        unsafe { from_raw_parts_mut(indval, nnz) }
    }

    pub fn data_mut(&mut self) -> &mut [sunrealtype] {
        let data = unsafe { SUNSparseMatrix_Data(self.sunmatrix) };
        let nnz = self.nnz();
        unsafe { from_raw_parts_mut(data, nnz) }
    }

    pub fn index_pointers_values_data_mut(
        &mut self,
    ) -> (&mut [sunindextype], &mut [sunindextype], &mut [sunrealtype]) {
        let indptr = unsafe { SUNSparseMatrix_IndexPointers(self.sunmatrix) };
        let indptr = match self.sparse_type() {
            SparseType::CSC => {
                let columns = self.columns();
                unsafe { from_raw_parts_mut(indptr, columns + 1) }
            }
            SparseType::CSR => {
                let rows = self.rows();
                unsafe { from_raw_parts_mut(indptr, rows + 1) }
            }
        };

        let indval = unsafe { SUNSparseMatrix_IndexValues(self.sunmatrix) };
        let nnz = self.nnz();
        let indval = unsafe { from_raw_parts_mut(indval, nnz) };

        let data = unsafe { SUNSparseMatrix_Data(self.sunmatrix) };
        let nnz = self.nnz();
        let data = unsafe { from_raw_parts_mut(data, nnz) };

        (indptr, indval, data)
    }

    pub fn reallocate(&self, nnz: usize) -> Result<()> {
        let retval = unsafe { SUNSparseMatrix_Reallocate(self.sunmatrix, nnz as sunindextype) };
        check_is_success(retval, "SUNSparseMatrix_Reallocate")
    }

    pub fn mat_vec(&self, x: &NVector, y: &mut NVector) -> Result<()> {
        let retval = unsafe { SUNMatMatvec_Sparse(self.sunmatrix, x.n_vector, y.n_vector) };
        check_is_success(retval, "SUNMatMatvec_Sparse")
    }

    pub fn zero(&mut self) -> Result<()> {
        let retval = unsafe { SUNMatZero(self.sunmatrix) };
        check_is_success(retval, "SUNMatZero")
    }
}

impl Drop for SparseMatrix {
    fn drop(&mut self) {
        if !self.raw {
            unsafe { SUNMatDestroy_Sparse(self.sunmatrix) }
        }
    }
}