pfapack 0.2.0

Rust interface for the pfapack library, a Fortran library to compute Pfaffians.
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

use crate::{c_char, c32, c64};

///  Single precision real
/// # Arguments
///
/// * __*`uplo`*__ - (input)
///         > 'U':  Upper triangle of A is stored;
///         > 'L':  Lower triangle of A is stored.
/// * __*`mode`*__ - (input)
///         > 'N':  A is fully tridiagonalized
///         > 'P':  A is partially tridiagonalized for Pfaffian computation
///         > (details see below)
/// * __*`n`*__ - (input) The order of the matrix A. `n >= 0`. `n` must be
/// even if `mode = 'P'`.
/// * __*`a`*__ - (input/output) dimension (LDA,N). On entry, the skew-symmetric
/// matrix A.
///     > If `uplo = 'U'`, the leading N-by-N upper triangular part
///     > of A contains the upper triangular part of the matrix A,
///     > and the strictly lower triangular part of A is not referenced.
///
///     > If `uplo = 'L'`, the leading N-by-N lower triangular part
///     > of A contains the lower triangular part of the matrix A,
///     > and the strictly upper triangular part of A is not referenced.
///
///     On exit, if `mode = 'N'`:
///     > If UPLO = 'U', the diagonal and first superdiagonal
///     > of A are overwritten by the corresponding elements of the
///     > tridiagonal matrix T, and the elements above the first
///     > superdiagonal, with the array TAU, represent the unitary
///     > matrix Q as a product of elementary reflectors;
///     > If `uplo = 'L'`, the diagonal and first subdiagonal of A are over-
///     > written by the corresponding elements of the tridiagonal
///     > matrix T, and the elements below the first subdiagonal, with
///     > the array TAU, represent the unitary matrix Q as a product
///     > of elementary reflectors.
///     See Further Details, also for information about `mode = 'P'`.
/// * __*`lda`*__ - (input) The leading dimension of the array A.
/// `lda >= max(1,N)`.
/// * __*`e`*__ - (output) dimension (N-1). The off-diagonal elements of the
/// tridiagonal matrix T:
///     > If `uplo = 'U'`, `e[i] = a[i,i+1]`.
///
///     > If `uplo = 'L'`, `e[i] = a[i+1,i]`.
///     > If `mode = 'P'`, only the entries at i odd are well-defined
///     > (see Further Details).
/// * __*`tau`*__ - (output) dimension (N-1). The scalar factors of the
/// elementary reflectors (see Further Details).
/// * __*`work`*__ - (workspace/output) dimension (MAX(1,LWORK)). On exit, if
/// `info = 0`, `work[0]` returns the optimal `lwork`.
/// * __*`lwork`*__ - (input) The dimension of the array `work`. `lwork >= 1`.
/// For optimum performance LWORK >= N*NB, where NB is the optimal blocksize.
/// If `lwork = -1`, then a workspace query is assumed; the routine
/// only calculates the optimal size of the `work` array, returns
/// this value as the first entry of the `work` array, and no error
/// message related to `lwork` is issued by XERBLA.
/// * __*`info`*__ - (output) If `info`
/// > = 0:  successful exit
///
/// > < 0:  if INFO = -i, the i-th argument had an illegal value
#[inline]
pub unsafe fn ssktrd(
    uplo: u8,
    mode: u8,
    n: &i32,
    a: &mut [f32],
    lda: &i32,
    e: &mut [f32],
    tau: &mut [f32],
    work: &mut [f32],
    lwork: &i32,
    info: &mut i32,
) {
    ffi::ssktrd_(
        &(uplo as c_char),
        &(mode as c_char),
        n,
        a.as_mut_ptr() as *mut _,
        lda,
        e.as_mut_ptr(),
        tau.as_mut_ptr() as *mut _,
        work.as_mut_ptr() as *mut _,
        lwork,
        info
    )
}

///  Double precision real
/// # Arguments
///
/// * __*`uplo`*__ - (input)
///         > 'U':  Upper triangle of A is stored;
///         > 'L':  Lower triangle of A is stored.
/// * __*`mode`*__ - (input)
///         > 'N':  A is fully tridiagonalized
///         > 'P':  A is partially tridiagonalized for Pfaffian computation
///         > (details see below)
/// * __*`n`*__ - (input) The order of the matrix A. `n >= 0`. `n` must be
/// even if `mode = 'P'`.
/// * __*`a`*__ - (input/output) dimension (LDA,N). On entry, the skew-symmetric
/// matrix A.
///     > If `uplo = 'U'`, the leading N-by-N upper triangular part
///     > of A contains the upper triangular part of the matrix A,
///     > and the strictly lower triangular part of A is not referenced.
///
///     > If `uplo = 'L'`, the leading N-by-N lower triangular part
///     > of A contains the lower triangular part of the matrix A,
///     > and the strictly upper triangular part of A is not referenced.
///
///     On exit, if `mode = 'N'`:
///     > If UPLO = 'U', the diagonal and first superdiagonal
///     > of A are overwritten by the corresponding elements of the
///     > tridiagonal matrix T, and the elements above the first
///     > superdiagonal, with the array TAU, represent the unitary
///     > matrix Q as a product of elementary reflectors;
///     > If `uplo = 'L'`, the diagonal and first subdiagonal of A are over-
///     > written by the corresponding elements of the tridiagonal
///     > matrix T, and the elements below the first subdiagonal, with
///     > the array TAU, represent the unitary matrix Q as a product
///     > of elementary reflectors.
///     See Further Details, also for information about `mode = 'P'`.
/// * __*`lda`*__ - (input) The leading dimension of the array A.
/// `lda >= max(1,N)`.
/// * __*`e`*__ - (output) dimension (N-1). The off-diagonal elements of the
/// tridiagonal matrix T:
///     > If `uplo = 'U'`, `e[i] = a[i,i+1]`.
///
///     > If `uplo = 'L'`, `e[i] = a[i+1,i]`.
///     > If `mode = 'P'`, only the entries at i odd are well-defined
///     > (see Further Details).
/// * __*`tau`*__ - (output) dimension (N-1). The scalar factors of the
/// elementary reflectors (see Further Details).
/// * __*`work`*__ - (workspace/output) dimension (MAX(1,LWORK)). On exit, if
/// `info = 0`, `work[0]` returns the optimal `lwork`.
/// * __*`lwork`*__ - (input) The dimension of the array `work`. `lwork >= 1`.
/// For optimum performance LWORK >= N*NB, where NB is the optimal blocksize.
/// If `lwork = -1`, then a workspace query is assumed; the routine
/// only calculates the optimal size of the `work` array, returns
/// this value as the first entry of the `work` array, and no error
/// message related to `lwork` is issued by XERBLA.
/// * __*`info`*__ - (output) If `info`
/// > = 0:  successful exit
///
/// > < 0:  if INFO = -i, the i-th argument had an illegal value
#[inline]
pub unsafe fn dsktrd(
    uplo: u8,
    mode: u8,
    n: &i32,
    a: &mut [f64],
    lda: &i32,
    e: &mut [f64],
    tau: &mut [f64],
    work: &mut [f64],
    lwork: &i32,
    info: &mut i32,
) {
    ffi::dsktrd_(
        &(uplo as c_char),
        &(mode as c_char),
        n,
        a.as_mut_ptr() as *mut _,
        lda,
        e.as_mut_ptr(),
        tau.as_mut_ptr() as *mut _,
        work.as_mut_ptr() as *mut _,
        lwork,
        info
    )
}

/// Single precision complex
/// # Arguments
///
/// * __*`uplo`*__ - (input)
///         > 'U':  Upper triangle of A is stored;
///         > 'L':  Lower triangle of A is stored.
/// * __*`mode`*__ - (input)
///         > 'N':  A is fully tridiagonalized
///         > 'P':  A is partially tridiagonalized for Pfaffian computation
///         > (details see below)
/// * __*`n`*__ - (input) The order of the matrix A. `n >= 0`. `n` must be
/// even if `mode = 'P'`.
/// * __*`a`*__ - (input/output) dimension (LDA,N). On entry, the skew-symmetric
/// matrix A.
///     > If `uplo = 'U'`, the leading N-by-N upper triangular part
///     > of A contains the upper triangular part of the matrix A,
///     > and the strictly lower triangular part of A is not referenced.
///
///     > If `uplo = 'L'`, the leading N-by-N lower triangular part
///     > of A contains the lower triangular part of the matrix A,
///     > and the strictly upper triangular part of A is not referenced.
///
///     On exit, if `mode = 'N'`:
///     > If UPLO = 'U', the diagonal and first superdiagonal
///     > of A are overwritten by the corresponding elements of the
///     > tridiagonal matrix T, and the elements above the first
///     > superdiagonal, with the array TAU, represent the unitary
///     > matrix Q as a product of elementary reflectors;
///     > If `uplo = 'L'`, the diagonal and first subdiagonal of A are over-
///     > written by the corresponding elements of the tridiagonal
///     > matrix T, and the elements below the first subdiagonal, with
///     > the array TAU, represent the unitary matrix Q as a product
///     > of elementary reflectors.
///     See Further Details, also for information about `mode = 'P'`.
/// * __*`lda`*__ - (input) The leading dimension of the array A.
/// `lda >= max(1,N)`.
/// * __*`e`*__ - (output) dimension (N-1). The off-diagonal elements of the
/// tridiagonal matrix T:
///     > If `uplo = 'U'`, `e[i] = a[i,i+1]`.
///
///     > If `uplo = 'L'`, `e[i] = a[i+1,i]`.
///     > If `mode = 'P'`, only the entries at i odd are well-defined
///     > (see Further Details).
/// * __*`tau`*__ - (output) dimension (N-1). The scalar factors of the
/// elementary reflectors (see Further Details).
/// * __*`work`*__ - (workspace/output) dimension (MAX(1,LWORK)). On exit, if
/// `info = 0`, `work[0]` returns the optimal `lwork`.
/// * __*`lwork`*__ - (input) The dimension of the array `work`. `lwork >= 1`.
/// For optimum performance LWORK >= N*NB, where NB is the optimal blocksize.
/// If `lwork = -1`, then a workspace query is assumed; the routine
/// only calculates the optimal size of the `work` array, returns
/// this value as the first entry of the `work` array, and no error
/// message related to `lwork` is issued by XERBLA.
/// * __*`info`*__ - (output) If `info`
/// > = 0:  successful exit
///
/// > < 0:  if INFO = -i, the i-th argument had an illegal value
#[inline]
pub unsafe fn csktrd(
    uplo: u8,
    mode: u8,
    n: &i32,
    a: &mut [c32],
    lda: &i32,
    e: &mut [f32],
    tau: &mut [c32],
    work: &mut [c32],
    lwork: &i32,
    info: &mut i32,
) {
    ffi::csktrd_(
        &(uplo as c_char),
        &(mode as c_char),
        n,
        a.as_mut_ptr() as *mut _,
        lda,
        e.as_mut_ptr(),
        tau.as_mut_ptr() as *mut _,
        work.as_mut_ptr() as *mut _,
        lwork,
        info,
    )
}


/// Double precision complex
/// # Arguments
///
/// * __*`uplo`*__ - (input)
///         > 'U':  Upper triangle of A is stored;
///         > 'L':  Lower triangle of A is stored.
/// * __*`mode`*__ - (input)
///         > 'N':  A is fully tridiagonalized
///         > 'P':  A is partially tridiagonalized for Pfaffian computation
///         > (details see below)
/// * __*`n`*__ - (input) The order of the matrix A. `n >= 0`. `n` must be
/// even if `mode = 'P'`.
/// * __*`a`*__ - (input/output) dimension (LDA,N). On entry, the skew-symmetric
/// matrix A.
///     > If `uplo = 'U'`, the leading N-by-N upper triangular part
///     > of A contains the upper triangular part of the matrix A,
///     > and the strictly lower triangular part of A is not referenced.
///
///     > If `uplo = 'L'`, the leading N-by-N lower triangular part
///     > of A contains the lower triangular part of the matrix A,
///     > and the strictly upper triangular part of A is not referenced.
///
///     On exit, if `mode = 'N'`:
///     > If UPLO = 'U', the diagonal and first superdiagonal
///     > of A are overwritten by the corresponding elements of the
///     > tridiagonal matrix T, and the elements above the first
///     > superdiagonal, with the array TAU, represent the unitary
///     > matrix Q as a product of elementary reflectors;
///     > If `uplo = 'L'`, the diagonal and first subdiagonal of A are over-
///     > written by the corresponding elements of the tridiagonal
///     > matrix T, and the elements below the first subdiagonal, with
///     > the array TAU, represent the unitary matrix Q as a product
///     > of elementary reflectors.
///     See Further Details, also for information about `mode = 'P'`.
/// * __*`lda`*__ - (input) The leading dimension of the array A.
/// `lda >= max(1,N)`.
/// * __*`e`*__ - (output) dimension (N-1). The off-diagonal elements of the
/// tridiagonal matrix T:
///     > If `uplo = 'U'`, `e[i] = a[i,i+1]`.
///
///     > If `uplo = 'L'`, `e[i] = a[i+1,i]`.
///     > If `mode = 'P'`, only the entries at i odd are well-defined
///     > (see Further Details).
/// * __*`tau`*__ - (output) dimension (N-1). The scalar factors of the
/// elementary reflectors (see Further Details).
/// * __*`work`*__ - (workspace/output) dimension (MAX(1,LWORK)). On exit, if
/// `info = 0`, `work[0]` returns the optimal `lwork`.
/// * __*`lwork`*__ - (input) The dimension of the array `work`. `lwork >= 1`.
/// For optimum performance LWORK >= N*NB, where NB is the optimal blocksize.
/// If `lwork = -1`, then a workspace query is assumed; the routine
/// only calculates the optimal size of the `work` array, returns
/// this value as the first entry of the `work` array, and no error
/// message related to `lwork` is issued by XERBLA.
/// * __*`info`*__ - (output) If `info`
/// > = 0:  successful exit
///
/// > < 0:  if INFO = -i, the i-th argument had an illegal value
#[inline]
pub unsafe fn zsktrd(
    uplo: u8,
    mode: u8,
    n: &i32,
    a: &mut [c64],
    lda: &i32,
    e: &mut [f64],
    tau: &mut [c64],
    work: &mut [c64],
    lwork: &i32,
    info: &mut i32,
) {
    ffi::zsktrd_(
        &(uplo as c_char),
        &(mode as c_char),
        n,
        a.as_mut_ptr() as *mut _,
        lda,
        e.as_mut_ptr(),
        tau.as_mut_ptr() as *mut _,
        work.as_mut_ptr() as *mut _,
        lwork,
        info,
    )
}