OSnLNodeVariable Class Reference

The OSnLNodeVariable Class. More...

#include <OSnLNode.h>

Inheritance diagram for OSnLNodeVariable:

OSnLNode

List of all members.

Public Member Functions

 OSnLNodeVariable ()
 default constructor.
 ~OSnLNodeVariable ()
 default destructor.
virtual void getVariableIndexMap (std::map< int, int > *varIdx)
virtual std::string getTokenNumber ()
 
Returns:
a string token that corresponds to the OSnLNode.

virtual std::string getTokenName ()
 
Returns:
a std::string token that corresponds to the OSnLNode.

virtual std::string getNonlinearExpressionInXML ()
 
Returns:
the OSiL XML for the variable node.

virtual double calculateFunction (double *x)
virtual OSnLNode * cloneOSnLNode ()
virtual AD< double > constructCppADTape (std::map< int, int > *cppADIdx, CppAD::vector< AD< double > > *XAD)
 The implementation of the virtual functions.

Public Attributes

double coef
 coef is an option coefficient on the variable, the default value is 1.o
int idx
 idx is the index of the variable

Detailed Description

The OSnLNodeVariable Class.

Author:
Robert Fourer, Jun Ma, Kipp Martin,
Version:
1.0, 10/05/2005
Since:
OS1.0
Remarks:
The in-memory representation of the OSnL element <variable>

Definition at line 1282 of file OSnLNode.h.

Constructor & Destructor Documentation

OSnLNodeVariable::OSnLNodeVariable (  ) 

default constructor.

Definition at line 1624 of file OSnLNode.cpp.

References coef, idx, OSnLNode::inodeInt, OSnLNode::inodeType, OSnLNode::inumberOfChildren, OSnLNode::m_mChildren, and OSnLNode::snodeName.

Referenced by cloneOSnLNode().

OSnLNodeVariable::~OSnLNodeVariable (  ) 

default destructor.

Definition at line 1635 of file OSnLNode.cpp.

References OSnLNode::inumberOfChildren, and OSnLNode::m_mChildren.

Member Function Documentation

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.

Definition at line 1728 of file OSnLNode.cpp.

References idx.

std::string OSnLNodeVariable::getTokenNumber (  )  [virtual]

Returns:
a string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

Definition at line 1651 of file OSnLNode.cpp.

References coef, idx, OSnLNode::inodeInt, and OSnLNode::inumberOfChildren.

std::string OSnLNodeVariable::getTokenName (  )  [virtual]

Returns:
a std::string token that corresponds to the OSnLNode.

Reimplemented from OSnLNode.

Definition at line 1667 of file OSnLNode.cpp.

References coef, idx, OSnLNode::inumberOfChildren, and OSnLNode::snodeName.

std::string OSnLNodeVariable::getNonlinearExpressionInXML (  )  [virtual]

Returns:
the OSiL XML for the variable node.

Reimplemented from OSnLNode.

Definition at line 1683 of file OSnLNode.cpp.

References coef, OSnLNode::getNonlinearExpressionInXML(), idx, OSnLNode::inumberOfChildren, OSnLNode::m_mChildren, and OSnLNode::snodeName.

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.

Definition at line 1712 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.

Parameters:
x holds the values of the variables in a double array.
Returns:
the function value given the current variable values.

Implements OSnLNode.

Definition at line 1743 of file OSnLNode.cpp.

References OSnLNodeVariable().

double OSnLNodeVariable::constructCppADTape ( std::map< int, int > *  cppADIdx,
CppAD::vector< AD< double > > *  XAD 
) [virtual]

The implementation of the virtual functions.

Returns:
a AD<double>.

Implements OSnLNode.

Definition at line 1717 of file OSnLNode.cpp.

References coef, idx, and OSnLNode::m_CppADTape.

Member Data Documentation

double OSnLNodeVariable::coef

coef is an option coefficient on the variable, the default value is 1.o

Definition at line 1288 of file OSnLNode.h.

Referenced by OSInstance::addQTermsToExressionTree(), calculateFunction(), constructCppADTape(), OSInstance::getLagrangianExpTree(), getNonlinearExpressionInXML(), OSInstance::getSparseJacobianFromColumnMajor(), OSInstance::getSparseJacobianFromRowMajor(), getTokenName(), getTokenNumber(), OSnLNodeVariable(), LindoSolver::processNonlinearExpressions(), OSInstance::setQuadraticTermsInNonlinearExpressions(), and OSnl2osil::walkTree().

int OSnLNodeVariable::idx

idx is the index of the variable

Definition at line 1291 of file OSnLNode.h.

Referenced by OSInstance::addQTermsToExressionTree(), calculateFunction(), constructCppADTape(), OSInstance::getLagrangianExpTree(), getNonlinearExpressionInXML(), OSInstance::getSparseJacobianFromColumnMajor(), OSInstance::getSparseJacobianFromRowMajor(), getTokenName(), getTokenNumber(), getVariableIndexMap(), main(), OSnLNodeVariable(), LindoSolver::processNonlinearExpressions(), OSInstance::setQuadraticTermsInNonlinearExpressions(), and OSnl2osil::walkTree().

The documentation for this class was generated from the following files:
Generated on Sat Mar 29 22:38:06 2008 by  doxygen 1.5.3