codi::WriteConnectivityData< T_Tape > Struct Template Reference

Write connectivity data for a tape. More...

#include <writeConnectivityData.hpp>

Inheritance diagram for codi::WriteConnectivityData< T_Tape >:

Public Types
using	Base = ApplyIdentifierModification<T_Tape, WriteConnectivityData<T_Tape>>
	Base class abbreviation.
using	EvalHandle = typename Tape::EvalHandle
	See FullTapeInterface.
using	Identifier = typename Tape::Identifier
	See FullTapeInterface.
using	Real = typename Tape::Real
	See FullTapeInterface.
using	Tape = T_Tape
	See WriteConnectivityData.
Public Types inherited from codi::ApplyIdentifierModification< T_Tape, WriteConnectivityData< T_Tape > >
using	EvalHandle
	See FullTapeInterface.
using	Identifier
	See FullTapeInterface.
using	Impl
	See ApplyIdentifierModification.
using	Real
	See FullTapeInterface.
using	Tape
	See ApplyIdentifierModification.
Public Types inherited from codi::CallbacksInterface< T_Tape::Real, T_Tape::Identifier >
using	EvalHandle
	See PrimalValueTapeTypes.
using	Identifier
	See ReadWriteTapeInterface.
using	Real
	See ReadWriteTapeInterface.
using	Tape
	Any CoDiPack tape implementation.

Public Member Functions
inlinevoid	applyPostOutputLogic ()
	Prepare for next statement.
inlinevoid	applyToInput (Identifier &id)
	Write to rhs connectivity.
inlinevoid	applyToOutput (Identifier &id)
	Write to lhs connectivity.
void	eval (std::string const &name)
	Create the two files. See the class description for details.
	WriteConnectivityData (Tape &t)
	Constructor.
Public Member Functions inherited from codi::ApplyIdentifierModification< T_Tape, WriteConnectivityData< T_Tape > >
	ApplyIdentifierModification (Tape &tape)
	Constructor.
	ApplyIdentifierModification (Tape &tape)
	Constructor.
inlinevoid	applyPostInputLogic ()
	Called after applyToInput has been called for all inputs.
inlinevoid	applyPostInputLogic ()
	Called after applyToInput has been called for all inputs.
inlinevoid	applyPostOutputLogic ()
	Called after applyToOutput has been called for all outputs.
inlinevoid	applyPostOutputLogic ()
	Called after applyToOutput has been called for all outputs.
inlinevoid	applyToInput (Identifier &id)
	Called for each input of each statement or low level function.
inlinevoid	applyToInput (Identifier &id)
	Called for each input of each statement or low level function.
inlinevoid	applyToOutput (Identifier &id)
	Called for each output of each statement or low level function.
inlinevoid	applyToOutput (Identifier &id)
	Called for each output of each statement or low level function.
inlinevoid	handleLowLevelFunction (codi::LowLevelFunctionEntry< Tape, Real, Identifier > const &func, codi::ByteDataView &llfData)
inlinevoid	handleLowLevelFunction (codi::LowLevelFunctionEntry< Tape, Real, Identifier > const &func, codi::ByteDataView &llfData)
inlinevoid	handleStatement (EvalHandle const &evalHandle, codi::Config::ArgumentSize const &nPassiveValues, size_t &linearAdjointPosition, char *stmtData)
inlinevoid	handleStatement (EvalHandle const &evalHandle, codi::Config::ArgumentSize const &nPassiveValues, size_t &linearAdjointPosition, char *stmtData)
inlinevoid	handleStatement (Identifier &lhsIndex, codi::Config::ArgumentSize const &size, Real const *jacobians, Identifier *rhsIdentifiers)
inlinevoid	handleStatement (Identifier &lhsIndex, codi::Config::ArgumentSize const &size, Real const *jacobians, Identifier *rhsIdentifiers)
Public Member Functions inherited from codi::CallbacksInterface< T_Tape::Real, T_Tape::Identifier >
void	handleLowLevelFunction (LowLevelFunctionEntry< Tape, Real, Identifier > const &func, ByteDataView &llfData)
	Called for each low level function.
void	handleStatement (EvalHandle const &evalHandle, Config::ArgumentSize const &nPassiveValues, size_t &linearAdjointPosition, char *stmtData)
	Called for each statement in a primal value tape.
void	handleStatement (Identifier &lhsIndex, Config::ArgumentSize const &size, Real const *jacobians, Identifier const *rhsIdentifiers)
	Called for each statement in a Jacobian tape.

Public Attributes
std::ofstream	lhsConnectivity = {}
	Output stream for lhs connectivity.
std::ofstream	rhsConnectivity = {}
	Output stream for rhs connectivity.
Identifier	stmtId = 0
	counter for statement data.
Tape &	tape
	Tape that is modified.

Detailed Description

template<typename T_Tape>
struct codi::WriteConnectivityData< T_Tape >

Write connectivity data for a tape.

Creates two files

• <name>_rhs.dat
• <name>_lhs.dat the both contain two columns of data. The first column is the statement id. The second one contains either the rhs or lhs identifier.

Template Parameters

T_Tape

Tape tape on which the optimization is applied.

---

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

• include/codi/tools/io/writeConnectivityData.hpp