Public Member Functions | Protected Attributes | List of all members
SparseMatrixRow Class Reference

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

#include <Matrices.hpp>

Inheritance diagram for SparseMatrixRow:
Inheritance graph
[legend]

Public Member Functions

virtual returnValue addToDiag (real_t alpha)
 
sparse_int_tcreateDiagInfo ()
 
virtual real_t diag (int_t i) const
 
virtual Matrixduplicate () const
 
virtual void free ()
 
virtual real_tfull () 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_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 returnValue print (const char *name=0) const
 
 SparseMatrixRow ()
 
 SparseMatrixRow (int_t nr, int_t nc, sparse_int_t *r, sparse_int_t *c, real_t *v)
 
 SparseMatrixRow (int_t nr, int_t nc, int_t ld, const real_t *const v)
 
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_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 ~SparseMatrixRow ()
 
- 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 returnValue print () const =0
 
virtual ~Matrix ()
 
virtual ~Matrix ()
 

Protected Attributes

sparse_int_tic
 
sparse_int_tjd
 
sparse_int_tjr
 
int_t nCols
 
int_t nRows
 
real_tval
 
- Protected Attributes inherited from Matrix
BooleanType freeMemory
 

Detailed Description

Interfaces matrix-vector operations tailored to general sparse matrices.

Sparse matrix class (row compressed format).

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

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

Constructor & Destructor Documentation

SparseMatrixRow::SparseMatrixRow ( )

Default constructor.

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

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

Constructor with arguments.

Parameters
nrNumber of rows.
ncNumber of columns.
rIndices to first entry of rows (nRows+1).
cColumn indices (length).
vVector of entries (length).

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

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

Constructor from dense matrix.

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

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

SparseMatrixRow::~SparseMatrixRow ( )
virtual

Destructor.

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

Member Function Documentation

returnValue SparseMatrixRow::addToDiag ( real_t  alpha)
virtual

Adds given offset to diagonal of matrix.

Returns
SUCCESSFUL_RETURN
RET_NO_DIAGONAL_AVAILABLE
Parameters
alphaDiagonal offset.

Implements Matrix.

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

sparse_int_t * SparseMatrixRow::createDiagInfo ( )

Create jd field from ir and jc.

Returns
Pointer to jd.

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

real_t SparseMatrixRow::diag ( int_t  i) const
virtual

Returns i-th diagonal entry.

Returns
i-th diagonal entry (or INFTY if diagonal does not exist)
Parameters
iIndex.

Implements Matrix.

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

Matrix * SparseMatrixRow::duplicate ( ) const
virtual

Returns a deep-copy of the Matrix object.

Returns
Deep-copy of Matrix object

Implements Matrix.

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

void SparseMatrixRow::free ( )
virtual

Frees all internal memory.

Implements Matrix.

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

real_t * SparseMatrixRow::full ( ) const
virtual

Allocates and creates dense matrix array in row major format.

Note: Calling function has to free allocated memory!

Returns
Pointer to matrix array.

Implements Matrix.

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

returnValue SparseMatrixRow::getCol ( int_t  cNum,
const Indexlist *const  irows,
real_t  alpha,
real_t col 
) const
virtual

Retrieve indexed entries of matrix column multiplied by alpha.

Parameters
cNumColumn number.
irowsIndex list specifying rows.
alphaScalar factor.
colOutput column vector.

Implements Matrix.

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

real_t SparseMatrixRow::getNorm ( int_t  type = 2) const
virtual

Get the N-norm of the matrix

Returns
N-norm of the matrix
Parameters
typeNorm type, 1: one-norm, 2: Euclidean norm.

Implements Matrix.

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

returnValue SparseMatrixRow::getRow ( int_t  rNum,
const Indexlist *const  icols,
real_t  alpha,
real_t row 
) const
virtual

Retrieve indexed entries of matrix row multiplied by alpha.

Parameters
rNumRow number.
icolsIndex list specifying columns.
alphaScalar factor.
rowOutput row vector.

Implements Matrix.

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

real_t SparseMatrixRow::getRowNorm ( int_t  rNum,
int_t  type = 2 
) const
virtual

Get the N-norm of a row

Returns
N-norm of row rNum
Parameters
rNumRow number.
typeNorm type, 1: one-norm, 2: Euclidean norm.

Implements Matrix.

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

returnValue SparseMatrixRow::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

Retrieve entries of submatrix in Harwell-Boeing sparse format. If irn, jcn, and avals are null, this only counts the number of nonzeros. Otherwise, numNonzeros containts the size of irn, jcn, and avals on entry, and the written number of entries on return.

Returns
SUCCESSFUL_RETURN
Parameters
irowsLengthNumber of rows.
irowsNumberArray with row numbers.
icolsLengthNumber of columns.
icolsNumberArray with column numbers.
rowoffsetOffset for row entries.
coloffsetOffset for row entries.
numNonzerosNumber of nonzeros in submatrix.
irnRow position of entries (as position in irows) plus rowoffset.
jcnColumn position of entries (as position in irows) plus coloffset.
avalsNumerical values of the entries.
only_lower_triangularif true, only the lower triangular portion is returned. This can only be true for symmetric matrices and if irows==jcols.

Implements Matrix.

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

BooleanType SparseMatrixRow::isDiag ( ) const
virtual

Checks whether matrix is square and diagonal.

Returns
BT_TRUE iff matrix is square and diagonal;
BT_FALSE otherwise.

Implements Matrix.

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

returnValue SparseMatrixRow::print ( const char *  name = 0) const
virtual

Prints matrix to screen.

Returns
SUCCESSFUL_RETURN
Parameters
nameName of matrix.

Implements Matrix.

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

returnValue SparseMatrixRow::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

Evaluate Y=alpha*A*X + beta*Y.

Parameters
xNNumber of vectors to multiply.
alphaScalar factor for matrix vector product.
xInput vector to be multiplied.
xLDLeading dimension of input x.
betaScalar factor for y.
yOutput vector of results.
yLDLeading dimension of output y.

Implements Matrix.

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

returnValue SparseMatrixRow::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

Evaluate matrix vector product with submatrix given by Indexlist.

Parameters
irowsIndex list specifying rows.
icolsIndex list specifying columns.
xNNumber of vectors to multiply.
alphaScalar factor for matrix vector product.
xInput vector to be multiplied.
xLDLeading dimension of input x.
betaScalar factor for y.
yOutput vector of results.
yLDLeading dimension of output y.
yComprCompressed storage for y.

Implements Matrix.

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

returnValue SparseMatrixRow::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

Evaluate Y=alpha*A'*X + beta*Y.

Parameters
xNNumber of vectors to multiply.
alphaScalar factor for matrix vector product.
xInput vector to be multiplied.
xLDLeading dimension of input x.
betaScalar factor for y.
yOutput vector of results.
yLDLeading dimension of output y.

Implements Matrix.

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

returnValue SparseMatrixRow::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

Evaluate matrix transpose vector product.

Parameters
irowsIndex list specifying rows.
icolsIndex list specifying columns.
xNNumber of vectors to multiply.
alphaScalar factor for matrix vector product.
xInput vector to be multiplied.
xLDLeading dimension of input x.
betaScalar factor for y.
yOutput vector of results.
yLDLeading dimension of output y.

Implements Matrix.

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

returnValue SparseMatrixRow::writeToFile ( FILE *  output_file,
const char *  prefix 
) const
virtual

Write matrix to file.

Returns
SUCCESSFUL_RETURN

Implements Matrix.

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

Member Data Documentation

sparse_int_t* SparseMatrixRow::ic
protected

Column indices (length).

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

sparse_int_t* SparseMatrixRow::jd
protected

Indices to first entry of upper triangle (including diagonal) (nRows).

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

sparse_int_t* SparseMatrixRow::jr
protected

Indices to first entry of row (nRows+1).

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

int_t SparseMatrixRow::nCols
protected

Number of columns.

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

int_t SparseMatrixRow::nRows
protected

Number of rows.

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

real_t* SparseMatrixRow::val
protected

Vector of entries (length).

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


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:26