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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
use crate::{Entity, MatMut, MatRef};
use assert2::{assert, debug_assert};
use core::mem::MaybeUninit;
use reborrow::*;
use seal::Seal;

mod seal {
    pub trait Seal {}
}

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum Diag {
    /// Do not include diagonal of matrix
    Skip,
    /// Include diagonal of matrix
    Include,
}

pub struct Read<'a, E: Entity> {
    ptr: E::Group<&'a MaybeUninit<E::Unit>>,
}
pub struct ReadWrite<'a, E: Entity> {
    ptr: E::Group<&'a mut MaybeUninit<E::Unit>>,
}

impl<E: Entity> Read<'_, E> {
    #[inline(always)]
    pub fn read(&self) -> E {
        E::from_units(E::map(
            E::as_ref(&self.ptr),
            #[inline(always)]
            |ptr| unsafe { ptr.assume_init_read() },
        ))
    }
}

impl<E: Entity> ReadWrite<'_, E> {
    #[inline(always)]
    pub fn read(&self) -> E {
        E::from_units(E::map(
            E::as_ref(&self.ptr),
            #[inline(always)]
            |ptr| unsafe { ptr.assume_init_ref().clone() },
        ))
    }

    #[inline(always)]
    pub fn write(&mut self, value: E) {
        let value = E::into_units(value);
        E::map(
            E::zip(E::as_mut(&mut self.ptr), value),
            #[inline(always)]
            |(ptr, value)| unsafe { *ptr.assume_init_mut() = value },
        );
    }
}

pub trait Mat<'short, Outlives = &'short Self>: Seal {
    type Item;
    type RawSlice;

    fn transpose(self) -> Self;
    fn reverse_rows(self) -> Self;
    fn reverse_cols(self) -> Self;
    fn nrows(&self) -> usize;
    fn ncols(&self) -> usize;
    fn row_stride(&self) -> isize;
    fn col_stride(&self) -> isize;
    unsafe fn get(&'short mut self, i: usize, j: usize) -> Self::Item;
    unsafe fn get_column_slice(
        &'short mut self,
        i: usize,
        j: usize,
        n_elems: usize,
    ) -> Self::RawSlice;

    // this is a bad api since it needs to extend the lifetime of slice, but this is somewhat fine
    // since we only use it internally in this module
    unsafe fn get_slice_elem(slice: &mut Self::RawSlice, idx: usize) -> Self::Item;
}

impl<'a, E: Entity> Seal for MatRef<'a, E> {}
impl<'a, 'short, E: Entity> Mat<'short> for MatRef<'a, E> {
    type Item = Read<'short, E>;
    type RawSlice = E::Group<&'a [MaybeUninit<E::Unit>]>;

    #[inline(always)]
    fn transpose(self) -> Self {
        self.transpose()
    }
    #[inline(always)]
    fn reverse_rows(self) -> Self {
        self.reverse_rows()
    }
    #[inline(always)]
    fn reverse_cols(self) -> Self {
        self.reverse_cols()
    }

    #[inline(always)]
    fn nrows(&self) -> usize {
        (*self).nrows()
    }

    #[inline(always)]
    fn ncols(&self) -> usize {
        (*self).ncols()
    }

    #[inline(always)]
    fn row_stride(&self) -> isize {
        (*self).row_stride()
    }

    #[inline(always)]
    fn col_stride(&self) -> isize {
        (*self).col_stride()
    }

    #[inline(always)]
    unsafe fn get(&mut self, i: usize, j: usize) -> Self::Item {
        Read {
            ptr: E::map(
                self.ptr_inbounds_at(i, j),
                #[inline(always)]
                |ptr| &*(ptr as *const MaybeUninit<E::Unit>),
            ),
        }
    }

    #[inline(always)]
    unsafe fn get_column_slice(&mut self, i: usize, j: usize, n_elems: usize) -> Self::RawSlice {
        E::map(
            self.ptr_at(i, j),
            #[inline(always)]
            |ptr| core::slice::from_raw_parts(ptr as *const MaybeUninit<E::Unit>, n_elems),
        )
    }

    #[inline(always)]
    unsafe fn get_slice_elem(slice: &mut Self::RawSlice, idx: usize) -> Self::Item {
        Read {
            ptr: E::map(
                E::as_mut(slice),
                #[inline(always)]
                |slice| slice.get_unchecked(idx),
            ),
        }
    }
}

impl<'a, E: Entity> Seal for MatMut<'a, E> {}
impl<'a, 'short, E: Entity> Mat<'short> for MatMut<'a, E> {
    type Item = ReadWrite<'short, E>;
    type RawSlice = E::Group<&'a mut [MaybeUninit<E::Unit>]>;

    #[inline(always)]
    fn transpose(self) -> Self {
        self.transpose()
    }
    #[inline(always)]
    fn reverse_rows(self) -> Self {
        self.reverse_rows()
    }
    #[inline(always)]
    fn reverse_cols(self) -> Self {
        self.reverse_cols()
    }

    #[inline(always)]
    fn nrows(&self) -> usize {
        (*self).nrows()
    }

    #[inline(always)]
    fn ncols(&self) -> usize {
        (*self).ncols()
    }

    #[inline(always)]
    fn row_stride(&self) -> isize {
        (*self).row_stride()
    }

    #[inline(always)]
    fn col_stride(&self) -> isize {
        (*self).col_stride()
    }

    #[inline(always)]
    unsafe fn get(&mut self, i: usize, j: usize) -> Self::Item {
        ReadWrite {
            ptr: E::map(
                self.rb_mut().ptr_inbounds_at(i, j),
                #[inline(always)]
                |ptr| &mut *(ptr as *mut MaybeUninit<E::Unit>),
            ),
        }
    }

    #[inline(always)]
    unsafe fn get_column_slice(&mut self, i: usize, j: usize, n_elems: usize) -> Self::RawSlice {
        E::map(
            self.rb_mut().ptr_at(i, j),
            #[inline(always)]
            |ptr| core::slice::from_raw_parts_mut(ptr as *mut MaybeUninit<E::Unit>, n_elems),
        )
    }

    #[inline(always)]
    unsafe fn get_slice_elem(slice: &mut Self::RawSlice, idx: usize) -> Self::Item {
        ReadWrite {
            ptr: E::map(
                E::as_mut(slice),
                #[inline(always)]
                |slice| &mut *(slice.get_unchecked_mut(idx) as *mut _),
            ),
        }
    }
}

pub struct Zip<Tuple> {
    pub(crate) tuple: Tuple,
}

include!(concat!(env!("OUT_DIR"), "/zip.rs"));

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{zipped, ComplexField, Mat};
    use assert2::assert;

    #[test]
    fn test_zip() {
        for (m, n) in [(2, 2), (4, 2), (2, 4)] {
            for rev_dst in [false, true] {
                for rev_src in [false, true] {
                    for transpose_dst in [false, true] {
                        for transpose_src in [false, true] {
                            for diag in [Diag::Include, Diag::Skip] {
                                let mut dst = Mat::with_dims(
                                    if transpose_dst { n } else { m },
                                    if transpose_dst { m } else { n },
                                    |_, _| f64::zero(),
                                );
                                let src = Mat::with_dims(
                                    if transpose_src { n } else { m },
                                    if transpose_src { m } else { n },
                                    |_, _| f64::one(),
                                );

                                let mut target = Mat::with_dims(m, n, |_, _| f64::zero());
                                let target_src = Mat::with_dims(m, n, |_, _| f64::one());

                                zipped!(target.as_mut(), target_src.as_ref())
                                    .for_each_triangular_lower(diag, |mut dst, src| {
                                        dst.write(src.read())
                                    });

                                let mut dst = dst.as_mut();
                                let mut src = src.as_ref();

                                if transpose_dst {
                                    dst = dst.transpose();
                                }
                                if rev_dst {
                                    dst = dst.reverse_rows();
                                }

                                if transpose_src {
                                    src = src.transpose();
                                }
                                if rev_src {
                                    src = src.reverse_rows();
                                }

                                zipped!(dst.rb_mut(), src)
                                    .for_each_triangular_lower(diag, |mut dst, src| {
                                        dst.write(src.read())
                                    });

                                assert!(dst.rb() == target.as_ref());
                            }
                        }
                    }
                }
            }
        }
    }
}