MathDAG::LockDAG Struct Reference

#include <equations.h>

Inheritance diagram for MathDAG::LockDAG:

Collaboration diagram for MathDAG::LockDAG:

Public Member Functions
	LockDAG (const Lock &lock)
int	BODMASlevel () const override
	algebraic heirarchy level, used for working out whether brackets are necessary. More...
ostream &	latex (ostream &o) const override
	writes LaTeX representation of this DAG to the stream More...
ostream &	matlab (ostream &o) const override
	writes a matlab representation of this DAG to the stream More...
void	render (ecolab::cairo::Surface &surf) const override
	renders a visual representation of this node to surf graphic extends right from the current pen position (which needs to be defined), and pen is moved to the right edge of the graphic. The determine bounding box, render into a recording surface, and use width()/height() More...
VariableValuePtr	addEvalOps (EvalOpVector &, const VariableValuePtr &result={}) override
	adds EvalOps to an EvalOpVector representing this node. More...
int	order (unsigned maxOrder) const override
	returns evaluation order in sequence of variable defintions More...
bool	tensorEval (std::set< const Node *> &) const override
	returns true if the evaluation of this involves tensor processing More...
std::shared_ptr< Node >	derivative (SystemOfEquations &) const override
	support for the derivative operator. More...
Public Member Functions inherited from MathDAG::Node
virtual	~Node ()
std::string	latexStr () const
std::string	matlabStr () const
bool	tensorEval ()
	returns true if the evaluation of this involves tensor processing More...
LaTeXManip	latex () const
	used within io streaming More...
MatlabManip	matlab () const

Public Attributes
const Lock &	lock
WeakNodePtr	rhs
Public Attributes inherited from MathDAG::Node
int	cachedOrder =-1
VariableValuePtr	result
	reference to where this node's value is stored More...

Detailed Description

Definition at line 276 of file equations.h.

Constructor & Destructor Documentation

LockDAG()

MathDAG::LockDAG::LockDAG ( const Lock &  lock )

inline

Definition at line 280 of file equations.h.

: lock(lock) {}

Member Function Documentation

addEvalOps()

VariableValuePtr MathDAG::LockDAG::addEvalOps ( EvalOpVector &  , const VariableValuePtr &  result = {}  )

overridevirtual

adds EvalOps to an EvalOpVector representing this node.

Returns

a variable where the result is stored. If a flowVariable has been provided in result, that may be used directly, otherwise a copy operation is added to ensure it receives the result.

Implements MathDAG::Node.

Definition at line 795 of file equations.cc.

References MathDAG::Node::addEvalOps(), civita::createRavelChain(), lock, minsky::Lock::locked(), minsky::Lock::lockedState, MathDAG::Node::result, rhs, minsky::VariableType::tempFlow, minsky::Item::throw_error(), and minsky::VariableType::undefined.

  {
    assert(result);
    if (result->type()==VariableType::undefined)
      {
        if (r && r->isFlowVar())
          result=r;
        else
          {
            result=VariableValuePtr(VariableType::tempFlow);
            result->allocValue();
          }
      }

    if (!rhs) return result;
    if (lock.locked())
      try
        {
          auto chain=createRavelChain(lock.lockedState, rhs->addEvalOps(ev,{}));
          if (chain.empty()) return {};
          result->index(chain.back()->index());
          result->hypercube(chain.back()->hypercube());
          ev.emplace_back(EvalOpPtr(new TensorEval(result, make_shared<EvalCommon>(), chain.back())));
          return result;
        }
      catch (const std::exception& ex)
        {
          lock.throw_error(ex.what());
        }
    return rhs->addEvalOps(ev,result);
  }

Here is the call graph for this function:

BODMASlevel()

int MathDAG::LockDAG::BODMASlevel ( ) const

inlineoverridevirtual

algebraic heirarchy level, used for working out whether brackets are necessary.

Implements MathDAG::Node.

Definition at line 281 of file equations.h.

{return 0;} 

derivative()

std::shared_ptr<Node> MathDAG::LockDAG::derivative ( SystemOfEquations &  ) const

inlineoverridevirtual

support for the derivative operator.

Implements MathDAG::Node.

Definition at line 288 of file equations.h.

References minsky::Item::throw_error().

    {lock.throw_error("derivative not defined for locked objects");}

Here is the call graph for this function:

latex()

ostream& MathDAG::LockDAG::latex ( ostream &  ) const

inlineoverridevirtual

writes LaTeX representation of this DAG to the stream

Implements MathDAG::Node.

Definition at line 282 of file equations.h.

{return o<<"locked";} 

matlab()

ostream& MathDAG::LockDAG::matlab ( ostream &  ) const

inlineoverridevirtual

writes a matlab representation of this DAG to the stream

Implements MathDAG::Node.

Definition at line 283 of file equations.h.

{return o<<"";} 

order()

int MathDAG::LockDAG::order ( unsigned  maxOrder ) const

inlineoverridevirtual

returns evaluation order in sequence of variable defintions

Parameters

maxOrder

is used to limit the recursion depth

Implements MathDAG::Node.

Definition at line 286 of file equations.h.

References MathDAG::Node::order().

{return rhs? rhs->order(maxOrder-1)+1:0;}

Here is the call graph for this function:

render()

void MathDAG::LockDAG::render ( ecolab::cairo::Surface &  surf ) const

overridevirtual

renders a visual representation of this node to surf graphic extends right from the current pen position (which needs to be defined), and pen is moved to the right edge of the graphic. The determine bounding box, render into a recording surface, and use width()/height()

Implements MathDAG::Node.

Definition at line 224 of file equationDisplayRender.cc.

References MathDAG::anonymous_namespace{equationDisplayRender.cc}::print().

  {
    print(surf.cairo(), "locked", Anchor::nw);
  }

Here is the call graph for this function:

tensorEval()

bool MathDAG::LockDAG::tensorEval ( std::set< const Node *> &  visited ) const

inlineoverridevirtual

returns true if the evaluation of this involves tensor processing

Parameters

visited

set to break graph cycles

Implements MathDAG::Node.

Definition at line 287 of file equations.h.

{return true;}

Member Data Documentation

lock

const Lock& MathDAG::LockDAG::lock

Definition at line 278 of file equations.h.

Referenced by addEvalOps().

rhs

WeakNodePtr MathDAG::LockDAG::rhs

Definition at line 279 of file equations.h.

Referenced by addEvalOps().

---

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

• engine/equations.h
• engine/equationDisplayRender.cc
• engine/equations.cc