Public Member Functions | List of all members
SymSparseMat Class Reference

Interfaces matrix-vector operations tailored to symmetric sparse matrices. More...

#include <Matrices.hpp>

Inheritance diagram for SymSparseMat:
Inheritance graph
[legend]

Public Member Functions

virtual returnValue bilinear (const Indexlist *const icols, int xN, const real_t *x, int xLD, real_t *y, int yLD) const
 
virtual returnValue bilinear (const Indexlist *const icols, int_t xN, const real_t *x, int_t xLD, real_t *y, int_t yLD) const
 
virtual Matrixduplicate () const
 
virtual Matrixduplicate () const
 
virtual SymmetricMatrixduplicateSym () const
 
 SymSparseMat ()
 
 SymSparseMat (long nr, long nc, long *r, long *c, real_t *v, long *d=0)
 
 SymSparseMat (int nr, int nc, int ld, const real_t *const v)
 
 SymSparseMat ()
 
 SymSparseMat (int_t nr, int_t nc, sparse_int_t *r, sparse_int_t *c, real_t *v)
 
 SymSparseMat (int_t nr, int_t nc, int_t ld, const real_t *const v)
 
virtual ~SymSparseMat ()
 
- Public Member Functions inherited from SymmetricMatrix
 SymmetricMatrix ()
 
virtual ~SymmetricMatrix ()
 
- Public Member Functions inherited from Matrix
void doFreeMemory ()
 
void doFreeMemory ()
 
void doNotFreeMemory ()
 
void doNotFreeMemory ()
 
virtual returnValue getSparseSubmatrix (const Indexlist *const irows, const Indexlist *const icols, int_t rowoffset, int_t coloffset, int_t &numNonzeros, int_t *irn, int_t *jcn, real_t *avals, BooleanType only_lower_triangular=BT_FALSE) const
 
virtual returnValue getSparseSubmatrix (const Indexlist *const irows, int_t idx_icol, int_t rowoffset, int_t coloffset, int_t &numNonzeros, int_t *irn, int_t *jcn, real_t *avals, BooleanType only_lower_triangular=BT_FALSE) const
 
virtual returnValue getSparseSubmatrix (int_t idx_row, const Indexlist *const icols, int_t rowoffset, int_t coloffset, int_t &numNonzeros, int_t *irn, int_t *jcn, real_t *avals, BooleanType only_lower_triangular=BT_FALSE) const
 
 Matrix ()
 
 Matrix ()
 
BooleanType needToFreeMemory () const
 
BooleanType needToFreeMemory () const
 
virtual ~Matrix ()
 
virtual ~Matrix ()
 
- Public Member Functions inherited from SparseMatrix
virtual returnValue addToDiag (real_t alpha)
 
virtual returnValue addToDiag (real_t alpha)
 
long * createDiagInfo ()
 
sparse_int_tcreateDiagInfo ()
 
virtual real_t diag (int i) const
 
virtual real_t diag (int_t i) const
 
virtual void free ()
 
virtual void free ()
 
real_tfull () const
 
virtual real_tfull () const
 
virtual returnValue getCol (int cNum, const Indexlist *const irows, real_t alpha, real_t *col) const
 
virtual returnValue getCol (int_t cNum, const Indexlist *const irows, real_t alpha, real_t *col) const
 
virtual real_t getNorm (int_t type=2) const
 
virtual returnValue getRow (int rNum, const Indexlist *const icols, real_t alpha, real_t *row) const
 
virtual returnValue getRow (int_t rNum, const Indexlist *const icols, real_t alpha, real_t *row) const
 
virtual real_t getRowNorm (int_t rNum, int_t type=2) const
 
virtual returnValue getSparseSubmatrix (int_t irowsLength, const int_t *const irowsNumber, int_t icolsLength, const int_t *const icolsNumber, int_t rowoffset, int_t coloffset, int_t &numNonzeros, int_t *irn, int_t *jcn, real_t *avals, BooleanType only_lower_triangular=BT_FALSE) const
 
virtual BooleanType isDiag () const
 
virtual BooleanType isDiag () const
 
virtual returnValue print () const
 
virtual returnValue print (const char *name=0) const
 
 SparseMatrix ()
 
 SparseMatrix (long nr, long nc, long *r, long *c, real_t *v, long *d=0)
 
 SparseMatrix (int nr, int nc, int ld, const real_t *const v)
 
 SparseMatrix ()
 
 SparseMatrix (int_t nr, int_t nc, sparse_int_t *r, sparse_int_t *c, real_t *v)
 
 SparseMatrix (int_t nr, int_t nc, int_t ld, const real_t *const v)
 
virtual returnValue times (int xN, real_t alpha, const real_t *x, int xLD, real_t beta, real_t *y, int yLD) const
 
virtual returnValue times (const Indexlist *const irows, const Indexlist *const icols, int xN, real_t alpha, const real_t *x, int xLD, real_t beta, real_t *y, int yLD, BooleanType yCompr=BT_TRUE) const
 
virtual returnValue times (int_t xN, real_t alpha, const real_t *x, int_t xLD, real_t beta, real_t *y, int_t yLD) const
 
virtual returnValue times (const Indexlist *const irows, const Indexlist *const icols, int_t xN, real_t alpha, const real_t *x, int_t xLD, real_t beta, real_t *y, int_t yLD, BooleanType yCompr=BT_TRUE) const
 
virtual returnValue transTimes (int xN, real_t alpha, const real_t *x, int xLD, real_t beta, real_t *y, int yLD) const
 
virtual returnValue transTimes (const Indexlist *const irows, const Indexlist *const icols, int xN, real_t alpha, const real_t *x, int xLD, real_t beta, real_t *y, int yLD) const
 
virtual returnValue transTimes (int_t xN, real_t alpha, const real_t *x, int_t xLD, real_t beta, real_t *y, int_t yLD) const
 
virtual returnValue transTimes (const Indexlist *const irows, const Indexlist *const icols, int_t xN, real_t alpha, const real_t *x, int_t xLD, real_t beta, real_t *y, int_t yLD) const
 
virtual returnValue writeToFile (FILE *output_file, const char *prefix) const
 
virtual ~SparseMatrix ()
 
virtual ~SparseMatrix ()
 

Additional Inherited Members

- Protected Attributes inherited from Matrix
BooleanType freeMemory
 
- Protected Attributes inherited from SparseMatrix
long * ir
 
sparse_int_tir
 
long * jc
 
sparse_int_tjc
 
long * jd
 
sparse_int_tjd
 
long nCols
 
int_t nCols
 
long nRows
 
int_t nRows
 
real_tval
 

Detailed Description

Interfaces matrix-vector operations tailored to symmetric sparse matrices.

Symmetric sparse matrix class (column compressed format).

Author
Andreas Potschka, Christian Kirches, Hans Joachim Ferreau
Version
3.0beta
Date
2011

Symmetric sparse matrix class (column compressed format).

Author
Andreas Potschka, Christian Kirches, Hans Joachim Ferreau
Version
3.2
Date
2011-2015

Definition at line 586 of file qpOASES-3.0beta/include/qpOASES/Matrices.hpp.

Constructor & Destructor Documentation

SymSparseMat::SymSparseMat ( )
inline

Default constructor.

Definition at line 590 of file qpOASES-3.0beta/include/qpOASES/Matrices.hpp.

SymSparseMat::SymSparseMat ( long  nr,
long  nc,
long *  r,
long *  c,
real_t v,
long *  d = 0 
)
inline

Constructor with arguments.

Parameters
nrNumber of rows.
ncNumber of columns.
rRow indices (length).
cIndices to first entry of columns (nCols+1).
vVector of entries (length).
dIndices to first entry of lower triangle (including diagonal) (nCols).

Definition at line 593 of file qpOASES-3.0beta/include/qpOASES/Matrices.hpp.

SymSparseMat::SymSparseMat ( int  nr,
int  nc,
int  ld,
const real_t *const  v 
)
inline

Constructor from dense matrix.

Parameters
nrNumber of rows.
ncNumber of columns.
ldLeading dimension.
vRow major stored matrix elements.

Definition at line 603 of file qpOASES-3.0beta/include/qpOASES/Matrices.hpp.

SymSparseMat::SymSparseMat ( )
inline

Default constructor.

Definition at line 965 of file qpOASES-3.2.0/include/qpOASES/Matrices.hpp.

SymSparseMat::SymSparseMat ( int_t  nr,
int_t  nc,
sparse_int_t r,
sparse_int_t c,
real_t v 
)
inline

Constructor with arguments.

Parameters
nrNumber of rows.
ncNumber of columns.
rRow indices (length).
cIndices to first entry of columns (nCols+1).
vVector of entries (length).

Definition at line 968 of file qpOASES-3.2.0/include/qpOASES/Matrices.hpp.

SymSparseMat::SymSparseMat ( int_t  nr,
int_t  nc,
int_t  ld,
const real_t *const  v 
)
inline

Constructor from dense matrix.

Parameters
nrNumber of rows.
ncNumber of columns.
ldLeading dimension.
vRow major stored matrix elements.

Definition at line 976 of file qpOASES-3.2.0/include/qpOASES/Matrices.hpp.

virtual SymSparseMat::~SymSparseMat ( )
inlinevirtual

Destructor.

Definition at line 983 of file qpOASES-3.2.0/include/qpOASES/Matrices.hpp.

Member Function Documentation

returnValue SymSparseMat::bilinear ( const Indexlist *const  icols,
int  xN,
const real_t x,
int  xLD,
real_t y,
int  yLD 
) const
virtual

Compute bilinear form y = x'*H*x using submatrix given by index list.

Returns
SUCCESSFUL_RETURN
Parameters
icolsIndex list specifying columns of x.
xNNumber of vectors to multiply.
xInput vector to be multiplied (uncompressed).
xLDLeading dimension of input x.
yOutput vector of results (compressed).
yLDLeading dimension of output y.

Implements SymmetricMatrix.

Definition at line 1108 of file qpOASES-3.0beta/src/Matrices.cpp.

virtual returnValue SymSparseMat::bilinear ( const Indexlist *const  icols,
int_t  xN,
const real_t x,
int_t  xLD,
real_t y,
int_t  yLD 
) const
virtual

Compute bilinear form y = x'*H*x using submatrix given by index list.

Returns
SUCCESSFUL_RETURN
Parameters
icolsIndex list specifying columns of x.
xNNumber of vectors to multiply.
xInput vector to be multiplied (uncompressed).
xLDLeading dimension of input x.
yOutput vector of results (compressed).
yLDLeading dimension of output y.

Implements SymmetricMatrix.

Matrix * SymSparseMat::duplicate ( ) const
virtual

Returns a deep-copy of the Matrix object.

Returns
Deep-copy of Matrix object

Reimplemented from SparseMatrix.

Definition at line 1085 of file qpOASES-3.0beta/src/Matrices.cpp.

virtual Matrix* SymSparseMat::duplicate ( ) const
virtual

Returns a deep-copy of the Matrix object.

Returns
Deep-copy of Matrix object

Reimplemented from SparseMatrix.

SymmetricMatrix * SymSparseMat::duplicateSym ( ) const
virtual

Returns a deep-copy of the SymmetricMatrix object.

Returns
Deep-copy of SymmetricMatrix object

Implements SymmetricMatrix.

Definition at line 2057 of file qpOASES-3.2.0/src/Matrices.cpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:27