ClpConstraint Class Reference

#include <ClpConstraint.hpp>

Inheritance diagram for ClpConstraint:

Public Member Functions
Stuff

virtual int	gradient (const ClpSimplex model, const double solution, double *gradient, double &functionValue, double &offset, bool useScaling=false, bool refresh=true) const =0
	Fills gradient.
virtual double	functionValue (const ClpSimplex model, const double solution, bool useScaling=false, bool refresh=true) const
	Constraint function value.
virtual void	resize (int newNumberColumns)=0
	Resize constraint.
virtual void	deleteSome (int numberToDelete, const int *which)=0
	Delete columns in constraint.
virtual void	reallyScale (const double *columnScale)=0
	Scale constraint.
virtual int	markNonlinear (char *which) const =0
	Given a zeroed array sets nonlinear columns to 1.
virtual int	markNonzero (char *which) const =0
	Given a zeroed array sets possible nonzero coefficients to 1.
Constructors and destructors

	ClpConstraint ()
	Default Constructor.
	ClpConstraint (const ClpConstraint &)
	Copy constructor.
ClpConstraint &	operator= (const ClpConstraint &rhs)
	Assignment operator.
virtual	~ClpConstraint ()
	Destructor.
virtual ClpConstraint *	clone () const =0
	Clone.
Other

int	type ()
	Returns type, 0 linear, 1 nonlinear.
int	rowNumber () const
	Row number (-1 is objective).
virtual int	numberCoefficients () const =0
	Number of possible coefficients in gradient.
double	functionValue () const
	Stored constraint function value.
double	offset () const
	Constraint offset.
virtual void	newXValues ()
	Say we have new primal solution - so may need to recompute.
Protected Attributes
Protected member data

double *	lastGradient_
	Gradient at last evaluation.
double	functionValue_
	Value of non-linear part of constraint.
double	offset_
	Value of offset for constraint.
int	type_
	Type of constraint - linear is 1.
int	rowNumber_
	Row number (-1 is objective).

Detailed Description

Constraint Abstract Base Class.

Abstract Base Class for describing a constraint or objective function

Definition at line 16 of file ClpConstraint.hpp.

Constructor & Destructor Documentation

ClpConstraint::ClpConstraint ( )

Default Constructor.

ClpConstraint::ClpConstraint ( const ClpConstraint & )

Copy constructor.

virtual ClpConstraint::~ClpConstraint ( ) [virtual]

Destructor.

Member Function Documentation

virtual int ClpConstraint::gradient	(	const ClpSimplex *	model,
		const double *	solution,
		double *	gradient,
		double &	functionValue,
		double &	offset,
		bool	useScaling = `false`,
		bool	refresh = `true`
	)			const `[pure virtual]`

Fills gradient.

If Linear then solution may be NULL, also returns true value of function and offset so we can use x not deltaX in constraint If refresh is false then uses last solution Uses model for scaling Returns non-zero if gradient undefined at current solution

Implemented in ClpConstraintAmpl, ClpConstraintLinear, and ClpConstraintQuadratic.

virtual double ClpConstraint::functionValue	(	const ClpSimplex *	model,
		const double *	solution,
		bool	useScaling = `false`,
		bool	refresh = `true`
	)			const `[virtual]`