ClpObjective Class Reference

#include <ClpObjective.hpp>

Inheritance diagram for ClpObjective:

Public Member Functions
Stuff

virtual double *	gradient (const ClpSimplex model, const double solution, double &offset, bool refresh, int includeLinear=2)=0
	Returns gradient.
virtual double	reducedGradient (ClpSimplex model, double region, bool useFeasibleCosts)=0
	Returns reduced gradient.Returns an offset (to be added to current one).
virtual double	stepLength (ClpSimplex model, const double solution, const double *change, double maximumTheta, double &currentObj, double &predictedObj, double &thetaObj)=0
	Returns step length which gives minimum of objective for solution + theta * change vector up to maximum theta.
virtual double	objectiveValue (const ClpSimplex model, const double solution) const =0
	Return objective value (without any ClpModel offset) (model may be NULL).
virtual void	resize (int newNumberColumns)=0
	Resize objective.
virtual void	deleteSome (int numberToDelete, const int *which)=0
	Delete columns in objective.
virtual void	reallyScale (const double *columnScale)=0
	Scale objective.
virtual int	markNonlinear (char *which)
	Given a zeroed array sets nonlinear columns to 1.
virtual void	newXValues ()
	Say we have new primal solution - so may need to recompute.
Constructors and destructors

	ClpObjective ()
	Default Constructor.
	ClpObjective (const ClpObjective &)
	Copy constructor.
ClpObjective &	operator= (const ClpObjective &rhs)
	Assignment operator.
virtual	~ClpObjective ()
	Destructor.
virtual ClpObjective *	clone () const =0
	Clone.
virtual ClpObjective *	subsetClone (int numberColumns, const int *whichColumns) const
	Subset clone.
Other

int	type ()
	Returns type (above 63 is extra information).
int	activated () const
	Whether activated.
void	setActivated (int value)
	Set whether activated.
double	nonlinearOffset () const
	Objective offset.
Protected Attributes
Protected member data

double	offset_
	Value of non-linear part of objective.
int	type_
	Type of objective - linear is 1.
int	activated_
	Whether activated.

Detailed Description

Objective Abstract Base Class.

Abstract Base Class for describing an objective function

Definition at line 16 of file ClpObjective.hpp.

Constructor & Destructor Documentation

ClpObjective::ClpObjective ( )

Default Constructor.

ClpObjective::ClpObjective ( const ClpObjective & )

Copy constructor.

virtual ClpObjective::~ClpObjective ( ) [virtual]

Destructor.

Member Function Documentation

virtual double* ClpObjective::gradient	(	const ClpSimplex *	model,
		const double *	solution,
		double &	offset,
		bool	refresh,
		int	includeLinear = `2`
	)			`[pure virtual]`

Returns gradient.

If Linear then solution may be NULL, also returns an offset (to be added to current one) If refresh is false then uses last solution Uses model for scaling includeLinear 0 - no, 1 as is, 2 as feasible

Implemented in ClpAmplObjective, ClpLinearObjective, and ClpQuadraticObjective.

virtual double ClpObjective::reducedGradient	(	ClpSimplex *	model,
		double *	region,
		bool	useFeasibleCosts
	)			`[pure virtual]`

Returns reduced gradient.Returns an offset (to be added to current one).

Implemented in ClpAmplObjective, ClpLinearObjective, and ClpQuadraticObjective.

virtual double ClpObjective::stepLength	(	ClpSimplex *	model,
		const double *	solution,
		const double *	change,
		double	maximumTheta,
		double &	currentObj,
		double &	predictedObj,
		double &	thetaObj
	)			`[pure virtual]`