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

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

/// Single precision real
///
///
/// # Arguments
///
/// * __*`uplo`*__ - (input) If `uplo = 'U'`, the 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 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.
/// * __*`mode`*__ - (input) If 'N':  `a` is fully tridiagonalized.
/// If 'P':  `a` is partially tridiagonalized for Pfaffian computation.
/// * __*`n`*__ - (input) Size of the matrix `a`. If `mode = 'P'`, `n` must be even. `n
/// >= 0`.
/// * __*`a`*__ - (input/output) Pointer to a memory block of size `n*n*sizeof(datatype)`.
/// On entry, the skew-symmetric `n`x`n`-matrix `a` in Fortran format.
///
///     > If `uplo = 'U'`, the 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 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, the tridiagonal matrix T and the multipliers used
///     to obtain the factor U or L (see below for further details).
/// * __*`ldim`*__ - (input) The leading dimension of the array `a`.
/// `ldim >= max(1,n)`.
/// * __*`ipiv`*__ - (output) Pointer to an array of dimension N.
/// Information about the permutation matrix P: row and column
/// i are interchanged with `ipiv[i-1]`. If `uplo = 'U'`, those
/// interchanges are done in the order `i = N ... 1`, if `uplo = 'L'`
/// in the order `i = 1 ... N`.
/// * __*`work`*__ - (workspace/output) Array of dimension `max(1,lwork)`.
/// On exit, if `info = 0`, `work[0]` returns the optimal `lwork`.
/// * __*`lwork`*__ - (input) The length of `work`.  `lwork >= 1`.
/// For best performance
/// `lwork >= n*NB`, where `NB` is the block size returned by ILAENV
/// (at the moment, uses the same block size as SSYTRF from Lapack).
/// 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](https://netlib.org/lapack/explore-html/d0/d73/group__aux__blas_ga377ee61015baf8dea7770b3a404b1c07.html).
/// * __*`info`*__ - (output) Succes of the computation. If `info`
///   > = 0: successful exit,
///
///   > < 0: if `info = -k`, the k-th argument had an illegal value,
///
///   > \> 0: if `info = k`, the off-diagonal entry in the k-th row
///   > `uplo = 'U'` or k-th column `uplo = 'L'`
///   > is exactly zero.
///
///   > = -100: failed to allocate enough internal memory.
///
#[inline]
pub unsafe fn ssktrf(
    uplo: u8,
    mode: u8,
    n: &i32,
    a: &mut [f32],
    ldim: &i32,
    ipiv: &mut [i32],
    work: &mut [f32],
    lwork: &[i32],
    info: &mut i32,
) {
    ffi::ssktrf_(
        &(uplo as c_char),
        &(mode as c_char),
        n,
        a.as_mut_ptr(),
        ldim,
        ipiv.as_mut_ptr(),
        work.as_mut_ptr(),
        lwork.as_ptr(),
        info,
    )
}


/// Double precision real
///
/// # Arguments
///
/// * __*`uplo`*__ - (input) If `uplo = 'U'`, the 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 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.
/// * __*`mode`*__ - (input) If 'N':  `a` is fully tridiagonalized.
/// If 'P':  `a` is partially tridiagonalized for Pfaffian computation.
/// * __*`n`*__ - (input) Size of the matrix `a`. If `mode = 'P'`, `n` must be even. `n
/// >= 0`.
/// * __*`a`*__ - (input/output) Pointer to a memory block of size `n*n*sizeof(datatype)`.
/// On entry, the skew-symmetric `n`x`n`-matrix `a` in Fortran format.
///
///     > If `uplo = 'U'`, the 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 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, the tridiagonal matrix T and the multipliers used
///     to obtain the factor U or L (see below for further details).
/// * __*`ldim`*__ - (input) The leading dimension of the array `a`.
/// `ldim >= max(1,n)`.
/// * __*`ipiv`*__ - (output) Pointer to an array of dimension N.
/// Information about the permutation matrix P: row and column
/// i are interchanged with `ipiv[i-1]`. If `uplo = 'U'`, those
/// interchanges are done in the order `i = N ... 1`, if `uplo = 'L'`
/// in the order `i = 1 ... N`.
/// * __*`work`*__ - (workspace/output) Array of dimension `max(1,lwork)`.
/// On exit, if `info = 0`, `work[0]` returns the optimal `lwork`.
/// * __*`lwork`*__ - (input) The length of `work`.  `lwork >= 1`.
/// For best performance
/// `lwork >= n*NB`, where `NB` is the block size returned by ILAENV
/// (at the moment, uses the same block size as SSYTRF from Lapack).
/// 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](https://netlib.org/lapack/explore-html/d0/d73/group__aux__blas_ga377ee61015baf8dea7770b3a404b1c07.html).
/// * __*`info`*__ - (output) Succes of the computation. If `info`
///   > = 0: successful exit,
///
///   > < 0: if `info = -k`, the k-th argument had an illegal value,
///
///   > \> 0: if `info = k`, the off-diagonal entry in the k-th row
///   > `uplo = 'U'` or k-th column `uplo = 'L'`
///   > is exactly zero.
///
///   > = -100: failed to allocate enough internal memory.
#[inline]
pub unsafe fn dsktrf(
    uplo: u8,
    mode: u8,
    n: &i32,
    a: &mut [f64],
    ldim: &i32,
    ipiv: &mut [i32],
    work: &mut [f64],
    lwork: &i32,
    info: &mut i32
) {
    ffi::dsktrf_(
        &(uplo as c_char),
        &(mode as c_char),
        n,
        a.as_mut_ptr(),
        ldim,
        ipiv.as_mut_ptr(),
        work.as_mut_ptr(),
        lwork,
        info,
    )
}


/// Single precision complex
///
/// # Arguments
///
/// * __*`uplo`*__ - (input) If `uplo = 'U'`, the 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 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.
/// * __*`mode`*__ - (input) If 'N':  `a` is fully tridiagonalized.
/// If 'P':  `a` is partially tridiagonalized for Pfaffian computation.
/// * __*`n`*__ - (input) Size of the matrix `a`. If `mode = 'P'`, `n` must be even. `n
/// >= 0`.
/// * __*`a`*__ - (input/output) Pointer to a memory block of size `n*n*sizeof(datatype)`.
/// On entry, the skew-symmetric `n`x`n`-matrix `a` in Fortran format.
///
///     > If `uplo = 'U'`, the 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 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, the tridiagonal matrix T and the multipliers used
///     to obtain the factor U or L (see below for further details).
/// * __*`ldim`*__ - (input) The leading dimension of the array `a`.
/// `ldim >= max(1,n)`.
/// * __*`ipiv`*__ - (output) Pointer to an array of dimension N.
/// Information about the permutation matrix P: row and column
/// i are interchanged with `ipiv[i-1]`. If `uplo = 'U'`, those
/// interchanges are done in the order `i = N ... 1`, if `uplo = 'L'`
/// in the order `i = 1 ... N`.
/// * __*`work`*__ - (workspace/output) Array of dimension `max(1,lwork)`.
/// On exit, if `info = 0`, `work[0]` returns the optimal `lwork`.
/// * __*`lwork`*__ - (input) The length of `work`.  `lwork >= 1`.
/// For best performance
/// `lwork >= n*NB`, where `NB` is the block size returned by ILAENV
/// (at the moment, uses the same block size as SSYTRF from Lapack).
/// 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](https://netlib.org/lapack/explore-html/d0/d73/group__aux__blas_ga377ee61015baf8dea7770b3a404b1c07.html).
/// * __*`info`*__ - (output) Succes of the computation. If `info`
///   > = 0: successful exit,
///
///   > < 0: if `info = -k`, the k-th argument had an illegal value,
///
///   > \> 0: if `info = k`, the off-diagonal entry in the k-th row
///   > `uplo = 'U'` or k-th column `uplo = 'L'`
///   > is exactly zero.
///
///   > = -100: failed to allocate enough internal memory.
#[inline]
pub unsafe fn csktrf(
    uplo: u8,
    mode: u8,
    n: &i32,
    a: &mut [c32],
    ldim: &i32,
    ipiv: &mut [i32],
    work: &mut [c32],
    lwork: &i32,
    info: &mut i32,
) {
    ffi::csktrf_(
        &(uplo as c_char),
        &(mode as c_char),
        n,
        a.as_mut_ptr() as *mut _,
        ldim,
        ipiv.as_mut_ptr(),
        work.as_mut_ptr() as *mut _,
        lwork,
        info,
    )
}

/// Double precision complex
///
/// # Arguments
///
/// * __*`uplo`*__ - (input) If `uplo = 'U'`, the 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 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.
/// * __*`mode`*__ - (input) If 'N':  `a` is fully tridiagonalized.
/// If 'P':  `a` is partially tridiagonalized for Pfaffian computation.
/// * __*`n`*__ - (input) Size of the matrix `a`. If `mode = 'P'`, `n` must be even. `n
/// >= 0`.
/// * __*`a`*__ - (input/output) Pointer to a memory block of size `n*n*sizeof(datatype)`.
/// On entry, the skew-symmetric `n`x`n`-matrix `a` in Fortran format.
///
///     > If `uplo = 'U'`, the 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 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, the tridiagonal matrix T and the multipliers used
///     to obtain the factor U or L (see below for further details).
/// * __*`ldim`*__ - (input) The leading dimension of the array `a`.
/// `ldim >= max(1,n)`.
/// * __*`ipiv`*__ - (output) Pointer to an array of dimension N.
/// Information about the permutation matrix P: row and column
/// i are interchanged with `ipiv[i-1]`. If `uplo = 'U'`, those
/// interchanges are done in the order `i = N ... 1`, if `uplo = 'L'`
/// in the order `i = 1 ... N`.
/// * __*`work`*__ - (workspace/output) Array of dimension `max(1,lwork)`.
/// On exit, if `info = 0`, `work[0]` returns the optimal `lwork`.
/// * __*`lwork`*__ - (input) The length of `work`.  `lwork >= 1`.
/// For best performance
/// `lwork >= n*NB`, where `NB` is the block size returned by ILAENV
/// (at the moment, uses the same block size as SSYTRF from Lapack).
/// 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](https://netlib.org/lapack/explore-html/d0/d73/group__aux__blas_ga377ee61015baf8dea7770b3a404b1c07.html).
/// * __*`info`*__ - (output) Succes of the computation. If `info`
///   > = 0: successful exit,
///
///   > < 0: if `info = -k`, the k-th argument had an illegal value,
///
///   > \> 0: if `info = k`, the off-diagonal entry in the k-th row
///   > `uplo = 'U'` or k-th column `uplo = 'L'`
///   > is exactly zero.
///
///   > = -100: failed to allocate enough internal memory.
#[inline]
pub unsafe fn zsktrf(
    uplo: u8,
    mode: u8,
    n: &i32,
    a: &mut [c64],
    ldim: &i32,
    ipiv: &mut [i32],
    work: &mut [c64],
    lwork: &i32,
    info: &mut i32,
) {
    ffi::zsktrf_(
        &(uplo as c_char),
        &(mode as c_char),
        n,
        a.as_mut_ptr() as *mut _,
        ldim,
        ipiv.as_mut_ptr(),
        work.as_mut_ptr() as *mut _,
        lwork,
        info,
    )
}