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

#include <bipartite_nodes.hpp>

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

Public Member Functions

 Vnode (size_t index, int tapeIndex, const std::string &name)
 
 Vnode (size_t index, size_t tapeIndex, Vnode< Base > *derivativeOf, const std::string &name="")
 
virtual const std::string & name () const
 
size_t tapeIndex () const
 
void setTapeIndex (size_t tapeIndex)
 
std::vector< Enode< Base > * > & equations ()
 
const std::vector< Enode< Base > * > & equations () const
 
Vnode< Base > * derivative () const
 
Vnode< Base > * antiDerivative () const
 
Vnode< Base > * originalVariable ()
 
Vnode< Base > * originalVariable (size_t origVarSize)
 
bool isDeleted () const
 
void makeParameter (std::ostream &out=std::cout, Verbosity verbosity=Verbosity::None)
 
bool isParameter () const
 
void deleteNode (std::ostream &out=std::cout, Verbosity verbosity=Verbosity::None)
 
Enode< Base > * assignmentEquation () const
 
void setAssignmentEquation (Enode< Base > &i, std::ostream &out=std::cout, Verbosity verbosity=Verbosity::None)
 
virtual std::string nodeType ()
 
void setDerivative (Vnode< Base > *div)
 
unsigned int order () const
 
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 Member Functions

void addEquation (Enode< Base > *i)
 

Protected Attributes

bool deleted_
 
bool parameter_
 
std::vector< Enode< Base > * > enodes_
 
Enode< Base > * assign_
 
Vnode< Base > * derivative_
 
Vnode< Base > *const antiDerivative_
 
size_t tapeIndex_
 
std::string name_
 
size_t index_
 
bool colored_
 

Static Protected Attributes

static const std::string TYPE = "Variable"
 

Friends

class Enode< Base >
 

Detailed Description

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

Variable nodes

Definition at line 218 of file bipartite_nodes.hpp.

Constructor & Destructor Documentation

◆ Vnode() [1/2]

template<class Base >
CppAD::cg::Vnode< Base >::Vnode ( size_t  index,
int  tapeIndex,
const std::string &  name 
)
inline

Definition at line 258 of file bipartite_nodes.hpp.

◆ Vnode() [2/2]

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

Definition at line 272 of file bipartite_nodes.hpp.

◆ ~Vnode()

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

Definition at line 289 of file bipartite_nodes.hpp.

Member Function Documentation

◆ addEquation()

template<class Base >
void CppAD::cg::Vnode< Base >::addEquation ( Enode< Base > *  i)
inlineprotected

Definition at line 400 of file bipartite_nodes.hpp.

◆ antiDerivative()

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

◆ assignmentEquation()

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

Definition at line 368 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::Vnode< Base >::deleteNode ( std::ostream &  out = std::cout,
Verbosity  verbosity = Verbosity::None 
)
inline

Definition at line 356 of file bipartite_nodes.hpp.

◆ derivative()

◆ equations() [1/2]

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

Definition at line 304 of file bipartite_nodes.hpp.

◆ equations() [2/2]

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

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

◆ isDeleted()

template<class Base >
bool CppAD::cg::Vnode< Base >::isDeleted ( ) const
inline

Definition at line 342 of file bipartite_nodes.hpp.

◆ isParameter()

template<class Base >
bool CppAD::cg::Vnode< Base >::isParameter ( ) const
inline

Definition at line 352 of file bipartite_nodes.hpp.

◆ makeParameter()

template<class Base >
void CppAD::cg::Vnode< Base >::makeParameter ( std::ostream &  out = std::cout,
Verbosity  verbosity = Verbosity::None 
)
inline

Definition at line 346 of file bipartite_nodes.hpp.

◆ name()

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

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

Definition at line 292 of file bipartite_nodes.hpp.

◆ nodeType()

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

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

Definition at line 382 of file bipartite_nodes.hpp.

◆ order()

template<class Base >
unsigned int CppAD::cg::Vnode< Base >::order ( ) const
inline

Definition at line 390 of file bipartite_nodes.hpp.

◆ originalVariable() [1/2]

template<class Base >
Vnode< Base > * CppAD::cg::Vnode< Base >::originalVariable ( )
inline

Definition at line 326 of file bipartite_nodes.hpp.

◆ originalVariable() [2/2]

template<class Base >
Vnode< Base > * CppAD::cg::Vnode< Base >::originalVariable ( size_t  origVarSize)
inline

Definition at line 334 of file bipartite_nodes.hpp.

◆ setAssignmentEquation()

template<class Base >
void CppAD::cg::Vnode< Base >::setAssignmentEquation ( Enode< Base > &  i,
std::ostream &  out = std::cout,
Verbosity  verbosity = Verbosity::None 
)
inline

Definition at line 372 of file bipartite_nodes.hpp.

◆ setDerivative()

template<class Base >
void CppAD::cg::Vnode< Base >::setDerivative ( Vnode< Base > *  div)
inline

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

◆ setTapeIndex()

template<class Base >
void CppAD::cg::Vnode< Base >::setTapeIndex ( size_t  tapeIndex)
inline

Definition at line 300 of file bipartite_nodes.hpp.

◆ tapeIndex()

template<class Base >
size_t CppAD::cg::Vnode< Base >::tapeIndex ( ) const
inline

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

Friends And Related Symbol Documentation

◆ Enode< Base >

template<class Base >
friend class Enode< Base >
friend

Definition at line 400 of file bipartite_nodes.hpp.

Member Data Documentation

◆ antiDerivative_

template<class Base >
Vnode<Base>* const CppAD::cg::Vnode< Base >::antiDerivative_
protected

the variable which was differentiated to create this one

Definition at line 246 of file bipartite_nodes.hpp.

Referenced by CppAD::cg::Vnode< Base >::antiDerivative().

◆ assign_

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

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

◆ deleted_

template<class Base >
bool CppAD::cg::Vnode< Base >::deleted_
protected

Definition at line 224 of file bipartite_nodes.hpp.

◆ derivative_

template<class Base >
Vnode<Base>* CppAD::cg::Vnode< Base >::derivative_
protected

the time derivative variable of this variable (A in Pantelides algorithm)

Definition at line 242 of file bipartite_nodes.hpp.

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

◆ enodes_

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

Equations that use this variable. A vector is used instead of a set to ensure reproducibility.

Definition at line 233 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::Vnode< Base >::name_
protected

name

Definition at line 254 of file bipartite_nodes.hpp.

◆ parameter_

template<class Base >
bool CppAD::cg::Vnode< Base >::parameter_
protected

Whether or not this variable is time dependent

Definition at line 228 of file bipartite_nodes.hpp.

◆ tapeIndex_

template<class Base >
size_t CppAD::cg::Vnode< Base >::tapeIndex_
protected

The index in the tape

Definition at line 250 of file bipartite_nodes.hpp.

◆ TYPE

template<class Base >
const std::string CppAD::cg::Vnode< Base >::TYPE = "Variable"
staticprotected

Definition at line 220 of file bipartite_nodes.hpp.


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