Classes | Functions
internal Namespace Reference

Classes

struct  colamd_col
 
struct  Colamd_Row
 

Functions

template<typename IndexType >
static IndexType clear_mark (IndexType n_row, Colamd_Row< IndexType > Row[])
 
template<typename IndexType >
static bool colamd (IndexType n_row, IndexType n_col, IndexType Alen, IndexType *A, IndexType *p, double knobs[COLAMD_KNOBS], IndexType stats[COLAMD_STATS])
 Computes a column ordering using the column approximate minimum degree ordering. More...
 
template<typename IndexType >
IndexType colamd_c (IndexType n_col)
 
template<typename IndexType >
IndexType colamd_r (IndexType n_row)
 
template<typename IndexType >
IndexType colamd_recommended (IndexType nnz, IndexType n_row, IndexType n_col)
 Returns the recommended value of Alen. More...
 
static void colamd_set_defaults (double knobs[COLAMD_KNOBS])
 set default parameters The use of this routine is optional. More...
 
template<typename IndexType >
static void detect_super_cols (colamd_col< IndexType > Col[], IndexType A[], IndexType head[], IndexType row_start, IndexType row_length)
 
template<typename IndexType >
static IndexType find_ordering (IndexType n_row, IndexType n_col, IndexType Alen, Colamd_Row< IndexType > Row[], colamd_col< IndexType > Col[], IndexType A[], IndexType head[], IndexType n_col2, IndexType max_deg, IndexType pfree)
 
template<typename IndexType >
static IndexType garbage_collection (IndexType n_row, IndexType n_col, Colamd_Row< IndexType > Row[], colamd_col< IndexType > Col[], IndexType A[], IndexType *pfree)
 
template<typename IndexType >
static IndexType init_rows_cols (IndexType n_row, IndexType n_col, Colamd_Row< IndexType > Row[], colamd_col< IndexType > col[], IndexType A[], IndexType p[], IndexType stats[COLAMD_STATS])
 
template<typename IndexType >
static void init_scoring (IndexType n_row, IndexType n_col, Colamd_Row< IndexType > Row[], colamd_col< IndexType > Col[], IndexType A[], IndexType head[], double knobs[COLAMD_KNOBS], IndexType *p_n_row2, IndexType *p_n_col2, IndexType *p_max_deg)
 
template<typename IndexType >
static void order_children (IndexType n_col, colamd_col< IndexType > Col[], IndexType p[])
 

Function Documentation

template<typename IndexType >
static IndexType internal::clear_mark ( IndexType  n_row,
Colamd_Row< IndexType >  Row[] 
)
inlinestatic

Definition at line 1820 of file Eigen_Colamd.h.

template<typename IndexType >
static bool internal::colamd ( IndexType  n_row,
IndexType  n_col,
IndexType  Alen,
IndexType *  A,
IndexType *  p,
double  knobs[COLAMD_KNOBS],
IndexType  stats[COLAMD_STATS] 
)
static

Computes a column ordering using the column approximate minimum degree ordering.

Computes a column ordering (Q) of A such that P(AQ)=LU or (AQ)'AQ=LL' have less fill-in and require fewer floating point operations than factorizing the unpermuted matrix A or A'A, respectively.

Parameters
n_rownumber of rows in A
n_colnumber of columns in A
Alen,sizeof the array A
Arow indices of the matrix, of size ALen
pcolumn pointers of A, of size n_col+1
knobsparameter settings for colamd
statscolamd output statistics and error codes

Definition at line 322 of file Eigen_Colamd.h.

template<typename IndexType >
IndexType internal::colamd_c ( IndexType  n_col)
inline

Definition at line 202 of file Eigen_Colamd.h.

template<typename IndexType >
IndexType internal::colamd_r ( IndexType  n_row)
inline

Definition at line 206 of file Eigen_Colamd.h.

template<typename IndexType >
IndexType internal::colamd_recommended ( IndexType  nnz,
IndexType  n_row,
IndexType  n_col 
)
inline

Returns the recommended value of Alen.

Returns recommended value of Alen for use by colamd. Returns -1 if any input argument is negative. The use of this routine or macro is optional. Note that the macro uses its arguments more than once, so be careful for side effects, if you pass expressions as arguments to COLAMD_RECOMMENDED.

Parameters
nnznonzeros in A
n_rownumber of rows in A
n_colnumber of columns in A
Returns
recommended value of Alen for use by colamd

Definition at line 257 of file Eigen_Colamd.h.

static void internal::colamd_set_defaults ( double  knobs[COLAMD_KNOBS])
inlinestatic

set default parameters The use of this routine is optional.

Colamd: rows with more than (knobs [COLAMD_DENSE_ROW] * n_col) entries are removed prior to ordering. Columns with more than (knobs [COLAMD_DENSE_COL] * n_row) entries are removed prior to ordering, and placed last in the output column ordering.

COLAMD_DENSE_ROW and COLAMD_DENSE_COL are defined as 0 and 1, respectively, in colamd.h. Default values of these two knobs are both 0.5. Currently, only knobs [0] and knobs [1] are used, but future versions may use more knobs. If so, they will be properly set to their defaults by the future version of colamd_set_defaults, so that the code that calls colamd will not need to change, assuming that you either use colamd_set_defaults, or pass a (double *) NULL pointer as the knobs array to colamd or symamd.

Parameters
knobsparameter settings for colamd

Definition at line 286 of file Eigen_Colamd.h.

template<typename IndexType >
static void internal::detect_super_cols ( colamd_col< IndexType >  Col[],
IndexType  A[],
IndexType  head[],
IndexType  row_start,
IndexType  row_length 
)
static

Definition at line 1548 of file Eigen_Colamd.h.

template<typename IndexType >
static IndexType internal::find_ordering ( IndexType  n_row,
IndexType  n_col,
IndexType  Alen,
Colamd_Row< IndexType >  Row[],
colamd_col< IndexType >  Col[],
IndexType  A[],
IndexType  head[],
IndexType  n_col2,
IndexType  max_deg,
IndexType  pfree 
)
static

Definition at line 936 of file Eigen_Colamd.h.

template<typename IndexType >
static IndexType internal::garbage_collection ( IndexType  n_row,
IndexType  n_col,
Colamd_Row< IndexType >  Row[],
colamd_col< IndexType >  Col[],
IndexType  A[],
IndexType *  pfree 
)
static

Definition at line 1699 of file Eigen_Colamd.h.

template<typename IndexType >
static IndexType internal::init_rows_cols ( IndexType  n_row,
IndexType  n_col,
Colamd_Row< IndexType >  Row[],
colamd_col< IndexType >  col[],
IndexType  A[],
IndexType  p[],
IndexType  stats[COLAMD_STATS] 
)
static

Definition at line 483 of file Eigen_Colamd.h.

template<typename IndexType >
static void internal::init_scoring ( IndexType  n_row,
IndexType  n_col,
Colamd_Row< IndexType >  Row[],
colamd_col< IndexType >  Col[],
IndexType  A[],
IndexType  head[],
double  knobs[COLAMD_KNOBS],
IndexType *  p_n_row2,
IndexType *  p_n_col2,
IndexType *  p_max_deg 
)
static

Definition at line 699 of file Eigen_Colamd.h.

template<typename IndexType >
static void internal::order_children ( IndexType  n_col,
colamd_col< IndexType >  Col[],
IndexType  p[] 
)
inlinestatic

Definition at line 1447 of file Eigen_Colamd.h.



hebiros
Author(s): Xavier Artache , Matthew Tesch
autogenerated on Thu Sep 3 2020 04:11:00