Public Member Functions
ConstraintProduct Class Reference

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

#include <ConstraintProduct.hpp>

Inheritance diagram for ConstraintProduct:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ConstraintProduct ()
 ConstraintProduct (const ConstraintProduct &toCopy)
virtual int operator() (int constrIndex, const real_t *const x, real_t *const constrValue) const =0
ConstraintProductoperator= (const ConstraintProduct &toCopy)
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

Definition at line 57 of file ConstraintProduct.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 61 of file ConstraintProduct.hpp.

Copy constructor.

Parameters:
toCopyRhs object.

Definition at line 64 of file ConstraintProduct.hpp.

virtual ConstraintProduct::~ConstraintProduct ( ) [inline, virtual]

Destructor.

Definition at line 68 of file 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:
constrIndexNumber of constraint to be evaluated.
xArray containing current primal iterate.
constrValueOutput: Scalar value of the evaluated constraint.

Implemented in MyConstraintProduct.

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

Assignment operator.

Parameters:
toCopyRhs object.

Definition at line 71 of file ConstraintProduct.hpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:23