My Project
QuadraticCone Class Reference

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

#include <OSInstance.h>

Inheritance diagram for QuadraticCone:
Cone

Public Member Functions

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

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
 
double normScaleFactor
 quadratic cones normally are of the form x0 >= x1^2 + x2^2 + ... However, the appearance can be modified using a norm factor k and a distortion matrix M to the form x0 >= p (x1, x2, ...) M (x1, x2, ...)' @default: k= 1, M = -1.
 
int distortionMatrixIdx
 
int axisDirection
 The index of the first component can be changed Since there are possibly many dimensions, the index is coded as i0*n1*n2*... + i1*n2*n3... + ... + i_r, where i0, i1, etc are zero-based indexes for the different dimensions: i0 = 0, 1, ..., n0 -1, where n0 is the number of rows, i1 = 0, 1, ..., n1 -1, where n1 is the number of columns, and so on for higher dimensions (if any) (@default: 0)
 
- 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 in-memory representation of a quadratic cone.

Definition at line 860 of file OSInstance.h.

Constructor & Destructor Documentation

◆ QuadraticCone()

QuadraticCone::QuadraticCone ( )

The QuadraticCone class constructor.

Definition at line 1107 of file OSInstance.cpp.

◆ ~QuadraticCone()

QuadraticCone::~QuadraticCone ( )

The QuadraticCone class destructor.

Definition at line 1117 of file OSInstance.cpp.

Member Function Documentation

◆ getConeName()

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

Reimplemented from Cone.

Definition at line 1124 of file OSInstance.cpp.

◆ getConeInXML()

std::string QuadraticCone::getConeInXML ( )
virtual

Write a QuadraticCone 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 7914 of file OSInstance.cpp.

◆ IsEqual()

bool QuadraticCone::IsEqual ( QuadraticCone * that)

A function to check for the equality of two objects.

Definition at line 8813 of file OSInstance.cpp.

◆ setRandom()

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

◆ numberOfRows

int QuadraticCone::numberOfRows

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

Definition at line 873 of file OSInstance.h.

◆ numberOfColumns

int QuadraticCone::numberOfColumns

Definition at line 874 of file OSInstance.h.

◆ numberOfOtherIndexes

int QuadraticCone::numberOfOtherIndexes

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.

Definition at line 881 of file OSInstance.h.

◆ otherIndexes

int* QuadraticCone::otherIndexes

Definition at line 882 of file OSInstance.h.

◆ coneType

int QuadraticCone::coneType

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

Definition at line 885 of file OSInstance.h.

◆ idx

int QuadraticCone::idx

cones are referenced by an (automatically created) index

Definition at line 888 of file OSInstance.h.

◆ normScaleFactor

double QuadraticCone::normScaleFactor

quadratic cones normally are of the form x0 >= x1^2 + x2^2 + ... However, the appearance can be modified using a norm factor k and a distortion matrix M to the form x0 >= p (x1, x2, ...) M (x1, x2, ...)' @default: k= 1, M = -1.

Definition at line 896 of file OSInstance.h.

◆ distortionMatrixIdx

int QuadraticCone::distortionMatrixIdx

Definition at line 897 of file OSInstance.h.

◆ axisDirection

int QuadraticCone::axisDirection

The index of the first component can be changed Since there are possibly many dimensions, the index is coded as i0*n1*n2*... + i1*n2*n3... + ... + i_r, where i0, i1, etc are zero-based indexes for the different dimensions: i0 = 0, 1, ..., n0 -1, where n0 is the number of rows, i1 = 0, 1, ..., n1 -1, where n1 is the number of columns, and so on for higher dimensions (if any) (@default: 0)

Definition at line 908 of file OSInstance.h.


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