Rustb 0.6.7

A package for calculating band, angle state, linear and nonlinear conductivities based on tight-binding models
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
//!这个模块是用来求解大矩阵的部分本征值的模块, 用的lapackc的 cheevx 等函数求解.
#[cfg(any(feature = "intel-mkl-system", feature = "intel-mkl-static"))]
extern crate intel_mkl_src as _src;

#[cfg(any(feature = "openblas-system", feature = "openblas-static"))]
extern crate openblas_src as _src;

#[cfg(any(feature = "netlib-system", feature = "netlib-static"))]
extern crate netlib_src as _src;

use lapack::{cheevx, zheev, zheevr, zheevr_2stage, zheevx};
use ndarray::{Array1, Array2, ArrayBase, Data, Ix2};
use ndarray_linalg::EigValsh;
use ndarray_linalg::UPLO;
use num_complex::Complex;
use std::ffi::c_char;

pub fn eigh_x<S>(
    x: &ArrayBase<S, Ix2>,
    range: (f64, f64),
    epsilon: f64,
    uplo: UPLO,
) -> (Array1<f64>, Array2<Complex<f64>>)
where
    S: Data<Elem = Complex<f64>>,
{
    // 获取矩阵的阶数
    let n = x.shape()[0] as i32;
    // 创建一个可变的副本,用于存储特征向量或被销毁
    let mut a: Vec<_> = x.iter().cloned().collect();
    // 创建一个可变的向量,用于存储特征值
    let mut w = vec![0.0; n as usize];
    // 创建一个可变的向量,用于存储特征向量
    let mut z = vec![Complex::new(0.0, 0.0); (n * n) as usize];
    // 创建一个可变的变量,用于存储特征值的个数
    let mut m = 0;
    // 创建一个可变的变量,用于存储函数的返回状态
    let mut info = 0;
    // 创建一个可变的向量,用于存储失败的特征值的索引
    let mut ifail = vec![0; n as usize];
    // 创建一个可变的向量,用于作为工作空间
    let mut work = vec![Complex::new(0.0, 0.0); (2 * n) as usize];
    // 创建一个可变的向量,用于作为实数工作空间
    let mut rwork = vec![0.0; (7 * n) as usize];
    // 创建一个可变的向量,用于作为整数工作空间
    let mut iwork = vec![0; (5 * n) as usize];
    // 调用 cheevx 函数,使用 'N' 表示不计算特征向量,使用 'V' 表示计算范围内的特征值,使用 'U' 表示输入的矩阵是上三角
    // Assuming range is a tuple like (f64, f64)
    let job1 = b'V';
    let job2 = b'V';
    let job3 = match uplo {
        UPLO::Upper => b'U',
        UPLO::Lower => b'L',
    };

    unsafe {
        zheevx(
            job1,
            job2,
            job3,
            n,
            &mut a,
            n,
            range.0,
            range.1,
            0,
            n,
            epsilon,
            &mut m,
            &mut w,
            &mut z,
            n,
            &mut work,
            2 * n,
            &mut rwork,
            &mut iwork,
            &mut ifail,
            &mut info,
        );
    }
    // 检查函数的返回状态,如果是 0,表示成功,否则表示有问题
    if info == 0 {
        // 将特征值向量转换为一维数组并返回
        (
            Array1::<f64>::from_vec(w.into_iter().take(m as usize).collect()),
            Array2::<Complex<f64>>::from_shape_vec(
                [m as usize, n as usize],
                z.into_iter().take((n * m) as usize).collect(),
            )
            .unwrap(),
        )
    } else {
        // 报告错误信息
        panic!("cheevx failed with info = {}", info);
    }
}

pub fn eigvalsh_x<S>(
    x: &ArrayBase<S, Ix2>,
    range: (f64, f64),
    epsilon: f64,
    uplo: UPLO,
) -> Array1<f64>
where
    S: Data<Elem = Complex<f64>>,
{
    // 获取矩阵的阶数
    let n = x.shape()[0] as i32;
    // 创建一个可变的副本,用于存储特征向量或被销毁
    let mut a: Vec<_> = x.iter().cloned().collect();
    // 创建一个可变的向量,用于存储特征值
    let mut w = vec![0.0; n as usize];
    // 创建一个可变的向量,用于存储特征向量
    let mut z = vec![Complex::new(0.0, 0.0); (n * n) as usize];
    // 创建一个可变的变量,用于存储特征值的个数
    let mut m = 0;
    // 创建一个可变的变量,用于存储函数的返回状态
    let mut info = 0;
    // 创建一个可变的向量,用于存储失败的特征值的索引
    let mut ifail = vec![0; n as usize];
    // 创建一个可变的向量,用于存储失败的特征值的索引
    let mut work = vec![Complex::new(0.0, 0.0); (2 * n) as usize];
    // 创建一个可变的向量,用于作为实数工作空间
    let mut rwork = vec![0.0; (7 * n) as usize];
    // 创建一个可变的向量,用于作为整数工作空间
    let mut iwork = vec![0; (5 * n) as usize];
    // 调用 cheevx 函数,使用 'N' 表示不计算特征向量,使用 'V' 表示计算范围内的特征值,使用 'U' 表示输入的矩阵是上三角
    // Assuming range is a tuple like (f64, f64)
    let job1 = b'N';
    let job2 = b'V';
    let job3 = match uplo {
        UPLO::Upper => b'U',
        UPLO::Lower => b'L',
    };

    unsafe {
        zheevx(
            job1,
            job2,
            job3,
            n,
            &mut a,
            n,
            range.0,
            range.1,
            0,
            n,
            epsilon,
            &mut m,
            &mut w,
            &mut z,
            n,
            &mut work,
            2 * n,
            &mut rwork,
            &mut iwork,
            &mut ifail,
            &mut info,
        );
    }
    // 检查函数的返回状态,如果是 0,表示成功,否则表示有问题
    if info == 0 {
        // 将特征值向量转换为一维数组并返回
        Array1::<f64>::from_vec(w.into_iter().take(m as usize).collect())
    } else {
        // 报告错误信息
        panic!("cheevx failed with info = {}", info);
    }
}

pub fn eigh_r<S>(
    x: &ArrayBase<S, Ix2>,
    range: (f64, f64),
    epsilon: f64,
    uplo: UPLO,
) -> (Array1<f64>, Array2<Complex<f64>>)
where
    S: Data<Elem = Complex<f64>>,
{
    let job1 = b'V';
    let job2 = b'V';
    let job3 = match uplo {
        UPLO::Upper => b'U',
        UPLO::Lower => b'L',
    };
    // 获取矩阵的阶数
    let n = x.shape()[0] as i32;
    // 创建一个可变的副本,用于存储特征向量或被销毁
    let mut a: Vec<_> = x.iter().cloned().collect();
    // 创建一个可变的向量,用于存储特征值
    let mut w = vec![0.0; n as usize];
    // 创建一个可变的向量,用于存储特征向量
    let mut z = vec![Complex::new(0.0, 0.0); (n * n) as usize];
    let mut isuppz = vec![0; 2 * n as usize];
    // 创建一个可变的变量,用于存储特征值的个数
    let mut m = 0;
    // 创建一个可变的变量,用于存储函数的返回状态
    let mut info = 0;
    /*
    // 创建一个可变的向量,用于作为工作空间
    let mut work = vec![Complex::new(0.0,0.0); 1 as usize];
    // 创建一个可变的向量,用于作为实数工作空间
    let mut rwork = vec![0.0; 1 as usize];
    // 创建一个可变的向量,用于作为整数工作空间
    let mut iwork = vec![0; 1 as usize];
    // 调用 cheevx 函数,使用 'N' 表示不计算特征向量,使用 'V' 表示计算范围内的特征值,使用 'U' 表示输入的矩阵是上三角
    // Assuming range is a tuple like (f64, f64)

    unsafe {
         zheevr(
            job1,
            job2,
            job3,
            n ,
            &mut a,
            n ,
            range.0,
            range.1,
            0 ,
            n ,
            epsilon ,
            &mut m,
            &mut w,
            &mut z,
            n ,
            &mut isuppz,
            &mut work,
            -1 ,
            &mut rwork,
            -1,
            &mut iwork,
            -1,
            &mut info,
        );
    }

    let lwork=work[0].re as i32;
    let liwork=iwork[0] as i32;
    let lrwork=rwork[0] as i32;
    */
    let lwork = n * 33 as i32;
    let liwork = n * 10 as i32;
    let lrwork = n * 24 as i32;
    let mut work = vec![Complex::new(0.0, 0.0); lwork as usize];
    // 创建一个可变的向量,用于作为实数工作空间
    let mut rwork = vec![0.0; lrwork as usize];
    // 创建一个可变的向量,用于作为整数工作空间
    let mut iwork = vec![0; liwork as usize];
    // 调用 cheevx 函数,使用 'N' 表示不计算特征向量,使用 'V' 表示计算范围内的特征值,使用 'U' 表示输入的矩阵是上三角

    unsafe {
        zheevr(
            job1,
            job2,
            job3,
            n,
            &mut a,
            n,
            range.0,
            range.1,
            0,
            n,
            epsilon,
            &mut m,
            &mut w,
            &mut z,
            n,
            &mut isuppz,
            &mut work,
            lwork,
            &mut rwork,
            lrwork,
            &mut iwork,
            liwork,
            &mut info,
        );
    }

    // 检查函数的返回状态,如果是 0,表示成功,否则表示有问题
    if info == 0 {
        // 将特征值向量转换为一维数组并返回
        (
            Array1::<f64>::from_vec(w.into_iter().take(m as usize).collect()),
            Array2::<Complex<f64>>::from_shape_vec(
                [m as usize, n as usize],
                z.into_iter().take((n * m) as usize).collect(),
            )
            .unwrap(),
        )
    } else {
        // 报告错误信息
        panic!("cheevx failed with info = {}", info);
    }
}

pub fn eigvalsh_r<S>(
    x: &ArrayBase<S, Ix2>,
    range: (f64, f64),
    epsilon: f64,
    uplo: UPLO,
) -> Array1<f64>
where
    S: Data<Elem = Complex<f64>>,
{
    // 获取矩阵的阶数
    let n = x.shape()[0] as i32;
    // 创建一个可变的副本,用于存储特征向量或被销毁
    let mut a: Vec<_> = x.iter().cloned().collect();
    // 创建一个可变的向量,用于存储特征值
    let mut w = vec![0.0; n as usize];
    // 创建一个可变的向量,用于存储特征向量
    let mut z = vec![Complex::new(0.0, 0.0); (n * n) as usize];
    let mut isuppz = vec![0; 2 * n as usize];
    // 创建一个可变的变量,用于存储特征值的个数
    let mut m = 0;
    // 创建一个可变的变量,用于存储函数的返回状态
    let mut info = 0;
    // 创建一个可变的向量,用于作为工作空间
    let mut work = vec![Complex::new(0.0, 0.0); 1 as usize];
    // 创建一个可变的向量,用于作为实数工作空间
    let mut rwork = vec![0.0; 1 as usize];
    // 创建一个可变的向量,用于作为整数工作空间
    let mut iwork = vec![0; 1 as usize];
    // 调用 cheevx 函数,使用 'N' 表示不计算特征向量,使用 'V' 表示计算范围内的特征值,使用 'U' 表示输入的矩阵是上三角
    // Assuming range is a tuple like (f64, f64)
    let job1 = b'N';
    let job2 = b'V';
    let job3 = match uplo {
        UPLO::Upper => b'U',
        UPLO::Lower => b'L',
    };

    unsafe {
        zheevr(
            job1,
            job2,
            job3,
            n,
            &mut a,
            n,
            range.0,
            range.1,
            0,
            n,
            epsilon,
            &mut m,
            &mut w,
            &mut z,
            n,
            &mut isuppz,
            &mut work,
            -1,
            &mut rwork,
            -1,
            &mut iwork,
            -1,
            &mut info,
        );
    }

    let lwork = work[0].re as i32;
    let liwork = iwork[0] as i32;
    let lrwork = rwork[0] as i32;
    let mut work = vec![Complex::new(0.0, 0.0); lwork as usize];
    // 创建一个可变的向量,用于作为实数工作空间
    let mut rwork = vec![0.0; lrwork as usize];
    // 创建一个可变的向量,用于作为整数工作空间
    let mut iwork = vec![0; liwork as usize];
    // 调用 cheevx 函数,使用 'N' 表示不计算特征向量,使用 'V' 表示计算范围内的特征值,使用 'U' 表示输入的矩阵是上三角

    unsafe {
        zheevr(
            job1,
            job2,
            job3,
            n,
            &mut a,
            n,
            range.0,
            range.1,
            0,
            n,
            epsilon,
            &mut m,
            &mut w,
            &mut z,
            n,
            &mut isuppz,
            &mut work,
            lwork,
            &mut rwork,
            lrwork,
            &mut iwork,
            liwork,
            &mut info,
        );
    }
    // 检查函数的返回状态,如果是 0,表示成功,否则表示有问题
    if info == 0 {
        // 将特征值向量转换为一维数组并返回
        Array1::<f64>::from_vec(w.into_iter().take(m as usize).collect())
    } else {
        // 报告错误信息
        panic!("cheevx failed with info = {}", info);
    }
}

pub fn eigvalsh_v<S>(x: &ArrayBase<S, Ix2>, uplo: UPLO) -> Array1<f64>
where
    S: Data<Elem = Complex<f64>>,
{
    // 获取矩阵的阶数
    let n = x.shape()[0] as i32;
    // 创建一个可变的副本,用于存储特征向量或被销毁
    let mut a: Vec<_> = x.iter().cloned().collect();
    // 创建一个可变的向量,用于存储特征值
    let mut w = vec![0.0; n as usize];
    // 创建一个可变的向量,用于存储特征向量
    let mut z = vec![Complex::new(0.0, 0.0); (n * n) as usize];
    let mut isuppz = vec![0; 2 * n as usize];
    // 创建一个可变的变量,用于存储特征值的个数
    let mut m = 0;
    // 创建一个可变的变量,用于存储函数的返回状态
    let mut info = 0;
    // 创建一个可变的向量,用于作为工作空间
    let mut work = vec![Complex::new(0.0, 0.0); 1 as usize];
    // 创建一个可变的向量,用于作为实数工作空间
    let mut rwork = vec![0.0; (3 * n - 2) as usize];
    // 创建一个可变的向量,用于作为整数工作空间
    let job1 = b'N';
    let job2 = match uplo {
        UPLO::Upper => b'U',
        UPLO::Lower => b'L',
    };

    unsafe {
        zheev(
            job1, job2, n, &mut a, n, &mut w, &mut work, -1, &mut rwork, &mut info,
        );
    }
    // 获取推荐的工作空间大小
    let lwork = work[0].re as i32;
    // 重新分配工作空间
    work = vec![Complex::new(0.0, 0.0); lwork as usize];

    // 第二次调用 zheev,实际计算特征值和特征向量
    unsafe {
        zheev(
            job1, job2, n, &mut a, n, &mut w, &mut work, lwork, &mut rwork, &mut info,
        );
    }
    // 检查函数的返回状态,如果是 0,表示成功,否则表示有问题
    if info == 0 {
        // 将特征值向量转换为一维数组并返回
        Array1::<f64>::from_vec(w.into_iter().collect())
    } else {
        // 报告错误信息
        panic!("zheev failed with info = {}", info);
    }
}