Options.h File Reference

#include <qpOASES_e/Utils.h>

Include dependency graph for Options.h:

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

Go to the source code of this file.

Classes
struct	Options
	Provides a generic way to set and pass user-specified options. More...

Functions
returnValue	Options_ensureConsistency (Options *_THIS)
returnValue	Options_print (Options *_THIS)
returnValue	Options_setToDefault (Options *_THIS)
returnValue	Options_setToFast (Options *_THIS)
returnValue	Options_setToMPC (Options *_THIS)
returnValue	Options_setToReliable (Options *_THIS)
void	OptionsCON (Options *_THIS)
void	OptionsCPY (Options *FROM, Options *TO)

Detailed Description

Author

Hans Joachim Ferreau, Andreas Potschka, Christian Kirches

Version

3.1embedded

Date

2007-2015

Declaration of the Options class designed to manage user-specified options for solving a QProblem.

Definition in file Options.h.

Function Documentation

returnValue Options_ensureConsistency

(

Options *

_THIS

)

Ensures that all options have consistent values by automatically adjusting inconsistent ones. Note: This routine cannot (and does not try to) ensure that values are set to reasonable values that make the QP solution work!

Returns

SUCCESSFUL_RETURN
RET_OPTIONS_ADJUSTED

Definition at line 263 of file Options.c.

returnValue Options_print

(

Options *

_THIS

)

Prints values of all options.

Returns

SUCCESSFUL_RETURN

Definition at line 406 of file Options.c.

returnValue Options_setToDefault

(

Options *

_THIS

)

Sets all options to default values.

Returns

SUCCESSFUL_RETURN

Definition at line 112 of file Options.c.

returnValue Options_setToFast

(

Options *

_THIS

)

Same as setToMPC( ), for ensuring backwards compatibility.

Returns

SUCCESSFUL_RETURN

Definition at line 252 of file Options.c.

returnValue Options_setToMPC

(

Options *

_THIS

)

Sets all options to values resulting in minimum solution time.

Returns

SUCCESSFUL_RETURN

Definition at line 214 of file Options.c.

returnValue Options_setToReliable

(

Options *

_THIS

)

Sets all options to values resulting in maximum reliabilty.

Returns

SUCCESSFUL_RETURN

Definition at line 193 of file Options.c.

void OptionsCON

(

Options *

_THIS

)

Definition at line 50 of file Options.c.

void OptionsCPY	(	Options *	FROM,
		Options *	TO
	)

Copies all members from given rhs object.

Returns

SUCCESSFUL_RETURN

Definition at line 64 of file Options.c.