My Project
MatrixObj Class Reference

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

#include <OSInstance.h>

Public Member Functions

 MatrixObj ()
 The MatrixVar class constructor.
 
 ~MatrixObj ()
 The MatrixVar class destructor.
 
bool IsEqual (MatrixObj *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 matrixObj that are allowed to be nonzero
 
int objReferenceMatrixIdx
 objReferenceMatrixIdx allows some or all of the components of this matrixObj to be copied from objectives defined in the core
 
int orderConeIdx
 orderConeIdx gives a cone that expresses preferences during the optimization x is (weakly) preferred to y if obj(x) - obj(y) lies in the cone.
 
int constantMatrixIdx
 constantMatrixIdx gives a constant added to the matrixObj
 
std::string name
 an optional name to this matrixObj
 

Detailed Description

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

Definition at line 1661 of file OSInstance.h.

Constructor & Destructor Documentation

◆ MatrixObj()

MatrixObj::MatrixObj ( )

The MatrixVar class constructor.

Definition at line 1554 of file OSInstance.cpp.

◆ ~MatrixObj()

MatrixObj::~MatrixObj ( )

The MatrixVar class destructor.

Definition at line 1568 of file OSInstance.cpp.

Member Function Documentation

◆ IsEqual()

bool MatrixObj::IsEqual ( MatrixObj * that)

A function to check for the equality of two objects.

Definition at line 9326 of file OSInstance.cpp.

Member Data Documentation

◆ numberOfRows

int MatrixObj::numberOfRows

numberOfRows gives the number of rows of this matrix

Definition at line 1665 of file OSInstance.h.

◆ numberOfColumns

int MatrixObj::numberOfColumns

numberOfColumns gives the number of columns of this matrix

Definition at line 1668 of file OSInstance.h.

◆ templateMatrixIdx

int MatrixObj::templateMatrixIdx

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

Definition at line 1673 of file OSInstance.h.

◆ objReferenceMatrixIdx

int MatrixObj::objReferenceMatrixIdx

objReferenceMatrixIdx allows some or all of the components of this matrixObj to be copied from objectives defined in the core

Definition at line 1678 of file OSInstance.h.

◆ orderConeIdx

int MatrixObj::orderConeIdx

orderConeIdx gives a cone that expresses preferences during the optimization x is (weakly) preferred to y if obj(x) - obj(y) lies in the cone.

Definition at line 1683 of file OSInstance.h.

◆ constantMatrixIdx

int MatrixObj::constantMatrixIdx

constantMatrixIdx gives a constant added to the matrixObj

Definition at line 1686 of file OSInstance.h.

◆ name

std::string MatrixObj::name

an optional name to this matrixObj

Definition at line 1689 of file OSInstance.h.


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