OrthantCone Class Reference

The OrthantCone Class. More...

#include <OSInstance.h>

Inheritance diagram for OrthantCone:

Collaboration diagram for OrthantCone:

Public Member Functions
	OrthantCone ()
	default constructor. More...
	~OrthantCone ()
	default destructor. More...
virtual std::string	getConeName ()
virtual std::string	getConeInXML ()
	Write an OrthantCone object in XML format. More...
bool	IsEqual (OrthantCone *that)
	A function to check for the equality of two objects. More...
bool	setRandom (double density, bool conformant, int iMin, int iMax)
	A function to make a random instance of this class. More...
bool	deepCopyFrom (OrthantCone *that)
	A function to make a deep copy of an instance of this class. More...
Public Member Functions inherited from Cone
	Cone ()
	The Cone class constructor. More...
virtual	~Cone ()
	The Cone class destructor. More...
bool	IsEqual (Cone *that)
	A function to check for the equality of two objects. More...
bool	setRandom (double density, bool conformant, int iMin, int iMax)
	A function to make a random instance of this class. More...
bool	deepCopyFrom (Cone *that)
	A function to make a deep copy of an instance of this class. More...

Public Attributes
double *	ub
	For each dimension of the cone, give the upper and lower bounds The upper bound can be only zero or +infty, the lower bound can be only zero or -infty,. More...
double *	lb
Public Attributes inherited from Cone
int	numberOfRows
	Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cones. More...
int	numberOfColumns
int	numberOfOtherIndexes
	Cones can also be formed by Multidimensional tensors. More...
int *	otherIndexes
ENUM_CONE_TYPE	coneType
	The type of the cone. More...
std::string	name
	The cone can have a name for easier identification. More...
int	idx
	cones are referenced by an (automatically created) index More...

Detailed Description

The OrthantCone Class.

Remarks

The in-memory representation of the OSiL element <orthantCone>

Definition at line 726 of file OSInstance.h.

Constructor & Destructor Documentation

OrthantCone::OrthantCone

(

)

default constructor.

Definition at line 1055 of file OSInstance.cpp.

OrthantCone::~OrthantCone

(

)

default destructor.

Definition at line 1064 of file OSInstance.cpp.

Member Function Documentation

std::string OrthantCone::getConeName ( )

virtual

Returns

the type of cone as a string

Reimplemented from Cone.

Definition at line 1081 of file OSInstance.cpp.

std::string OrthantCone::getConeInXML ( )

virtual

Write an OrthantCone object in XML format.

This is used by OSiLWriter to write a <cone> element.

Returns

the cone and its children as an XML string.

Implements Cone.

Definition at line 7857 of file OSInstance.cpp.

bool OrthantCone::IsEqual

(

OrthantCone *

that

)

A function to check for the equality of two objects.

bool OrthantCone::setRandom	(	double	density,
		bool	conformant,
		int	iMin,
		int	iMax
	)

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)
iMin,:	lowest index value (inclusive) that a variable reference in this matrix can take
iMax,:	greatest index value (inclusive) that a variable reference in this matrix can take

bool OrthantCone::deepCopyFrom

(

OrthantCone *

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

Member Data Documentation

double* OrthantCone::ub

For each dimension of the cone, give the upper and lower bounds The upper bound can be only zero or +infty, the lower bound can be only zero or -infty,.

Definition at line 733 of file OSInstance.h.

double* OrthantCone::lb

Definition at line 734 of file OSInstance.h.

---

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

• /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSInstance.h
• /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSInstance.cpp