mdarray-linalg-lapack 0.1.2

LAPACK backend for mdarray-linalg
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
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
//! Eigenvalue Decomposition (EIG):
//!     A * v = λ * v (right eigenvectors)
//!     u^H * A = λ * u^H (left eigenvectors)
//! where:
//!     - A is n × n         (input square matrix)
//!     - λ are eigenvalues  (can be complex)
//!     - v are right eigenvectors
//!     - u are left eigenvectors
//!
//! For Hermitian/symmetric matrices (EIGH):
//!     A * v = λ * v
//! where:
//!     - A is n × n Hermitian/symmetric matrix
//!     - λ are real eigenvalues
//!     - v are orthonormal eigenvectors

use super::simple::{gees, gees_complex, geig, geigh};
use mdarray_linalg::{get_dims, into_i32, transpose_in_place};

use mdarray::{DSlice, Dense, Layout, tensor};

use super::scalar::{LapackScalar, NeedsRwork};
use mdarray_linalg::eig::{
    Eig, EigDecomp, EigError, EigResult, SchurDecomp, SchurError, SchurResult,
};
use num_complex::{Complex, ComplexFloat};
use num_traits::identities::Zero;

use crate::Lapack;

impl<T> Eig<T> for Lapack
where
    T: ComplexFloat + Default + LapackScalar + NeedsRwork<Elem = T>,
    i8: Into<T::Real>,
    T::Real: Into<T>,
{
    /// Compute eigenvalues and right eigenvectors with new allocated matrices
    fn eig<L: Layout>(&self, a: &mut DSlice<T, 2, L>) -> EigResult<T>
    where
        T: ComplexFloat,
    {
        let (m, n) = get_dims!(a);
        if m != n {
            return Err(EigError::NotSquareMatrix);
        }

        let x = T::default();

        let mut eigenvalues_real = tensor![[T::default(); n as usize]; 1];
        let mut eigenvalues_imag = tensor![[T::default(); n as usize]; 1];
        let mut eigenvalues = tensor![[Complex::new(x.re(), x.re()); n as usize]; 1];

        let mut right_eigenvectors_tmp = tensor![[T::default();n as usize]; n as usize];
        let mut right_eigenvectors = tensor![[Complex::new(x.re(), x.re());n as usize]; n as usize];

        match geig::<L, Dense, Dense, Dense, Dense, T>(
            a,
            &mut eigenvalues_real,
            &mut eigenvalues_imag,
            None, // no left eigenvectors
            Some(&mut right_eigenvectors_tmp),
        ) {
            Ok(_) => {
                for i in 0..(n as usize) {
                    eigenvalues[[0, i]] = if !eigenvalues_real[[0, i]].im().is_zero() {
                        Complex::new(eigenvalues_real[[0, i]].re(), eigenvalues_real[[0, i]].im())
                    } else {
                        Complex::new(eigenvalues_real[[0, i]].re(), eigenvalues_imag[[0, i]].re())
                    }
                }
                let mut j = 0_usize;
                while j < n as usize {
                    let imag = eigenvalues_imag[[0, j]];
                    if imag == T::default() {
                        for i in 0..(n as usize) {
                            let re = right_eigenvectors_tmp[[i, j]];
                            right_eigenvectors[[i, j]] = Complex::new(re.re(), re.im());
                        }
                        j += 1;
                    } else {
                        for i in 0..(n as usize) {
                            let re = right_eigenvectors_tmp[[i, j]];
                            let im = right_eigenvectors_tmp[[i, j + 1]];
                            right_eigenvectors[[i, j]] = Complex::new(re.re(), im.re()); // v = Re + i Im
                            right_eigenvectors[[i, j + 1]] =
                                ComplexFloat::conj(Complex::new(re.re(), im.re())); // v̄ = Re - i Im
                        }
                        j += 2;
                    }
                }

                Ok(EigDecomp {
                    eigenvalues,
                    left_eigenvectors: None,
                    right_eigenvectors: Some(right_eigenvectors),
                })
            }
            Err(e) => Err(e),
        }
    }

    /// Compute eigenvalues and both left/right eigenvectors with new allocated matrices
    fn eig_full<L: Layout>(&self, _a: &mut DSlice<T, 2, L>) -> EigResult<T> {
        todo!(); // fix bug in complex case
        // let (m, n) = get_dims!(a);
        // if m != n {
        //     return Err(EigError::NotSquareMatrix);
        // }

        // let x = T::default();

        // let mut eigenvalues_real = tensor![[T::default(); n as usize]; 1];
        // let mut eigenvalues_imag = tensor![[T::default(); n as usize]; 1];
        // let mut eigenvalues = tensor![[Complex::new(x.re(), x.re()); n as usize]; 1];

        // let mut left_eigenvectors_tmp = tensor![[T::default(); n as usize]; n as usize];
        // let mut right_eigenvectors_tmp = tensor![[T::default(); n as usize]; n as usize];

        // let x = T::default();
        // let mut left_eigenvectors = tensor![[Complex::new(x.re(), x.re()); n as usize]; n as usize];
        // let mut right_eigenvectors =
        //     tensor![[Complex::new(x.re(), x.re()); n as usize]; n as usize];

        // match geig(
        //     a,
        //     &mut eigenvalues_real,
        //     &mut eigenvalues_imag,
        //     Some(&mut left_eigenvectors_tmp),
        //     Some(&mut right_eigenvectors_tmp),
        // ) {
        //     Ok(_) => {
        //         for i in 0..(n as usize) {
        //             eigenvalues[[0, i]] =
        //                 Complex::new(eigenvalues_real[[0, i]].re(), eigenvalues_imag[[0, i]].re());
        //         }

        //         // Process right eigenvectors
        //         let mut j = 0_usize;
        //         while j < n as usize {
        //             let imag = eigenvalues_imag[[0, j]];
        //             if imag == T::default() {
        //                 // Real eigenvalue
        //                 for i in 0..(n as usize) {
        //                     let re_right = right_eigenvectors_tmp[[i, j]];
        //                     let re_left = left_eigenvectors_tmp[[i, j]];
        //                     right_eigenvectors[[i, j]] = Complex::new(re_right.re(), re_right.im());
        //                     left_eigenvectors[[i, j]] = Complex::new(re_left.re(), re_left.im());
        //                 }
        //                 j += 1;
        //             } else {
        //                 // Complex conjugate pair
        //                 for i in 0..(n as usize) {
        //                     let re_right = right_eigenvectors_tmp[[i, j]];
        //                     let im_right = right_eigenvectors_tmp[[i, j + 1]];
        //                     let re_left = left_eigenvectors_tmp[[i, j]];
        //                     let im_left = left_eigenvectors_tmp[[i, j + 1]];

        //                     right_eigenvectors[[i, j]] = Complex::new(re_right.re(), im_right.re());
        //                     right_eigenvectors[[i, j + 1]] =
        //                         ComplexFloat::conj(Complex::new(re_right.re(), im_right.re()));

        //                     left_eigenvectors[[i, j]] = Complex::new(re_left.re(), im_left.re());
        //                     left_eigenvectors[[i, j + 1]] =
        //                         ComplexFloat::conj(Complex::new(re_left.re(), im_left.re()));
        //                 }
        //                 j += 2;
        //             }
        //         }

        //         Ok(EigDecomp {
        //             eigenvalues,
        //             left_eigenvectors: Some(left_eigenvectors),
        //             right_eigenvectors: Some(right_eigenvectors),
        //         })
        //     }
        //     Err(e) => Err(e),
        // }
    }

    /// Compute only eigenvalues with new allocated vectors
    fn eig_values<L: Layout>(&self, a: &mut DSlice<T, 2, L>) -> EigResult<T> {
        let (m, n) = get_dims!(a);
        if m != n {
            return Err(EigError::NotSquareMatrix);
        }
        let x = T::default();

        let mut eigenvalues_real = tensor![[T::default(); n as usize]; 1];
        let mut eigenvalues_imag = tensor![[T::default(); n as usize]; 1];
        let mut eigenvalues = tensor![[Complex::new(x.re(), x.re()); n as usize]; 1];

        match geig::<L, Dense, Dense, Dense, Dense, T>(
            a,
            &mut eigenvalues_real,
            &mut eigenvalues_imag,
            None,
            None,
        ) {
            Ok(_) => {
                for i in 0..(n as usize) {
                    eigenvalues[[0, i]] =
                        Complex::new(eigenvalues_real[[0, i]].re(), eigenvalues_imag[[0, i]].re());
                }

                Ok(EigDecomp {
                    eigenvalues,
                    left_eigenvectors: None,
                    right_eigenvectors: None,
                })
            }
            Err(e) => Err(e),
        }
    }

    /// Compute eigenvalues and eigenvectors of a Hermitian matrix
    fn eigh<L: Layout>(&self, a: &mut DSlice<T, 2, L>) -> EigResult<T> {
        let (m, n) = get_dims!(a);
        if m != n {
            return Err(EigError::NotSquareMatrix);
        }

        let x = T::default();

        let mut eigenvalues_real = tensor![[T::default(); n as usize]; 1];
        let mut eigenvalues = tensor![[Complex::new(x.re(), x.re()); n as usize]; 1];
        // let mut eigenvalues = tensor![[x.re()]; 1];

        let mut right_eigenvectors_tmp = tensor![[T::default(); n as usize]; n as usize];

        let x = T::default();
        let mut right_eigenvectors =
            tensor![[Complex::new(x.re(), x.re()); n as usize]; n as usize];

        match geigh(a, &mut eigenvalues_real, &mut right_eigenvectors_tmp) {
            Ok(_) => {
                println!("{}", n / 2);
                for i in 0..((n / 2 + 1) as usize) {
                    eigenvalues[[0, 2 * i]] = Complex::new(eigenvalues_real[[0, i]].re(), x.re());
                    if 2 * i + 1 < n as usize {
                        eigenvalues[[0, 2 * i + 1]] =
                            Complex::new(eigenvalues_real[[0, i]].im(), x.re());
                    }
                }

                for j in 0..(n as usize) {
                    for i in 0..(n as usize) {
                        let re = a[[j, i]];
                        right_eigenvectors[[i, j]] = Complex::new(re.re(), re.im());
                    }
                }

                Ok(EigDecomp {
                    eigenvalues,
                    left_eigenvectors: None,
                    right_eigenvectors: Some(right_eigenvectors),
                })
            }
            Err(e) => Err(e),
        }
    }

    /// Compute eigenvalues and eigenvectors of a Hermitian matrix
    fn eigs<L: Layout>(&self, a: &mut DSlice<T, 2, L>) -> EigResult<T> {
        let (m, n) = get_dims!(a);
        if m != n {
            return Err(EigError::NotSquareMatrix);
        }

        let x = T::default();

        let mut eigenvalues_real = tensor![[T::default(); n as usize]; 1];
        let mut eigenvalues = tensor![[Complex::new(x.re(), x.re()); n as usize]; 1];
        // let mut eigenvalues = tensor![[x.re()]; 1];

        let mut right_eigenvectors_tmp = tensor![[T::default(); n as usize]; n as usize];

        let x = T::default();
        let mut right_eigenvectors =
            tensor![[Complex::new(x.re(), x.re()); n as usize]; n as usize];

        match geigh(a, &mut eigenvalues_real, &mut right_eigenvectors_tmp) {
            Ok(_) => {
                for i in 0..n as usize {
                    eigenvalues[[0, i]] = Complex::new(eigenvalues_real[[0, i]].re(), x.re());
                }

                for j in 0..(n as usize) {
                    for i in 0..(n as usize) {
                        let re = a[[j, i]];
                        right_eigenvectors[[i, j]] = Complex::new(re.re(), re.im());
                    }
                }

                Ok(EigDecomp {
                    eigenvalues,
                    left_eigenvectors: None,
                    right_eigenvectors: Some(right_eigenvectors),
                })
            }
            Err(e) => Err(e),
        }
    }

    /// Compute Schur decomposition with new allocated matrices
    fn schur<L: Layout>(&self, a: &mut DSlice<T, 2, L>) -> SchurResult<T> {
        let (m, n) = get_dims!(a);
        if m != n {
            return Err(SchurError::NotSquareMatrix);
        }

        let mut eigenvalues_real = tensor![[T::default(); n as usize]; 1];
        let mut eigenvalues_imag = tensor![[T::default(); n as usize]; 1];
        let mut schur_vectors = tensor![[T::default(); n as usize]; n as usize];

        match gees::<L, Dense, Dense, Dense, T>(
            a,
            &mut eigenvalues_real,
            &mut eigenvalues_imag,
            &mut schur_vectors,
        ) {
            Ok(_) => {
                let mut t = tensor![[T::default(); n as usize]; n as usize];
                for j in 0..(n as usize) {
                    for i in 0..(n as usize) {
                        t[[i, j]] = a[[j, i]];
                    }
                }

                transpose_in_place(&mut schur_vectors);

                Ok(SchurDecomp {
                    t,
                    z: schur_vectors,
                })
            }
            Err(e) => Err(e),
        }
    }

    /// Compute Schur decomposition overwriting existing matrices
    fn schur_overwrite<L: Layout>(
        &self,
        a: &mut DSlice<T, 2, L>,
        t: &mut DSlice<T, 2, Dense>,
        z: &mut DSlice<T, 2, Dense>,
    ) -> Result<(), SchurError> {
        let (m, n) = get_dims!(a);
        if m != n {
            return Err(SchurError::NotSquareMatrix);
        }

        for j in 0..(n as usize) {
            for i in 0..(n as usize) {
                t[[i, j]] = a[[i, j]];
            }
        }

        let mut eigenvalues_real = tensor![[T::default(); n as usize]; 1];
        let mut eigenvalues_imag = tensor![[T::default(); n as usize]; 1];

        let result = gees::<Dense, Dense, Dense, Dense, T>(
            t,
            &mut eigenvalues_real,
            &mut eigenvalues_imag,
            z,
        );
        transpose_in_place(z);
        transpose_in_place(t);
        result
    }

    /// Compute Schur (complex) decomposition with new allocated matrices
    fn schur_complex<L: Layout>(&self, a: &mut DSlice<T, 2, L>) -> SchurResult<T> {
        let (m, n) = get_dims!(a);
        if m != n {
            return Err(SchurError::NotSquareMatrix);
        }

        let mut eigenvalues = tensor![T::default(); n as usize];
        let mut schur_vectors = tensor![[T::default(); n as usize]; n as usize];

        match gees_complex::<L, Dense, Dense, T>(a, &mut eigenvalues, &mut schur_vectors) {
            Ok(_) => {
                let mut t = tensor![[T::default(); n as usize]; n as usize];
                for j in 0..(n as usize) {
                    for i in 0..(n as usize) {
                        t[[i, j]] = a[[j, i]];
                    }
                }

                transpose_in_place(&mut schur_vectors);

                Ok(SchurDecomp {
                    t,
                    z: schur_vectors,
                })
            }
            Err(e) => Err(e),
        }
    }

    /// Compute Schur (complex) decomposition overwriting existing matrices
    fn schur_complex_overwrite<L: Layout>(
        &self,
        a: &mut DSlice<T, 2, L>,
        t: &mut DSlice<T, 2, Dense>,
        z: &mut DSlice<T, 2, Dense>,
    ) -> Result<(), SchurError> {
        let (m, n) = get_dims!(a);
        if m != n {
            return Err(SchurError::NotSquareMatrix);
        }

        for j in 0..(n as usize) {
            for i in 0..(n as usize) {
                t[[i, j]] = a[[i, j]];
            }
        }

        let mut eigenvalues = tensor![T::default(); n as usize];
        let result = gees_complex::<Dense, Dense, Dense, T>(t, &mut eigenvalues, z);

        transpose_in_place(z);
        transpose_in_place(t);

        result
    }
}