/usr/include/suitesparse/SuiteSparseQR_C.h is in libsuitesparse-dev 1:5.1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* ========================================================================== */
/* === SuiteSparseQR_C.h ==================================================== */
/* ========================================================================== */
/* For inclusion in a C or C++ program. */
#ifndef SUITESPARSEQR_C_H
#define SUITESPARSEQR_C_H
#ifdef __cplusplus
/* If included by a C++ program, the Complex type is std::complex<double> */
#include <complex>
#define Complex std::complex<double>
extern "C" {
#endif
#include "cholmod.h"
#include "SuiteSparseQR_definitions.h"
#ifndef __cplusplus
/* The C++ functions will return a pointer to a std::complex<double> array of
size n, which the C code must then interpret as double array of size 2*n,
with real and imaginary parts interleaved. */
#define Complex double
#endif
/* ========================================================================== */
/* === SuiteSparseQR_C ====================================================== */
/* ========================================================================== */
SuiteSparse_long SuiteSparseQR_C /* returns rank(A) estimate, (-1) if failure */
(
/* inputs: */
int ordering, /* all, except 3:given treated as 0:fixed */
double tol, /* columns with 2-norm <= tol treated as 0 */
SuiteSparse_long econ, /* e = max(min(m,econ),rank(A)) */
int getCTX, /* 0: Z=C (e-by-k), 1: Z=C', 2: Z=X (e-by-k) */
cholmod_sparse *A, /* m-by-n sparse matrix to factorize */
cholmod_sparse *Bsparse, /* sparse m-by-k B */
cholmod_dense *Bdense, /* dense m-by-k B */
/* outputs: */
cholmod_sparse **Zsparse, /* sparse Z */
cholmod_dense **Zdense, /* dense Z */
cholmod_sparse **R, /* e-by-n sparse matrix */
SuiteSparse_long **E, /* size n column perm, NULL if identity */
cholmod_sparse **H, /* m-by-nh Householder vectors */
SuiteSparse_long **HPinv, /* size m row permutation */
cholmod_dense **HTau, /* 1-by-nh Householder coefficients */
cholmod_common *cc /* workspace and parameters */
) ;
/* ========================================================================== */
/* === SuiteSparseQR_C_QR =================================================== */
/* ========================================================================== */
/* [Q,R,E] = qr(A), returning Q as a sparse matrix */
SuiteSparse_long SuiteSparseQR_C_QR /* returns rank(A) est., (-1) if failure */
(
/* inputs: */
int ordering, /* all, except 3:given treated as 0:fixed */
double tol, /* columns with 2-norm <= tol treated as 0 */
SuiteSparse_long econ, /* e = max(min(m,econ),rank(A)) */
cholmod_sparse *A, /* m-by-n sparse matrix to factorize */
/* outputs: */
cholmod_sparse **Q, /* m-by-e sparse matrix */
cholmod_sparse **R, /* e-by-n sparse matrix */
SuiteSparse_long **E, /* size n column perm, NULL if identity */
cholmod_common *cc /* workspace and parameters */
) ;
/* ========================================================================== */
/* === SuiteSparseQR_C_backslash ============================================ */
/* ========================================================================== */
/* X = A\B where B is dense */
cholmod_dense *SuiteSparseQR_C_backslash /* returns X, NULL if failure */
(
int ordering, /* all, except 3:given treated as 0:fixed */
double tol, /* columns with 2-norm <= tol treated as 0 */
cholmod_sparse *A, /* m-by-n sparse matrix */
cholmod_dense *B, /* m-by-k */
cholmod_common *cc /* workspace and parameters */
) ;
/* ========================================================================== */
/* === SuiteSparseQR_C_backslash_default ==================================== */
/* ========================================================================== */
/* X = A\B where B is dense, using default ordering and tol */
cholmod_dense *SuiteSparseQR_C_backslash_default /* returns X, NULL if failure*/
(
cholmod_sparse *A, /* m-by-n sparse matrix */
cholmod_dense *B, /* m-by-k */
cholmod_common *cc /* workspace and parameters */
) ;
/* ========================================================================== */
/* === SuiteSparseQR_C_backslash_sparse ===================================== */
/* ========================================================================== */
/* X = A\B where B is sparse */
cholmod_sparse *SuiteSparseQR_C_backslash_sparse /* returns X, or NULL */
(
/* inputs: */
int ordering, /* all, except 3:given treated as 0:fixed */
double tol, /* columns with 2-norm <= tol treated as 0 */
cholmod_sparse *A, /* m-by-n sparse matrix */
cholmod_sparse *B, /* m-by-k */
cholmod_common *cc /* workspace and parameters */
) ;
#ifndef NEXPERT
/* ========================================================================== */
/* === SuiteSparseQR_C_factorization ======================================== */
/* ========================================================================== */
/* A real or complex QR factorization, computed by SuiteSparseQR_C_factorize */
typedef struct SuiteSparseQR_C_factorization_struct
{
int xtype ; /* CHOLMOD_REAL or CHOLMOD_COMPLEX */
void *factors ; /* from SuiteSparseQR_factorize <double> or
SuiteSparseQR_factorize <Complex> */
} SuiteSparseQR_C_factorization ;
/* ========================================================================== */
/* === SuiteSparseQR_C_factorize ============================================ */
/* ========================================================================== */
SuiteSparseQR_C_factorization *SuiteSparseQR_C_factorize
(
/* inputs: */
int ordering, /* all, except 3:given treated as 0:fixed */
double tol, /* columns with 2-norm <= tol treated as 0 */
cholmod_sparse *A, /* m-by-n sparse matrix */
cholmod_common *cc /* workspace and parameters */
) ;
/* ========================================================================== */
/* === SuiteSparseQR_C_symbolic ============================================= */
/* ========================================================================== */
SuiteSparseQR_C_factorization *SuiteSparseQR_C_symbolic
(
/* inputs: */
int ordering, /* all, except 3:given treated as 0:fixed */
int allow_tol, /* if TRUE allow tol for rank detection */
cholmod_sparse *A, /* m-by-n sparse matrix, A->x ignored */
cholmod_common *cc /* workspace and parameters */
) ;
/* ========================================================================== */
/* === SuiteSparseQR_C_numeric ============================================== */
/* ========================================================================== */
int SuiteSparseQR_C_numeric
(
/* inputs: */
double tol, /* treat columns with 2-norm <= tol as zero */
cholmod_sparse *A, /* sparse matrix to factorize */
/* input/output: */
SuiteSparseQR_C_factorization *QR,
cholmod_common *cc /* workspace and parameters */
) ;
/* ========================================================================== */
/* === SuiteSparseQR_C_free ================================================= */
/* ========================================================================== */
/* Free the QR factors computed by SuiteSparseQR_C_factorize */
int SuiteSparseQR_C_free /* returns TRUE (1) if OK, FALSE (0) otherwise*/
(
SuiteSparseQR_C_factorization **QR,
cholmod_common *cc /* workspace and parameters */
) ;
/* ========================================================================== */
/* === SuiteSparseQR_C_solve ================================================ */
/* ========================================================================== */
cholmod_dense* SuiteSparseQR_C_solve /* returnx X, or NULL if failure */
(
int system, /* which system to solve */
SuiteSparseQR_C_factorization *QR, /* of an m-by-n sparse matrix A */
cholmod_dense *B, /* right-hand-side, m-by-k or n-by-k */
cholmod_common *cc /* workspace and parameters */
) ;
/* ========================================================================== */
/* === SuiteSparseQR_C_qmult ================================================ */
/* ========================================================================== */
/*
Applies Q in Householder form (as stored in the QR factorization object
returned by SuiteSparseQR_C_factorize) to a dense matrix X.
method SPQR_QTX (0): Y = Q'*X
method SPQR_QX (1): Y = Q*X
method SPQR_XQT (2): Y = X*Q'
method SPQR_XQ (3): Y = X*Q
*/
cholmod_dense *SuiteSparseQR_C_qmult /* returns Y, or NULL on failure */
(
/* inputs: */
int method, /* 0,1,2,3 */
SuiteSparseQR_C_factorization *QR, /* of an m-by-n sparse matrix A */
cholmod_dense *X, /* size m-by-n with leading dimension ldx */
cholmod_common *cc /* workspace and parameters */
) ;
#endif
/* ========================================================================== */
#ifdef __cplusplus
}
#endif
#endif
|