My Project
OrthantCone Class Reference

The OrthantCone Class. More...

#include <OSInstance.h>

Inheritance diagram for OrthantCone:
Cone

Public Member Functions

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

Public Attributes

double * ub
 For each dimension of the cone, give the upper and lower bounds The upper bound can be only zero or +infty, the lower bound can be only zero or -infty,.
 
double * lb
 
- 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 OrthantCone Class.

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

Definition at line 726 of file OSInstance.h.

Constructor & Destructor Documentation

◆ OrthantCone()

OrthantCone::OrthantCone ( )

default constructor.

Definition at line 1055 of file OSInstance.cpp.

◆ ~OrthantCone()

OrthantCone::~OrthantCone ( )

default destructor.

Definition at line 1064 of file OSInstance.cpp.

Member Function Documentation

◆ getConeName()

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

Reimplemented from Cone.

Definition at line 1081 of file OSInstance.cpp.

◆ getConeInXML()

std::string OrthantCone::getConeInXML ( )
virtual

Write an OrthantCone 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 7857 of file OSInstance.cpp.

◆ IsEqual()

bool OrthantCone::IsEqual ( OrthantCone * that)

A function to check for the equality of two objects.

◆ setRandom()

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

◆ ub

double* OrthantCone::ub

For each dimension of the cone, give the upper and lower bounds The upper bound can be only zero or +infty, the lower bound can be only zero or -infty,.

Definition at line 733 of file OSInstance.h.

◆ lb

double* OrthantCone::lb

Definition at line 734 of file OSInstance.h.


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