Public Member Functions

Provides matrix-valued optimization variables. More...

#include <matrix_variable.hpp>

Inheritance diagram for MatrixVariable:
Inheritance graph
[legend]

List of all members.

Public Member Functions

MatrixVariable getCols (uint startIdx, uint endIdx) const
DMatrix getMatrix () const
MatrixVariable getRows (uint startIdx, uint endIdx) const
returnValue init (uint _nRows, uint _nCols, VariableType _type=VT_UNKNOWN, const char **const _names=0, const char **const _units=0, DVector _scaling=emptyVector, DVector _lb=emptyVector, DVector _ub=emptyVector, BooleanType _autoInit=defaultAutoInit)
 MatrixVariable ()
 MatrixVariable (uint _nRows, uint _nCols, VariableType _type=VT_UNKNOWN, const char **const _names=0, const char **const _units=0, DVector _scaling=emptyVector, DVector _lb=emptyVector, DVector _ub=emptyVector, BooleanType _autoInit=defaultAutoInit)
 MatrixVariable (const MatrixVariable &rhs)
 MatrixVariable (const DMatrix &_matrix, VariableType _type=VT_UNKNOWN)
MatrixVariableoperator= (const MatrixVariable &rhs)
MatrixVariableoperator= (const DMatrix &rhs)
 ~MatrixVariable ()

Detailed Description

Provides matrix-valued optimization variables.

The class MatrixVariable provides matrix-valued optimization variables by enhancing the DMatrix class with variable-specific settings.

Author:
Hans Joachim Ferreau, Boris Houska

Definition at line 55 of file matrix_variable.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 46 of file matrix_variable.cpp.

MatrixVariable::MatrixVariable ( uint  _nRows,
uint  _nCols,
VariableType  _type = VT_UNKNOWN,
const char **const  _names = 0,
const char **const  _units = 0,
DVector  _scaling = emptyVector,
DVector  _lb = emptyVector,
DVector  _ub = emptyVector,
BooleanType  _autoInit = defaultAutoInit 
)

Constructor which takes dimensions of the matrix as well as all variable settings.

Parameters:
[in]_nRowsNumber of rows of each matrix.
[in]_nColsNumber of columns of each matrix.
[in]_typeType of the variable.
[in]_namesArray containing name labels for each component of the variable.
[in]_unitsArray containing unit labels for each component of the variable.
[in]_scalingScaling for each component of the variable.
[in]_lbLower bounds for each component of the variable.
[in]_ubUpper bounds for each component of the variable.
[in]_autoInitFlag indicating whether variable is to be automatically initialized.

Definition at line 51 of file matrix_variable.cpp.

Copy constructor (deep copy).

Parameters:
[in]rhsRight-hand side object.

Definition at line 65 of file matrix_variable.cpp.

MatrixVariable::MatrixVariable ( const DMatrix _matrix,
VariableType  _type = VT_UNKNOWN 
)

Copy constructor converting a matrix to a MatrixVariable (of given type).

Parameters:
[in]_matrixDMatrix to be converted.
[in]_typeType of the variable.

Definition at line 70 of file matrix_variable.cpp.

Destructor.

Definition at line 77 of file matrix_variable.cpp.


Member Function Documentation

MatrixVariable MatrixVariable::getCols ( uint  startIdx,
uint  endIdx 
) const

Returns a MatrixVariable containing only the columns between given indices while keeping all rows.

Parameters:
[in]startIdxIndex of first column to be included.
[in]endIdxIndex of last column to be included.
Note:
Is not fully implemented yet!
Returns:
DMatrix containing desired columns

Definition at line 148 of file matrix_variable.cpp.

DMatrix MatrixVariable::getMatrix ( ) const [inline]

Returns matrix containing the numerical values of the MatrixVariable.

Returns:
DMatrix containing the numerical values
MatrixVariable MatrixVariable::getRows ( uint  startIdx,
uint  endIdx 
) const

Returns a MatrixVariable containing only the rows between given indices while keeping all columns.

Parameters:
[in]startIdxIndex of first row to be included.
[in]endIdxIndex of last row to be included.
Note:
Is not fully implemented yet!
Returns:
DMatrix containing desired rows

Definition at line 128 of file matrix_variable.cpp.

returnValue MatrixVariable::init ( uint  _nRows,
uint  _nCols,
VariableType  _type = VT_UNKNOWN,
const char **const  _names = 0,
const char **const  _units = 0,
DVector  _scaling = emptyVector,
DVector  _lb = emptyVector,
DVector  _ub = emptyVector,
BooleanType  _autoInit = defaultAutoInit 
)

Initializes object with given dimensions of the matrix and given variable settings.

Parameters:
[in]_nRowsNumber of rows of each matrix.
[in]_nColsNumber of columns of each matrix.
[in]_typeType of the variable.
[in]_namesArray containing name labels for each component of the variable.
[in]_unitsArray containing unit labels for each component of the variable.
[in]_scalingScaling for each component of the variable.
[in]_lbLower bounds for each component of the variable.
[in]_ubUpper bounds for each component of the variable.
[in]_autoInitFlag indicating whether variable is to be automatically initialized.
Returns:
SUCCESSFUL_RETURN,
RET_UNKNOWN_BUG

Definition at line 107 of file matrix_variable.cpp.

MatrixVariable & MatrixVariable::operator= ( const MatrixVariable rhs)

Assignment operator (deep copy).

Parameters:
[in]rhsRight-hand side object.

Definition at line 82 of file matrix_variable.cpp.

MatrixVariable & MatrixVariable::operator= ( const DMatrix rhs)

Assignment operator converting a matrix to a MatrixVariable.

Parameters:
[in]rhsRight-hand side object.

Definition at line 94 of file matrix_variable.cpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Thu Aug 27 2015 12:01:39