Indexlist.h File Reference

#include <qpOASES_e/Utils.h>

Include dependency graph for Indexlist.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	Indexlist
	Stores and manages index lists. More...

Functions
returnValue	Indexlist_addNumber (Indexlist *_THIS, int addnumber)
int	Indexlist_findInsert (Indexlist *_THIS, int i)
int	Indexlist_getIndex (Indexlist *_THIS, int givennumber)
returnValue	Indexlist_getISortArray (Indexlist *_THIS, int **const iSortArray)
static int	Indexlist_getLastNumber (Indexlist *_THIS)
static int	Indexlist_getLength (Indexlist *_THIS)
static int	Indexlist_getNumber (Indexlist *_THIS, int physicalindex)
returnValue	Indexlist_getNumberArray (Indexlist *_THIS, int **const numberarray)
returnValue	Indexlist_init (Indexlist *_THIS, int n)
static BooleanType	Indexlist_isMember (Indexlist *_THIS, int _number)
returnValue	Indexlist_removeNumber (Indexlist *_THIS, int removenumber)
returnValue	Indexlist_swapNumbers (Indexlist *_THIS, int number1, int number2)
void	IndexlistCON (Indexlist *_THIS, int n)
void	IndexlistCPY (Indexlist *FROM, Indexlist *TO)

Detailed Description

Author

Hans Joachim Ferreau, Andreas Potschka, Christian Kirches

Version

3.1embedded

Date

2007-2015

Declaration of the Indexlist class designed to manage index lists of constraints and bounds within a SubjectTo object.

Definition in file Indexlist.h.

Function Documentation

returnValue Indexlist_addNumber	(	Indexlist *	_THIS,
		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 139 of file Indexlist.c.

int Indexlist_findInsert	(	Indexlist *	_THIS,
		int	i
	)

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 219 of file Indexlist.c.

int Indexlist_getIndex	(	Indexlist *	_THIS,
		int	givennumber
	)

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.

Definition at line 129 of file Indexlist.c.

returnValue Indexlist_getISortArray	(	Indexlist *	_THIS,
		int **const	iSortArray
	)

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 118 of file Indexlist.c.

static int Indexlist_getLastNumber ( Indexlist *  _THIS )

inlinestatic

Returns last number within the index list.

Returns

Last number within the index list.

Definition at line 192 of file Indexlist.h.

static int Indexlist_getLength ( Indexlist *  _THIS )

inlinestatic

Returns the current length of the index list.

Returns

Current length of the index list.

Definition at line 183 of file Indexlist.h.

static int Indexlist_getNumber ( Indexlist *  _THIS, int  physicalindex  )

inlinestatic

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.

Definition at line 170 of file Indexlist.h.

returnValue Indexlist_getNumberArray	(	Indexlist *	_THIS,
		int **const	numberarray
	)

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 105 of file Indexlist.c.

returnValue Indexlist_init	(	Indexlist *	_THIS,
		int	n
	)

Initialises index list of desired physical length.

Returns

SUCCESSFUL_RETURN
RET_INVALID_ARGUMENTS

Parameters

n	Physical length of index list.

Definition at line 86 of file Indexlist.c.

static BooleanType Indexlist_isMember ( Indexlist *  _THIS, int  _number  )

inlinestatic

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.

Definition at line 201 of file Indexlist.h.

returnValue Indexlist_removeNumber	(	Indexlist *	_THIS,
		int	removenumber
	)

Removes number from index list.

Returns

SUCCESSFUL_RETURN

Parameters

removenumber

Number to be removed.

Definition at line 160 of file Indexlist.c.

returnValue Indexlist_swapNumbers	(	Indexlist *	_THIS,
		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 190 of file Indexlist.c.

void IndexlistCON	(	Indexlist *	_THIS,
		int	n
	)

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

Parameters

n	Physical length of index list.

Definition at line 49 of file Indexlist.c.

void IndexlistCPY	(	Indexlist *	FROM,
		Indexlist *	TO
	)

Copies all members from given rhs object.

Returns

SUCCESSFUL_RETURN

Definition at line 60 of file Indexlist.c.