My Project
PolyhedralCone Class Reference

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

#include <OSInstance.h>

Inheritance diagram for PolyhedralCone:
Cone

Public Member Functions

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

Public Attributes

int numberOfRows
 Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cones.
 
int numberOfColumns
 
int numberOfOtherIndexes
 Multidimensional tensors can also form cones (the Kronecker product, for instance, can be thought of as a four-dimensional tensor).
 
int * otherIndexes
 
int coneType
 The type of the cone (one of the values in ENUM_CONE_TYPE)
 
int idx
 cones are referenced by an (automatically created) index
 
int referenceMatrixIdx
 Polyhedral cones use a reference to a previously defined matrix for the extreme rays.
 
- Public Attributes inherited from Cone
int numberOfRows
 Every cone has (at least) two dimensions; no distinction is made between vector cones and matrix cones.
 
int numberOfColumns
 
int numberOfOtherIndexes
 Cones can also be formed by Multidimensional tensors.
 
int * otherIndexes
 
ENUM_CONE_TYPE coneType
 The type of the cone.
 
std::string name
 The cone can have a name for easier identification.
 
int idx
 cones are referenced by an (automatically created) index
 

Detailed Description

The in-memory representation of a polyhedral cone.

Definition at line 786 of file OSInstance.h.

Constructor & Destructor Documentation

◆ PolyhedralCone()

PolyhedralCone::PolyhedralCone ( )

The PolyhedralCone class constructor.

Definition at line 1086 of file OSInstance.cpp.

◆ ~PolyhedralCone()

PolyhedralCone::~PolyhedralCone ( )

The PolyhedralCone class destructor.

Definition at line 1094 of file OSInstance.cpp.

Member Function Documentation

◆ getConeName()

std::string PolyhedralCone::getConeName ( )
virtual
Returns
the type of cone as a string

Reimplemented from Cone.

Definition at line 1101 of file OSInstance.cpp.

◆ getConeInXML()

std::string PolyhedralCone::getConeInXML ( )
virtual

Write a PolyhedralCone 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 7901 of file OSInstance.cpp.

◆ IsEqual()

bool PolyhedralCone::IsEqual ( PolyhedralCone * that)

A function to check for the equality of two objects.

Definition at line 8774 of file OSInstance.cpp.

◆ setRandom()

bool PolyhedralCone::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

◆ deepCopyFrom()

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

◆ numberOfRows

int PolyhedralCone::numberOfRows

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

Definition at line 799 of file OSInstance.h.

◆ numberOfColumns

int PolyhedralCone::numberOfColumns

Definition at line 800 of file OSInstance.h.

◆ numberOfOtherIndexes

int PolyhedralCone::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 807 of file OSInstance.h.

◆ otherIndexes

int* PolyhedralCone::otherIndexes

Definition at line 808 of file OSInstance.h.

◆ coneType

int PolyhedralCone::coneType

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

Definition at line 811 of file OSInstance.h.

◆ idx

int PolyhedralCone::idx

cones are referenced by an (automatically created) index

Definition at line 814 of file OSInstance.h.

◆ referenceMatrixIdx

int PolyhedralCone::referenceMatrixIdx

Polyhedral cones use a reference to a previously defined matrix for the extreme rays.

Definition at line 817 of file OSInstance.h.


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