My Project
Nl Class Reference

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

#include <OSInstance.h>

Public Member Functions

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

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).
 
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
 
ScalarExpressionTreeosExpressionTree
 osExpressionTree contains the root of the ScalarExpressionTree
 
OSExpressionTreeosExpressionTree
 osExpressionTree contains the root of the OSExpressionTree
 

Detailed Description

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

Definition at line 410 of file OSInstance.h.

Constructor & Destructor Documentation

◆ Nl() [1/2]

Nl::Nl ( )

default constructor.

Definition at line 816 of file OSInstance.cpp.

◆ ~Nl() [1/2]

Nl::~Nl ( )

default destructor.

Definition at line 828 of file OSInstance.cpp.

◆ Nl() [2/2]

Nl::Nl ( )

default constructor.

◆ ~Nl() [2/2]

Nl::~Nl ( )

default destructor.

Member Function Documentation

◆ IsEqual()

bool Nl::IsEqual ( Nl * that)

A function to check for the equality of two objects.

Definition at line 8606 of file OSInstance.cpp.

Member Data Documentation

◆ idx

int Nl::idx

idx holds the row index of the nonlinear expression

Definition at line 414 of file OSInstance.h.

◆ shape

ENUM_NL_EXPR_SHAPE Nl::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 420 of file OSInstance.h.

◆ m_bDeleteExpressionTree

bool Nl::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 427 of file OSInstance.h.

◆ osExpressionTree [1/2]

ScalarExpressionTree* Nl::osExpressionTree

osExpressionTree contains the root of the ScalarExpressionTree

Definition at line 430 of file OSInstance.h.

◆ osExpressionTree [2/2]

OSExpressionTree* Nl::osExpressionTree

osExpressionTree contains the root of the OSExpressionTree

Definition at line 401 of file OSInstance.h.


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