PolarCone Class Reference

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

#include <OSInstance.h>

Inheritance diagram for PolarCone:

Collaboration diagram for PolarCone:

Public Member Functions
	PolarCone ()
	The PolarCone class constructor. More...
	~PolarCone ()
	The PolarCone class destructor. More...
virtual std::string	getConeName ()
bool	IsEqual (PolarCone *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 (PolarCone *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...
virtual std::string	getConeInXML ()=0
	Write a Cone object in XML format. 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...
int	referenceConeIdx
	Polar cones use a reference to another, 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 polar cone.

Definition at line 1465 of file OSInstance.h.

Constructor & Destructor Documentation

PolarCone::PolarCone

(

)

The PolarCone class constructor.

Definition at line 1285 of file OSInstance.cpp.

PolarCone::~PolarCone

(

)

The PolarCone class destructor.

Definition at line 1293 of file OSInstance.cpp.

Member Function Documentation

std::string PolarCone::getConeName ( )

virtual

Returns

the type of cone as a string

Reimplemented from Cone.

Definition at line 1300 of file OSInstance.cpp.

bool PolarCone::IsEqual

(

PolarCone *

that

)

A function to check for the equality of two objects.

Definition at line 9054 of file OSInstance.cpp.

bool PolarCone::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 PolarCone::deepCopyFrom

(

PolarCone *

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 PolarCone::numberOfRows

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

Definition at line 1478 of file OSInstance.h.

int PolarCone::numberOfColumns

Definition at line 1479 of file OSInstance.h.

int PolarCone::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 1486 of file OSInstance.h.

int* PolarCone::otherIndexes

Definition at line 1487 of file OSInstance.h.

int PolarCone::coneType

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

Definition at line 1490 of file OSInstance.h.

int PolarCone::idx

cones are referenced by an (automatically created) index

Definition at line 1493 of file OSInstance.h.

int PolarCone::referenceConeIdx

Polar cones use a reference to another, previously defined cone.

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