The in-memory representation of a product cone. More...

#include <OSInstance.h>

Inheritance diagram for ProductCone:

Collaboration diagram for ProductCone:

Public Member Functions
	ProductCone ()
	The ProductCone class constructor. More...

	~ProductCone ()
	The ProductCone class destructor. More...

virtual std::string	getConeName ()

virtual std::string	getConeInXML ()
	Write a ProductCone object in XML format. More...

bool	IsEqual (ProductCone *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 (ProductCone *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
int	numberOfRows
	Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cones. More...

int	numberOfColumns

int	numberOfOtherIndexes
	Multidimensional tensors can also form cones (the Kronecker product, for instance, can be thought of as a four-dimensional tensor). More...

int *	otherIndexes

int	coneType
	The type of the cone (one of the values in ENUM_CONE_TYPE) More...

int	idx
	cones are referenced by an (automatically created) index More...

IntVector *	factors
	the list of "factors" contributing to the product each factor contains a reference to a previously defined cone More...

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 in-memory representation of a product cone.

Definition at line 1248 of file OSInstance.h.

Constructor & Destructor Documentation

ProductCone::ProductCone ( )

The ProductCone class constructor.

Definition at line 1216 of file OSInstance.cpp.

ProductCone::~ProductCone ( )

The ProductCone class destructor.

Definition at line 1224 of file OSInstance.cpp.

Member Function Documentation

std::string ProductCone::getConeName ( )

virtual

Returns: the type of cone as a string

Reimplemented from Cone.

Definition at line 1234 of file OSInstance.cpp.

std::string ProductCone::getConeInXML ( )

virtual

Write a ProductCone 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 7989 of file OSInstance.cpp.

bool ProductCone::IsEqual ( ProductCone * that )

A function to check for the equality of two objects.

Definition at line 8939 of file OSInstance.cpp.

bool ProductCone::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 ProductCone::deepCopyFrom ( ProductCone * 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

int ProductCone::numberOfRows

Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cones.

Definition at line 1261 of file OSInstance.h.

int ProductCone::numberOfColumns

Definition at line 1262 of file OSInstance.h.

int ProductCone::numberOfOtherIndexes

Multidimensional tensors can also form cones (the Kronecker product, for instance, can be thought of as a four-dimensional tensor).

We therefore allow additional dimensions.

Definition at line 1269 of file OSInstance.h.

int* ProductCone::otherIndexes

Definition at line 1270 of file OSInstance.h.

int ProductCone::coneType

The type of the cone (one of the values in ENUM_CONE_TYPE)

Definition at line 1273 of file OSInstance.h.

int ProductCone::idx

cones are referenced by an (automatically created) index

Definition at line 1276 of file OSInstance.h.

IntVector* ProductCone::factors

the list of "factors" contributing to the product each factor contains a reference to a previously defined cone

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation