the InitDualVariableValues class. More...

#include <OSOption.h>

Collaboration diagram for InitDualVariableValues:

Public Member Functions
	InitDualVariableValues ()
	Default constructor. More...

	~InitDualVariableValues ()
	Class destructor. More...

bool	IsEqual (InitDualVariableValues *that)
	A function to check for the equality of two objects. More...

bool	setRandom (double density, bool conformant)
	A function to make a random instance of this class. More...

bool	deepCopyFrom (InitDualVariableValues *that)
	A function to make a deep copy of an instance of this class. More...

bool	setCon (int numberOfCon, InitDualVarValue **con)
	A function to set an array of <con> elements. More...

bool	setCon (int numberOfCon, InitDualVarValue **con, ENUM_COMBINE_ARRAYS disp)
	Alternative signature for this function. More...

bool	setCon (int numberOfCon, int idx, double lbValue, double ubValue, std::string name)
	Another alternative signature for this function. More...

bool	addCon (int idx, double lbDualValue, double ubDualValue)
	A function to add a <con> element. More...

bool	addCon (int numberOfCon, InitDualVarValue **con)
	Alternative signature for this function. More...

Public Attributes
int	numberOfCon
	number of <con> children More...

InitDualVarValue **	con
	initial dual values for each constraint More...

Detailed Description

the InitDualVariableValues class.

Author: Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin

Version: 1.0, 21/07/2008

Since: OS 1.1

Remarks: A data structure class that corresponds to an xml element in the OSoL schema.

Definition at line 2987 of file OSOption.h.

Constructor & Destructor Documentation

InitDualVariableValues::InitDualVariableValues ( )

Default constructor.

Definition at line 1047 of file OSOption.cpp.

InitDualVariableValues::~InitDualVariableValues ( )

Class destructor.

Definition at line 1056 of file OSOption.cpp.

Member Function Documentation

bool InitDualVariableValues::IsEqual ( InitDualVariableValues * that )

A function to check for the equality of two objects.

Definition at line 11861 of file OSOption.cpp.

bool InitDualVariableValues::setRandom	(	double	density,
		bool	conformant
	)

A function to make a random instance of this class.

Parameters

density,:	corresponds to the probability that a particular child element is created
conformant,:	if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

Definition at line 13145 of file OSOption.cpp.

bool InitDualVariableValues::deepCopyFrom ( InitDualVariableValues * that )

A function to make a deep copy of an instance of this class.

Parameters

that,: the instance from which information is to be copied

Returns: whether the copy was created successfully

Definition at line 14226 of file OSOption.cpp.

bool InitDualVariableValues::setCon	(	int	numberOfCon,
		InitDualVarValue **	con
	)

A function to set an array of <con> elements.

Parameters

numberOfCon,:	number of <con> elements to be set
con,:	the array of <con> elements that are to be set

Definition at line 6984 of file OSOption.cpp.

bool InitDualVariableValues::setCon	(	int	numberOfCon,
		InitDualVarValue **	con,
		ENUM_COMBINE_ARRAYS	disp
	)

Alternative signature for this function.

A function to set an array of <con> elements.

Parameters

numberOfVar,:	number of elements to be set
var,:	the array of elements that are to be set
disp,:	method of disposition if previous data exist
numberOfCon,:	number of <con> elements to be set
con,:	the array of <con> elements that are to be set
disp,:	method of disposition if previous data exist

Definition at line 7021 of file OSOption.cpp.

bool InitDualVariableValues::setCon	(	int	numberOfCon,
		int *	idx,
		double *	lbValue,
		double *	ubValue,
		std::string *	name
	)

Another alternative signature for this function.

Parameters

numberOfCon,:	number of <con> elements to be set
idx,:	the array of indices
lbValue,:	the array of dual values for the lower bound
ubValue,:	the array of dual values for the upper bound
name,:	the array of constraint names

Definition at line 7065 of file OSOption.cpp.

bool InitDualVariableValues::addCon	(	int	idx,
		double	lbDualValue,
		double	ubDualValue
	)

A function to add a <con> element.

Parameters

idx,:	the index of the constraint to be given initial dual variables
lbDualValue,:	an initial value for the dual variable associated with the lower bound
ubDualValue,:	an initial value for the dual variable associated with the upper bound
idx,:	the index of the constraint to be given initial dual variable bounds
lbValue,:	an initial lower bound for the dual variable
ubValue,:	an initial upper bound for the dual variable

Definition at line 7099 of file OSOption.cpp.

bool InitDualVariableValues::addCon	(	int	numberOfCon,
		InitDualVarValue **	con
	)

Alternative signature for this function.

A function to add several <con> elements.

A function to add an array of <con> elements simultaneously

Parameters

numberOfCon,:	number of <con> elements to be set
obj,:	the array of <con> elements that are to be set
numberOfVar,:	number of <con> elements to be added
con,:	the array of <con> elements that are to be added

Definition at line 7143 of file OSOption.cpp.

Member Data Documentation

int InitDualVariableValues::numberOfCon

number of <con> children

Definition at line 2992 of file OSOption.h.

InitDualVarValue** InitDualVariableValues::con

initial dual values for each constraint

Definition at line 2995 of file OSOption.h.

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

/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.h
/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation