RotatedQuadraticCone Class Reference

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

#include <OSInstance.h>

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

List of all members.

Public Member Functions

 RotatedQuadraticCone ()
 The RotatedQuadraticCone class constructor.
 ~RotatedQuadraticCone ()
 The RotatedQuadraticCone class destructor.
virtual std::string getConeName ()
virtual std::string getConeInXML ()
 Write a RotatedQuadraticCone object in XML format.
bool IsEqual (RotatedQuadraticCone *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 (RotatedQuadraticCone *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
 rotated quadratic cones normally are of the form x0x1 >= x2^2 + x3^2 + .
int distortionMatrixIdx
int firstAxisDirection
 The indices of the first two component can be changed Since there are possibly many dimensions, each index is coded as i0*n1*n2*.
int secondAxisDirection

Detailed Description

The in-memory representation of a rotated quadratic cone.

Definition at line 951 of file OSInstance.h.

Constructor & Destructor Documentation

RotatedQuadraticCone::RotatedQuadraticCone (  ) 

The RotatedQuadraticCone class constructor.

Definition at line 1130 of file OSInstance.cpp.

RotatedQuadraticCone::~RotatedQuadraticCone (  ) 

The RotatedQuadraticCone class destructor.

Definition at line 1141 of file OSInstance.cpp.

Member Function Documentation

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

Reimplemented from Cone.

Definition at line 1148 of file OSInstance.cpp.

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

Write a RotatedQuadraticCone 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 7930 of file OSInstance.cpp.

bool RotatedQuadraticCone::IsEqual ( RotatedQuadraticCone *  that  ) 

A function to check for the equality of two objects.

Reimplemented from Cone.

Definition at line 8855 of file OSInstance.cpp.

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

int RotatedQuadraticCone::numberOfRows

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

Reimplemented from Cone.

Definition at line 964 of file OSInstance.h.

int RotatedQuadraticCone::numberOfColumns

Reimplemented from Cone.

Definition at line 965 of file OSInstance.h.

int RotatedQuadraticCone::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.

Reimplemented from Cone.

Definition at line 972 of file OSInstance.h.

int* RotatedQuadraticCone::otherIndexes

Reimplemented from Cone.

Definition at line 973 of file OSInstance.h.

int RotatedQuadraticCone::coneType

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

Reimplemented from Cone.

Definition at line 976 of file OSInstance.h.

int RotatedQuadraticCone::idx

cones are referenced by an (automatically created) index

Reimplemented from Cone.

Definition at line 979 of file OSInstance.h.

double RotatedQuadraticCone::normScaleFactor

rotated quadratic cones normally are of the form x0x1 >= x2^2 + x3^2 + .

.. However, the appearance can be modified using a norm factor k and a distortion matrix M to the form x0x1 >= p (x2, x3, ...) M (x2, x3, ...)' : k= 1, M = -1.

Definition at line 987 of file OSInstance.h.

int RotatedQuadraticCone::distortionMatrixIdx

Definition at line 988 of file OSInstance.h.

int RotatedQuadraticCone::firstAxisDirection

The indices of the first two component can be changed Since there are possibly many dimensions, each 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) : i0 = 0, i1 = 1.

Definition at line 999 of file OSInstance.h.

int RotatedQuadraticCone::secondAxisDirection

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