#include <CEvaluationNodeOperator.h>

Inheritance diagram for CEvaluationNodeOperator:

Public Member Functions
virtual void	calculate () override

	CEvaluationNodeOperator (const CEvaluationNodeOperator &src)

	CEvaluationNodeOperator (const SubType &subType, const Data &data)

virtual CIssue	compile () override

bool	createModuloTree (const CEvaluationNodeOperator pNode, ASTNode pASTNode, const CDataModel *pDataModel) const

virtual std::string	getBerkeleyMadonnaString (const std::vector< std::string > &children) const override

virtual std::string	getCCodeString (const std::vector< std::string > &children) const override

virtual std::string	getDisplayString (const std::vector< std::string > &children) const override

virtual std::string	getInfix (const std::vector< std::string > &children) const override

CEvaluationNode *	getLeft ()

const CEvaluationNode *	getLeft () const

virtual std::string	getMMLString (const std::vector< std::string > &children, bool expand, const std::vector< std::vector< std::string > > &variables) const override

CEvaluationNode *	getRight ()

const CEvaluationNode *	getRight () const

virtual CValidatedUnit	getUnit (const CMathContainer &container, const std::vector< CValidatedUnit > &units) const override

virtual std::string	getXPPString (const std::vector< std::string > &children) const override

virtual CValidatedUnit	setUnit (const CMathContainer &container, const std::map< CEvaluationNode , CValidatedUnit > &currentUnits, std::map< CEvaluationNode , CValidatedUnit > &targetUnits) const override

virtual CEvaluationNode *	simplifyNode (const std::vector< CEvaluationNode * > &children) const override

virtual ASTNode *	toAST (const CDataModel *pDataModel) const override

virtual	~CEvaluationNodeOperator ()

Public Member Functions inherited from CEvaluationNode
void	addChildren (const std::vector< CEvaluationNode * > &children)

std::string	buildBerkeleyMadonnaString () const

std::string	buildCCodeString () const

std::string	buildDisplayString () const

std::string	buildInfix () const

std::string	buildMMLString (bool expand, const std::vector< std::vector< std::string > > &variables) const

std::string	buildXPPString () const

	CEvaluationNode ()

	CEvaluationNode (const CEvaluationNode &src)

CEvaluationNode *	copyBranch () const

CEvaluationNode *	copyNode (CEvaluationNode child1, CEvaluationNode child2) const

CEvaluationNode *	copyNode (const std::vector< CEvaluationNode * > &children) const

const CEvaluationNode *	findTopMinus (const std::vector< CFunctionAnalyzer::CValue > &callParameters) const

const CEvaluationTree *	getTree () const

const C_FLOAT64 *	getValuePointer () const

const ValueType &	getValueType () const

virtual bool	isBoolean () const

const MainType &	mainType () const

bool	operator!= (const CEvaluationNode &right) const

bool	operator< (const CEvaluationNode &rhs)

bool	operator< (const CEvaluationNode &right) const

bool	operator== (const CEvaluationNode &right) const

void	printRecursively () const

void	printRecursively (std::ostream &os, int indent=0) const

void	setTree (const CEvaluationTree *pTree)

virtual CIssue	setValueType (const ValueType &valueType)

CEvaluationNode *	splitBranch (const CEvaluationNode *splitnode, bool left) const

const SubType &	subType () const

virtual	~CEvaluationNode ()

Public Member Functions inherited from CCopasiNode< std::string >
virtual bool	addChild (CCopasiNode< Data > pChild, CCopasiNode< Data > pAfter=NULL)

bool	addSibling (CCopasiNode< Data > pSibling, CCopasiNode< Data > pAfter=NULL)

	CCopasiNode (CCopasiNode< Data > *pParent=NULL)

	CCopasiNode (const CCopasiNode< Data > &src)

	CCopasiNode (const Data &data, CCopasiNode< Data > *pParent=NULL)

bool	deleteChildren ()

CCopasiNode< Data > *	getChild ()

const CCopasiNode< Data > *	getChild () const

CCopasiNode< Data > *	getChild (const size_t &index)

const CCopasiNode< Data > *	getChild (const size_t &index) const

virtual Data &	getData ()

virtual const Data &	getData () const

CCopasiNode< Data > *	getNext ()

const CCopasiNode< Data > *	getNext () const

CCopasiNode< Data > *	getNextNonChild ()

const CCopasiNode< Data > *	getNextNonChild () const

size_t	getNumChildren () const

CCopasiNode< Data > *	getParent ()

const CCopasiNode< Data > *	getParent () const

CCopasiNode< Data > *	getSibling ()

const CCopasiNode< Data > *	getSibling () const

virtual bool	removeChild (CCopasiNode< Data > *pChild)

virtual bool	setData (const Data &data)

virtual	~CCopasiNode ()

Static Public Member Functions
static CEvaluationNode *	fromAST (const ASTNode pASTNode, const std::vector< CEvaluationNode > &children)

Static Public Member Functions inherited from CEvaluationNode
static CEvaluationNode *	create (const MainType &mainType, const SubType &subType, const std::string &data)

static bool	isKeyword (const std::string &str)

Private Types
typedef void(CEvaluationNodeOperator::*	OPERATOR) ()

Private Member Functions
	CEvaluationNodeOperator ()

void	s_divide ()

void	s_invalid ()

void	s_minus ()

void	s_modulus ()

void	s_multiply ()

void	s_plus ()

void	s_power ()

void	s_remainder ()

Private Attributes
CEvaluationNode *	mpLeftNode

const C_FLOAT64 *	mpLeftValue

OPERATOR	mpOperator

CEvaluationNode *	mpRightNode

const C_FLOAT64 *	mpRightValue

Additional Inherited Members
Public Types inherited from CEvaluationNode
enum class	MainType { INVALID , NUMBER , CONSTANT , OPERATOR , OBJECT , FUNCTION , CALL , STRUCTURE , CHOICE , VARIABLE , WHITESPACE , LOGICAL , MV_FUNCTION , VECTOR , DELAY , UNIT , __SIZE }

enum class	SubType { DEFAULT , DELAY , IF , VECTOR , CN , DOUBLE , FUNCTION , LOG , OPEN , PI , POWER , EXPRESSION , POINTER , EXPONENTIALE , INTEGER , LOG10 , MULTIPLY , OR , VECTOROPEN , COMMA , DIVIDE , ENOTATION , EXP , True , XOR , RATIONALE , AND , CLOSE , False , MODULUS , SIN , VECTORCLOSE , COS , EQ , Infinity , PLUS , NaN , MINUS , NE , TAN , REMAINDER , GT , SEC , CSC , GE , COT , LT , LE , SINH , COSH , TANH , SECH , CSCH , COTH , ARCSIN , ARCCOS , ARCTAN , ARCSEC , ARCCSC , ARCCOT , ARCSINH , ARCCOSH , ARCTANH , ARCSECH , ARCCSCH , ARCCOTH , SQRT , ABS , FLOOR , CEIL , FACTORIAL , NOT , RUNIFORM , RNORMAL , MAX , MIN , RGAMMA , RPOISSON , SIGN , AVOGADRO , INVALID , __SIZE }

enum class	ValueType { Unknown , Boolean , Number , __SIZE }

Public Types inherited from CCopasiNode< std::string >
typedef std::string	Data

Static Public Attributes inherited from CEvaluationNode
static const CEnumAnnotation< std::string, MainType >	MainTypeName

static const CEnumAnnotation< std::string, SubType >	SubTypeName

Protected Member Functions inherited from CEvaluationNode
	CEvaluationNode (const MainType &type, const SubType &subType, const Data &data)

Protected Member Functions inherited from CCopasiNode< std::string >
bool	setChild (CCopasiNode< Data > *pChild)

bool	setParent (CCopasiNode< Data > *pParent)

bool	setSibling (CCopasiNode< Data > *pSibling)

Protected Attributes inherited from CEvaluationNode
MainType	mMainType

class CEvaluationNode::CPrecedence	mPrecedence

const CEvaluationTree *	mpTree

const C_FLOAT64 *	mpValue

SubType	mSubType

C_FLOAT64	mValue

ValueType	mValueType

Protected Attributes inherited from CCopasiNode< std::string >
Data	mData

Detailed Description

This is the class for nodes presenting operators used in an evaluation trees.

Member Typedef Documentation

◆ OPERATOR

typedef void(CEvaluationNodeOperator::* CEvaluationNodeOperator::OPERATOR) ()

private

Constructor & Destructor Documentation

◆ CEvaluationNodeOperator() [1/3]

CEvaluationNodeOperator::CEvaluationNodeOperator ( )

private

Default constructor

Referenced by fromAST().

◆ CEvaluationNodeOperator() [2/3]

CEvaluationNodeOperator::CEvaluationNodeOperator	(	const SubType &	subType,
		const Data &	data
	)

Default constructor

Parameters

const	SubType & subType
const	Data & data

References CEvaluationNode::DIVIDE, CEvaluationNode::MINUS, CEvaluationNode::MODULUS, mpOperator, CEvaluationNode::mPrecedence, CEvaluationNode::mSubType, CEvaluationNode::MULTIPLY, CEvaluationNode::mValueType, CEvaluationNode::Number, CEvaluationNode::PLUS, CEvaluationNode::POWER, PRECEDENCE_OPERATOR_DIVIDE, PRECEDENCE_OPERATOR_MINUS, PRECEDENCE_OPERATOR_MODULUS, PRECEDENCE_OPERATOR_MULTIPLY, PRECEDENCE_OPERATOR_PLUS, PRECEDENCE_OPERATOR_POWER, PRECEDENCE_OPERATOR_REMAINDER, CEvaluationNode::REMAINDER, s_divide(), s_minus(), s_modulus(), s_multiply(), s_plus(), s_power(), and s_remainder().

◆ CEvaluationNodeOperator() [3/3]

CEvaluationNodeOperator::CEvaluationNodeOperator ( const CEvaluationNodeOperator & src )

Copy constructor

Parameters

const CEvaluationNodeOperator & src

◆ ~CEvaluationNodeOperator()

CEvaluationNodeOperator::~CEvaluationNodeOperator ( )

virtual

Destructor

Member Function Documentation

◆ calculate()

void CEvaluationNodeOperator::calculate ( void )

overridevirtual

Calculate the numerical result of the node. It is assumed that all child nodes are up to date.

Reimplemented from CEvaluationNode.

References mpOperator.

◆ compile()

CIssue CEvaluationNodeOperator::compile ( )

overridevirtual

Compile a node;

Parameters

const CEvaluationTree * pTree

Returns: CIssue issue;

Reimplemented from CEvaluationNode.

References CIssue::Error, CCopasiNode< std::string >::getChild(), CCopasiNode< _Data >::getSibling(), CEvaluationNode::getValuePointer(), mpLeftNode, mpLeftValue, mpRightNode, mpRightValue, CEvaluationNode::Number, CEvaluationNode::setValueType(), CIssue::StructureInvalid, and CIssue::TooManyArguments.

Referenced by getBerkeleyMadonnaString(), getCCodeString(), getDisplayString(), getInfix(), and getXPPString().

◆ createModuloTree()

bool CEvaluationNodeOperator::createModuloTree	(	const CEvaluationNodeOperator *	pNode,
		ASTNode *	pASTNode,
		const CDataModel *	pDataModel
	)		const

Convert our modulo to something SBML understands

Parameters

const	CEvaluationNodeOperator* pNode the modulo operator node to be converted.
const	ASTNode* pASTNode the root node for the SBML math expression

Returns: bool which is true on sucessfull conversion.

References CCopasiNode< _Data >::getChild(), CCopasiNode< _Data >::getSibling(), CEvaluationNode::MODULUS, CEvaluationNode::subType(), and CEvaluationNode::toAST().

Referenced by toAST().

◆ fromAST()

CEvaluationNode * CEvaluationNodeOperator::fromAST	(	const ASTNode *	pASTNode,
		const std::vector< CEvaluationNode * > &	children
	)

static

Creates a new CEvaluationNodeCall from an ASTNode and the given children

Parameters

const	ASTNode* pNode
const	std::vector< CEvaluationNode * > & children

Returns: CEvaluationNode * pCretedNode

References CCopasiNode< _Data >::addChild(), CEvaluationNodeOperator(), CEvaluationNode::DIVIDE, CEvaluationNode::DOUBLE, CCopasiMessage::EXCEPTION, fatalError, CEvaluationNode::INVALID, MCMathML, CEvaluationNode::MINUS, CEvaluationNode::MULTIPLY, CEvaluationNode::PLUS, CEvaluationNode::POWER, and CEvaluationNode::subType().

Referenced by CEvaluationTree::fromAST().

◆ getBerkeleyMadonnaString()

std::string CEvaluationNodeOperator::getBerkeleyMadonnaString ( const std::vector< std::string > & children ) const

overridevirtual

Retrieve the display string of the node and its eventual child nodes in Berkeley Madonna format.

Returns: const Data & value

Reimplemented from CEvaluationNode.

References compile(), CCopasiNode< std::string >::mData, mpLeftNode, and mpRightNode.

◆ getCCodeString()

std::string CEvaluationNodeOperator::getCCodeString ( const std::vector< std::string > & children ) const

overridevirtual

Retrieve the display string of the node and its eventual child nodes in C.

Returns: const Data & value

Reimplemented from CEvaluationNode.

References compile(), CCopasiNode< std::string >::mData, CEvaluationNode::MODULUS, mpLeftNode, mpRightNode, CEvaluationNode::POWER, CEvaluationNode::REMAINDER, and CEvaluationNode::subType().

◆ getDisplayString()

std::string CEvaluationNodeOperator::getDisplayString ( const std::vector< std::string > & children ) const

overridevirtual

Retrieve the display string of the node and its eventual child nodes.

Returns: const Data & value

Reimplemented from CEvaluationNode.

References compile(), CCopasiNode< std::string >::mData, mpLeftNode, mpRightNode, CEvaluationNode::mSubType, and CEvaluationNode::REMAINDER.

◆ getInfix()

std::string CEvaluationNodeOperator::getInfix ( const std::vector< std::string > & children ) const

overridevirtual

Retrieve the infix value of the node and its eventual child nodes.

Returns: const Data & value

Reimplemented from CEvaluationNode.

References compile(), CCopasiNode< std::string >::mData, mpLeftNode, mpRightNode, CEvaluationNode::mSubType, and CEvaluationNode::REMAINDER.

◆ getLeft() [1/2]

CEvaluationNode * CEvaluationNodeOperator::getLeft ( )

References mpLeftNode.

Referenced by CDerive::deriveBranch().

◆ getLeft() [2/2]

const CEvaluationNode * CEvaluationNodeOperator::getLeft ( ) const

References mpLeftNode.

◆ getMMLString()

std::string CEvaluationNodeOperator::getMMLString	(	const std::vector< std::string > &	children,
		bool	expand,
		const std::vector< std::vector< std::string > > &	variables
	)		const

overridevirtual

Build the MathML string

Parameters

const	std::vector< std::string > & children
bool	expand = true
const	std::vector< std::vector< std::string > > & variables

Returns: std::string MMLString

Reimplemented from CEvaluationNode.

References CEvaluationNode::CALL, CEvaluationNode::DIVIDE, CEvaluationNode::mainType(), CEvaluationNode::MINUS, CEvaluationNode::MODULUS, mpLeftNode, mpRightNode, CEvaluationNode::mSubType, CEvaluationNode::MULTIPLY, CEvaluationNode::OPERATOR, CEvaluationNode::PLUS, CEvaluationNode::POWER, CEvaluationNode::REMAINDER, and CEvaluationNode::subType().

◆ getRight() [1/2]

CEvaluationNode * CEvaluationNodeOperator::getRight ( )

References mpRightNode.

Referenced by CDerive::deriveBranch().

◆ getRight() [2/2]

const CEvaluationNode * CEvaluationNodeOperator::getRight ( ) const

References mpRightNode.

◆ getUnit()

CValidatedUnit CEvaluationNodeOperator::getUnit	(	const CMathContainer &	container,
		const std::vector< CValidatedUnit > &	units
	)		const

overridevirtual

Figure out the appropriate CUnit to use, based on the child nodes. This sets the default, appropriate for many cases, as Dimensionless

Parameters

const	CMathContainer & container
const	std::vector< CValidatedUnit > & units

Returns: CValidatedUnit unit

Reimplemented from CEvaluationNode.

References CMathContainer::areObjectsConstant(), C_FLOAT64, CBaseUnit::dimensionless, CEvaluationNode::DIVIDE, CNodeContextIterator< Node, Context >::end(), CUnit::getComponents(), CMathContainer::getMathObject(), CEvaluationNode::getValuePointer(), CMathObject::isInitialValue(), CValidatedUnit::merge(), CEvaluationNode::MINUS, CEvaluationNode::MODULUS, mpRightNode, CEvaluationNode::mSubType, CEvaluationNode::MULTIPLY, CNodeContextIterator< Node, Context >::next(), CEvaluationNode::OBJECT, CEvaluationNode::PLUS, CEvaluationNode::POWER, CValidatedUnit::setConflict(), and CBaseUnit::undefined.

◆ getXPPString()

std::string CEvaluationNodeOperator::getXPPString ( const std::vector< std::string > & children ) const

overridevirtual

Retrieve the display string of the node and its eventual child nodes in XPPAUT format.

Returns: const Data & value

Reimplemented from CEvaluationNode.

References compile(), CCopasiNode< std::string >::mData, CEvaluationNode::MODULUS, mpLeftNode, mpRightNode, CEvaluationNode::REMAINDER, and CEvaluationNode::subType().

◆ s_divide()

void CEvaluationNodeOperator::s_divide ( )

private

References mpLeftValue, mpRightValue, and CEvaluationNode::mValue.

Referenced by CEvaluationNodeOperator().

◆ s_invalid()

void CEvaluationNodeOperator::s_invalid ( )

private

References CEvaluationNode::mValue.

◆ s_minus()

void CEvaluationNodeOperator::s_minus ( )

private

References mpLeftValue, mpRightValue, and CEvaluationNode::mValue.

Referenced by CEvaluationNodeOperator().

◆ s_modulus()

void CEvaluationNodeOperator::s_modulus ( )

private

References C_FLOAT64, C_INT32, mpLeftValue, mpRightValue, and CEvaluationNode::mValue.

Referenced by CEvaluationNodeOperator().

◆ s_multiply()

void CEvaluationNodeOperator::s_multiply ( )

private

References mpLeftValue, mpRightValue, and CEvaluationNode::mValue.

Referenced by CEvaluationNodeOperator().

◆ s_plus()

void CEvaluationNodeOperator::s_plus ( )

private

References mpLeftValue, mpRightValue, and CEvaluationNode::mValue.

Referenced by CEvaluationNodeOperator().

◆ s_power()

void CEvaluationNodeOperator::s_power ( )

private

References mpLeftValue, mpRightValue, and CEvaluationNode::mValue.

Referenced by CEvaluationNodeOperator().

◆ s_remainder()

void CEvaluationNodeOperator::s_remainder ( )

private

References mpLeftValue, mpRightValue, and CEvaluationNode::mValue.

Referenced by CEvaluationNodeOperator().

◆ setUnit()

CValidatedUnit CEvaluationNodeOperator::setUnit	(	const CMathContainer &	container,
		const std::map< CEvaluationNode *, CValidatedUnit > &	currentUnits,
		std::map< CEvaluationNode *, CValidatedUnit > &	targetUnits
	)		const

overridevirtual

Set the unit for the node and return the resulting unit. The child node units are added to the map

Parameters

const	CMathContainer & container
const	std::map < CEvaluationNode * , CValidatedUnit > & currentUnits
std::map	< CEvaluationNode * , CValidatedUnit > & targetUnits

Returns: CValidatedUnit unit

Reimplemented from CEvaluationNode.

References C_FLOAT64, CValidatedUnit::conflict(), CBaseUnit::dimensionless, CEvaluationNode::DIVIDE, CValidatedUnit::exponentiate(), CCopasiNode< _Data >::getChild(), CUnit::getComponents(), CEvaluationNode::getValuePointer(), min, CEvaluationNode::MINUS, CEvaluationNode::MODULUS, mpLeftNode, mpRightNode, CEvaluationNode::mSubType, CEvaluationNode::MULTIPLY, CEvaluationNode::PLUS, CEvaluationNode::POWER, CValidatedUnit::setConflict(), and CEvaluationNode::setUnit().

◆ simplifyNode()

CEvaluationNode * CEvaluationNodeOperator::simplifyNode ( const std::vector< CEvaluationNode * > & children ) const

overridevirtual

Create a simplified node for an operatorNode with children from vector (if not exist, = NULL), and assign new children

Returns: CEvaluationNode* return a pointer to the simplified node;

Reimplemented from CEvaluationNode.

References CCopasiNode< _Data >::addChild(), CEvaluationNode::buildInfix(), CEvaluationNode::copyBranch(), CEvaluationNode::copyNode(), CEvaluationNode::create(), CEvaluationNode::DIVIDE, CEvaluationNode::DOUBLE, fatalError, CEvaluationNode::FUNCTION, CCopasiNode< _Data >::getChild(), CCopasiNode< _Data >::getData(), CCopasiNode< std::string >::getSibling(), CEvaluationNode::getValuePointer(), CEvaluationNode::mainType(), CEvaluationNode::MINUS, CEvaluationNode::mSubType, CEvaluationNode::MULTIPLY, CEvaluationNode::NUMBER, CEvaluationNode::OPERATOR, CEvaluationNode::PLUS, CEvaluationNode::POWER, CEvaluationNode::simplifyNode(), and CEvaluationNode::subType().

◆ toAST()

ASTNode * CEvaluationNodeOperator::toAST ( const CDataModel * pDataModel ) const

overridevirtual

Create a new ASTNode corresponding to this OperatorNode.

Returns: ASTNode* return a pointer to the newly created node;

Reimplemented from CEvaluationNode.

References CCopasiNode< _Data >::addChild(), createModuloTree(), CEvaluationNode::DIVIDE, CCopasiNode< std::string >::getChild(), CCopasiNode< _Data >::getSibling(), CEvaluationNode::INVALID, CEvaluationNode::MINUS, CEvaluationNode::MODULUS, CEvaluationNode::MULTIPLY, CEvaluationNode::PLUS, CEvaluationNode::POWER, CEvaluationNode::REMAINDER, CEvaluationNode::subType(), and CEvaluationNode::toAST().

Member Data Documentation

◆ mpLeftNode

CEvaluationNode* CEvaluationNodeOperator::mpLeftNode

private

Referenced by compile(), getBerkeleyMadonnaString(), getCCodeString(), getDisplayString(), getInfix(), getLeft(), getMMLString(), getXPPString(), and setUnit().

◆ mpLeftValue

const C_FLOAT64* CEvaluationNodeOperator::mpLeftValue

private

Referenced by compile(), s_divide(), s_minus(), s_modulus(), s_multiply(), s_plus(), s_power(), and s_remainder().

◆ mpOperator

OPERATOR CEvaluationNodeOperator::mpOperator

private

Referenced by calculate(), and CEvaluationNodeOperator().

◆ mpRightNode

CEvaluationNode* CEvaluationNodeOperator::mpRightNode

private

Referenced by compile(), getBerkeleyMadonnaString(), getCCodeString(), getDisplayString(), getInfix(), getMMLString(), getRight(), getUnit(), getXPPString(), and setUnit().

◆ mpRightValue

const C_FLOAT64* CEvaluationNodeOperator::mpRightValue

private

Referenced by compile(), s_divide(), s_minus(), s_modulus(), s_multiply(), s_plus(), s_power(), and s_remainder().

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

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ OPERATOR

Constructor & Destructor Documentation

◆ CEvaluationNodeOperator() [1/3]

◆ CEvaluationNodeOperator() [2/3]

◆ CEvaluationNodeOperator() [3/3]

◆ ~CEvaluationNodeOperator()

Member Function Documentation

◆ calculate()

◆ compile()

◆ createModuloTree()

◆ fromAST()

◆ getBerkeleyMadonnaString()

◆ getCCodeString()

◆ getDisplayString()

◆ getInfix()

◆ getLeft() [1/2]

◆ getLeft() [2/2]

◆ getMMLString()

◆ getRight() [1/2]

◆ getRight() [2/2]

◆ getUnit()

◆ getXPPString()

◆ s_divide()

◆ s_invalid()

◆ s_minus()

◆ s_modulus()

◆ s_multiply()

◆ s_plus()

◆ s_power()

◆ s_remainder()

◆ setUnit()

◆ simplifyNode()

◆ toAST()

Member Data Documentation

◆ mpLeftNode

◆ mpLeftValue

◆ mpOperator

◆ mpRightNode

◆ mpRightValue