Manages working sets of bounds (= box constraints). More...

#include <Bounds.hpp>

Inheritance diagram for Bounds:

Public Member Functions
	Bounds ()

	Bounds ()

	Bounds (const Bounds &rhs)

	Bounds (const Bounds &rhs)

	Bounds ()

	Bounds ()

	Bounds (int_t _n)

	Bounds (int _n)

	Bounds (const Bounds &rhs)

	Bounds (const Bounds &rhs)

returnValue	flipFixed (int_t number)

returnValue	flipFixed (int number)

Indexlist *	getFixed ()

Indexlist *	getFixed ()

Indexlist *	getFixed ()

Indexlist *	getFixed ()

Indexlist *	getFree ()

Indexlist *	getFree ()

Indexlist *	getFree ()

Indexlist *	getFree ()

int	getNBV () const

int	getNBV () const

int_t	getNBV () const

int	getNBV () const

int	getNFR ()

int	getNFR ()

int_t	getNFR () const

int	getNFR () const

int	getNFV () const

int	getNFV () const

int_t	getNFV () const

int	getNFV () const

int	getNFX ()

int	getNFX ()

int_t	getNFX () const

int	getNFX () const

int	getNUV () const

int	getNUV () const

int_t	getNUV () const

int	getNUV () const

int	getNV () const

int	getNV () const

int	getNV () const

int_t	getNV () const

returnValue	init (int n)

returnValue	init (int n)

returnValue	init (int_t _n=0)

returnValue	init (int _n=0)

returnValue	moveFixedToFree (int _number)

returnValue	moveFixedToFree (int _number)

returnValue	moveFixedToFree (int_t number)

returnValue	moveFixedToFree (int number)

returnValue	moveFreeToFixed (int _number, SubjectToStatus _status)

returnValue	moveFreeToFixed (int _number, SubjectToStatus _status)

returnValue	moveFreeToFixed (int_t number, SubjectToStatus _status)

returnValue	moveFreeToFixed (int number, SubjectToStatus _status)

Bounds &	operator= (const Bounds &rhs)

Bounds &	operator= (const Bounds &rhs)

Bounds &	operator= (const Bounds &rhs)

Bounds &	operator= (const Bounds &rhs)

returnValue	print ()

returnValue	print ()

virtual returnValue	rotate (int_t offset)

virtual returnValue	rotate (int offset)

returnValue	setNBV (int n)

returnValue	setNBV (int n)

returnValue	setNFV (int n)

returnValue	setNFV (int n)

returnValue	setNUV (int n)

returnValue	setNUV (int n)

returnValue	setupAllFree ()

returnValue	setupAllFree ()

returnValue	setupAllFree ()

returnValue	setupAllFree ()

returnValue	setupAllLower ()

returnValue	setupAllLower ()

returnValue	setupAllUpper ()

returnValue	setupAllUpper ()

returnValue	setupBound (int _number, SubjectToStatus _status)

returnValue	setupBound (int _number, SubjectToStatus _status)

returnValue	setupBound (int_t number, SubjectToStatus _status)

returnValue	setupBound (int number, SubjectToStatus _status)

virtual returnValue	shift (int_t offset)

virtual returnValue	shift (int offset)

returnValue	swapFree (int number1, int number2)

returnValue	swapFree (int number1, int number2)

returnValue	swapFree (int number1, int number2)

returnValue	swapFree (int_t number1, int_t number2)

	~Bounds ()

	~Bounds ()

virtual	~Bounds ()

virtual	~Bounds ()

Public Member Functions inherited from SubjectTo
int	getNumberOfType (SubjectToType _type) const

int_t	getNumberOfType (SubjectToType _type) const

SubjectToStatus	getStatus (int i) const

SubjectToStatus	getStatus (int i) const

SubjectToStatus	getStatus (int i) const

SubjectToStatus	getStatus (int_t i) const

SubjectToType	getType (int i) const

SubjectToType	getType (int i) const

SubjectToType	getType (int i) const

SubjectToType	getType (int_t i) const

BooleanType	hasNoLower () const

BooleanType	hasNoLower () const

BooleanType	hasNoUpper () const

BooleanType	hasNoUpper () const

returnValue	init (int n)

returnValue	init (int n)

returnValue	init (int _n=0)

returnValue	init (int_t _n=0)

BooleanType	isNoLower () const

BooleanType	isNoLower () const

BooleanType	isNoUpper () const

BooleanType	isNoUpper () const

SubjectTo &	operator= (const SubjectTo &rhs)

SubjectTo &	operator= (const SubjectTo &rhs)

SubjectTo &	operator= (const SubjectTo &rhs)

SubjectTo &	operator= (const SubjectTo &rhs)

void	setNoLower (BooleanType _status)

void	setNoLower (BooleanType _status)

void	setNoLower (BooleanType _status)

void	setNoLower (BooleanType _status)

void	setNoUpper (BooleanType _status)

void	setNoUpper (BooleanType _status)

void	setNoUpper (BooleanType _status)

void	setNoUpper (BooleanType _status)

returnValue	setStatus (int i, SubjectToStatus value)

returnValue	setStatus (int i, SubjectToStatus value)

returnValue	setStatus (int_t i, SubjectToStatus value)

returnValue	setStatus (int i, SubjectToStatus value)

returnValue	setType (int i, SubjectToType value)

returnValue	setType (int i, SubjectToType value)

returnValue	setType (int_t i, SubjectToType value)

returnValue	setType (int i, SubjectToType value)

	SubjectTo ()

	SubjectTo ()

	SubjectTo (const SubjectTo &rhs)

	SubjectTo (const SubjectTo &rhs)

	SubjectTo ()

	SubjectTo ()

	SubjectTo (int _n)

	SubjectTo (int_t _n)

	SubjectTo (const SubjectTo &rhs)

	SubjectTo (const SubjectTo &rhs)

	~SubjectTo ()

	~SubjectTo ()

virtual	~SubjectTo ()

virtual	~SubjectTo ()

Public Attributes
int	n

BooleanType	noLower

BooleanType	noUpper

SubjectToStatus	status [NVMAX]

SubjectToType	type [NVMAX]

Protected Member Functions
returnValue	clear ()

returnValue	clear ()

returnValue	copy (const Bounds &rhs)

returnValue	copy (const Bounds &rhs)

returnValue	setupAll (SubjectToStatus _status)

returnValue	setupAll (SubjectToStatus _status)

Protected Member Functions inherited from SubjectTo
returnValue	addIndex (Indexlist *const indexlist, int newnumber, SubjectToStatus newstatus)

returnValue	addIndex (Indexlist *const indexlist, int newnumber, SubjectToStatus newstatus)

returnValue	addIndex (Indexlist *const indexlist, int newnumber, SubjectToStatus newstatus)

returnValue	addIndex (Indexlist *const indexlist, int_t newnumber, SubjectToStatus newstatus)

returnValue	clear ()

returnValue	clear ()

returnValue	copy (const SubjectTo &rhs)

returnValue	copy (const SubjectTo &rhs)

returnValue	removeIndex (Indexlist *const indexlist, int removenumber)

returnValue	removeIndex (Indexlist *const indexlist, int removenumber)

returnValue	removeIndex (Indexlist *const indexlist, int_t removenumber)

returnValue	removeIndex (Indexlist *const indexlist, int removenumber)

returnValue	swapIndex (Indexlist *const indexlist, int number1, int number2)

returnValue	swapIndex (Indexlist *const indexlist, int number1, int number2)

returnValue	swapIndex (Indexlist *const indexlist, int number1, int number2)

returnValue	swapIndex (Indexlist *const indexlist, int_t number1, int_t number2)

Protected Attributes
Indexlist	fixed

Indexlist	free

Indexlist	freee

int	nBV

int	nFV

int	nUV

int	nV

Protected Attributes inherited from SubjectTo
int	n

int_t	n

BooleanType	noLower

BooleanType	noUpper

SubjectToStatus	status [NVMAX+NCMAX]

SubjectToStatus *	status

SubjectToType	type [NVMAX+NCMAX]

SubjectToType *	type

Detailed Description

Manages working sets of bounds (= box constraints).

Manages working sets of bounds (i.e. box constraints).

This class manages working sets of bounds by storing index sets and other status information.

Author: Hans Joachim Ferreau

Version: 1.3embedded

Date: 2007-2008

This class manages working sets of bounds (= box constraints) by storing index sets and other status information.

Author: Hans Joachim Ferreau

Version: 3.0beta

Date: 2007-2011

This class manages working sets of bounds (= box constraints) by storing index sets and other status information.

Author: Hans Joachim Ferreau

Version: 3.2

Date: 2007-2015

This class manages working sets of bounds (= box constraints) by storing index sets and other status information.

Author: Hans Joachim Ferreau

Version: 3.1embedded

Date: 2007-2015

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

Constructor & Destructor Documentation

BEGIN_NAMESPACE_QPOASES Bounds::Bounds ( )

Default constructor.

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

Bounds::Bounds ( const Bounds & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

Definition at line 59 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Bounds.cpp.

Bounds::~Bounds ( )

Destructor.

Definition at line 73 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Bounds.cpp.

Bounds::Bounds ( )

Default constructor.

Bounds::Bounds ( const Bounds & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

Bounds::~Bounds ( )

Destructor.

Bounds::Bounds ( )

Default constructor.

Bounds::Bounds ( int _n )

Constructor which takes the number of bounds.

Parameters

_n	Number of bounds.

Definition at line 58 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

Bounds::Bounds ( const Bounds & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

virtual Bounds::~Bounds ( )

virtual

Destructor.

Bounds::Bounds ( )

Default constructor.

Bounds::Bounds ( int_t _n )

Constructor which takes the number of bounds.

Parameters

_n	Number of bounds.

Bounds::Bounds ( const Bounds & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

virtual Bounds::~Bounds ( )

virtual

Destructor.

Member Function Documentation

returnValue Bounds::clear ( )

protected

Frees all allocated memory.

Returns: SUCCESSFUL_RETURN

Definition at line 439 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

returnValue Bounds::clear ( )

protected

Frees all allocated memory.

Returns: SUCCESSFUL_RETURN

returnValue Bounds::copy ( const Bounds & rhs )

protected

Copies all members from given rhs object.

Returns: SUCCESSFUL_RETURN

Parameters

rhs	Rhs object.

returnValue Bounds::copy ( const Bounds & rhs )

protected

Copies all members from given rhs object.

Returns: SUCCESSFUL_RETURN

Parameters

rhs	Rhs object.

Definition at line 448 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

returnValue Bounds::flipFixed ( int_t number )

Flip fixed bound.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

returnValue Bounds::flipFixed ( int number )

Flip fixed bound.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

Definition at line 228 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

Indexlist* Bounds::getFixed ( )

inline

Returns a pointer to fixed variables index list.

Returns: Pointer to fixed variables index list.

Indexlist* Bounds::getFixed ( )

inline

Returns a pointer to fixed variables index list.

Returns: Pointer to fixed variables index list.

Indexlist* Bounds::getFixed ( )

inline

Returns a pointer to fixed variables index list.

Returns: Pointer to fixed variables index list.

Indexlist* Bounds::getFixed ( )

inline

Returns a pointer to fixed variables index list.

Returns: Pointer to fixed variables index list.

Indexlist* Bounds::getFree ( )

inline

Returns a pointer to free variables index list.

Returns: Pointer to free variables index list.

Indexlist* Bounds::getFree ( )

inline

Returns a pointer to free variables index list.

Returns: Pointer to free variables index list.

Indexlist* Bounds::getFree ( )

inline

Returns a pointer to free variables index list.

Returns: Pointer to free variables index list.

Indexlist* Bounds::getFree ( )

inline

Returns a pointer to free variables index list.

Returns: Pointer to free variables index list.

int Bounds::getNBV ( ) const

inline

Returns number of bounded (but possibly free) variables.

Returns: Number of bounded (but possibly free) variables.

int Bounds::getNBV ( ) const

inline

Returns number of bounded (but possibly free) variables.

Returns: Number of bounded (but possibly free) variables.

int_t Bounds::getNBV ( ) const

inline

Returns number of bounded (but possibly free) variables.

Returns: Number of bounded (but possibly free) variables.

int Bounds::getNBV ( ) const

inline

Returns number of bounded (but possibly free) variables.

Returns: Number of bounded (but possibly free) variables.

int Bounds::getNFR ( )

inline

Returns number of free variables.

Returns: Number of free variables.

int Bounds::getNFR ( )

inline

Returns number of free variables.

Returns: Number of free variables.

int_t Bounds::getNFR ( ) const

inline

Returns number of free variables.

Returns: Number of free variables.

int Bounds::getNFR ( ) const

inline

Returns number of free variables.

Returns: Number of free variables.

int Bounds::getNFV ( ) const

inline

Returns number of implicitly fixed variables.

Returns: Number of implicitly fixed variables.

int Bounds::getNFV ( ) const

inline

Returns number of implicitly fixed variables.

Returns: Number of implicitly fixed variables.

int_t Bounds::getNFV ( ) const

inline

Returns number of implicitly fixed variables.

Returns: Number of implicitly fixed variables.

int Bounds::getNFV ( ) const

inline

Returns number of implicitly fixed variables.

Returns: Number of implicitly fixed variables.

int Bounds::getNFX ( )

inline

Returns number of fixed variables.

Returns: Number of fixed variables.

int Bounds::getNFX ( )

inline

Returns number of fixed variables.

Returns: Number of fixed variables.

int_t Bounds::getNFX ( ) const

inline

Returns number of fixed variables.

Returns: Number of fixed variables.

int Bounds::getNFX ( ) const

inline

Returns number of fixed variables.

Returns: Number of fixed variables.

int Bounds::getNUV ( ) const

inline

Returns number of unbounded variables.

Returns: Number of unbounded variables.

int Bounds::getNUV ( ) const

inline

Returns number of unbounded variables.

Returns: Number of unbounded variables.

int_t Bounds::getNUV ( ) const

inline

Returns number of unbounded variables.

Returns: Number of unbounded variables.

int Bounds::getNUV ( ) const

inline

Returns number of unbounded variables.

Returns: Number of unbounded variables.

int Bounds::getNV ( ) const

inline

Returns number of variables.

Returns: Number of variables.

int Bounds::getNV ( ) const

inline

Returns number of variables.

Returns: Number of variables.

int_t Bounds::getNV ( ) const

inline

Returns number of variables.

Returns: Number of variables.

int Bounds::getNV ( ) const

inline

Returns number of variables.

Returns: Number of variables.

returnValue Bounds::init ( int n )

Pseudo-constructor takes the number of bounds.

Returns: SUCCESSFUL_RETURN

Parameters

n	Number of bounds.

Definition at line 103 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Bounds.cpp.

returnValue Bounds::init ( int n )

Pseudo-constructor takes the number of bounds.

Returns: SUCCESSFUL_RETURN

Parameters

n	Number of bounds.

returnValue Bounds::init ( int _n = 0 )

Initialises object with given number of bounds.

Returns: SUCCESSFUL_RETURN
RET_INVALID_ARGUMENTS

Parameters

_n	Number of bounds.

returnValue Bounds::init ( int_t _n = 0 )

Initialises object with given number of bounds.

Returns: SUCCESSFUL_RETURN
RET_INVALID_ARGUMENTS

Parameters

_n	Number of bounds.

returnValue Bounds::moveFixedToFree ( int _number )

Moves index of a bound from index list of fixed to that of free bounds.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

Parameters

_number Number of bound to be freed.

returnValue Bounds::moveFixedToFree ( int _number )

Moves index of a bound from index list of fixed to that of free bounds.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

Parameters

_number Number of bound to be freed.

Definition at line 197 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Bounds.cpp.

returnValue Bounds::moveFixedToFree ( int_t number )

Moves index of a bound from index list of fixed to that of free bounds.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

Parameters

number Number of bound to be freed.

returnValue Bounds::moveFixedToFree ( int number )

Moves index of a bound from index list of fixed to that of free bounds.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

Parameters

number Number of bound to be freed.

returnValue Bounds::moveFreeToFixed	(	int	_number,
		SubjectToStatus	_status
	)

Moves index of a bound from index list of free to that of fixed bounds.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

Parameters

_number	Number of bound to be fixed.
_status	Status of bound to be fixed.

returnValue Bounds::moveFreeToFixed	(	int	_number,
		SubjectToStatus	_status
	)

Moves index of a bound from index list of free to that of fixed bounds.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

Parameters

_number	Number of bound to be fixed.
_status	Status of bound to be fixed.

Definition at line 217 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Bounds.cpp.

returnValue Bounds::moveFreeToFixed	(	int	number,
		SubjectToStatus	_status
	)

Moves index of a bound from index list of free to that of fixed bounds.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

Parameters

number	Number of bound to be fixed.
_status	Status of bound to be fixed.

returnValue Bounds::moveFreeToFixed	(	int_t	number,
		SubjectToStatus	_status
	)

Moves index of a bound from index list of free to that of fixed bounds.

Returns: SUCCESSFUL_RETURN
RET_MOVING_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS

Parameters

number	Number of bound to be fixed.
_status	Status of bound to be fixed.

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

Assignment operator (deep copy).

Parameters

rhs	Rhs object.

Definition at line 81 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Bounds.cpp.

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

Assignment operator (deep copy).

Parameters

rhs	Rhs object.

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

Assignment operator (deep copy).

Parameters

rhs	Rhs object.

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

Assignment operator (deep copy).

Parameters

rhs	Rhs object.

returnValue Bounds::print ( )

Prints information on bounds object (in particular, lists of free and fixed bounds.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_CORRUPTED

returnValue Bounds::print ( )

Prints information on bounds object (in particular, lists of free and fixed bounds.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_CORRUPTED

Definition at line 400 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

virtual returnValue Bounds::rotate ( int_t offset )

virtual

Rotates forward type and status of all bounds by a given offset. This offset has to lie within the range [0,n]. Example for offset = 2:
rotate( {b1,b2,b3,b4,b5,b6} ) = {b3,b4,b5,b6,b1,b2}

Returns: SUCCESSFUL_RETURN
RET_INDEX_OUT_OF_BOUNDS
RET_ROTATING_FAILED

Parameters

offset Rotation offset within the range [0,n].

Implements SubjectTo.

returnValue Bounds::rotate ( int offset )

virtual

Rotates forward type and status of all bounds by a given offset. This offset has to lie within the range [0,n]. Example for offset = 2:
rotate( {c/b1,c/b2,c/b3,c/b4,c/b5,c/b6} ) = {c/b3,c/b4,c/b5,c/b6,c/b1,c/b2}

Returns: SUCCESSFUL_RETURN
RET_INDEX_OUT_OF_BOUNDS
RET_ROTATING_FAILED

Parameters

offset Rotation offset within the range [0,n].

Implements SubjectTo.

Definition at line 325 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

returnValue Bounds::setNBV ( int n )

inline

Sets number of bounded (but possibly free) variables.

Returns: SUCCESSFUL_RETURN

Parameters

n	Number of bounded (but possibly free) variables.

returnValue Bounds::setNBV ( int n )

inline

Sets number of bounded (but possibly free) variables.

Returns: SUCCESSFUL_RETURN

Parameters

n	Number of bounded (but possibly free) variables.

returnValue Bounds::setNFV ( int n )

inline

Sets number of implicitly fixed variables.

Returns: SUCCESSFUL_RETURN

Parameters

n	Number of implicitly fixed variables.

returnValue Bounds::setNFV ( int n )

inline

Sets number of implicitly fixed variables.

Returns: SUCCESSFUL_RETURN

Parameters

n	Number of implicitly fixed variables.

returnValue Bounds::setNUV ( int n )

inline

Sets number of unbounded variables.

Returns: SUCCESSFUL_RETURN

Parameters

n	Number of unbounded variables

returnValue Bounds::setNUV ( int n )

inline

Sets number of unbounded variables.

Returns: SUCCESSFUL_RETURN

Parameters

n	Number of unbounded variables

returnValue Bounds::setupAll ( SubjectToStatus _status )

protected

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set corresponding to the desired status; the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

Parameters

_status Desired initial status for all bounds.

returnValue Bounds::setupAll ( SubjectToStatus _status )

protected

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set corresponding to the desired status; the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

Parameters

_status Desired initial status for all bounds.

Definition at line 462 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

returnValue Bounds::setupAllFree ( )

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set of free bounds; the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

Definition at line 156 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Bounds.cpp.

returnValue Bounds::setupAllFree ( )

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set of free bounds; the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

returnValue Bounds::setupAllFree ( )

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set of free bounds; the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

returnValue Bounds::setupAllFree ( )

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set of free bounds; the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

returnValue Bounds::setupAllLower ( )

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set of fixed bounds (on their lower bounds); the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

Definition at line 169 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

returnValue Bounds::setupAllLower ( )

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set of fixed bounds (on their lower bounds); the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

returnValue Bounds::setupAllUpper ( )

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set of fixed bounds (on their upper bounds); the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

Definition at line 178 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

returnValue Bounds::setupAllUpper ( )

Initially adds all numbers of new (i.e. not yet in the list) bounds to to the index set of fixed bounds (on their upper bounds); the order depends on the SujectToType of each index.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED

returnValue Bounds::setupBound	(	int	_number,
		SubjectToStatus	_status
	)

Initially adds number of a new (i.e. not yet in the list) bound to given index set.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS
RET_INVALID_ARGUMENTS

Parameters

_number	Number of new bound.
_status	Status of new bound.

returnValue Bounds::setupBound	(	int	_number,
		SubjectToStatus	_status
	)

Initially adds number of a new (i.e. not yet in the list) bound to given index set.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS
RET_INVALID_ARGUMENTS

Parameters

_number	Number of new bound.
_status	Status of new bound.

Definition at line 120 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Bounds.cpp.

returnValue Bounds::setupBound	(	int_t	number,
		SubjectToStatus	_status
	)

Initially adds number of a new (i.e. not yet in the list) bound to given index set.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS
RET_INVALID_ARGUMENTS

Parameters

number	Number of new bound.
_status	Status of new bound.

returnValue Bounds::setupBound	(	int	number,
		SubjectToStatus	_status
	)

Initially adds number of a new (i.e. not yet in the list) bound to given index set.

Returns: SUCCESSFUL_RETURN
RET_SETUP_BOUND_FAILED
RET_INDEX_OUT_OF_BOUNDS
RET_INVALID_ARGUMENTS

Parameters

number	Number of new bound.
_status	Status of new bound.

returnValue Bounds::shift ( int offset )

virtual

Shifts forward type and status of all bounds by a given offset. This offset has to lie within the range [0,n/2] and has to be an integer divisor of the total number of bounds n. Type and status of the first <offset> bounds is thrown away, type and status of the last <offset> bounds is real_td, e.g. for offset = 2:
shift( {c/b1,c/b2,c/b3,c/b4,c/b5,c/b6} ) = {c/b3,c/b4,c/b5,c/b6,c/b5,c/b6}

Returns: SUCCESSFUL_RETURN
RET_INDEX_OUT_OF_BOUNDS
RET_INVALID_ARGUMENTS
RET_SHIFTING_FAILED

Parameters

offset Shift offset within the range [0,n/2] and integer divisor of n.

Implements SubjectTo.

Definition at line 264 of file external_packages/qpOASES-3.0beta/src/Bounds.cpp.

virtual returnValue Bounds::shift ( int_t offset )

virtual

Shifts forward type and status of all bounds by a given offset. This offset has to lie within the range [0,n/2] and has to be an integer divisor of the total number of bounds n. Type and status of the first <offset> bounds is thrown away, type and status of the last <offset> bounds is doubled, e.g. for offset = 2:
shift( {b1,b2,b3,b4,b5,b6} ) = {b3,b4,b5,b6,b5,b6}

Returns: SUCCESSFUL_RETURN
RET_INDEX_OUT_OF_BOUNDS
RET_INVALID_ARGUMENTS
RET_SHIFTING_FAILED

Parameters

offset Shift offset within the range [0,n/2] and integer divisor of n.

Implements SubjectTo.

returnValue Bounds::swapFree	(	int	number1,
		int	number2
	)

Swaps the indices of two free bounds within the index set.

Returns: SUCCESSFUL_RETURN
RET_SWAPINDEX_FAILED

Parameters

number1	Number of first constraint or bound.
number2	Number of second constraint or bound.

Definition at line 238 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Bounds.cpp.

returnValue Bounds::swapFree	(	int	number1,
		int	number2
	)

Swaps the indices of two free bounds within the index set.

Returns: SUCCESSFUL_RETURN
RET_SWAPINDEX_FAILED

Parameters

number1	Number of first constraint or bound.
number2	Number of second constraint or bound.

returnValue Bounds::swapFree	(	int_t	number1,
		int_t	number2
	)

Swaps the indices of two free bounds within the index set.

Returns: SUCCESSFUL_RETURN
RET_SWAPINDEX_FAILED

Parameters

number1	Number of first constraint or bound.
number2	Number of second constraint or bound.

returnValue Bounds::swapFree	(	int	number1,
		int	number2
	)

Swaps the indices of two free bounds within the index set.

Returns: SUCCESSFUL_RETURN
RET_SWAPINDEX_FAILED

Parameters

number1	Number of first constraint or bound.
number2	Number of second constraint or bound.

Member Data Documentation

Indexlist Bounds::fixed

protected

Index list of fixed variables.

Definition at line 179 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Bounds.hpp.

Indexlist Bounds::free

protected

Index list of free variables.

Definition at line 178 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Bounds.hpp.

Indexlist Bounds::freee

protected

Index list of free variables.

Definition at line 242 of file external_packages/qpOASES-3.0beta/include/qpOASES/Bounds.hpp.

int Bounds::n

Total number of bounds.

Definition at line 58 of file Bounds.h.

int Bounds::nBV

protected

Number of bounded (but possibly free) variables.

Definition at line 175 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Bounds.hpp.

int Bounds::nFV

protected

Number of implicitly fixed variables.

Definition at line 174 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Bounds.hpp.

BooleanType Bounds::noLower

This flag indicates if there is no lower bound on any variable.

Definition at line 63 of file Bounds.h.

BooleanType Bounds::noUpper

This flag indicates if there is no upper bound on any variable.

Definition at line 64 of file Bounds.h.

int Bounds::nUV

protected

Number of unbounded variables.

Definition at line 176 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Bounds.hpp.

int Bounds::nV

protected

Number of variables (nV = nFV + nBV + nUV).

Definition at line 173 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Bounds.hpp.

SubjectToStatus Bounds::status[NVMAX]

Status of bounds.

Definition at line 61 of file Bounds.h.

SubjectToType Bounds::type[NVMAX]

Type of bounds.

Definition at line 60 of file Bounds.h.

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation