graphblas_sparse_linear_algebra 0.62.0

Wrapper for SuiteSparse:GraphBLAS
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

use suitesparse_graphblas_sys::GxB_Matrix_isStoredElement;

use crate::collections::sparse_matrix::{
    ColumnIndex, GetCoordinateIndices, GetGraphblasSparseMatrix, RowIndex, SparseMatrix,
};
use crate::context::CallGraphBlasContext;
use crate::error::{
    GraphblasErrorType, LogicErrorType, SparseLinearAlgebraError, SparseLinearAlgebraErrorType,
};
use crate::index::IndexConversion;
use crate::value_type::ValueType;

pub trait IsSparseMatrixElement {
    fn is_element(
        &self,
        row_index: RowIndex,
        column_index: ColumnIndex,
    ) -> Result<bool, SparseLinearAlgebraError>;
    fn try_is_element(
        &self,
        row_index: RowIndex,
        column_index: ColumnIndex,
    ) -> Result<(), SparseLinearAlgebraError>;

    fn is_element_at_coordinate(
        &self,
        coordinate: &impl GetCoordinateIndices,
    ) -> Result<bool, SparseLinearAlgebraError>;
    fn try_is_element_at_coordinate(
        &self,
        coordinate: &impl GetCoordinateIndices,
    ) -> Result<(), SparseLinearAlgebraError>;
}

impl<T: ValueType> IsSparseMatrixElement for SparseMatrix<T> {
    fn is_element(
        &self,
        row_index: RowIndex,
        column_index: ColumnIndex,
    ) -> Result<bool, SparseLinearAlgebraError> {
        is_sparse_matrix_element(self, row_index, column_index)
    }

    fn try_is_element(
        &self,
        row_index: RowIndex,
        column_index: ColumnIndex,
    ) -> Result<(), SparseLinearAlgebraError> {
        try_is_sparse_matrix_element(self, row_index, column_index)
    }

    fn is_element_at_coordinate(
        &self,
        coordinate: &impl GetCoordinateIndices,
    ) -> Result<bool, SparseLinearAlgebraError> {
        is_sparse_matrix_element_at_coordinate(self, coordinate)
    }

    fn try_is_element_at_coordinate(
        &self,
        coordinate: &impl GetCoordinateIndices,
    ) -> Result<(), SparseLinearAlgebraError> {
        try_is_sparse_matrix_element_at_coordinate(self, coordinate)
    }
}

pub fn is_sparse_matrix_element(
    matrix: &impl GetGraphblasSparseMatrix,
    row_index: RowIndex,
    column_index: ColumnIndex,
) -> Result<bool, SparseLinearAlgebraError> {
    let row_index = row_index.as_graphblas_index()?;
    let column_index = column_index.as_graphblas_index()?;

    let result = matrix.context_ref().call(
        || unsafe {
            GxB_Matrix_isStoredElement(matrix.graphblas_matrix_ptr(), row_index, column_index)
        },
        unsafe { &matrix.graphblas_matrix_ptr() },
    );
    // println!("{:?}", result);
    match result {
        Ok(_) => Ok(true),
        Err(error) => match error.error_type() {
            SparseLinearAlgebraErrorType::LogicErrorType(LogicErrorType::GraphBlas(
                GraphblasErrorType::NoValue,
            )) => Ok(false),
            SparseLinearAlgebraErrorType::LogicErrorType(LogicErrorType::GraphBlas(
                GraphblasErrorType::IndexOutOfBounds,
            )) => Ok(false),
            SparseLinearAlgebraErrorType::LogicErrorType(LogicErrorType::GraphBlas(
                GraphblasErrorType::InvalidIndex,
            )) => Ok(false),
            _ => Err(error),
        },
    }
}

pub fn is_sparse_matrix_element_at_coordinate(
    matrix: &impl GetGraphblasSparseMatrix,
    coordinate: &impl GetCoordinateIndices,
) -> Result<bool, SparseLinearAlgebraError> {
    is_sparse_matrix_element(matrix, coordinate.row_index(), coordinate.column_index())
}

pub fn try_is_sparse_matrix_element(
    matrix: &impl GetGraphblasSparseMatrix,
    row_index: RowIndex,
    column_index: ColumnIndex,
) -> Result<(), SparseLinearAlgebraError> {
    let row_index = row_index.as_graphblas_index()?;
    let column_index = column_index.as_graphblas_index()?;

    let result = matrix.context_ref().call(
        || unsafe {
            GxB_Matrix_isStoredElement(matrix.graphblas_matrix_ptr(), row_index, column_index)
        },
        unsafe { &matrix.graphblas_matrix_ptr() },
    );
    match result {
        Ok(_) => Ok(()),
        Err(error) => Err(error),
    }
}

pub fn try_is_sparse_matrix_element_at_coordinate(
    matrix: &impl GetGraphblasSparseMatrix,
    coordinate: &impl GetCoordinateIndices,
) -> Result<(), SparseLinearAlgebraError> {
    try_is_sparse_matrix_element(matrix, coordinate.row_index(), coordinate.column_index())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        collections::sparse_matrix::{
            operations::SetSparseMatrixElement, ColumnIndex, Coordinate, MatrixElement, RowIndex,
            Size, SparseMatrix,
        },
        context::Context,
    };

    #[test]
    fn is_element_outside_matrix_size() {
        let context = Context::init_default().unwrap();

        let target_height: RowIndex = 10;
        let target_width: ColumnIndex = 5;
        let size = Size::new(target_height, target_width);

        let mut sparse_matrix = SparseMatrix::<i32>::new(context, size).unwrap();

        sparse_matrix
            .set_element(MatrixElement::from_triple(1, 2, 3))
            .unwrap();
        sparse_matrix
            .set_element(MatrixElement::from_triple(1, 4, 4))
            .unwrap();

        assert!(!sparse_matrix
            .is_element(target_height, target_width)
            .unwrap());
    }
}