MatrixVar Class Reference

The in-memory representation of the <matrixVar> element. More...

#include <OSInstance.h>

Collaboration diagram for MatrixVar:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 MatrixVar ()
 The MatrixVar class constructor.
 ~MatrixVar ()
 The MatrixVar class destructor.
bool IsEqual (MatrixVar *that)
 A function to check for the equality of two objects.

Public Attributes

int numberOfRows
 numberOfRows gives the number of rows of this matrix
int numberOfColumns
 numberOfColumns gives the number of columns of this matrix
int templateMatrixIdx
 templateMatrixIdx refers to a matrix that describes the locations in this matrixVar that are allowed to be nonzero
int varReferenceMatrixIdx
 varReferenceMatrixIdx allows some or all of the components of this matrix variable to be copied from variables defined in the core
int lbMatrixIdx
 lbMatrixIdx gives a lower bound for this matrixVar
int lbConeIdx
 lbConeIdx gives a cone that must contain matrixVar - lbMatrix
int ubMatrixIdx
 ubMatrixIdx gives an upper bound for this matrixVar
int ubConeIdx
 ubConeIdx gives a cone that must contain ubMatrix - matrixVar
std::string name
 an optional name to this matrixVar
char varType
 an optional variable type (C, B, I, D, J, S).

Detailed Description

The in-memory representation of the <matrixVar> element.

Definition at line 1579 of file OSInstance.h.


Constructor & Destructor Documentation

MatrixVar::MatrixVar (  ) 

The MatrixVar class constructor.

Definition at line 1529 of file OSInstance.cpp.

MatrixVar::~MatrixVar (  ) 

The MatrixVar class destructor.

Definition at line 1546 of file OSInstance.cpp.


Member Function Documentation

bool MatrixVar::IsEqual ( MatrixVar that  ) 

A function to check for the equality of two objects.

Definition at line 9218 of file OSInstance.cpp.


Member Data Documentation

numberOfRows gives the number of rows of this matrix

Definition at line 1583 of file OSInstance.h.

numberOfColumns gives the number of columns of this matrix

Definition at line 1586 of file OSInstance.h.

templateMatrixIdx refers to a matrix that describes the locations in this matrixVar that are allowed to be nonzero

Definition at line 1591 of file OSInstance.h.

varReferenceMatrixIdx allows some or all of the components of this matrix variable to be copied from variables defined in the core

Definition at line 1596 of file OSInstance.h.

lbMatrixIdx gives a lower bound for this matrixVar

Definition at line 1599 of file OSInstance.h.

lbConeIdx gives a cone that must contain matrixVar - lbMatrix

Definition at line 1602 of file OSInstance.h.

ubMatrixIdx gives an upper bound for this matrixVar

Definition at line 1605 of file OSInstance.h.

ubConeIdx gives a cone that must contain ubMatrix - matrixVar

Definition at line 1608 of file OSInstance.h.

std::string MatrixVar::name

an optional name to this matrixVar

Definition at line 1611 of file OSInstance.h.

an optional variable type (C, B, I, D, J, S).

Remarks:
must be the same for each component of this matrixVar

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