Public Member Functions | Protected Attributes

(not yet documented) More...

#include <acado_csparse.hpp>

Inheritance diagram for ACADOcsparse:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ACADOcsparse ()
 ACADOcsparse (const ACADOcsparse &arg)
virtual ACADOcsparseclone () const
virtual returnValue getX (double *x_)
virtual returnValue setDimension (const int &n)
virtual returnValue setIndices (const int *rowIdx_, const int *colIdx_)
virtual returnValue setMatrix (double *A_)
virtual returnValue setNumberOfEntries (const int &nDense_)
virtual returnValue setPrintLevel (PrintLevel printLevel_)
virtual returnValue setTolerance (double TOL_)
virtual returnValue solve (double *b)
virtual returnValue solveTranspose (double *b)
virtual ~ACADOcsparse ()

Protected Attributes

int dim
int * index1
int * index2
cs_numericN
int nDense
PrintLevel printLevel
cs_symbolicS
double TOL
double * x

Detailed Description

(not yet documented)

The class ...

Author:
Boris Houska, Hans Joachim Ferreau

Definition at line 66 of file acado_csparse.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 52 of file acado_csparse.cpp.

Copy constructor (deep copy).

Definition at line 65 of file acado_csparse.cpp.

Destructor.

Definition at line 90 of file acado_csparse.cpp.


Member Function Documentation

ACADOcsparse * ACADOcsparse::clone ( ) const [virtual]

Clone operator (deep copy).

Implements SparseSolver.

Definition at line 116 of file acado_csparse.cpp.

returnValue ACADOcsparse::getX ( double *  x_) [virtual]

Returns the solution of the equation A*x = b if solved.

Returns:
SUCCESSFUL_RETURN

Implements SparseSolver.

Definition at line 230 of file acado_csparse.cpp.

returnValue ACADOcsparse::setDimension ( const int &  n) [virtual]

Defines the dimension n of A R^{n n}

Returns:
SUCCESSFUL_RETURN

Implements SparseSolver.

Definition at line 164 of file acado_csparse.cpp.

returnValue ACADOcsparse::setIndices ( const int *  rowIdx_,
const int *  colIdx_ 
) [virtual]

Sets an index list containing the positions of the
non-zero elements in the matrix A.

Implements SparseSolver.

Definition at line 184 of file acado_csparse.cpp.

returnValue ACADOcsparse::setMatrix ( double *  A_) [virtual]

Sets the non-zero elements of the matrix A. The double* A
is assumed to contain nDense entries corresponding to
non-zero elements of A.

Implements SparseSolver.

Definition at line 204 of file acado_csparse.cpp.

returnValue ACADOcsparse::setNumberOfEntries ( const int &  nDense_) [virtual]

Defines the number of non-zero elements in the
matrix A

Returns:
SUCCESSFUL_RETURN

Implements SparseSolver.

Definition at line 178 of file acado_csparse.cpp.

Sets the print level.

Returns:
SUCCESSFUL_RETURN

Implements SparseSolver.

Definition at line 245 of file acado_csparse.cpp.

returnValue ACADOcsparse::setTolerance ( double  TOL_) [virtual]

Sets the required tolerance (accuracy) for the solution of
the linear equation. For large tolerances an iterative
algorithm might converge earlier.

Requires || A*x - b || <= TOL

The norm || . || is possibly scaled by a preconditioner.

Returns:
SUCCESSFUL_RETURN

Implements SparseSolver.

Definition at line 239 of file acado_csparse.cpp.

returnValue ACADOcsparse::solve ( double *  b) [virtual]

Solves the system A*x = b for the specified data.

Returns:
SUCCESSFUL_RETURN
RET_LINEAR_SYSTEM_NUMERICALLY_SINGULAR

Implements SparseSolver.

Definition at line 122 of file acado_csparse.cpp.

returnValue ACADOcsparse::solveTranspose ( double *  b) [virtual]

Solves the system A^T*x = b for the specified data.

Returns:
SUCCESSFUL_RETURN
RET_LINEAR_SYSTEM_NUMERICALLY_SINGULAR

Reimplemented from SparseSolver.

Definition at line 143 of file acado_csparse.cpp.


Member Data Documentation

int ACADOcsparse::dim [protected]

Definition at line 181 of file acado_csparse.hpp.

int* ACADOcsparse::index1 [protected]

Definition at line 183 of file acado_csparse.hpp.

int * ACADOcsparse::index2 [protected]

Definition at line 183 of file acado_csparse.hpp.

Definition at line 195 of file acado_csparse.hpp.

int ACADOcsparse::nDense [protected]

Definition at line 182 of file acado_csparse.hpp.

Definition at line 199 of file acado_csparse.hpp.

Definition at line 194 of file acado_csparse.hpp.

double ACADOcsparse::TOL [protected]

Definition at line 198 of file acado_csparse.hpp.

double* ACADOcsparse::x [protected]

Definition at line 189 of file acado_csparse.hpp.


The documentation for this class was generated from the following files:


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:23