Specialization for ForwardEvaluation. More...

#include <eventSystem.hpp>

Inheritance diagram for codi::EventSystem< ForwardEvaluation< Real, Gradient > >:

[legend]

Public Types
using	Base
	Base class abbreviation.

using	Event
	See EventSystemBase.

using	Gradient
	Gradient type used by the tape.

using	Handle
	See EventSystemBase.

using	Identifier
	Identifier type used by the tape.

using	Index
	Index type used by the tape.

using	Position

using	Real
	Floating point type the tape is based on.

using	Tape
	See EventSystem.

using	VectorAccess
	Vector access interface that is compatible with the Tape.

Public Types inherited from codi::EventSystemBase< ForwardEvaluation< Real, Gradient > >
using	Handle
	Handle that identifies a registered callback.

using	Identifier
	Identifier type used by the tape.

using	Real
	Floating point type the tape is based on.

using	Tape
	See EventSystemBase.

Static Public Member Functions
AD workflow events
static inlineHandle	registerTapeStartRecordingListener (void(callback)(Tape &, void ), void *customData=nullptr)
	Register callbacks for TapeStartRecording events.

static inlinevoid	notifyTapeStartRecordingListeners (Tape &tape)
	Invoke callbacks for TapeStartRecording events.

static inlineHandle	registerTapeStopRecordingListener (void(callback)(Tape &, void ), void *customData=nullptr)
	Register callbacks for TapeStopRecording events.

static inlinevoid	notifyTapeStopRecordingListeners (Tape &tape)
	Invoke callbacks for TapeStopRecording events.

static inlineHandle	registerTapeRegisterInputListener (void(callback)(Tape &, Real &, Identifier &, void ), void *customData=nullptr)
	Register callbacks for TapeRegisterInput events.

static inlinevoid	notifyTapeRegisterInputListeners (Tape &tape, Real &value, Identifier &identifier)
	Invoke callbacks for TapeRegisterInput events.

static inlineHandle	registerTapeRegisterOutputListener (void(callback)(Tape &, Real &, Identifier &, void ), void *customData=nullptr)
	Register callbacks for TapeRegisterOutput events.

static inlinevoid	notifyTapeRegisterOutputListeners (Tape &tape, Real &value, Identifier &identifier)
	Invoke callbacks for TapeRegisterOutput events.

static inlineHandle	registerTapeEvaluateListener (void(callback)(Tape &, Position const &, Position const &, VectorAccess , EventHints::EvaluationKind, EventHints::Endpoint, void ), void customData=nullptr)
	Register callbacks for TapeEvaluate events.

static inlinevoid	notifyTapeEvaluateListeners (Tape &tape, Position const &start, Position const &end, VectorAccess *adjoint, EventHints::EvaluationKind evalKind, EventHints::Endpoint endpoint)
	Invoke callbacks for TapeEvaluate events.

static inlineHandle	registerTapeResetListener (void(callback)(Tape &, Position const &, EventHints::Reset, bool, void ), void *customData=nullptr)
	Register callbacks for TapeReset events.

static inlinevoid	notifyTapeResetListeners (Tape &tape, Position const &position, EventHints::Reset kind, bool clearAdjoints)
	Invoke callbacks for TapeReset events.

Preaccumulation events
static inlineHandle	registerPreaccStartListener (void(callback)(Tape &, void ), void *customData=nullptr)
	Register callbacks for PreaccStart events.

static inlinevoid	notifyPreaccStartListeners (Tape &tape)
	Invoke callbacks for PreaccStart events.

static inlineHandle	registerPreaccFinishListener (void(callback)(Tape &, void ), void *customData=nullptr)
	Register callbacks for PreaccFinish events.

static inlinevoid	notifyPreaccFinishListeners (Tape &tape)
	Invoke callbacks for PreaccFinish events.

static inlineHandle	registerPreaccAddInputListener (void(callback)(Tape &, Real const &, Identifier const &, void ), void *customData=nullptr)
	Register callbacks for PreaccAddInput events.

static inlinevoid	notifyPreaccAddInputListeners (Tape &tape, Real const &value, Identifier const &identifier)
	Invoke callbacks for PreaccAddInput events.

static inlineHandle	registerPreaccAddOutputListener (void(callback)(Tape &, Real &, Identifier &, void ), void *customData=nullptr)
	Register callbacks for PreaccAddOutput events.

static inlinevoid	notifyPreaccAddOutputListeners (Tape &tape, Real &value, Identifier &identifier)
	Invoke callbacks for PreaccAddOutput events.

Statement events
static inlineHandle	registerStatementStoreOnTapeListener (void(callback)(Tape &, Identifier const &, Real const &, size_t, Identifier const , Real const , void ), void *customData=nullptr)
	Register callbacks for StatementStoreOnTape events.

static inlinevoid	notifyStatementStoreOnTapeListeners (Tape &tape, Identifier const &lhsIdentifier, Real const &newValue, size_t numActiveVariables, Identifier const rhsIdentifiers, Real const jacobians)
	Invoke callbacks for StatementStoreOnTape events.

static inlineHandle	registerStatementEvaluateListener (void(callback)(Tape &, Identifier const &, size_t, Real const , void ), void customData=nullptr)
	Register callbacks for StatementEvaluate events.

static inlinevoid	notifyStatementEvaluateListeners (Tape &tape, Identifier const &lhsIdentifier, size_t sizeLhsAdjoint, Real const *lhsAdjoint)
	Invoke callbacks for StatementEvaluate events.

static inlineHandle	registerStatementEvaluatePrimalListener (void(callback)(Tape &, Identifier const &, Real const &, void ), void *customData=nullptr)
	Register callbacks for StatementEvaluatePrimal events.

static inlinevoid	notifyStatementEvaluatePrimalListeners (Tape &tape, Identifier const &lhsIdentifier, Real const &lhsValue)
	Invoke callbacks for StatementEvaluatePrimal events.

Index handling events
static inlineHandle	registerIndexAssignListener (void(callback)(Index const &, void ), void *customData=nullptr)
	Register callbacks for IndexAssign events.

static inlinevoid	notifyIndexAssignListeners (Index const &index)
	Invoke callbacks for IndexAssign events.

static inlineHandle	registerIndexFreeListener (void(callback)(Index const &, void ), void *customData=nullptr)
	Register callbacks for IndexFree events.

static inlinevoid	notifyIndexFreeListeners (Index const &index)
	Invoke callbacks for IndexFree events.

static inlineHandle	registerIndexCopyListener (void(callback)(Index const &, void ), void *customData=nullptr)
	Register callbacks for IndexCopy events.

static inlinevoid	notifyIndexCopyListeners (Index const &index)
	Invoke callbacks for IndexCopy events.

Static Public Member Functions inherited from codi::EventSystemBase< ForwardEvaluation< Real, Gradient > >
static inlineHandle	registerStatementPrimalListener (void(callback)(Tape &, Real const &, Identifier const &, Real const &, EventHints::Statement, void ), void *customData=nullptr)
	Register callbacks for StatementPrimal events.

static inlinevoid	notifyStatementPrimalListeners (Tape &tape, Real const &lhsValue, Identifier const &lhsIdentifier, Real const &newValue, EventHints::Statement statement)
	Invoke callbacks for StatementPrimal events.

static inlinevoid	notifyStatementPrimalListeners (Tape &&tape, Real const &lhsValue, Identifier const &lhsIdentifier, Real const &newValue, EventHints::Statement statement)
	Invoke callbacks for StatementPrimal events.

static inlinevoid	deregisterListener (Handle const &handle)
	Deregister a listener.

Additional Inherited Members
Protected Types inherited from codi::EventSystemBase< ForwardEvaluation< Real, Gradient > >
using	Callback

enum	Event
	Full set of events.

using	EventListenerMap
	Map that links events to registered callbacks and their associated custom data.

Static Protected Member Functions inherited from codi::EventSystemBase< ForwardEvaluation< Real, Gradient > >
static inlineEventListenerMap &	getListeners ()
	Access the static EventListenerMap.

static inlinevoid	internalNotifyListeners (bool const enabled, Event event, Args &&... args)
	Internal method for callback invocation.

static inlineHandle	internalRegisterListener (bool const enabled, Event event, TypedCallback callback, void *customData)
	Internal method for callback registration.

Detailed Description

template<typename Real, typename Gradient>
struct codi::EventSystem< ForwardEvaluation< Real, Gradient > >

Specialization for ForwardEvaluation.

See EventSystem and EventSystemBase.

Template Parameters

Real	Floating point the forward tape is based on.
Gradient	Gradient type used by the forward tape.

Member Typedef Documentation

◆ Position

using codi::EventSystem< ForwardEvaluation< Real, Gradient > >::Position

Position used by the tape.

Member Function Documentation

◆ notifyIndexAssignListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyIndexAssignListeners ( Index const & index )

inlinestatic

Invoke callbacks for IndexAssign events.

IndexAssign events occur when an index management assigns an index to a left hand side variable. This includes cases where an index is left in place, in the sense that it is freed and immediately assigned again. It is unspecified whether the event occurs before or after the actual index assignment.

Parameters

index The assigned index.

◆ notifyIndexCopyListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyIndexCopyListeners ( Index const & index )

inlinestatic

Invoke callbacks for IndexCopy events.

IndexCopy events occur when an index management assigns an index to a left hand side variable by copying it from the right hand side variable. It is unspecified whether the event occurs before or after the actual index copy operation.

Parameters

index The copied index.

◆ notifyIndexFreeListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyIndexFreeListeners ( Index const & index )

inlinestatic

Invoke callbacks for IndexFree events.

IndexFree events occur when an index management frees an index of a left hand side variable. This includes cases where an existing index is overwritten by a new one, and cases where an index is left in place (in the sense that it is freed and immediately assigned again). It is unspecified whether the event occurs before or after the actual index free operation.

Parameters

index The freed index.

◆ notifyPreaccAddInputListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyPreaccAddInputListeners	(	Tape &	tape,
		Real const &	value,
		Identifier const &	identifier )

inlinestatic

Invoke callbacks for PreaccAddInput events.

A PreaccAddInput event occurs when an input is added via a PreaccumulationHelper, e.g., by passing them to start or by calling addInput. The event occurs before the internal registration.

Parameters

tape	Reference to the tape.
value	The value of the input that is registered.
identifier	The identifier of the input that is registered.

◆ notifyPreaccAddOutputListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyPreaccAddOutputListeners	(	Tape &	tape,
		Real &	value,
		Identifier &	identifier )

inlinestatic

Invoke callbacks for PreaccAddOutput events.

A PreaccAddOutput event occurs when an output is added via a PreaccumulationHelper, e.g., by passing them to finish or by calling addOutput. The event occurs before the internal registration.

Parameters

tape	Reference to the tape.
value	The value of the output that is registered.
identifier	The identifier of the output that is registered.

◆ notifyPreaccFinishListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyPreaccFinishListeners ( Tape & tape )

inlinestatic

Invoke callbacks for PreaccFinish events.

A PreaccFinish event occurs whenever a preaccumulation is finished via a PreaccumulationHelper, after everything related to the preaccumulation is completed. Note that there may be TapeEvaluate, TapeReset, and StatementStore events due to preaccumulation after the call to finish but before this event.

Parameters

tape	Reference to the tape.

◆ notifyPreaccStartListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyPreaccStartListeners ( Tape & tape )

inlinestatic

Invoke callbacks for PreaccStart events.

A PreaccStart event occurs whenever a preaccumulation is started via a PreaccumulationHelper, prior to internal preparations for the preaccumulation.

Parameters

tape	Reference to the tape.

◆ notifyStatementEvaluateListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyStatementEvaluateListeners	(	Tape &	tape,
		Identifier const &	lhsIdentifier,
		size_t	sizeLhsAdjoint,
		Real const *	lhsAdjoint )

inlinestatic

Invoke callbacks for StatementEvaluate events.

A StatementEvaluate occurs whenever a tape evaluates a statement. For forward evaluations, the event occurs after the statement evaluation. For reverse evaluations, the event occurs before statement evaluation and before the left hand side adjoint is zeroed, if applicable.

Parameters

tape	Reference to the tape.
lhsIdentifier	Left hand side identifier.
sizeLhsAdjoint	Number of left hand side adjoint components.
lhsAdjoint	Pointer to the left hand side adjoint components.

◆ notifyStatementEvaluatePrimalListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyStatementEvaluatePrimalListeners	(	Tape &	tape,
		Identifier const &	lhsIdentifier,
		Real const &	lhsValue )

inlinestatic

Invoke callbacks for StatementEvaluatePrimal events.

A StatementEvaluatePrimal occurs whenever a primal value tape evaluates a statement. For forward and reverse evaluations, it occurs in addition to StatementEvaluate events. Primal tape evaluations produce only StatementEvaluatePrimal events. StatementEvaluatePrimal events occur after StatementEvaluate events. For primal evaluations, they occur after the evaluation of the primal statement.

Parameters

tape	Reference to the tape.
lhsIdentifier	Identifier of the left hand side variable.
lhsValue	Value of the left hand side variable.

◆ notifyStatementStoreOnTapeListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyStatementStoreOnTapeListeners	(	Tape &	tape,
		Identifier const &	lhsIdentifier,
		Real const &	newValue,
		size_t	numActiveVariables,
		Identifier const *	rhsIdentifiers,
		Real const *	jacobians )

inlinestatic

Invoke callbacks for StatementStoreOnTape events.

A StatementStoreOnTape event occurs whenever a statement is stored on an associated tape. Note that all statements emit StatementPrimal events, but might not be stored on the tape, for example because nothing is active. The event is emitted after storing all data on the tape, after the left hand side has been assigned an identifier, but before the left hand side updates its primal value.

Parameters

tape	Reference to the tape.
lhsIdentifier	Identifier assigned to the left hand side.
newValue	Value that is assigned to the left hand side.
numActiveVariables	Number of active variables on the right hand side.
rhsIdentifiers	Pointer to numActiveVariables identifiers.
jacobians	Pointer to numActiveVariables Jacobian values.

◆ notifyTapeEvaluateListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyTapeEvaluateListeners	(	Tape &	tape,
		Position const &	start,
		Position const &	end,
		VectorAccess *	adjoint,
		EventHints::EvaluationKind	evalKind,
		EventHints::Endpoint	endpoint )

inlinestatic

Invoke callbacks for TapeEvaluate events.

TapeEvaluate events occur both prior to and after the evaluation process, with correspondingly different endpoint parameter. The tape evaluation is classified by the evalKind parameter.

Parameters

tape	Reference to the tape.
start	Starting position of the evaluation.
end	End position of the evaluation.
adjoint	Vector access interface that provides access to adjoint variables.
evalKind	Indicates whether the evaluation is primal, forward, or reverse.
endpoint	Indicates whether this is the event before or after the tape evaluation.

◆ notifyTapeRegisterInputListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyTapeRegisterInputListeners	(	Tape &	tape,
		Real &	value,
		Identifier &	identifier )

inlinestatic

Invoke callbacks for TapeRegisterInput events.

A TapeRegisterInput event occurs whenever registerInput calls are made to an associated tape, after the internal input registration is completed.

Parameters

tape	Reference to the tape.
value	The value of the input that has been registered.
identifier	The new identifier of the input that has been registered.

◆ notifyTapeRegisterOutputListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyTapeRegisterOutputListeners	(	Tape &	tape,
		Real &	value,
		Identifier &	identifier )

inlinestatic

Invoke callbacks for TapeRegisterOutput events.

A TapeRegisterOutput event occurs whenever registerOutput calls are made to the tape, after the internal output registration is completed.

Parameters

tape	Reference to the tape.
value	The value of the output that has been registered.
identifier	The new identifier of the output that has been registered.

◆ notifyTapeResetListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyTapeResetListeners	(	Tape &	tape,
		Position const &	position,
		EventHints::Reset	kind,
		bool	clearAdjoints )

inlinestatic

Invoke callbacks for TapeReset events.

A TapeReset event occurs in the course of reset, resetTo, and resetHard calls made to an associated tape, the respective origin is indicated by kind. For Jacobian tapes, the event occurs before any internal reset takes place. For primal value tapes, some internal reset operations have already been performed when the event occurs.

Parameters

tape	Reference to the tape.
position	Position to which we reset, zero position for full and hard resets.
kind	Reset kind, see codi::EventHints::Reset.
clearAdjoints	Indicates whether adjoints are zeroed.

◆ notifyTapeStartRecordingListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyTapeStartRecordingListeners ( Tape & tape )

inlinestatic

Invoke callbacks for TapeStartRecording events.

A TapeStartRecording event is triggered whenever an associated tape is set active. The event occurs before the internal tape status change.

Parameters

tape	Reference to the tape.

◆ notifyTapeStopRecordingListeners()

static inlinevoid codi::EventSystem< ForwardEvaluation< Real, Gradient > >::notifyTapeStopRecordingListeners ( Tape & tape )

inlinestatic

Invoke callbacks for TapeStopRecording events.

A TapeStopRecording event is triggered whenever an associated type is set passive. The event occurs before the internal tape status change.

Parameters

tape	Reference to the tape.

◆ registerIndexAssignListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerIndexAssignListener	(	void(*	callback )(Index const &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for IndexAssign events.

See notifyIndexAssignListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerIndexCopyListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerIndexCopyListener	(	void(*	callback )(Index const &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for IndexCopy events.

See notifyIndexCopyListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerIndexFreeListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerIndexFreeListener	(	void(*	callback )(Index const &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for IndexFree events.

See notifyIndexFreeListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerPreaccAddInputListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerPreaccAddInputListener	(	void(*	callback )(Tape &, Real const &, Identifier const &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for PreaccAddInput events.

See notifyPreaccAddInputListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerPreaccAddOutputListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerPreaccAddOutputListener	(	void(*	callback )(Tape &, Real &, Identifier &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for PreaccAddOutput events.

See notifyPreaccAddOutputListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerPreaccFinishListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerPreaccFinishListener	(	void(*	callback )(Tape &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for PreaccFinish events.

See notifyPreaccFinishListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerPreaccStartListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerPreaccStartListener	(	void(*	callback )(Tape &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for PreaccStart events.

See notifyPreaccStartListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerStatementEvaluateListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerStatementEvaluateListener	(	void(*	callback )(Tape &, Identifier const &, size_t, Real const , void ),
		void *	customData = nullptr )

inlinestatic

Register callbacks for StatementEvaluate events.

See notifyStatementEvaluateListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerStatementEvaluatePrimalListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerStatementEvaluatePrimalListener	(	void(*	callback )(Tape &, Identifier const &, Real const &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for StatementEvaluatePrimal events.

See notifyStatementEvaluatePrimalListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerStatementStoreOnTapeListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerStatementStoreOnTapeListener	(	void(*	callback )(Tape &, Identifier const &, Real const &, size_t, Identifier const , Real const , void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for StatementStoreOnTape events.

See notifyStatementStoreOnTapeListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerTapeEvaluateListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerTapeEvaluateListener	(	void(*	callback )(Tape &, Position const &, Position const &, VectorAccess , EventHints::EvaluationKind, EventHints::Endpoint, void ),
		void *	customData = nullptr )

inlinestatic

Register callbacks for TapeEvaluate events.

See notifyTapeEvaluateListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerTapeRegisterInputListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerTapeRegisterInputListener	(	void(*	callback )(Tape &, Real &, Identifier &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for TapeRegisterInput events.

See notifyTapeRegisterInputListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerTapeRegisterOutputListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerTapeRegisterOutputListener	(	void(*	callback )(Tape &, Real &, Identifier &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for TapeRegisterOutput events.

See notifyTapeRegisterOutputListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerTapeResetListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerTapeResetListener	(	void(*	callback )(Tape &, Position const &, EventHints::Reset, bool, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for TapeReset events.

See notifyTapeResetListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerTapeStartRecordingListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerTapeStartRecordingListener	(	void(*	callback )(Tape &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for TapeStartRecording events.

See notifyTapeStartRecordingListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

◆ registerTapeStopRecordingListener()

static inlineHandle codi::EventSystem< ForwardEvaluation< Real, Gradient > >::registerTapeStopRecordingListener	(	void(*	callback )(Tape &, void *),
		void *	customData = nullptr )

inlinestatic

Register callbacks for TapeStopRecording events.

See notifyTapeStopRecordingListeners for the callback parameters and event order.

Parameters

callback	Callback to be invoked.
customData	Optional. Custom data that should be linked with the callback, otherwise nullptr.

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

include/codi/misc/eventSystem.hpp

Public Types

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Position

Member Function Documentation

◆ notifyIndexAssignListeners()

◆ notifyIndexCopyListeners()

◆ notifyIndexFreeListeners()

◆ notifyPreaccAddInputListeners()

◆ notifyPreaccAddOutputListeners()

◆ notifyPreaccFinishListeners()

◆ notifyPreaccStartListeners()

◆ notifyStatementEvaluateListeners()

◆ notifyStatementEvaluatePrimalListeners()

◆ notifyStatementStoreOnTapeListeners()

◆ notifyTapeEvaluateListeners()

◆ notifyTapeRegisterInputListeners()

◆ notifyTapeRegisterOutputListeners()

◆ notifyTapeResetListeners()

◆ notifyTapeStartRecordingListeners()

◆ notifyTapeStopRecordingListeners()

◆ registerIndexAssignListener()

◆ registerIndexCopyListener()

◆ registerIndexFreeListener()

◆ registerPreaccAddInputListener()

◆ registerPreaccAddOutputListener()

◆ registerPreaccFinishListener()

◆ registerPreaccStartListener()

◆ registerStatementEvaluateListener()

◆ registerStatementEvaluatePrimalListener()

◆ registerStatementStoreOnTapeListener()

◆ registerTapeEvaluateListener()

◆ registerTapeRegisterInputListener()

◆ registerTapeRegisterOutputListener()

◆ registerTapeResetListener()

◆ registerTapeStartRecordingListener()

◆ registerTapeStopRecordingListener()