OS  2.9.3
Public Member Functions | Public Attributes | List of all members
MatrixExpression Class Reference

The in-memory representation of the <expr> element, which is like a nonlinear expression, but since it involves matrices, the expression could be linear, so a "shape" attribute is added to distinguish linear and nonlinear expressions. More...

#include <OSInstance.h>

+ Collaboration diagram for MatrixExpression:

Public Member Functions

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

Public Attributes

int idx
 idx holds the row index of the nonlinear expression More...
 
ENUM_NL_EXPR_SHAPE shape
 shape holds the shape of the nonlinear expression (linear/quadratic/convex/general) (see further up in this file). More...
 
bool m_bDeleteExpressionTree
 m_bDeleteExpressionTree is true, if in garbage collection, we should delete the osExpression tree object, if the OSInstance class created a map of the expression trees this should be false since the osExpressionTree is deleted by the OSInstance object More...
 
MatrixExpressionTree * matrixExpressionTree
 matrixExpressionTree contains the root of the MatrixExpressionTree More...
 

Detailed Description

The in-memory representation of the <expr> element, which is like a nonlinear expression, but since it involves matrices, the expression could be linear, so a "shape" attribute is added to distinguish linear and nonlinear expressions.

Definition at line 1793 of file OSInstance.h.

Constructor & Destructor Documentation

MatrixExpression::MatrixExpression ( )

The MatrixExpression class constructor.

MatrixExpression::~MatrixExpression ( )

The MatrixExpression class destructor.

Member Function Documentation

bool MatrixExpression::IsEqual ( MatrixExpression *  that)

A function to check for the equality of two objects.

Member Data Documentation

int MatrixExpression::idx

idx holds the row index of the nonlinear expression

Definition at line 1797 of file OSInstance.h.

ENUM_NL_EXPR_SHAPE MatrixExpression::shape

shape holds the shape of the nonlinear expression (linear/quadratic/convex/general) (see further up in this file).

this might be useful in guiding solver selection.

Definition at line 1803 of file OSInstance.h.

bool MatrixExpression::m_bDeleteExpressionTree

m_bDeleteExpressionTree is true, if in garbage collection, we should delete the osExpression tree object, if the OSInstance class created a map of the expression trees this should be false since the osExpressionTree is deleted by the OSInstance object

Definition at line 1810 of file OSInstance.h.

MatrixExpressionTree* MatrixExpression::matrixExpressionTree

matrixExpressionTree contains the root of the MatrixExpressionTree

Definition at line 1813 of file OSInstance.h.


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