internal::Colamd Namespace Reference

Classes
struct	ColStructure
struct	RowStructure

Enumerations
enum	KnobsStatsIndex {   DenseRow = 0 , DenseCol = 1 , DefragCount = 2 , Status = 3 ,   Info1 = 4 , Info2 = 5 , Info3 = 6 }
enum	Status {   Ok = 0 , OkButJumbled = 1 , ErrorANotPresent = -1 , ErrorPNotPresent = -2 ,   ErrorNrowNegative = -3 , ErrorNcolNegative = -4 , ErrorNnzNegative = -5 , ErrorP0Nonzero = -6 ,   ErrorATooSmall = -7 , ErrorColLengthNegative = -8 , ErrorRowIndexOutOfBounds = -9 , ErrorOutOfMemory = -10 ,   ErrorInternalError = -999 }
enum	RowColumnStatus { Alive = 0 , Dead = -1 }
enum	ColumnStatus { DeadPrincipal = -1 , DeadNonPrincipal = -2 }

Functions
template<typename IndexType >
IndexType	ones_complement (const IndexType r)
template<typename IndexType >
IndexType	colamd_c (IndexType n_col)
template<typename IndexType >
IndexType	colamd_r (IndexType n_row)
template<typename IndexType >
IndexType	recommended (IndexType nnz, IndexType n_row, IndexType n_col)
	Returns the recommended value of Alen.

Variables
const int	NKnobs = 20
const int	NStats = 20
const int	Empty = -1

Enumeration Type Documentation

ColumnStatus

enum internal::Colamd::ColumnStatus

Enumerator
DeadPrincipal
DeadNonPrincipal

KnobsStatsIndex

enum internal::Colamd::KnobsStatsIndex

Enumerator
DenseRow
DenseCol
DefragCount
Status
Info1
Info2
Info3

RowColumnStatus

enum internal::Colamd::RowColumnStatus

Enumerator
Alive
Dead

Status

enum internal::Colamd::Status

Enumerator
Ok
OkButJumbled
ErrorANotPresent
ErrorPNotPresent
ErrorNrowNegative
ErrorNcolNegative
ErrorNnzNegative
ErrorP0Nonzero
ErrorATooSmall
ErrorColLengthNegative
ErrorRowIndexOutOfBounds
ErrorOutOfMemory
ErrorInternalError

Function Documentation

colamd_c()

template<typename IndexType >

IndexType internal::Colamd::colamd_c ( IndexType  n_col )

inline

colamd_r()

template<typename IndexType >

IndexType internal::Colamd::colamd_r ( IndexType  n_row )

inline

ones_complement()

template<typename IndexType >

IndexType internal::Colamd::ones_complement

(

const IndexType

r

)

recommended()

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

nnz	nonzeros in A
n_row	number of rows in A
n_col	number of columns in A

Returns

recommended value of Alen for use by colamd

Variable Documentation

Empty

const int internal::Colamd::Empty = -1

NKnobs

const int internal::Colamd::NKnobs = 20

NStats

const int internal::Colamd::NStats = 20