Stores and manages index lists. More...

#include <Indexlist.hpp>

Public Member Functions
returnValue	addNumber (int addnumber)

returnValue	addNumber (int addnumber)

returnValue	addNumber (int addnumber)

returnValue	addNumber (int_t addnumber)

int	getIndex (int givennumber) const

int	getIndex (int givennumber) const

int	getIndex (int givennumber) const

int_t	getIndex (int_t givennumber) const

returnValue	getISortArray (int_t **const iSortArray) const

int	getLastNumber () const

int	getLastNumber () const

int	getLastNumber () const

int_t	getLastNumber () const

int	getLength ()

int	getLength ()

int	getLength () const

int_t	getLength () const

int	getNumber (int physicalindex) const

int	getNumber (int physicalindex) const

int	getNumber (int physicalindex) const

int_t	getNumber (int_t physicalindex) const

returnValue	getNumberArray (int *const numberarray) const

returnValue	getNumberArray (int *const numberarray) const

returnValue	getNumberArray (int **const numberarray) const

returnValue	getNumberArray (int_t **const numberarray) const

int	getPhysicalIndex (int givennumber) const

int	getPhysicalIndex (int givennumber) const

	Indexlist ()

	Indexlist ()

	Indexlist (const Indexlist &rhs)

	Indexlist (const Indexlist &rhs)

	Indexlist ()

	Indexlist ()

	Indexlist (int n)

	Indexlist (int_t n)

	Indexlist (const Indexlist &rhs)

	Indexlist (const Indexlist &rhs)

returnValue	init ()

returnValue	init ()

returnValue	init (int n=0)

returnValue	init (int_t n=0)

BooleanType	isMember (int _number) const

BooleanType	isMember (int _number) const

BooleanType	isMember (int _number) const

BooleanType	isMember (int_t _number) const

Indexlist &	operator= (const Indexlist &rhs)

Indexlist &	operator= (const Indexlist &rhs)

Indexlist &	operator= (const Indexlist &rhs)

Indexlist &	operator= (const Indexlist &rhs)

returnValue	removeNumber (int removenumber)

returnValue	removeNumber (int removenumber)

returnValue	removeNumber (int removenumber)

returnValue	removeNumber (int_t removenumber)

returnValue	swapNumbers (int number1, int number2)

returnValue	swapNumbers (int number1, int number2)

returnValue	swapNumbers (int number1, int number2)

returnValue	swapNumbers (int_t number1, int_t number2)

	~Indexlist ()

	~Indexlist ()

	~Indexlist ()

	~Indexlist ()

Public Attributes
int	iSort [NVCMAX]

Protected Member Functions
returnValue	clear ()

returnValue	clear ()

returnValue	copy (const Indexlist &rhs)

returnValue	copy (const Indexlist &rhs)

int	findInsert (int i) const

int_t	findInsert (int_t i) const

Protected Attributes
int	first

int_t	first

int *	iSort

int_t *	iSort

int	last

int_t	last

int	lastusedindex

int_t	lastusedindex

int	length

int_t	length

int	next [INDEXLISTFACTOR *(NVMAX+NCMAX)]

int	number [INDEXLISTFACTOR *(NVMAX+NCMAX)]

int *	number

int_t *	number

int	physicallength

int_t	physicallength

int	previous [INDEXLISTFACTOR *(NVMAX+NCMAX)]

Friends
class	DenseMatrix

class	SparseMatrix

class	SparseMatrixRow

class	SymDenseMat

class	SymSparseMat

Detailed Description

Stores and manages index lists.

This class manages index lists.

\author Hans Joachim Ferreau
\version 1.3embedded
\date 2007-2008

This class manages index lists of active/inactive bounds/constraints.

Author: Hans Joachim Ferreau

Version: 3.0beta

Date: 2007-2011

This class manages index lists of active/inactive bounds/constraints.

Author: Hans Joachim Ferreau

Version: 3.2

Date: 2007-2015

This class manages index lists of active/inactive bounds/constraints.

Author: Hans Joachim Ferreau

Version: 3.1embedded

Date: 2007-2015

Definition at line 48 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Indexlist.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_QPOASES Indexlist::Indexlist ( )

Default constructor.

Definition at line 46 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

Indexlist::Indexlist ( const Indexlist & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

Definition at line 66 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

Indexlist::~Indexlist ( )

Destructor.

Definition at line 86 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

Indexlist::Indexlist ( )

Default constructor.

Indexlist::Indexlist ( const Indexlist & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

Indexlist::~Indexlist ( )

Destructor.

Indexlist::Indexlist ( )

Default constructor.

Indexlist::Indexlist ( int n )

Constructor which takes the desired physical length of the index list.

Parameters

n	Physical length of index list.

Definition at line 62 of file external_packages/qpOASES-3.0beta/src/Indexlist.cpp.

Indexlist::Indexlist ( const Indexlist & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

Indexlist::~Indexlist ( )

Destructor.

Indexlist::Indexlist ( )

Default constructor.

Indexlist::Indexlist ( int_t n )

Constructor which takes the desired physical length of the index list.

Parameters

n	Physical length of index list.

Indexlist::Indexlist ( const Indexlist & rhs )

Copy constructor (deep copy).

Parameters

rhs	Rhs object.

Indexlist::~Indexlist ( )

Destructor.

Member Function Documentation

returnValue Indexlist::addNumber ( int addnumber )

Adds number to index list.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_MUST_BE_REORDERD
RET_INDEXLIST_EXCEEDS_MAX_LENGTH

Parameters

addnumber Number to be added.

Definition at line 218 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

returnValue Indexlist::addNumber ( int addnumber )

Adds number to index list.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_MUST_BE_REORDERD
RET_INDEXLIST_EXCEEDS_MAX_LENGTH

Parameters

addnumber Number to be added.

returnValue Indexlist::addNumber ( int addnumber )

Adds number to index list.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_MUST_BE_REORDERD
RET_INDEXLIST_EXCEEDS_MAX_LENGTH

Parameters

addnumber Number to be added.

returnValue Indexlist::addNumber ( int_t addnumber )

Adds number to index list.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_MUST_BE_REORDERD
RET_INDEXLIST_EXCEEDS_MAX_LENGTH

Parameters

addnumber Number to be added.

returnValue Indexlist::clear ( )

protected

Frees all allocated memory.

Returns: SUCCESSFUL_RETURN

Definition at line 237 of file external_packages/qpOASES-3.0beta/src/Indexlist.cpp.

returnValue Indexlist::clear ( )

protected

Frees all allocated memory.

Returns: SUCCESSFUL_RETURN

returnValue Indexlist::copy ( const Indexlist & rhs )

protected

Copies all members from given rhs object.

Returns: SUCCESSFUL_RETURN

Parameters

rhs	Rhs object.

Definition at line 258 of file external_packages/qpOASES-3.0beta/src/Indexlist.cpp.

returnValue Indexlist::copy ( const Indexlist & rhs )

protected

Copies all members from given rhs object.

Returns: SUCCESSFUL_RETURN

Parameters

rhs	Rhs object.

int_t Indexlist::findInsert ( int i ) const

protected

Find first index j between -1 and length in sorted list of indices iSort such that numbers[iSort[j]] <= i < numbers[iSort[j+1]]. Uses bisection.

Returns: j.

Definition at line 284 of file external_packages/qpOASES-3.0beta/src/Indexlist.cpp.

int_t Indexlist::findInsert ( int_t i ) const

protected

Find first index j between -1 and length in sorted list of indices iSort such that numbers[iSort[j]] <= i < numbers[iSort[j+1]]. Uses bisection.

Returns: j.

int Indexlist::getIndex ( int givennumber ) const

Determines the index within the index list at with a given number is stored.

Returns: >= 0: Index of given number.
-1: Number not found.

Parameters

givennumber Number whose index shall be determined.

int_t Indexlist::getIndex ( int givennumber ) const

Determines the index within the index list at with a given number is stored.

Returns: >= 0: Index of given number.
-1: Number not found.

Parameters

givennumber Number whose index shall be determined.

Definition at line 168 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

int Indexlist::getIndex ( int givennumber ) const

Determines the index within the index list at with a given number is stored.

Returns: >= 0: Index of given number.
-1: Number not found.

Parameters

givennumber Number whose index shall be determined.

int_t Indexlist::getIndex ( int_t givennumber ) const

Determines the index within the index list at which a given number is stored.

Returns: >= 0: Index of given number.
-1: Number not found.

Parameters

givennumber Number whose index shall be determined.

returnValue Indexlist::getISortArray ( int_t **const iSortArray ) const

Creates an array of all numbers within the index set in correct order.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_CORRUPTED

Parameters

iSortArray Output: iSort Array.

Definition at line 146 of file external_packages/qpOASES-3.2.0/src/Indexlist.cpp.

int Indexlist::getLastNumber ( ) const

inline

Returns last number within the index list.

Returns: Last number within the index list.

int Indexlist::getLastNumber ( ) const

inline

Returns last number within the index list.

Returns: Last number within the index list.

int Indexlist::getLastNumber ( ) const

inline

Returns last number within the index list.

Returns: Last number within the index list.

int_t Indexlist::getLastNumber ( ) const

inline

Returns last number within the index list.

Returns: Last number within the index list.

int Indexlist::getLength ( )

inline

Returns the current length of the index list.

Returns: Current length of the index list.

int Indexlist::getLength ( )

inline

Returns the current length of the index list.

Returns: Current length of the index list.

int Indexlist::getLength ( ) const

inline

Returns the current length of the index list.

Returns: Current length of the index list.

int_t Indexlist::getLength ( ) const

inline

Returns the current length of the index list.

Returns: Current length of the index list.

int Indexlist::getNumber ( int physicalindex ) const

Returns the number stored at a given physical index.

Returns: >= 0: Number stored at given physical index.
-RET_INDEXLIST_OUTOFBOUNDS

Parameters

physicalindex Physical index of the number to be returned.

int Indexlist::getNumber ( int physicalindex ) const

Returns the number stored at a given physical index.

Returns: >= 0: Number stored at given physical index.
-RET_INDEXLIST_OUTOFBOUNDS

Parameters

physicalindex Physical index of the number to be returned.

int Indexlist::getNumber ( int physicalindex ) const

Returns the number stored at a given physical index.

Returns: >= 0: Number stored at given physical index.
-RET_INDEXLIST_OUTOFBOUNDS

Parameters

physicalindex Physical index of the number to be returned.

int_t Indexlist::getNumber ( int_t physicalindex ) const

Returns the number stored at a given physical index.

Returns: >= 0: Number stored at given physical index.
-RET_INDEXLIST_OUTOFBOUNDS

Parameters

physicalindex Physical index of the number to be returned.

returnValue Indexlist::getNumberArray ( int *const numberarray ) const

Creates an array of all numbers within the index set in correct order.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_CORRUPTED

Parameters

numberarray Output: Array of numbers (NULL on error).

Definition at line 145 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

returnValue Indexlist::getNumberArray ( int *const numberarray ) const

Creates an array of all numbers within the index set in correct order.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_CORRUPTED

Parameters

numberarray Output: Array of numbers (NULL on error).

returnValue Indexlist::getNumberArray ( int **const numberarray ) const

Creates an array of all numbers within the index set in correct order.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_CORRUPTED

Parameters

numberarray Output: Array of numbers (NULL on error).

Definition at line 132 of file external_packages/qpOASES-3.0beta/src/Indexlist.cpp.

returnValue Indexlist::getNumberArray ( int_t **const numberarray ) const

Creates an array of all numbers within the index set in correct order.

Returns: SUCCESSFUL_RETURN
RET_INDEXLIST_CORRUPTED

Parameters

numberarray Output: Array of numbers (NULL on error).

int Indexlist::getPhysicalIndex ( int givennumber ) const

Determines the physical index within the index list at with a given number is stored.

Returns: >= 0: Index of given number.
-1: Number not found.

Parameters

givennumber Number whose physical index shall be determined.

int Indexlist::getPhysicalIndex ( int givennumber ) const

Determines the physical index within the index list at with a given number is stored.

Returns: >= 0: Index of given number.
-1: Number not found.

Parameters

givennumber Number whose physical index shall be determined.

Definition at line 193 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

returnValue Indexlist::init ( )

Pseudo-constructor.

Returns: SUCCESSFUL_RETURN

returnValue Indexlist::init ( )

Pseudo-constructor.

Returns: SUCCESSFUL_RETURN

Definition at line 121 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

returnValue Indexlist::init ( int n = 0 )

Initialises index list of desired physical length.

Returns: SUCCESSFUL_RETURN
RET_INVALID_ARGUMENTS

Parameters

n	Physical length of index list.

Definition at line 108 of file external_packages/qpOASES-3.0beta/src/Indexlist.cpp.

returnValue Indexlist::init ( int_t n = 0 )

Initialises index list of desired physical length.

Returns: SUCCESSFUL_RETURN
RET_INVALID_ARGUMENTS

Parameters

n	Physical length of index list.

BooleanType Indexlist::isMember ( int _number ) const

inline

Determines if a given number is contained in the index set.

Returns: BT_TRUE iff number is contain in the index set

Parameters

_number Number to be tested for membership.

BooleanType Indexlist::isMember ( int _number ) const

inline

Determines if a given number is contained in the index set.

Returns: BT_TRUE iff number is contain in the index set

Parameters

_number Number to be tested for membership.

BooleanType Indexlist::isMember ( int _number ) const

inline

Determines if a given number is contained in the index set.

Returns: BT_TRUE iff number is contain in the index set

Parameters

_number Number to be tested for membership.

BooleanType Indexlist::isMember ( int_t _number ) const

inline

Determines if a given number is contained in the index set.

Returns: BT_TRUE iff number is contain in the index set

Parameters

_number Number to be tested for membership.

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

Assingment operator (deep copy).

Parameters

rhs	Rhs object.

Definition at line 94 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

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

Assingment operator (deep copy).

Parameters

rhs	Rhs object.

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

Assingment operator (deep copy).

Parameters

rhs	Rhs object.

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

Assingment operator (deep copy).

Parameters

rhs	Rhs object.

returnValue Indexlist::removeNumber ( int removenumber )

Removes number from index list.

Returns: SUCCESSFUL_RETURN

Parameters

removenumber Number to be removed.

Definition at line 290 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

returnValue Indexlist::removeNumber ( int removenumber )

Removes number from index list.

Returns: SUCCESSFUL_RETURN

Parameters

removenumber Number to be removed.

returnValue Indexlist::removeNumber ( int removenumber )

Removes number from index list.

Returns: SUCCESSFUL_RETURN

Parameters

removenumber Number to be removed.

returnValue Indexlist::removeNumber ( int_t removenumber )

Removes number from index list.

Returns: SUCCESSFUL_RETURN

Parameters

removenumber Number to be removed.

returnValue Indexlist::swapNumbers	(	int	number1,
		int	number2
	)

Swaps two numbers within index list.

Returns: SUCCESSFUL_RETURN

Parameters

number1	First number for swapping.
number2	Second number for swapping.

returnValue Indexlist::swapNumbers	(	int	number1,
		int	number2
	)

Swaps two numbers within index list.

Returns: SUCCESSFUL_RETURN

Parameters

number1	First number for swapping.
number2	Second number for swapping.

Definition at line 323 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/SRC/Indexlist.cpp.

returnValue Indexlist::swapNumbers	(	int	number1,
		int	number2
	)

Swaps two numbers within index list.

Returns: SUCCESSFUL_RETURN

Parameters

number1	First number for swapping.
number2	Second number for swapping.

returnValue Indexlist::swapNumbers	(	int_t	number1,
		int_t	number2
	)

Swaps two numbers within index list.

Returns: SUCCESSFUL_RETURN

Parameters

number1	First number for swapping.
number2	Second number for swapping.

Friends And Related Function Documentation

DenseMatrix

friend

Definition at line 60 of file external_packages/qpOASES-3.0beta/include/qpOASES/Indexlist.hpp.

SparseMatrix

friend

Definition at line 62 of file external_packages/qpOASES-3.0beta/include/qpOASES/Indexlist.hpp.

friend class SparseMatrixRow

friend

Definition at line 63 of file external_packages/qpOASES-3.2.0/include/qpOASES/Indexlist.hpp.

SymDenseMat

friend

Definition at line 61 of file external_packages/qpOASES-3.0beta/include/qpOASES/Indexlist.hpp.

SymSparseMat

friend

Definition at line 63 of file external_packages/qpOASES-3.0beta/include/qpOASES/Indexlist.hpp.

Member Data Documentation

int Indexlist::first

protected

Physical index of first element.

Definition at line 140 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Indexlist.hpp.

int_t Indexlist::first

protected

Physical index of first element.

Definition at line 184 of file external_packages/qpOASES-3.2.0/include/qpOASES/Indexlist.hpp.

int Indexlist::iSort[NVCMAX]

Index list to sort vector number

Definition at line 58 of file Indexlist.h.

int* Indexlist::iSort

protected

Index list to sort vector number

Definition at line 174 of file external_packages/qpOASES-3.0beta/include/qpOASES/Indexlist.hpp.

int_t* Indexlist::iSort

protected

Index list to sort vector number

Definition at line 181 of file external_packages/qpOASES-3.2.0/include/qpOASES/Indexlist.hpp.

int Indexlist::last

protected

Physical index of last element.

Definition at line 141 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Indexlist.hpp.

int_t Indexlist::last

protected

Physical index of last element.

Definition at line 185 of file external_packages/qpOASES-3.2.0/include/qpOASES/Indexlist.hpp.

int Indexlist::lastusedindex

protected

Physical index of last entry in index list.

Definition at line 142 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Indexlist.hpp.

int_t Indexlist::lastusedindex

protected

Physical index of last entry in index list.

Definition at line 186 of file external_packages/qpOASES-3.2.0/include/qpOASES/Indexlist.hpp.

int Indexlist::length

protected

Length of index list.

Definition at line 139 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Indexlist.hpp.

int_t Indexlist::length

protected

Length of index list.

Definition at line 183 of file external_packages/qpOASES-3.2.0/include/qpOASES/Indexlist.hpp.

int Indexlist::next

protected

Array to store physical index of successor.

Definition at line 137 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Indexlist.hpp.

int Indexlist::number

protected

Array to store numbers of constraints or bounds.

Definition at line 136 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Indexlist.hpp.

int* Indexlist::number

protected

Array to store numbers of constraints or bounds.

Definition at line 173 of file external_packages/qpOASES-3.0beta/include/qpOASES/Indexlist.hpp.

int_t* Indexlist::number

protected

Array to store numbers of constraints or bounds.

Definition at line 180 of file external_packages/qpOASES-3.2.0/include/qpOASES/Indexlist.hpp.

int Indexlist::physicallength

protected

Physical length of index list.

Definition at line 143 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Indexlist.hpp.

int_t Indexlist::physicallength

protected

Physical length of index list.

Definition at line 187 of file external_packages/qpOASES-3.2.0/include/qpOASES/Indexlist.hpp.

int Indexlist::previous

protected

Array to store physical index of predecossor.

Definition at line 138 of file examples/code_generation/mpc_mhe/getting_started_export/qpoases/INCLUDE/Indexlist.hpp.

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation