My Project
CopositiveMatricesCone Class Reference

The CopositiveMatricesCone Class. More...

#include <OSInstance.h>

Inheritance diagram for CopositiveMatricesCone:
Cone

Public Member Functions

 CopositiveMatricesCone ()
 default constructor.
 
 ~CopositiveMatricesCone ()
 default destructor.
 
virtual std::string getConeName ()
 
virtual std::string getConeInXML ()
 Write a CopositiveMatricesCone object in XML format.
 
bool IsEqual (CopositiveMatricesCone *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 (CopositiveMatricesCone *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.
 

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.
 
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 CopositiveMatricesCone Class.

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

Definition at line 1127 of file OSInstance.h.

Constructor & Destructor Documentation

◆ CopositiveMatricesCone()

CopositiveMatricesCone::CopositiveMatricesCone ( )

default constructor.

Definition at line 1177 of file OSInstance.cpp.

◆ ~CopositiveMatricesCone()

CopositiveMatricesCone::~CopositiveMatricesCone ( )

default destructor.

Definition at line 1184 of file OSInstance.cpp.

Member Function Documentation

◆ getConeName()

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

Reimplemented from Cone.

Definition at line 1191 of file OSInstance.cpp.

◆ getConeInXML()

std::string CopositiveMatricesCone::getConeInXML ( )
virtual

Write a CopositiveMatricesCone 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 7965 of file OSInstance.cpp.

◆ IsEqual()

bool CopositiveMatricesCone::IsEqual ( CopositiveMatricesCone * that)

A function to check for the equality of two objects.

◆ setRandom()

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

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