OS  2.9.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
NonnegativeCone Class Reference

The NonnegativeCone Class. More...

#include <OSInstance.h>

+ Inheritance diagram for NonnegativeCone:
+ Collaboration diagram for NonnegativeCone:

Public Member Functions

 NonnegativeCone ()
 default constructor. More...
 
 ~NonnegativeCone ()
 default destructor. More...
 
virtual std::string getConeName ()
 
virtual std::string getConeInXML ()
 Write a NonnegativeCone object in XML format. More...
 
bool IsEqual (NonnegativeCone *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 (NonnegativeCone *that)
 A function to make a deep copy of an instance of this class. More...
 
- Public Member Functions inherited from Cone
 Cone ()
 The Cone class constructor. More...
 
 ~Cone ()
 The Cone class destructor. 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...
 

Additional Inherited Members

- Public Attributes inherited from Cone
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 NonnegativeCone Class.

Remarks
The in-memory representation of the OSiL element <nonnegativeCone>

Definition at line 611 of file OSInstance.h.

Constructor & Destructor Documentation

NonnegativeCone::NonnegativeCone ( )

default constructor.

NonnegativeCone::~NonnegativeCone ( )

default destructor.

Member Function Documentation

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

Reimplemented from Cone.

virtual std::string NonnegativeCone::getConeInXML ( )
virtual

Write a NonnegativeCone 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.

bool NonnegativeCone::IsEqual ( NonnegativeCone that)

A function to check for the equality of two objects.

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

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