PolarCone Class Reference

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

#include <OSInstance.h>

Inheritance diagram for PolarCone:
Inheritance graph
[legend]
Collaboration diagram for PolarCone:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 PolarCone ()
 The PolarCone class constructor.
 ~PolarCone ()
 The PolarCone class destructor.
virtual std::string getConeName ()
bool IsEqual (PolarCone *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 (PolarCone *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
 Polar cones use a reference to another, previously defined cone.

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.

Reimplemented from Cone.

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

Reimplemented from Cone.

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

Reimplemented from Cone.


Member Data Documentation

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

Reimplemented from Cone.

Definition at line 1478 of file OSInstance.h.

Reimplemented from Cone.

Definition at line 1479 of file OSInstance.h.

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.

Reimplemented from Cone.

Definition at line 1486 of file OSInstance.h.

Reimplemented from Cone.

Definition at line 1487 of file OSInstance.h.

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

Reimplemented from Cone.

Definition at line 1490 of file OSInstance.h.

cones are referenced by an (automatically created) index

Reimplemented from Cone.

Definition at line 1493 of file OSInstance.h.

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:

Generated on 5 Jul 2015 by  doxygen 1.6.1