Public Member Functions | Protected Member Functions | Protected Attributes | Friends
Flipper Class Reference

Auxiliary class for storing a copy of the current matrix factorisations. More...

#include <Flipper.hpp>

List of all members.

Public Member Functions

 Flipper ()
 Flipper (int _nV, int _nC=0)
 Flipper (const Flipper &rhs)
returnValue get (Bounds *const _bounds, double *const R, Constraints *const _constraints=0, double *const _Q=0, double *const _T=0) const
returnValue init (int _nV=0, int _nC=0)
Flipperoperator= (const Flipper &rhs)
returnValue set (const Bounds *const _bounds, const double *const _R, const Constraints *const _constraints=0, const double *const _Q=0, const double *const _T=0)
 ~Flipper ()

Protected Member Functions

returnValue clear ()
returnValue copy (const Flipper &rhs)
int getDimT () const

Protected Attributes

Bounds bounds
Constraints constraints
int nC
int nV
real_tQ
real_tR
real_tT

Friends

class QProblem
class QProblemB

Detailed Description

Auxiliary class for storing a copy of the current matrix factorisations.

This auxiliary class stores a copy of the current matrix factorisations. It is used by the classe QProblemB and QProblem in case flipping bounds are enabled.

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

Definition at line 57 of file Flipper.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 50 of file Flipper.cpp.

Flipper::Flipper ( int  _nV,
int  _nC = 0 
)

Constructor which takes the number of bounds and constraints.

Parameters:
_nVNumber of bounds.
_nCNumber of constraints.

Definition at line 63 of file Flipper.cpp.

Flipper::Flipper ( const Flipper rhs)

Copy constructor (deep copy).

Parameters:
rhsRhs object.

Definition at line 78 of file Flipper.cpp.

Destructor.

Definition at line 91 of file Flipper.cpp.


Member Function Documentation

returnValue Flipper::clear ( ) [protected]

Frees all allocated memory.

Returns:
SUCCESSFUL_RETURN

Definition at line 225 of file Flipper.cpp.

returnValue Flipper::copy ( const Flipper rhs) [protected]

Copies all members from given rhs object.

Returns:
SUCCESSFUL_RETURN
Parameters:
rhsRhs object.

Definition at line 252 of file Flipper.cpp.

returnValue Flipper::get ( Bounds *const  _bounds,
double *const  R,
Constraints *const  _constraints = 0,
double *const  _Q = 0,
double *const  _T = 0 
) const

Copies current values to non-null arguments (assumed to be allocated with consistent size).

Returns:
SUCCESSFUL_RETURN
Parameters:
_boundsPointer to new bounds.
RNew matrix R.
_constraintsPointer to new constraints.
_QNew matrix Q.
_TNew matrix T.

Definition at line 147 of file Flipper.cpp.

int Flipper::getDimT ( ) const [protected]

Returns dimension of matrix T.

Returns:
Dimension of matrix T.

Definition at line 259 of file Flipper.cpp.

returnValue Flipper::init ( int  _nV = 0,
int  _nC = 0 
)

Initialises object with given number of bounds and constraints.

Returns:
SUCCESSFUL_RETURN
RET_INVALID_ARGUMENTS
Parameters:
_nVNumber of bounds.
_nCNumber of constraints.

Definition at line 116 of file Flipper.cpp.

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

Assignment operator (deep copy).

Parameters:
rhsRhs object.

Definition at line 100 of file Flipper.cpp.

returnValue Flipper::set ( const Bounds *const  _bounds,
const double *const  _R,
const Constraints *const  _constraints = 0,
const double *const  _Q = 0,
const double *const  _T = 0 
)

Assigns new values to non-null arguments.

Returns:
SUCCESSFUL_RETURN
Parameters:
_boundsPointer to new bounds.
_RNew matrix R.
_constraintsPointer to new constraints.
_QNew matrix Q.
_TNew matrix T.

Definition at line 176 of file Flipper.cpp.


Friends And Related Function Documentation

friend class QProblem [friend]

Definition at line 60 of file Flipper.hpp.

friend class QProblemB [friend]

Definition at line 59 of file Flipper.hpp.


Member Data Documentation

Bounds Flipper::bounds [protected]

Data structure for problem's bounds.

Definition at line 138 of file Flipper.hpp.

Data structure for problem's constraints.

Definition at line 139 of file Flipper.hpp.

int Flipper::nC [protected]

Number of constraints.

Definition at line 136 of file Flipper.hpp.

int Flipper::nV [protected]

Number of variables.

Definition at line 135 of file Flipper.hpp.

real_t* Flipper::Q [protected]

Orthonormal quadratic matrix, A = [0 T]*Q'.

Definition at line 142 of file Flipper.hpp.

real_t* Flipper::R [protected]

Cholesky factor of H (i.e. H = R^T*R).

Definition at line 141 of file Flipper.hpp.

real_t* Flipper::T [protected]

Reverse triangular matrix, A = [0 T]*Q'.

Definition at line 143 of file Flipper.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:24