codi::ActiveArgumentValueStore< T_PointerStore > Struct Template Reference

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

#include <activeArgumentStoreTraits.hpp>

Public Types
using	Gradient = typename PointerStore::Gradient
	See ActiveArgumentPointerStore.
using	Identifier = typename PointerStore::Identifier
	See ActiveArgumentPointerStore.
using	PointerStore = T_PointerStore
	See ActiveArgumentValueStore.
using	Real = typename PointerStore::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
PointerStore	base
	Declaration of base.

Detailed Description

template<typename T_PointerStore>
struct codi::ActiveArgumentValueStore< T_PointerStore >

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

Template Parameters

T_PointerStore

The pointer store implementation.

Member Function Documentation

gradientIn()

template<typename T_PointerStore >

Gradient & codi::ActiveArgumentValueStore< T_PointerStore >::gradientIn ( )

inline

Get the input gradients.

gradientOut()

template<typename T_PointerStore >

Gradient & codi::ActiveArgumentValueStore< T_PointerStore >::gradientOut ( )

inline

Get the output gradients.

identifierIn()

template<typename T_PointerStore >

Identifier & codi::ActiveArgumentValueStore< T_PointerStore >::identifierIn ( )

inline

Get the input identifiers.

identifierOut()

template<typename T_PointerStore >

Identifier & codi::ActiveArgumentValueStore< T_PointerStore >::identifierOut ( )

inline

Get the output identifiers.

oldPrimal()

template<typename T_PointerStore >

Real & codi::ActiveArgumentValueStore< T_PointerStore >::oldPrimal ( )

inline

Get old primal values.

primal()

template<typename T_PointerStore >

Real & codi::ActiveArgumentValueStore< T_PointerStore >::primal ( )

inline

Get the primal values.

---

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

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