My Project
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>

Public Member Functions

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

Public Attributes

int idx
 idx holds the row index of the nonlinear expression
 
ENUM_NL_EXPR_SHAPE shape
 shape holds the shape of the nonlinear expression (linear/quadratic/convex/general) (see further up in this file).
 
MatrixExpressionTreematrixExpressionTree
 matrixExpressionTree contains the root of the MatrixExpressionTree
 
bool m_bDeleteExpressionTree
 if m_bDeleteExpressionTree is true during 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
 

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 1816 of file OSInstance.h.

Constructor & Destructor Documentation

◆ MatrixExpression()

MatrixExpression::MatrixExpression ( )

The MatrixExpression class constructor.

Definition at line 1599 of file OSInstance.cpp.

◆ ~MatrixExpression()

MatrixExpression::~MatrixExpression ( )

The MatrixExpression class destructor.

Definition at line 1610 of file OSInstance.cpp.

Member Function Documentation

◆ IsEqual()

bool MatrixExpression::IsEqual ( MatrixExpression * that)

A function to check for the equality of two objects.

Definition at line 9529 of file OSInstance.cpp.

Member Data Documentation

◆ idx

int MatrixExpression::idx

idx holds the row index of the nonlinear expression

Definition at line 1820 of file OSInstance.h.

◆ shape

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 1826 of file OSInstance.h.

◆ matrixExpressionTree

MatrixExpressionTree* MatrixExpression::matrixExpressionTree

matrixExpressionTree contains the root of the MatrixExpressionTree

Definition at line 1829 of file OSInstance.h.

◆ m_bDeleteExpressionTree

bool MatrixExpression::m_bDeleteExpressionTree

if m_bDeleteExpressionTree is true during 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 1836 of file OSInstance.h.


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