#include <CyclingManager.hpp>

Public Member Functions
returnValue	clearCyclingData ()

returnValue	clearCyclingData ()

	CyclingManager ()

	CyclingManager ()

	CyclingManager (const CyclingManager &rhs)

	CyclingManager (const CyclingManager &rhs)

CyclingStatus	getCyclingStatus (int number, BooleanType isBound) const

CyclingStatus	getCyclingStatus (int number, BooleanType isBound) const

returnValue	init (int _nV, int _nC)

returnValue	init (int _nV, int _nC)

BooleanType	isCyclingDetected () const

BooleanType	isCyclingDetected () const

CyclingManager &	operator= (const CyclingManager &rhs)

CyclingManager &	operator= (const CyclingManager &rhs)

returnValue	setCyclingStatus (int number, BooleanType isBound, CyclingStatus _status)

returnValue	setCyclingStatus (int number, BooleanType isBound, CyclingStatus _status)

	~CyclingManager ()

	~CyclingManager ()

Protected Attributes
BooleanType	cyclingDetected

int	nC

int	nV

CyclingStatus	status [NVMAX+NCMAX]

Detailed Description

This class is intended to detect and handle possible cycling during QP iterations. As cycling seems to occur quite rarely, this class is NOT FULLY IMPLEMENTED YET!

Author: Hans Joachim Ferreau

Version: 1.3embedded

Date: 2007-2008

Definition at line 50 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/CyclingManager.hpp.

Constructor & Destructor Documentation

CyclingManager::CyclingManager ( )

Default constructor.

Definition at line 47 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/CyclingManager.cpp.

CyclingManager::CyclingManager ( const CyclingManager & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

Definition at line 57 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/CyclingManager.cpp.

CyclingManager::~CyclingManager ( )

Destructor.

Definition at line 71 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/CyclingManager.cpp.

CyclingManager::CyclingManager ( )

Default constructor.

CyclingManager::CyclingManager ( const CyclingManager & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

CyclingManager::~CyclingManager ( )

Destructor.

Member Function Documentation

returnValue CyclingManager::clearCyclingData ( )

Clears all previous cycling information.

Returns: SUCCESSFUL_RETURN

Definition at line 171 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/CyclingManager.cpp.

returnValue CyclingManager::clearCyclingData ( )

Clears all previous cycling information.

Returns: SUCCESSFUL_RETURN

CyclingStatus CyclingManager::getCyclingStatus	(	int	number,
		BooleanType	isBound
	)		const

Returns if bound/constraint might cause cycling.

Returns: BT_TRUE: bound/constraint might cause cycling
BT_FALSE: otherwise

Parameters

number	Number of bound/constraint.
isBound	Flag that indicates if given number corresponds to a bound (BT_TRUE) or a constraint (BT_FALSE).

Definition at line 149 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/CyclingManager.cpp.

CyclingStatus CyclingManager::getCyclingStatus	(	int	number,
		BooleanType	isBound
	)		const

Returns if bound/constraint might cause cycling.

Returns: BT_TRUE: bound/constraint might cause cycling
BT_FALSE: otherwise

Parameters

number	Number of bound/constraint.
isBound	Flag that indicates if given number corresponds to a bound (BT_TRUE) or a constraint (BT_FALSE).

returnValue CyclingManager::init	(	int	_nV,
		int	_nC
	)

Pseudo-constructor which takes the number of bounds/constraints.

Returns: SUCCESSFUL_RETURN

Parameters

_nV	Number of bounds to be managed.
_nC	Number of constraints to be managed.

returnValue CyclingManager::init	(	int	_nV,
		int	_nC
	)

Pseudo-constructor which takes the number of bounds/constraints.

Returns: SUCCESSFUL_RETURN

Parameters

_nV	Number of bounds to be managed.
_nC	Number of constraints to be managed.

Definition at line 102 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/CyclingManager.cpp.

BooleanType CyclingManager::isCyclingDetected ( ) const

inline

Returns if cycling was detected.

Returns: BT_TRUE iff cycling was detected.

BooleanType CyclingManager::isCyclingDetected ( ) const

inline

Returns if cycling was detected.

Returns: BT_TRUE iff cycling was detected.

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

Copy asingment operator (deep copy).

Parameters

rhs	Rhs object.

Definition at line 79 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/CyclingManager.cpp.

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

Copy asingment operator (deep copy).

Parameters

rhs	Rhs object.

returnValue CyclingManager::setCyclingStatus	(	int	number,
		BooleanType	isBound,
		CyclingStatus	_status
	)

Stores index of a bound/constraint that might cause cycling.

Returns: SUCCESSFUL_RETURN
RET_INDEX_OUT_OF_BOUNDS

Parameters

number	Number of bound/constraint.
isBound	Flag that indicates if given number corresponds to a bound (BT_TRUE) or a constraint (BT_FALSE).
_status	Cycling status of bound/constraint.

Definition at line 117 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/CyclingManager.cpp.

returnValue CyclingManager::setCyclingStatus	(	int	number,
		BooleanType	isBound,
		CyclingStatus	_status
	)

Stores index of a bound/constraint that might cause cycling.

Returns: SUCCESSFUL_RETURN
RET_INDEX_OUT_OF_BOUNDS

Parameters

number	Number of bound/constraint.
isBound	Flag that indicates if given number corresponds to a bound (BT_TRUE) or a constraint (BT_FALSE).
_status	Cycling status of bound/constraint.