the IntegerVariableBranchingWeights class. More...

#include <OSOption.h>

Collaboration diagram for IntegerVariableBranchingWeights:

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

	~IntegerVariableBranchingWeights ()
	Class destructor. More...

bool	IsEqual (IntegerVariableBranchingWeights *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 (IntegerVariableBranchingWeights *that)
	A function to make a deep copy of an instance of this class. More...

bool	setVar (int numberOfVar, BranchingWeight **var)
	A function to set an array of elements. More...

bool	setVar (int numberOfVar, BranchingWeight **var, ENUM_COMBINE_ARRAYS disp)
	Alternative signature for this function. More...

bool	setVar (int numberOfVar, int idx, double value, std::string *name)
	Another alternative signature for this function. More...

bool	addVar (int idx, double value)
	A function to add a element. More...

bool	addVar (int numberOfVar, BranchingWeight **var)
	Alternative signature for this function. More...

Public Attributes
int	numberOfVar
	number of children More...

BranchingWeight **	var
	branching weight for each variable More...

Detailed Description

the IntegerVariableBranchingWeights class.

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

Version: 1.0, 21/11/2008

Since: OS 1.1

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

Definition at line 1671 of file OSOption.h.

Constructor & Destructor Documentation

IntegerVariableBranchingWeights::IntegerVariableBranchingWeights ( )

Default constructor.

Definition at line 589 of file OSOption.cpp.

IntegerVariableBranchingWeights::~IntegerVariableBranchingWeights ( )

Class destructor.

Definition at line 598 of file OSOption.cpp.

Member Function Documentation

bool IntegerVariableBranchingWeights::IsEqual ( IntegerVariableBranchingWeights * that )

A function to check for the equality of two objects.

Definition at line 10992 of file OSOption.cpp.

bool IntegerVariableBranchingWeights::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 12733 of file OSOption.cpp.

bool IntegerVariableBranchingWeights::deepCopyFrom ( IntegerVariableBranchingWeights * 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 13849 of file OSOption.cpp.

bool IntegerVariableBranchingWeights::setVar	(	int	numberOfVar,
		BranchingWeight **	var
	)

A function to set an array of elements.

Parameters

numberOfVar,:	number of elements to be set
var,:	the array of elements to be that are to be set

Definition at line 5514 of file OSOption.cpp.

bool IntegerVariableBranchingWeights::setVar	(	int	numberOfVar,
		BranchingWeight **	var,
		ENUM_COMBINE_ARRAYS	disp
	)

Alternative signature for this function.

A function to set an array of 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

numberOfVar,: number of elements to be set

var,: the array of elements to be that are to be set

Definition at line 5551 of file OSOption.cpp.

bool IntegerVariableBranchingWeights::setVar	(	int	numberOfVar,
		int *	idx,
		double *	value,
		std::string *	name
	)

Another alternative signature for this function.

A function to set an array of elements.

Parameters

numberOfVar,: number of elements to be set

idx,: the array of indices

value,: the array of corresponding values

name,: the array of corresponding names

numberOfVar,: number of elements to be set

idx,: the array of indices for the elements that are to be set

value,: the array of the corresponding values

name,: the array of the corresponding names

Definition at line 5603 of file OSOption.cpp.

bool IntegerVariableBranchingWeights::addVar	(	int	idx,
		double	value
	)

A function to add a element.

Parameters

idx,:	the index of the variable to be given a branching weight
value,:	the branching weight to be added

Definition at line 5637 of file OSOption.cpp.

bool IntegerVariableBranchingWeights::addVar	(	int	numberOfVar,
		BranchingWeight **	var
	)

Alternative signature for this function.

A function to add several elements.

A function to add an array of elements simultaneously

Parameters

numberOfVar,: number of elements to be set

var,: the array of elements that are to be set

numberOfVar,: number of elements to be added

var,: the array of elements that are to be added

Definition at line 5680 of file OSOption.cpp.

Member Data Documentation

int IntegerVariableBranchingWeights::numberOfVar

number of children

Definition at line 1676 of file OSOption.h.

BranchingWeight** IntegerVariableBranchingWeights::var

branching weight for each variable

Definition at line 1679 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