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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
use suitesparse_graphblas_sys::GrB_Descriptor;

use super::{
    graphblas_descriptor, GetClearOutputBeforeUse, GetGraphblasDescriptor, GetOperatorMaskOptions,
    GetOperatorOptions, GetTransposeArguments, WithTransposeArguments,
};

// Implemented methods do not provide mutable access to GraphBLAS operators or options.
// Code review must consider that no mtable access is provided.
// https://doc.rust-lang.org/nomicon/send-and-sync.html
unsafe impl Send for OptionsForOperatorWithMatrixArguments {}
unsafe impl Sync for OptionsForOperatorWithMatrixArguments {}

#[derive(Debug, Clone)]
pub struct OptionsForOperatorWithMatrixArguments {
    clear_output_before_use: bool,
    use_mask_structure_of_stored_values_as_mask: bool,
    use_mask_complement: bool,
    transpose_first_argument: bool,
    transpose_second_argument: bool,

    graphblas_descriptor: GrB_Descriptor,
}

pub trait GetOptionsForOperatorWithMatrixArguments:
    GetOperatorOptions + GetTransposeArguments
{
}

impl GetOperatorOptions for OptionsForOperatorWithMatrixArguments {}
impl GetOptionsForOperatorWithMatrixArguments for OptionsForOperatorWithMatrixArguments {}

impl GetClearOutputBeforeUse for OptionsForOperatorWithMatrixArguments {
    fn clear_output_before_use(&self) -> bool {
        self.clear_output_before_use
    }
}

impl GetOperatorMaskOptions for OptionsForOperatorWithMatrixArguments {
    fn use_mask_structure_of_stored_values_as_mask(&self) -> bool {
        self.use_mask_structure_of_stored_values_as_mask
    }

    fn use_mask_complement(&self) -> bool {
        self.use_mask_complement
    }
}

impl GetTransposeArguments for OptionsForOperatorWithMatrixArguments {
    fn transpose_first_argument(&self) -> bool {
        self.transpose_first_argument
    }

    fn transpose_second_argument(&self) -> bool {
        self.transpose_second_argument
    }
}

impl GetGraphblasDescriptor for OptionsForOperatorWithMatrixArguments {
    fn graphblas_descriptor(&self) -> GrB_Descriptor {
        self.graphblas_descriptor
    }
}

impl WithTransposeArguments for OptionsForOperatorWithMatrixArguments {
    fn with_negated_transpose_first_argument(&self) -> Self {
        OptionsForOperatorWithMatrixArguments::new(
            self.clear_output_before_use,
            self.use_mask_structure_of_stored_values_as_mask,
            self.use_mask_complement,
            !self.transpose_first_argument,
            self.transpose_second_argument,
        )
    }

    fn with_negated_transpose_second_argument(&self) -> Self {
        OptionsForOperatorWithMatrixArguments::new(
            self.clear_output_before_use,
            self.use_mask_structure_of_stored_values_as_mask,
            self.use_mask_complement,
            self.transpose_first_argument,
            !self.transpose_second_argument,
        )
    }

    fn with_transpose_first_argument(&self, transpose_first_argument: bool) -> Self {
        if transpose_first_argument == self.transpose_first_argument {
            self.clone()
        } else {
            OptionsForOperatorWithMatrixArguments::new(
                self.clear_output_before_use,
                self.use_mask_structure_of_stored_values_as_mask,
                self.use_mask_complement,
                transpose_first_argument,
                self.transpose_second_argument,
            )
        }
    }

    fn with_transpose_second_argument(&self, transpose_second_argument: bool) -> Self {
        if transpose_second_argument == self.transpose_second_argument {
            self.clone()
        } else {
            OptionsForOperatorWithMatrixArguments::new(
                self.clear_output_before_use,
                self.use_mask_structure_of_stored_values_as_mask,
                self.use_mask_complement,
                self.transpose_first_argument,
                transpose_second_argument,
            )
        }
    }

    fn with_transpose_matrix_arguments(
        &self,
        transpose_first_argument: bool,
        transpose_second_argument: bool,
    ) -> Self {
        if transpose_first_argument == self.transpose_first_argument
            && transpose_second_argument == self.transpose_second_argument
        {
            self.clone()
        } else {
            OptionsForOperatorWithMatrixArguments::new(
                self.clear_output_before_use,
                self.use_mask_structure_of_stored_values_as_mask,
                self.use_mask_complement,
                transpose_first_argument,
                transpose_second_argument,
            )
        }
    }
}

impl OptionsForOperatorWithMatrixArguments {
    pub fn new(
        clear_output_before_use: bool,
        use_mask_structure_of_stored_values_as_mask: bool,
        use_mask_complement: bool,
        transpose_first_argument: bool,
        transpose_second_argument: bool,
    ) -> Self {
        Self {
            clear_output_before_use,
            use_mask_structure_of_stored_values_as_mask,
            use_mask_complement,
            transpose_first_argument,
            transpose_second_argument,

            graphblas_descriptor: graphblas_descriptor(
                clear_output_before_use,
                false,
                false,
                transpose_first_argument,
                transpose_second_argument,
            ),
        }
    }

    pub fn new_default() -> Self {
        let use_mask_structure_of_stored_values_as_mask = false;
        let use_mask_complement = false;
        let transpose_first_argument = false;
        let transpose_second_argument = false;
        let clear_output_before_use = false;

        Self {
            clear_output_before_use,
            use_mask_structure_of_stored_values_as_mask,
            use_mask_complement,
            transpose_first_argument,
            transpose_second_argument,

            graphblas_descriptor: graphblas_descriptor(
                clear_output_before_use,
                false,
                false,
                transpose_first_argument,
                transpose_second_argument,
            ),
        }
    }
}

#[cfg(test)]
mod tests {
    use std::ptr;

    use super::*;

    #[test]
    fn test_options() {
        let default_options = OptionsForOperatorWithMatrixArguments::new_default();
        let expected_value: GrB_Descriptor = ptr::null_mut();
        assert_eq!(default_options.graphblas_descriptor(), expected_value)
    }
}