codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector > Struct Template Reference

Implementation of VectorAccessInterface for adjoint and primal vectors. More...

#include <primalAdjointVectorAccess.hpp>

Inheritance diagram for codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >:

Public Types
using	AdjointVector = T_AdjointVector
	See PrimalAdjointVectorAccess.
using	Base = AdjointVectorAccess<Real, Identifier, AdjointVector>
	Base class abbreviation.
using	Gradient = AdjointVectorTraits::Gradient<T_AdjointVector>
	Adjoint vector entry type.
using	Identifier = T_Identifier
	See PrimalAdjointVectorAccess.
using	Real = T_Real
	See PrimalAdjointVectorAccess.
Public Types inherited from codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >
using	AdjointVector = T_AdjointVector
	See AdjointVectorAccess.
using	Gradient = AdjointVectorTraits::Gradient<T_AdjointVector>
	Adjoint vector entry type.
using	Identifier = T_Identifier
	See AdjointVectorAccess.
using	Real = T_Real
	See AdjointVectorAccess.
Public Types inherited from codi::VectorAccessInterface< T_Real, T_Identifier >
using	Identifier = T_Identifier
	See VectorAccessInterface.
using	Real = T_Real
	See VectorAccessInterface.

Public Member Functions
	PrimalAdjointVectorAccess (AdjointVector adjointVector, Real *primalVector)
	Constructor. See interface documentation for details about the vectors.
Misc
VectorAccessInterface< Real, Identifier > *	clone () const
Primal access
void	setPrimal (Identifier const &index, Real const &primal)
	Set the primal value.
Real	getPrimal (Identifier const &index)
	Get the primal value.
bool	hasPrimals ()
	True if the tape/vector interface has primal values.
Public Member Functions inherited from codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >
	AdjointVectorAccess (AdjointVector adjointVector)
	Constructor. See interface documentation for details about the adjoint vector.
size_t	getVectorSize () const
	Vector size in the current tape evaluation.
bool	isLhsZero ()
	True if the adjoint set with setLhsAdjoint is zero.
void	setLhsAdjoint (Identifier const &index)
void	updateAdjointWithLhs (Identifier const &index, Real const &jacobian)
void	setLhsTangent (Identifier const &index)
void	updateTangentWithLhs (Identifier const &index, Real const &jacobian)
void	resetAdjoint (Identifier const &index, size_t dim)
	Set the adjoint component to zero.
void	resetAdjointVec (Identifier const &index)
	Set the adjoint entry to zero.
Real	getAdjoint (Identifier const &index, size_t dim)
	Get the adjoint component.
void	getAdjointVec (Identifier const &index, Real *const vec)
	Get the adjoint entry.
Real const *	getAdjointVec (Identifier const &index)
	Get the adjoint entry.
void	updateAdjoint (Identifier const &index, size_t dim, Real const &adjoint)
	Update the adjoint component.
void	updateAdjointVec (Identifier const &index, Real const *const vec)
	Update the adjoint entry.
Public Member Functions inherited from codi::VectorAccessInterface< T_Real, T_Identifier >
virtual	~VectorAccessInterface ()
	Destructor.

Additional Inherited Members
Protected Attributes inherited from codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >
AdjointVector	adjointVector
	Pointer/reference to an array-accessible collection of gradients.

Detailed Description

template<typename T_Real, typename T_Identifier, typename T_AdjointVector>
struct codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >

Implementation of VectorAccessInterface for adjoint and primal vectors.

Both vectors are used as is, they are assumed to have correct sizes. No bounds checking is performed.

Inherits from AdjointVectorAccess and overwrites all methods specific to the primals.

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_AdjointVector	Either a pointer type, for example Gradient*, or a reference to something that can be accessed like a gradient array, for example std::vector<Gradient>&.

Member Function Documentation

clone()

template<typename T_Real , typename T_Identifier , typename T_AdjointVector >

VectorAccessInterface< Real, Identifier > * codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::clone ( ) const

inlinevirtual

Obtain a heap-allocated copy of the vector access inter- face. The user is responsible for deleting the pointer.

Reimplemented from codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >.

getPrimal()

template<typename T_Real , typename T_Identifier , typename T_AdjointVector >

Real codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::getPrimal ( Identifier const & index )

inlinevirtual

Get the primal value.

Reimplemented from codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >.

hasPrimals()

template<typename T_Real , typename T_Identifier , typename T_AdjointVector >

bool codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::hasPrimals ( )

inlinevirtual

True if the tape/vector interface has primal values.

Implementation: Always returns true.

Reimplemented from codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >.

setPrimal()

template<typename T_Real , typename T_Identifier , typename T_AdjointVector >

void codi::PrimalAdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >::setPrimal ( Identifier const & index, Real const & primal )

inlinevirtual

Set the primal value.

Reimplemented from codi::AdjointVectorAccess< T_Real, T_Identifier, T_AdjointVector >.

---

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

• include/codi/tapes/misc/primalAdjointVectorAccess.hpp