My Project
DualCone Class Reference

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

#include <OSInstance.h>

Inheritance diagram for DualCone:
Cone

Public Member Functions

 DualCone ()
 The DualCone class constructor.
 
 ~DualCone ()
 The DualCone class destructor.
 
virtual std::string getConeName ()
 
bool IsEqual (DualCone *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 (DualCone *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.
 
virtual std::string getConeInXML ()=0
 Write a Cone object in XML format.
 
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 referenceConeIdx
 Dual cones use a reference to another, previously defined cone.
 
- 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 dual cone.

Definition at line 1400 of file OSInstance.h.

Constructor & Destructor Documentation

◆ DualCone()

DualCone::DualCone ( )

The DualCone class constructor.

Definition at line 1264 of file OSInstance.cpp.

◆ ~DualCone()

DualCone::~DualCone ( )

The DualCone class destructor.

Definition at line 1272 of file OSInstance.cpp.

Member Function Documentation

◆ getConeName()

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

Reimplemented from Cone.

Definition at line 1279 of file OSInstance.cpp.

◆ IsEqual()

bool DualCone::IsEqual ( DualCone * that)

A function to check for the equality of two objects.

Definition at line 9015 of file OSInstance.cpp.

◆ setRandom()

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

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

Definition at line 1413 of file OSInstance.h.

◆ numberOfColumns

int DualCone::numberOfColumns

Definition at line 1414 of file OSInstance.h.

◆ numberOfOtherIndexes

int DualCone::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 1421 of file OSInstance.h.

◆ otherIndexes

int* DualCone::otherIndexes

Definition at line 1422 of file OSInstance.h.

◆ coneType

int DualCone::coneType

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

Definition at line 1425 of file OSInstance.h.

◆ idx

int DualCone::idx

cones are referenced by an (automatically created) index

Definition at line 1428 of file OSInstance.h.

◆ referenceConeIdx

int DualCone::referenceConeIdx

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

Definition at line 1431 of file OSInstance.h.


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