1
/* ========================================================================== */
2
/* === colamd prototypes and definitions ==================================== */
3
/* ========================================================================== */
6
This is the colamd include file,
8
http://www.cise.ufl.edu/~davis/colamd/colamd.h
10
for use in the colamd.c, colamdmex.c, and symamdmex.c files located at
12
http://www.cise.ufl.edu/~davis/colamd/
14
See those files for a description of colamd and symamd, and for the
15
copyright notice, which also applies to this file.
17
August 3, 1998. Version 1.0.
20
/* ========================================================================== */
21
/* === Definitions ========================================================== */
22
/* ========================================================================== */
24
/* size of the knobs [ ] array. Only knobs [0..1] are currently used. */
25
#define COLAMD_KNOBS 20
27
/* number of output statistics. Only A [0..2] are currently used. */
28
#define COLAMD_STATS 20
30
/* knobs [0] and A [0]: dense row knob and output statistic. */
31
#define COLAMD_DENSE_ROW 0
33
/* knobs [1] and A [1]: dense column knob and output statistic. */
34
#define COLAMD_DENSE_COL 1
36
/* A [2]: memory defragmentation count output statistic */
37
#define COLAMD_DEFRAG_COUNT 2
39
/* A [3]: whether or not the input columns were jumbled or had duplicates */
40
#define COLAMD_JUMBLED_COLS 3
42
/* ========================================================================== */
43
/* === Prototypes of user-callable routines ================================= */
44
/* ========================================================================== */
46
int colamd_recommended /* returns recommended value of Alen */
48
int nnz, /* nonzeros in A */
49
int n_row, /* number of rows in A */
50
int n_col /* number of columns in A */
53
void colamd_set_defaults /* sets default parameters */
54
( /* knobs argument is modified on output */
55
double knobs [COLAMD_KNOBS] /* parameter settings for colamd */
58
int colamd /* returns TRUE if successful, FALSE otherwise*/
59
( /* A and p arguments are modified on output */
60
int n_row, /* number of rows in A */
61
int n_col, /* number of columns in A */
62
int Alen, /* size of the array A */
63
int A [], /* row indices of A, of size Alen */
64
int p [], /* column pointers of A, of size n_col+1 */
65
double knobs [COLAMD_KNOBS] /* parameter settings for colamd */