MyConstraintProduct Class Reference

Example illustrating the use of the ConstraintProduct class. More...

Inheritance diagram for MyConstraintProduct:

List of all members.

Public Member Functions
	MyConstraintProduct ()
	MyConstraintProduct (int _nV, int _nC, real_t *_A)
	MyConstraintProduct (const MyConstraintProduct &rhs)
virtual	~MyConstraintProduct ()
MyConstraintProduct &	operator= (const MyConstraintProduct &rhs)
virtual int	operator() (int constrIndex, const real_t *const x, real_t *const constrValue) const
Protected Attributes
int	nV
int	nC
real_t *	A

---

Detailed Description

Example illustrating the use of the ConstraintProduct class.

Author:

Hans Joachim Ferreau

Version:

3.0

Date:

2007-2014

---

Constructor & Destructor Documentation

MyConstraintProduct::MyConstraintProduct

(

)

[inline]

Default constructor.

MyConstraintProduct::MyConstraintProduct	(	int	_nV,
		int	_nC,
		real_t *	_A
	)		[inline]

Constructor.

References A, nC, and nV.

MyConstraintProduct::MyConstraintProduct

(

const MyConstraintProduct &

rhs

)

[inline]

Copy constructor (flat copy).

References A, nC, and nV.

virtual MyConstraintProduct::~MyConstraintProduct

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual int MyConstraintProduct::operator()	(	int	constrIndex,
		const real_t *const	x,
		real_t *const	constrValue
	)		const [inline, 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

Implements ConstraintProduct.

References A, and nV.

MyConstraintProduct& MyConstraintProduct::operator=

(

const MyConstraintProduct &

rhs

)

[inline]

Assignment operator (flat copy).

References A, nC, and nV.

---

Member Data Documentation

real_t* MyConstraintProduct::A [protected]

Pointer to full constraint matrix (typically not needed!).

Referenced by MyConstraintProduct(), operator()(), and operator=().

int MyConstraintProduct::nC [protected]

Number of constraints.

Referenced by MyConstraintProduct(), and operator=().

int MyConstraintProduct::nV [protected]

Number of variables.

Referenced by MyConstraintProduct(), operator()(), and operator=().

---

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

• examples/example4CP.cpp