#include <OSnLNode.h>
Inheritance diagram for OSnLNodeVariable:
Public Member Functions | |
OSnLNodeVariable () | |
default constructor. | |
~OSnLNodeVariable () | |
default destructor. | |
virtual void | getVariableIndexMap (std::map< int, int > *varIdx) |
virtual std::string | getTokenNumber () |
virtual std::string | getTokenName () |
virtual std::string | getNonlinearExpressionInXML () |
virtual double | calculateFunction (double *x) |
virtual OSnLNode * | cloneOSnLNode () |
virtual ADdouble | constructADTape (std::map< int, int > *ADIdx, ADvector *XAD) |
Public Attributes | |
double | coef |
coef is an option coefficient on the variable, the default value is 1.0 | |
int | idx |
idx is the index of the variable |
Definition at line 1415 of file OSnLNode.h.
OSnLNodeVariable::OSnLNodeVariable | ( | ) |
default constructor.
Definition at line 1957 of file OSnLNode.cpp.
References coef, idx, OSnLNode::inodeInt, OSnLNode::inodeType, OSnLNode::inumberOfChildren, and OSnLNode::m_mChildren.
Referenced by cloneOSnLNode().
OSnLNodeVariable::~OSnLNodeVariable | ( | ) |
default destructor.
Definition at line 1967 of file OSnLNode.cpp.
References OSnLNode::inumberOfChildren, and OSnLNode::m_mChildren.
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
a | pointer to a map of the variables in the OSnLNode and its children |
Reimplemented from OSnLNode.
Definition at line 2073 of file OSnLNode.cpp.
References idx.
std::string OSnLNodeVariable::getTokenNumber | ( | ) | [virtual] |
Reimplemented from OSnLNode.
Definition at line 1986 of file OSnLNode.cpp.
References coef, idx, OSnLNode::inodeInt, and OSnLNode::inumberOfChildren.
std::string OSnLNodeVariable::getTokenName | ( | ) | [virtual] |
Implements OSnLNode.
Definition at line 2003 of file OSnLNode.cpp.
References coef, idx, and OSnLNode::inumberOfChildren.
std::string OSnLNodeVariable::getNonlinearExpressionInXML | ( | ) | [virtual] |
Reimplemented from OSnLNode.
Definition at line 2020 of file OSnLNode.cpp.
References coef, idx, OSnLNode::inumberOfChildren, OSnLNode::m_mChildren, and os_dtoa_format().
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.
x | holds the values of the variables in a double array. |
Implements OSnLNode.
Definition at line 2055 of file OSnLNode.cpp.
References coef, idx, and OSnLNode::m_dFunctionValue.
OSnLNode * OSnLNodeVariable::cloneOSnLNode | ( | ) | [virtual] |
Create or clone a node of this type. This is an abstract method which is required to be implemented by the concrete operator nodes that derive or extend from this OSnLNode class.
x | holds the values of the variables in a double array. |
Implements OSnLNode.
Definition at line 2091 of file OSnLNode.cpp.
References OSnLNodeVariable().
ADdouble OSnLNodeVariable::constructADTape | ( | std::map< int, int > * | ADIdx, | |
ADvector * | XAD | |||
) | [virtual] |
Create the AD tape to be evaluated by AD. This is an abstract method which is required to be implemented by the concrete operator nodes that derive or extend from this OSnLNode class.
Implements OSnLNode.
Definition at line 2061 of file OSnLNode.cpp.
References coef, idx, and OSnLNode::m_ADTape.
double OSnLNodeVariable::coef |
coef is an option coefficient on the variable, the default value is 1.0
Definition at line 1422 of file OSnLNode.h.
Referenced by OSInstance::addQTermsToExressionTree(), calculateFunction(), constructADTape(), CouenneSolver::createCouenneExpression(), OSInstance::getLagrangianExpTree(), getNonlinearExpressionInXML(), OSInstance::getNonlinearExpressionTreeInInfix(), OSInstance::getSparseJacobianFromColumnMajor(), OSInstance::getSparseJacobianFromRowMajor(), getTokenName(), getTokenNumber(), OSnLNodeVariable(), OSgams2osil::parseGamsInstructions(), LindoSolver::processNonlinearExpressions(), OSInstance::setQuadraticTermsInNonlinearExpressions(), and OSnl2osil::walkTree().
idx is the index of the variable
Definition at line 1425 of file OSnLNode.h.
Referenced by OSInstance::addQTermsToExressionTree(), calculateFunction(), constructADTape(), CouenneSolver::createCouenneExpression(), OSInstance::getLagrangianExpTree(), getNonlinearExpressionInXML(), OSInstance::getNonlinearExpressionTreeInInfix(), OSInstance::getSparseJacobianFromColumnMajor(), OSInstance::getSparseJacobianFromRowMajor(), getTokenName(), getTokenNumber(), getVariableIndexMap(), main(), OSnLNodeVariable(), OSgams2osil::parseGamsInstructions(), LindoSolver::processNonlinearExpressions(), OSInstance::setQuadraticTermsInNonlinearExpressions(), and OSnl2osil::walkTree().