OS  2.9.3
Public Member Functions | Public Attributes | List of all members
Cone Class Referenceabstract

The in-memory representation of a generic cone Specific cone types are derived from this generic class. More...

#include <OSInstance.h>

+ Inheritance diagram for Cone:
+ Collaboration diagram for Cone:

Public Member Functions

 Cone ()
 The Cone class constructor. More...
 
 ~Cone ()
 The Cone class destructor. More...
 
virtual std::string getConeName ()
 
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
 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 generic cone Specific cone types are derived from this generic class.

Definition at line 532 of file OSInstance.h.

Constructor & Destructor Documentation

Cone::Cone ( )

The Cone class constructor.

Cone::~Cone ( )

The Cone class destructor.

Member Function Documentation

virtual std::string Cone::getConeName ( )
virtual
virtual std::string Cone::getConeInXML ( )
pure virtual

Write a Cone object in XML format.

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

Returns
the cone and its children as an XML string.

Implemented in IntersectionCone, ProductCone, CompletelyPositiveMatricesCone, CopositiveMatricesCone, SemidefiniteCone, RotatedQuadraticCone, QuadraticCone, PolyhedralCone, OrthantCone, NonpositiveCone, and NonnegativeCone.

bool Cone::IsEqual ( Cone that)

A function to check for the equality of two objects.

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

A function to make a random instance of this class.

Parameters
densitycorresponds to the probability that a particular child element is created
conformantif true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
iMinlowest index value (inclusive) that a variable reference in this matrix can take
iMaxgreatest index value (inclusive) that a variable reference in this matrix can take
bool Cone::deepCopyFrom ( Cone that)

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

Parameters
thatthe instance from which information is to be copied
Returns
whether the copy was created successfully

Member Data Documentation

int Cone::numberOfRows

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

Definition at line 545 of file OSInstance.h.

int Cone::numberOfColumns

Definition at line 546 of file OSInstance.h.

int Cone::numberOfOtherIndexes

Cones can also be formed by Multidimensional tensors.

(the Kronecker product, for instance, can be thought of as a four-dimensional tensor). We therefore allow additional dimensions, although they have not yet been implemented.

Definition at line 554 of file OSInstance.h.

int* Cone::otherIndexes

Definition at line 555 of file OSInstance.h.

ENUM_CONE_TYPE Cone::coneType

The type of the cone.

Definition at line 558 of file OSInstance.h.

std::string Cone::name

The cone can have a name for easier identification.

Definition at line 561 of file OSInstance.h.

int Cone::idx

cones are referenced by an (automatically created) index

Definition at line 564 of file OSInstance.h.


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