Interface for specifying user-defined evaluations of constraint products. More...

#include <ConstraintProduct.hpp>

Inheritance diagram for ConstraintProduct:

Public Member Functions
	ConstraintProduct ()

	ConstraintProduct ()

	ConstraintProduct (const ConstraintProduct &toCopy)

	ConstraintProduct (const ConstraintProduct &toCopy)

virtual int	operator() (int constrIndex, const real_t const x, real_t const constrValue) const =0

virtual int_t	operator() (int_t constrIndex, const real_t const x, real_t const constrValue) const =0

ConstraintProduct &	operator= (const ConstraintProduct &toCopy)

ConstraintProduct &	operator= (const ConstraintProduct &toCopy)

virtual	~ConstraintProduct ()

virtual	~ConstraintProduct ()

Detailed Description

Interface for specifying user-defined evaluations of constraint products.

A class which allows to specify a user-defined function for evaluating the constraint product at the current iterate to speed-up QP solution in case of a specially structured constraint matrix.

Author: Hans Joachim Ferreau

Version: 3.0beta

Date: 2009-2011

A class which allows to specify a user-defined function for evaluating the constraint product at the current iterate to speed-up QP solution in case of a specially structured constraint matrix.

Author: Hans Joachim Ferreau

Version: 3.2

Date: 2009-2015

Definition at line 57 of file qpOASES-3.0beta/include/qpOASES/ConstraintProduct.hpp.

Constructor & Destructor Documentation

ConstraintProduct::ConstraintProduct ( )

inline

Default constructor.

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

ConstraintProduct::ConstraintProduct ( const ConstraintProduct & toCopy )

inline

Copy constructor.

Parameters

toCopy Rhs object.

Definition at line 64 of file qpOASES-3.0beta/include/qpOASES/ConstraintProduct.hpp.

virtual ConstraintProduct::~ConstraintProduct ( )

inlinevirtual

Destructor.

Definition at line 68 of file qpOASES-3.0beta/include/qpOASES/ConstraintProduct.hpp.

ConstraintProduct::ConstraintProduct ( )

inline

Default constructor.

Definition at line 61 of file qpOASES-3.2.0/include/qpOASES/ConstraintProduct.hpp.

ConstraintProduct::ConstraintProduct ( const ConstraintProduct & toCopy )

inline

Copy constructor.

Parameters

toCopy Rhs object.

Definition at line 64 of file qpOASES-3.2.0/include/qpOASES/ConstraintProduct.hpp.

virtual ConstraintProduct::~ConstraintProduct ( )

inlinevirtual

Destructor.

Definition at line 68 of file qpOASES-3.2.0/include/qpOASES/ConstraintProduct.hpp.

Member Function Documentation

virtual int ConstraintProduct::operator()	(	int	constrIndex,
		const real_t *const	x,
		real_t *const	constrValue
	)		const

pure virtual

Evaluates the product of a given constraint with the current iterate. This function needs to be implemented in a derived class for the user-defined constraint product function.

Returns: 0: successful
otherwise: not successful

Parameters

constrIndex	Number of constraint to be evaluated.
x	Array containing current primal iterate.
constrValue	Output: Scalar value of the evaluated constraint.

Implemented in MpcConstraintProduct, MpcConstraintProduct, MyConstraintProduct, and MyConstraintProduct.

virtual int_t ConstraintProduct::operator()	(	int_t	constrIndex,
		const real_t *const	x,
		real_t *const	constrValue
	)		const

pure virtual

Evaluates the product of a given constraint with the current iterate. This function needs to be implemented in a derived class for the user-defined constraint product function.