The OSnLNodeVariable Class.
More...
#include <OSnLNode.h>
|
double | coef |
| coef is an option coefficient on the variable, the default value is 1.0 More...
|
|
int | idx |
| idx is the index of the variable More...
|
|
double | m_dFunctionValue |
| m_dFunctionValue holds the function value given the current variable values. More...
|
|
ADdouble | m_ADTape |
| m_ADTape stores the expression tree for the this OSnLNode as an ADdouble. More...
|
|
int | inodeInt |
| inodeInt is the unique integer assigned to the OSnLNode or OSnLMNode in OSParameters.h. More...
|
|
int | inodeType |
| inodeType essentially tracks whether the number of children are known or not. More...
|
|
unsigned int | inumberOfChildren |
| inumberOfChildren is the number of OSnLNode child elements If this number is not fixed, e.g., for a sum node, it is temporarily set to 0 More...
|
|
unsigned int | inumberOfMatrixChildren |
| inumberOfMatrixChildren is the number of OSnLMNode child elements If this number is not fixed, e.g., for a matrixProduct node, it is temporarily set to 0 More...
|
|
OSnLNode ** | m_mChildren |
| m_mChildren holds all the operands, that is, nodes that the current node operates on. More...
|
|
OSnLMNode ** | m_mMatrixChildren |
| m_mMatrixChildren holds all the matrix-valued operands, if any. More...
|
|
The OSnLNodeVariable Class.
- Author
- Robert Fourer, Jun Ma, Kipp Martin
- Version
- 1.0, 10/05/2005
- Since
- OS1.0
Definition at line 1494 of file OSnLNode.h.
OSnLNodeVariable::OSnLNodeVariable |
( |
| ) |
|
OSnLNodeVariable::~OSnLNodeVariable |
( |
| ) |
|
virtual void OSnLNodeVariable::getVariableIndexMap |
( |
std::map< int, int > * |
varIdx | ) |
|
|
virtual |
varIdx is a map where the key is the index of an OSnLNodeVariable and (*varIdx)[ idx] is the kth variable in the map, e.g. (*varIdx)[ 5] = 2 means that variable indexed by 5 is the second variable in the OSnLNode and all of its children
- Parameters
-
a | pointer to a map of the variables in the OSnLNode and its children |
Reimplemented from OSnLNode.
virtual std::string OSnLNodeVariable::getTokenNumber |
( |
| ) |
|
|
virtual |
- Returns
- a string token that corresponds to the OSnLNode.
Reimplemented from ExprNode.
virtual std::string OSnLNodeVariable::getTokenName |
( |
| ) |
|
|
virtual |
- Returns
- a std::string token that corresponds to the OSnLNode.
Implements ExprNode.
virtual std::string OSnLNodeVariable::getNonlinearExpressionInXML |
( |
| ) |
|
|
virtual |
- Returns
- the OSiL XML for the variable node.
Reimplemented from ExprNode.
virtual double OSnLNodeVariable::calculateFunction |
( |
double * |
x | ) |
|
|
virtual |
Calculate the function value given the current variable values. This is an abstract method which is required to be implemented by the concrete operator nodes that derive or extend from this OSnLNode class.
- Parameters
-
x | holds the values of the variables in a double array. |
- Returns
- the function value given the current variable values.
Implements OSnLNode.
OSnLNode * OSnLNodeVariable::cloneExprNode |
( |
| ) |
|
|
virtual |
The implementation of the virtual functions.
- Returns
- a pointer to a new OSnLNode of the proper type.
Implements ExprNode.
double OSnLNodeVariable::constructADTape |
( |
std::map< int, int > * |
ADIdx, |
|
|
ADvector * |
XAD |
|
) |
| |
|
virtual |
The implementation of the virtual functions.
- Returns
- a ADdouble.
Implements OSnLNode.
double OSnLNodeVariable::coef |
coef is an option coefficient on the variable, the default value is 1.0
Definition at line 1501 of file OSnLNode.h.
int OSnLNodeVariable::idx |
idx is the index of the variable
Definition at line 1504 of file OSnLNode.h.
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/OS-2.9.3/src/OSCommonInterfaces/OSnLNode.h