Provides global adjoint variables owned by a tape type. Thread-safe for use in parallel taping. More...

#include <threadSafeGlobalAdjoints.hpp>

Inheritance diagram for codi::ThreadSafeGlobalAdjoints< T_Gradient, T_Identifier, T_Tape, T_ParallelToolbox >:

[legend]

Public Types
using	Gradient = T_Gradient
	See ThreadSafeGlobalAdjoints.

using	Identifier = T_Identifier

using	LockForRealloc = typename ParallelToolbox::LockForWrite
	See ParallelToolbox.

using	LockForUse = typename ParallelToolbox::LockForRead
	See ParallelToolbox.

using	ParallelToolbox = T_ParallelToolbox
	See ThreadSafeGlobalAdjoints.

using	ReadWriteMutex = typename ParallelToolbox::ReadWriteMutex
	See ParallelToolbox.

using	Tape = T_Tape
	See ThreadSafeGlobalAdjoints.

Public Types inherited from codi::InternalAdjointsInterface< T_Gradient, T_Identifier, T_Tape >
using	Gradient = T_Gradient
	See InternalAdjointsInterface.

using	Identifier = T_Identifier
	See InternalAdjointsInterface.

using	Tape = T_Tape
	See InternalAdjointsInterface.

Public Member Functions
inlinevoid	beginUse ()
	Declare that the adjoints are in use, e.g., during a tape evaluation, and cannot be resized right now.

inlineGradient *	data ()
	Return an array-like object for data access, for example a pointer to an underlying array or a reference to something with overloaded operator[].

inlinevoid	endUse ()
	Declare that the adjoints are no longer occupied.

inlineGradient &	operator[] (Identifier const &identifier)
	Reference access to the adjoint variable identified by identifier.

inlineGradient const &	operator[] (Identifier const &identifier) const
	Constant reference access to the adjoint variable identified by identifier.

void	resize (Identifier const &newSize)
	Ensure that identifiers up to newSize can be passed to operator[] without error.

inlinesize_t	size () const
	Returns the number of adjoint variables. Internally, declares usage of the adjoints.

inlinevoid	swap (ThreadSafeGlobalAdjoints &)
	Swap two sets of adjoint variables. Internally, declares usage of the adjoints.

	ThreadSafeGlobalAdjoints (size_t initialSize)
	Constructor.

inlinevoid	zeroAll (Identifier const &maxIdentifier)
	Set all adjoint variables up to and including maxIdentifier to Gradient().

Public Member Functions inherited from codi::InternalAdjointsInterface< T_Gradient, T_Identifier, T_Tape >
inlinevoid	beginUse ()
	Declare that the adjoints are in use, e.g., during a tape evaluation, and cannot be resized right now.

template<typename ArrayAccess>
ArrayAccess	data ()
	Return an array-like object for data access, for example a pointer to an underlying array or a reference to something with overloaded operator[].

inlinevoid	endUse ()
	Declare that the adjoints are no longer occupied.

	InternalAdjointsInterface (size_t initialSize)

inlineGradient &	operator[] (Identifier const &identifier)
	Reference access to the adjoint variable identified by identifier.

inlineGradient const &	operator[] (Identifier const &identifier) const
	Constant reference access to the adjoint variable identified by identifier.

void	resize (Identifier const &newSize)
	Ensure that identifiers up to newSize can be passed to operator[] without error.

inlinesize_t	size () const
	Returns the number of adjoint variables. Internally, declares usage of the adjoints.

template<typename Impl>
inlinevoid	swap (Impl &other)
	Swap two sets of adjoint variables. Internally, declares usage of the adjoints.

inlinevoid	zeroAll (Identifier const &maxIdentifier)
	Set all adjoint variables up to and including maxIdentifier to Gradient().

Detailed Description

template<typename T_Gradient, typename T_Identifier, typename T_Tape, typename T_ParallelToolbox>
struct codi::ThreadSafeGlobalAdjoints< T_Gradient, T_Identifier, T_Tape, T_ParallelToolbox >

Provides global adjoint variables owned by a tape type. Thread-safe for use in parallel taping.

Template Parameters

T_Gradient	The gradient type of a tape, usually chosen as ActiveType::Gradient.
T_Identifier	The adjoint/tangent identification of a tape, usually chosen as ActiveType::Identifier.
T_Tape	The associated tape type.
T_ParallelToolbox	The parallel toolbox used in the associated tape. See codi::ParallelToolbox.