Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

ClpCholeskyBase Class Reference

Abstract Base class for Clp Cholesky factorization. More...

#include <ClpCholeskyBase.hpp>

Inheritance diagram for ClpCholeskyBase:

ClpCholeskyDense ClpCholeskyTaucs ClpCholeskyWssmp ClpCholeskyWssmpKKT List of all members.

Constructors, destructor<br>

NOTE: All constructors are protected.

There's no need to expose them, after all, this is an abstract class.

virtual ~ClpCholeskyBase ()
 Destructor (has to be public).

 ClpCholeskyBase ()
 Default constructor.

 ClpCholeskyBase (const ClpCholeskyBase &)
 Destructor (has to be public).

ClpCholeskyBaseoperator= (const ClpCholeskyBase &)
 Destructor (has to be public).


Other

Clone

virtual ClpCholeskyBaseclone () const=0
int type () const
 Returns type.

void setType (int type)
 Sets type.


Public Member Functions

Virtual methods that the derived classes must provide
virtual int order (ClpInterior *model)=0
 Orders rows and saves pointer to matrix.and model.

virtual int factorize (const double *diagonal, int *rowsDropped)=0
 Factorize - filling in rowsDropped and returning number dropped.

virtual void solve (double *region)=0
 Uses factorization to solve.

virtual void solveKKT (double *region1, double *region2, const double *diagonal, double diagonalScaleFactor)
 Uses factorization to solve.

Gets
int status () const
 status. Returns status

int numberRowsDropped () const
 numberRowsDropped. Number of rows gone

void resetRowsDropped ()
 reset numberRowsDropped and rowsDropped.

char * rowsDropped () const
 rowsDropped - which rows are gone

double choleskyCondition () const
 choleskyCondition.

int rank () const
 rank. Returns rank

int numberRows () const
 Return number of rows.


Protected Attributes

Data members
The data members are protected to allow access for derived classes.

int type_
 type (may be useful) if > 20 do KKT

double pivotTolerance_
 pivotTolerance.

double zeroTolerance_
 zeroTolerance.

double choleskyCondition_
 choleskyCondition.

ClpInteriormodel_
 model.

int numberTrials_
 numberTrials. Number of trials before rejection

int numberRows_
 numberRows. Number of Rows in factorization

int status_
 status. Status of factorization

char * rowsDropped_
 rowsDropped

int * permuteIn_
 permuteIn.

int * permuteOut_
 permuteOut.

int numberRowsDropped_
 numberRowsDropped. Number of rows gone


Detailed Description

Abstract Base class for Clp Cholesky factorization.

Derived classes will be using sophisticated methods apart from ClpCholeskyDense

Definition at line 15 of file ClpCholeskyBase.hpp.


Constructor & Destructor Documentation

ClpCholeskyBase::ClpCholeskyBase  )  [protected]
 

Default constructor.

virtual ClpCholeskyBase::~ClpCholeskyBase  )  [virtual]
 

Destructor (has to be public).

ClpCholeskyBase::ClpCholeskyBase const ClpCholeskyBase  )  [protected]
 

Destructor (has to be public).


Member Function Documentation

virtual int ClpCholeskyBase::order ClpInterior model  )  [pure virtual]
 

Orders rows and saves pointer to matrix.and model.

returns non-zero if not enough memory

Implemented in ClpCholeskyDense, ClpCholeskyTaucs, ClpCholeskyWssmp, and ClpCholeskyWssmpKKT.

virtual int ClpCholeskyBase::factorize const double *  diagonal,
int *  rowsDropped
[pure virtual]
 

Factorize - filling in rowsDropped and returning number dropped.

If return code negative then out of memory

Implemented in ClpCholeskyDense, ClpCholeskyTaucs, ClpCholeskyWssmp, and ClpCholeskyWssmpKKT.

virtual void ClpCholeskyBase::solve double *  region  )  [pure virtual]
 

Uses factorization to solve.

Implemented in ClpCholeskyDense, ClpCholeskyTaucs, ClpCholeskyWssmp, and ClpCholeskyWssmpKKT.

virtual void ClpCholeskyBase::solveKKT double *  region1,
double *  region2,
const double *  diagonal,
double  diagonalScaleFactor
[virtual]
 

Uses factorization to solve.

  • given as if KKT. region1 is rows+columns, region2 is rows

Reimplemented in ClpCholeskyWssmpKKT.

int ClpCholeskyBase::status  )  const [inline]
 

status. Returns status

Definition at line 37 of file ClpCholeskyBase.hpp.

References status_.

int ClpCholeskyBase::numberRowsDropped  )  const [inline]
 

numberRowsDropped. Number of rows gone

Definition at line 40 of file ClpCholeskyBase.hpp.

References numberRowsDropped_.

void ClpCholeskyBase::resetRowsDropped  ) 
 

reset numberRowsDropped and rowsDropped.

char* ClpCholeskyBase::rowsDropped  )  const [inline]
 

rowsDropped - which rows are gone

Definition at line 45 of file ClpCholeskyBase.hpp.

References rowsDropped_.

double ClpCholeskyBase::choleskyCondition  )  const [inline]
 

choleskyCondition.

Definition at line 48 of file ClpCholeskyBase.hpp.

References choleskyCondition_.

int ClpCholeskyBase::rank  )  const [inline]
 

rank. Returns rank

Definition at line 51 of file ClpCholeskyBase.hpp.

References numberRows_, and numberRowsDropped_.

int ClpCholeskyBase::numberRows  )  const [inline]
 

Return number of rows.

Definition at line 54 of file ClpCholeskyBase.hpp.

References numberRows_.

ClpCholeskyBase& ClpCholeskyBase::operator= const ClpCholeskyBase  )  [protected]
 

Destructor (has to be public).

virtual ClpCholeskyBase* ClpCholeskyBase::clone  )  const [pure virtual]
 

Implemented in ClpCholeskyDense, ClpCholeskyTaucs, ClpCholeskyWssmp, and ClpCholeskyWssmpKKT.

int ClpCholeskyBase::type  )  const [inline]
 

Returns type.

Definition at line 83 of file ClpCholeskyBase.hpp.

References type_.

void ClpCholeskyBase::setType int  type  )  [inline, protected]
 

Sets type.

Definition at line 87 of file ClpCholeskyBase.hpp.

References type_.


Member Data Documentation

int ClpCholeskyBase::type_ [protected]
 

type (may be useful) if > 20 do KKT

Definition at line 96 of file ClpCholeskyBase.hpp.

Referenced by setType(), and type().

double ClpCholeskyBase::pivotTolerance_ [protected]
 

pivotTolerance.

Definition at line 98 of file ClpCholeskyBase.hpp.

double ClpCholeskyBase::zeroTolerance_ [protected]
 

zeroTolerance.

Definition at line 100 of file ClpCholeskyBase.hpp.

double ClpCholeskyBase::choleskyCondition_ [protected]
 

choleskyCondition.

Definition at line 102 of file ClpCholeskyBase.hpp.

Referenced by choleskyCondition().

ClpInterior* ClpCholeskyBase::model_ [protected]
 

model.

Definition at line 104 of file ClpCholeskyBase.hpp.

int ClpCholeskyBase::numberTrials_ [protected]
 

numberTrials. Number of trials before rejection

Definition at line 106 of file ClpCholeskyBase.hpp.

int ClpCholeskyBase::numberRows_ [protected]
 

numberRows. Number of Rows in factorization

Definition at line 108 of file ClpCholeskyBase.hpp.

Referenced by numberRows(), and rank().

int ClpCholeskyBase::status_ [protected]
 

status. Status of factorization

Definition at line 110 of file ClpCholeskyBase.hpp.

Referenced by status().

char* ClpCholeskyBase::rowsDropped_ [protected]
 

rowsDropped

Definition at line 112 of file ClpCholeskyBase.hpp.

Referenced by rowsDropped().

int* ClpCholeskyBase::permuteIn_ [protected]
 

permuteIn.

Definition at line 114 of file ClpCholeskyBase.hpp.

int* ClpCholeskyBase::permuteOut_ [protected]
 

permuteOut.

Definition at line 116 of file ClpCholeskyBase.hpp.

int ClpCholeskyBase::numberRowsDropped_ [protected]
 

numberRowsDropped. Number of rows gone

Definition at line 118 of file ClpCholeskyBase.hpp.

Referenced by numberRowsDropped(), and rank().


The documentation for this class was generated from the following file:
Generated on Fri Aug 6 11:42:58 2004 by doxygen 1.3.5