codi::EvaluationHandle< T_Func, T_Type, T_InputStore, T_OutputStore, TapeTraits::EnableIfPrimalValueTape< typename T_Type::Tape > > Struct Template Reference

See EvaluationHandleReversePrimalValueTapes. More...

#include <evaluationHelper.hpp>

Inheritance diagram for codi::EvaluationHandle< T_Func, T_Type, T_InputStore, T_OutputStore, TapeTraits::EnableIfPrimalValueTape< typename T_Type::Tape > >:

Additional Inherited Members
Public Types inherited from codi::EvaluationHandleReversePrimalValueTapes< T_Func, T_Type, T_InputStore, T_OutputStore >
using	Base = EvaluationHandleReverseBase< Func, Type, InputStore, OutputStore >
	Abbreviation for the base class.
using	Func = T_Func
	See EvaluationHandleBase.
using	InputStore = T_InputStore
	See EvaluationHandleBase.
using	OutputStore = T_OutputStore
	See EvaluationHandleBase.
using	Type = T_Type
	See EvaluationHandleBase.
Public Types inherited from codi::EvaluationHandleReverseBase< T_Func, T_Type, T_InputStore, T_OutputStore >
using	Base = EvaluationHandleBase< Func, Type, InputStore, OutputStore >
	Abbreviation for the base class.
using	Func = T_Func
	See EvaluationHandleBase.
using	InputStore = T_InputStore
	See EvaluationHandleBase.
using	OutputStore = T_OutputStore
	See EvaluationHandleBase.
using	Type = T_Type
	See EvaluationHandleBase.
Public Types inherited from codi::EvaluationHandleBase< T_Func, T_Type, T_InputStore, T_OutputStore >
using	Func = T_Func
	See EvaluationHandleBase.
using	InputStore = T_InputStore
	See EvaluationHandleBase.
using	OutputStore = T_OutputStore
	See EvaluationHandleBase.
using	Type = T_Type
	See EvaluationHandleBase.
Public Member Functions inherited from codi::EvaluationHandleReversePrimalValueTapes< T_Func, T_Type, T_InputStore, T_OutputStore >
void	computeHessian (VecX const &locX, Hes &hes, VecY &locY, Jac &jac)
	Perform a Hessian evaluation with the inputs provided in locX and store the result in hes, jac and locY.
	EvaluationHandleReverseBase (Func &func, size_t m, size_t n)
	Constructor.
Public Member Functions inherited from codi::EvaluationHandleReverseBase< T_Func, T_Type, T_InputStore, T_OutputStore >
void	computeHessian (VecX const &locX, Hes &hes, VecY &locY, Jac &jac)
	Perform a Hessian evaluation with the inputs provided in locX and store the result in hes, jac and locY.
void	computeJacobian (VecX const &locX, Jac &jac, VecY &locY)
	Perform a Jacobian evaluation with the inputs provided in locX and store the result in jac and locY.
void	computePrimal (VecX const &locX, VecY &locY)
	Perform a primal evaluation with the inputs provided in locX and store the result in locY.
	EvaluationHandleReverseBase (Func &func, size_t m, size_t n)
	Constructor.
void	getPrimalOutputs (VecY &locY, bool reg)
	Store the primal values from the CoDiPack vector into the user vector.
void	setPrimalInputs (VecX const &locX, bool reg)
	Set the primal values from the user provided vector into the CoDiPack ones.
Public Member Functions inherited from codi::EvaluationHandleBase< T_Func, T_Type, T_InputStore, T_OutputStore >
void	computeHessian (VecX const &locX, Hes &hes, VecY &locY, Jac &jac)
	Perform a Hessian evaluation with the inputs provided in locX and store the result in hes, jac and locY.
void	computeJacobian (VecX const &locX, Jac &jac, VecY &locY)
	Perform a Jacobian evaluation with the inputs provided in locX and store the result in jac and locY.
void	computePrimal (VecX const &locX, VecY &locY)
	Perform a primal evaluation with the inputs provided in locX and store the result in locY.
	EvaluationHandleBase (Func &func, size_t m, size_t n)
	Constructor.
Protected Member Functions inherited from codi::EvaluationHandleReverseBase< T_Func, T_Type, T_InputStore, T_OutputStore >
void	recordTape (VecX const &locX, VecY &locY)
	Helper function that records a new tape.
Protected Member Functions inherited from codi::EvaluationHandleBase< T_Func, T_Type, T_InputStore, T_OutputStore >
void	eval ()
	Helper for the evaluation of the function object with the internal input and output vector.
void	getPrimalOutputs (VecY &locY)
	Store the primal values from the CoDiPack vector into the user vector.
void	setPrimalInputs (VecX const &locX)
	Set the primal values from the user provided vector into the CoDiPack ones.
Protected Attributes inherited from codi::EvaluationHandleReverseBase< T_Func, T_Type, T_InputStore, T_OutputStore >
TapeHelper< Type >	th
	Manages the evaluations.
Protected Attributes inherited from codi::EvaluationHandleBase< T_Func, T_Type, T_InputStore, T_OutputStore >
DummyJacobian	dummyJacobian
	Used if no output is required.
DummyVector	dummyVector
	Used if no output is required.
Func &	func
	The function object for the evaluations.
size_t	m
	Size of the output vector.
size_t	n
	Size of the input vector.
InputStore	x
	Storage for the input arguments.
OutputStore	y
	Storage for the output arguments.

Detailed Description

template<typename T_Func, typename T_Type, typename T_InputStore, typename T_OutputStore>
struct codi::EvaluationHandle< T_Func, T_Type, T_InputStore, T_OutputStore, TapeTraits::EnableIfPrimalValueTape< typename T_Type::Tape > >

See EvaluationHandleReversePrimalValueTapes.

---

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

• include/codi/tools/helpers/evaluationHelper.hpp