CppADCodeGen 2.4.3
A C++ Algorithmic Differentiation Package with Source Code Generation
Loading...
Searching...
No Matches
CppAD::cg::Enode< Base > Class Template Reference

#include <bipartite_nodes.hpp>

Inheritance diagram for CppAD::cg::Enode< Base >:
Inheritance graph
Collaboration diagram for CppAD::cg::Enode< Base >:
Collaboration graph

Public Member Functions

 Enode (size_t index, const std::string &name="")
 
 Enode (size_t index, Enode< Base > *differentiationOf)
 
const std::vector< Vnode< Base > * > & variables () const
 
const std::vector< Vnode< Base > * > & originalVariables () const
 
void addVariable (Vnode< Base > *j)
 
Vnode< Base > * assignmentVariable () const
 
void setAssigmentVariable (Vnode< Base > &j)
 
Enode< Base > * derivative () const
 
Enode< Base > * derivativeOf () const
 
Enode< Base > * originalEquation ()
 
void deleteNode (Vnode< Base > *j)
 
void setDerivative (Enode< Base > *difEq)
 
virtual const std::string & name () const
 
virtual std::string nodeType ()
 
void color (std::ostream &out=std::cout, Verbosity verbosity=Verbosity::None)
 
void uncolor ()
 
bool isColored () const
 
size_t index () const
 
void setIndex (size_t index)
 

Protected Attributes

std::vector< Vnode< Base > * > vnodes_orig_
 
std::vector< Vnode< Base > * > vnodes_
 
Enode< Base > * differentiation_
 
Enode< Base > * differentiationOf_
 
Vnode< Base > * assign_
 
std::string name_
 
size_t index_
 
bool colored_
 

Static Protected Attributes

static const std::string TYPE = "Equation"
 

Detailed Description

template<class Base>
class CppAD::cg::Enode< Base >

Equation nodes

Definition at line 81 of file bipartite_nodes.hpp.

Constructor & Destructor Documentation

◆ Enode() [1/2]

template<class Base >
CppAD::cg::Enode< Base >::Enode ( size_t  index,
const std::string &  name = "" 
)
inline

Definition at line 113 of file bipartite_nodes.hpp.

◆ Enode() [2/2]

template<class Base >
CppAD::cg::Enode< Base >::Enode ( size_t  index,
Enode< Base > *  differentiationOf 
)
inline

Definition at line 122 of file bipartite_nodes.hpp.

◆ ~Enode()

template<class Base >
virtual CppAD::cg::Enode< Base >::~Enode ( )
inlinevirtual

Definition at line 132 of file bipartite_nodes.hpp.

Member Function Documentation

◆ addVariable()

template<class Base >
void CppAD::cg::Enode< Base >::addVariable ( Vnode< Base > *  j)
inline

Definition at line 143 of file bipartite_nodes.hpp.

◆ assignmentVariable()

template<class Base >
Vnode< Base > * CppAD::cg::Enode< Base >::assignmentVariable ( ) const
inline

Definition at line 153 of file bipartite_nodes.hpp.

◆ color()

template<class Base >
void CppAD::cg::BiPGraphNode< Base >::color ( std::ostream &  out = std::cout,
Verbosity  verbosity = Verbosity::None 
)
inlineinherited

Definition at line 42 of file bipartite_nodes.hpp.

◆ deleteNode()

template<class Base >
void CppAD::cg::Enode< Base >::deleteNode ( Vnode< Base > *  j)
inline

Definition at line 181 of file bipartite_nodes.hpp.

◆ derivative()

template<class Base >
Enode< Base > * CppAD::cg::Enode< Base >::derivative ( ) const
inline

◆ derivativeOf()

template<class Base >
Enode< Base > * CppAD::cg::Enode< Base >::derivativeOf ( ) const
inline

Definition at line 169 of file bipartite_nodes.hpp.

◆ index()

template<class Base >
size_t CppAD::cg::BiPGraphNode< Base >::index ( ) const
inlineinherited

Definition at line 58 of file bipartite_nodes.hpp.

◆ isColored()

template<class Base >
bool CppAD::cg::BiPGraphNode< Base >::isColored ( ) const
inlineinherited

Definition at line 54 of file bipartite_nodes.hpp.

◆ name()

template<class Base >
virtual const std::string & CppAD::cg::Enode< Base >::name ( ) const
inlinevirtual

Implements CppAD::cg::BiPGraphNode< Base >.

Definition at line 191 of file bipartite_nodes.hpp.

◆ nodeType()

template<class Base >
virtual std::string CppAD::cg::Enode< Base >::nodeType ( )
inlinevirtual

Implements CppAD::cg::BiPGraphNode< Base >.

Definition at line 195 of file bipartite_nodes.hpp.

◆ originalEquation()

template<class Base >
Enode< Base > * CppAD::cg::Enode< Base >::originalEquation ( )
inline

Definition at line 173 of file bipartite_nodes.hpp.

◆ originalVariables()

template<class Base >
const std::vector< Vnode< Base > * > & CppAD::cg::Enode< Base >::originalVariables ( ) const
inline

Definition at line 139 of file bipartite_nodes.hpp.

◆ setAssigmentVariable()

template<class Base >
void CppAD::cg::Enode< Base >::setAssigmentVariable ( Vnode< Base > &  j)
inline

Definition at line 157 of file bipartite_nodes.hpp.

◆ setDerivative()

template<class Base >
void CppAD::cg::Enode< Base >::setDerivative ( Enode< Base > *  difEq)
inline

Definition at line 187 of file bipartite_nodes.hpp.

◆ setIndex()

template<class Base >
void CppAD::cg::BiPGraphNode< Base >::setIndex ( size_t  index)
inlineinherited

Definition at line 62 of file bipartite_nodes.hpp.

◆ uncolor()

template<class Base >
void CppAD::cg::BiPGraphNode< Base >::uncolor ( )
inlineinherited

Definition at line 50 of file bipartite_nodes.hpp.

◆ variables()

template<class Base >
const std::vector< Vnode< Base > * > & CppAD::cg::Enode< Base >::variables ( ) const
inline

Definition at line 135 of file bipartite_nodes.hpp.

Member Data Documentation

◆ assign_

template<class Base >
Vnode<Base>* CppAD::cg::Enode< Base >::assign_
protected

Definition at line 106 of file bipartite_nodes.hpp.

◆ colored_

template<class Base >
bool CppAD::cg::BiPGraphNode< Base >::colored_
protectedinherited

Definition at line 34 of file bipartite_nodes.hpp.

◆ differentiation_

template<class Base >
Enode<Base>* CppAD::cg::Enode< Base >::differentiation_
protected

the differentiated equation used to produce this one (B in Pantelides algorithm)

Definition at line 98 of file bipartite_nodes.hpp.

Referenced by CppAD::cg::Enode< Base >::derivative().

◆ differentiationOf_

template<class Base >
Enode<Base>* CppAD::cg::Enode< Base >::differentiationOf_
protected

Original equation which was differentiated

Definition at line 102 of file bipartite_nodes.hpp.

◆ index_

template<class Base >
size_t CppAD::cg::BiPGraphNode< Base >::index_
protectedinherited

Definition at line 33 of file bipartite_nodes.hpp.

◆ name_

template<class Base >
std::string CppAD::cg::Enode< Base >::name_
protected

A name for the equation

Definition at line 110 of file bipartite_nodes.hpp.

◆ TYPE

template<class Base >
const std::string CppAD::cg::Enode< Base >::TYPE = "Equation"
staticprotected

Definition at line 83 of file bipartite_nodes.hpp.

◆ vnodes_

template<class Base >
std::vector<Vnode<Base>*> CppAD::cg::Enode< Base >::vnodes_
protected

Variables present in this equation which where not deleted. A vector is used instead of a set to ensure reproducibility.

Definition at line 93 of file bipartite_nodes.hpp.

◆ vnodes_orig_

template<class Base >
std::vector<Vnode<Base>*> CppAD::cg::Enode< Base >::vnodes_orig_
protected

Original variables present in this equation. A vector is used instead of a set to ensure reproducibility.

Definition at line 88 of file bipartite_nodes.hpp.


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