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

#include <OSInstance.h>

Inheritance diagram for QuadraticCone:

Collaboration diagram for QuadraticCone:

Public Member Functions
	QuadraticCone ()
	The QuadraticCone class constructor. More...

	~QuadraticCone ()
	The QuadraticCone class destructor. More...

virtual std::string	getConeName ()

virtual std::string	getConeInXML ()
	Write a QuadraticCone object in XML format. More...

bool	IsEqual (QuadraticCone *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 (QuadraticCone *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...

virtual	~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...

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

int	numberOfColumns

int	numberOfOtherIndexes
	Multidimensional tensors can also form cones (the Kronecker product, for instance, can be thought of as a four-dimensional tensor). More...

int *	otherIndexes

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

int	idx
	cones are referenced by an (automatically created) index More...

double	normScaleFactor
	quadratic cones normally are of the form x0 >= x1^2 + x2^2 + ... More...

int	distortionMatrixIdx

int	axisDirection
	The index of the first component can be changed Since there are possibly many dimensions, the index is coded as i0n1n2*... More...

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 in-memory representation of a quadratic cone.

Definition at line 860 of file OSInstance.h.

Constructor & Destructor Documentation

QuadraticCone::QuadraticCone ( )

The QuadraticCone class constructor.

Definition at line 1107 of file OSInstance.cpp.

QuadraticCone::~QuadraticCone ( )

The QuadraticCone class destructor.

Definition at line 1117 of file OSInstance.cpp.

Member Function Documentation

std::string QuadraticCone::getConeName ( )

virtual

Returns: the type of cone as a string

Reimplemented from Cone.

Definition at line 1124 of file OSInstance.cpp.

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.

bool QuadraticCone::IsEqual ( QuadraticCone * that )

A function to check for the equality of two objects.

Definition at line 8813 of file OSInstance.cpp.

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

Member Data Documentation

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.

int QuadraticCone::numberOfColumns

Definition at line 874 of file OSInstance.h.

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.

int* QuadraticCone::otherIndexes

Definition at line 882 of file OSInstance.h.

int QuadraticCone::coneType

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

Definition at line 885 of file OSInstance.h.

int QuadraticCone::idx

cones are referenced by an (automatically created) index

Definition at line 888 of file OSInstance.h.

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, ...)' : k= 1, M = -1.

Definition at line 896 of file OSInstance.h.

int QuadraticCone::distortionMatrixIdx

Definition at line 897 of file OSInstance.h.

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) (: 0)

Definition at line 908 of file OSInstance.h.

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

/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSInstance.h
/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSInstance.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation