qpOASES  3.2.1
An Implementation of the Online Active Set Strategy
Public Member Functions | List of all members
ConstraintProduct Class Referenceabstract

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

#include <ConstraintProduct.hpp>

Inheritance diagram for ConstraintProduct:
MyConstraintProduct

Public Member Functions

 ConstraintProduct ()
 
 ConstraintProduct (const ConstraintProduct &toCopy)
 
virtual ~ConstraintProduct ()
 
ConstraintProductoperator= (const ConstraintProduct &toCopy)
 
virtual int_t operator() (int_t constrIndex, const real_t *const x, real_t *const constrValue) const =0
 

Detailed Description

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-2017

Constructor & Destructor Documentation

◆ ConstraintProduct() [1/2]

ConstraintProduct::ConstraintProduct ( )
inline

Default constructor.

◆ ConstraintProduct() [2/2]

ConstraintProduct::ConstraintProduct ( const ConstraintProduct toCopy)
inline

Copy constructor.

Parameters
toCopyRhs object.

◆ ~ConstraintProduct()

virtual ConstraintProduct::~ConstraintProduct ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ operator()()

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.

Returns
0: successful
otherwise: not successful
Parameters
constrIndexNumber of constraint to be evaluated.
xArray containing current primal iterate.
constrValueOutput: Scalar value of the evaluated constraint.

Implemented in MyConstraintProduct.

◆ operator=()

ConstraintProduct& ConstraintProduct::operator= ( const ConstraintProduct toCopy)
inline

Assignment operator.

Parameters
toCopyRhs object.

The documentation for this class was generated from the following file: