codi::ActiveArgumentPointerStore< T_Real, T_Identifier, T_Gradient > Struct Template Reference

Declares all variables that may be needed to store/restore an active argument which has a pointer type. More...

#include <activeArgumentStoreTraits.hpp>

Public Types
using	Gradient = T_Gradient
	See ActiveArgumentPointerStore.
using	Identifier = T_Identifier
	See ActiveArgumentPointerStore.
using	Real = T_Real
	See ActiveArgumentPointerStore.

Public Member Functions
Gradient *	gradientIn ()
	Get the input gradients.
Gradient *	gradientOut ()
	Get the output gradients.
Identifier *	identifierIn ()
	Get the input identifiers.
Identifier *	identifierOut ()
	Get the output identifiers.
Real *	oldPrimal ()
	Get old primal values.
Real *	primal ()
	Get the primal values.

Public Attributes
Real *	oldPrimals
	Old primal values in primal value tape setting.
int	passiveValuesCount
	Number of passive values.
Gradient *	value_deriv_in
	Gradient vector of an input argument.
Gradient *	value_deriv_out
	Gradient vector of an output argument.
Identifier *	value_i_in
	Identifier vector of an input argument.
Identifier *	value_i_out
	Identifier vector of an output argument.
Real *	value_v
	Primal value vector.

Detailed Description

template<typename T_Real, typename T_Identifier, typename T_Gradient>
struct codi::ActiveArgumentPointerStore< T_Real, T_Identifier, T_Gradient >

Declares all variables that may be needed to store/restore an active argument which has a pointer type.

Template Parameters

T_Real	The computation type of a tape, usually chosen as ActiveType::Real.
T_Identifier	The adjoint/tangent identification of a tape, usually chosen as ActiveType::Identifier.
T_Gradient	The gradient type of a tape, usually chosen as ActiveType::Gradient.

Member Function Documentation

gradientIn()

template<typename T_Real, typename T_Identifier, typename T_Gradient>

Gradient * codi::ActiveArgumentPointerStore< T_Real, T_Identifier, T_Gradient >::gradientIn ( )

inline

Get the input gradients.

gradientOut()

template<typename T_Real, typename T_Identifier, typename T_Gradient>

Gradient * codi::ActiveArgumentPointerStore< T_Real, T_Identifier, T_Gradient >::gradientOut ( )

inline

Get the output gradients.

identifierIn()

template<typename T_Real, typename T_Identifier, typename T_Gradient>

Identifier * codi::ActiveArgumentPointerStore< T_Real, T_Identifier, T_Gradient >::identifierIn ( )

inline

Get the input identifiers.

identifierOut()

template<typename T_Real, typename T_Identifier, typename T_Gradient>

Identifier * codi::ActiveArgumentPointerStore< T_Real, T_Identifier, T_Gradient >::identifierOut ( )

inline

Get the output identifiers.

oldPrimal()

template<typename T_Real, typename T_Identifier, typename T_Gradient>

Real * codi::ActiveArgumentPointerStore< T_Real, T_Identifier, T_Gradient >::oldPrimal ( )

inline

Get old primal values.

primal()

template<typename T_Real, typename T_Identifier, typename T_Gradient>

Real * codi::ActiveArgumentPointerStore< T_Real, T_Identifier, T_Gradient >::primal ( )

inline

Get the primal values.

---

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

• include/codi/tools/lowlevelFunctions/traits/activeArgumentStoreTraits.hpp