ProductCone Class Reference

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

#include <OSInstance.h>

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

List of all members.

Public Member Functions

 ProductCone ()
 The ProductCone class constructor.
 ~ProductCone ()
 The ProductCone class destructor.
virtual std::string getConeName ()
virtual std::string getConeInXML ()
 Write a ProductCone object in XML format.
bool IsEqual (ProductCone *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 (ProductCone *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
IntVectorfactors
 the list of "factors" contributing to the product each factor contains a reference to a previously defined cone

Detailed Description

The in-memory representation of a product cone.

Definition at line 1248 of file OSInstance.h.


Constructor & Destructor Documentation

ProductCone::ProductCone (  ) 

The ProductCone class constructor.

Definition at line 1216 of file OSInstance.cpp.

ProductCone::~ProductCone (  ) 

The ProductCone class destructor.

Definition at line 1224 of file OSInstance.cpp.


Member Function Documentation

std::string ProductCone::getConeName (  )  [virtual]
Returns:
the type of cone as a string

Reimplemented from Cone.

Definition at line 1234 of file OSInstance.cpp.

std::string ProductCone::getConeInXML (  )  [virtual]

Write a ProductCone 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 7987 of file OSInstance.cpp.

bool ProductCone::IsEqual ( ProductCone that  ) 

A function to check for the equality of two objects.

Reimplemented from Cone.

Definition at line 8937 of file OSInstance.cpp.

bool ProductCone::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 ProductCone::deepCopyFrom ( ProductCone 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 1261 of file OSInstance.h.

Reimplemented from Cone.

Definition at line 1262 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 1269 of file OSInstance.h.

Reimplemented from Cone.

Definition at line 1270 of file OSInstance.h.

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

Reimplemented from Cone.

Definition at line 1273 of file OSInstance.h.

cones are referenced by an (automatically created) index

Reimplemented from Cone.

Definition at line 1276 of file OSInstance.h.

the list of "factors" contributing to the product each factor contains a reference to a previously defined cone

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