codi::EventSystem< ForwardEvaluation< Real, Gradient > > Struct Template Reference

Specialization for ForwardEvaluation. More...

#include <eventSystem.hpp>

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

Additional Inherited Members
Public Types inherited from codi::EventSystemBase< ForwardEvaluation< Real, Gradient > >
using	Handle = size_t
	Handle that identifies a registered callback.
using	Identifier = typename Tape::Identifier
	Identifier type used by the tape.
using	Real = typename Tape::Real
	Floating point type the tape is based on.
using	Tape = ForwardEvaluation< Real, Gradient >
	See EventSystemBase.
Static Public Member Functions inherited from codi::EventSystemBase< ForwardEvaluation< Real, Gradient > >
static Handle	registerStatementPrimalListener (void(*callback)(Tape &, Real const &, Identifier const &, Real const &, EventHints::Statement, void *), void *customData=nullptr)
	Register callbacks for StatementPrimal events.
static void	notifyStatementPrimalListeners (Tape &tape, Real const &lhsValue, Identifier const &lhsIdentifier, Real const &newValue, EventHints::Statement statement)
	Invoke callbacks for StatementPrimal events.
static void	notifyStatementPrimalListeners (Tape &&tape, Real const &lhsValue, Identifier const &lhsIdentifier, Real const &newValue, EventHints::Statement statement)
	Invoke callbacks for StatementPrimal events.
static void	deregisterListener (Handle const &handle)
	Deregister a listener.
Protected Types inherited from codi::EventSystemBase< ForwardEvaluation< Real, Gradient > >
using	Callback = void *
enum	Event
	Full set of events.
using	EventListenerMap = std::map< Event, std::list< std::pair< Handle, std::pair< Callback, void * > > > >
	Map that links events to registered callbacks and their associated custom data.
Static Protected Member Functions inherited from codi::EventSystemBase< ForwardEvaluation< Real, Gradient > >
static EventListenerMap &	getListeners ()
	Access the static EventListenerMap.
static void	internalNotifyListeners (bool const enabled, Event event, Args &&... args)
	Internal method for callback invocation.
static Handle	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.

---

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

• include/codi/misc/eventSystem.hpp