CoDiPack  3.0.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
codi::ReuseIndexManagerBase< T_Index, T_Impl > Struct Template Reference

Identifiers are reused. Freed identifiers are assigned to new variables. Variables keep their indices as long as they are active. More...

#include <reuseIndexManagerBase.hpp>

Inheritance diagram for codi::ReuseIndexManagerBase< T_Index, T_Impl >:

Public Types

using Base = IndexManagerInterface<Index>
 Base class abbreviation.
 
using Impl = T_Impl
 See ReuseIndexManagerBase.
 
using Index = T_Index
 See ReuseIndexManagerBase.
 
using Position = EmptyData::Position
 See EmptyData.
 
- Public Types inherited from codi::IndexManagerInterface< T_Index >
using Index = T_Index
 See IndexManagerInterface.
 
- Public Types inherited from codi::EmptyData
using InternalPosHandle = size_t
 Will always be zero.
 
using NestedData = void
 No nested data.
 
using Position = EmptyPosition
 No positional data.
 
- Public Types inherited from codi::DataInterface< T_NestedData, T_InternalPosHandle >
using InternalPosHandle = T_InternalPosHandle
 See DataInterface.
 
using NestedData = T_NestedData
 See DataInterface.
 
using Position = EmptyPosition
 Contains position data for this DataInterface and all nested interfaces.
 

Public Member Functions

 ReuseIndexManagerBase ()
 
 ~ReuseIndexManagerBase ()
 Destructor.
 
IndexManagerInterface: Methods
template<typename Tape>
inlinebool assignIndex (Index &index)
 Call on assignment of a primal value, e.g. on w for w = a + b.
 
template<typename Tape>
inlinebool assignUnusedIndex (Index &index)
 Call on registering input values.
 
template<typename Tape>
inlinevoid copyIndex (Index &lhs, Index const &rhs)
 Call on copy of a primal value, e.g. w = a.
 
template<typename Tape>
inlinevoid freeIndex (Index &index)
 Call on destruction of a primal value. Usually called from the destructor.
 
void updateLargestCreatedIndex (Index const &index)
 Update the largest generated index.
 
inlinevoid reset ()
 Reset for a new recording.
 
void addToTapeValues (TapeValues &values) const
 Add storage and other information to the tape values.


 
- Public Member Functions inherited from codi::IndexManagerInterface< T_Index >
void addToTapeValues (TapeValues &values) const
 Add storage and other information to the tape values.
 
Index getLargestCreatedIndex () const
 Returns the largest created index.
 
template<typename Tape>
bool assignIndex (Index &index)
 Call on assignment of a primal value, e.g. on w for w = a + b.
 
void updateLargestCreatedIndex (Index const &index)
 Update the largest generated index.
 
template<typename Tape>
bool assignUnusedIndex (Index &index)
 Call on registering input values.
 
template<typename Tape>
void copyIndex (Index &lhs, Index const &rhs)
 Call on copy of a primal value, e.g. w = a.
 
template<typename Tape>
void freeIndex (Index &index)
 Call on destruction of a primal value. Usually called from the destructor.
 
void reset ()
 Reset for a new recording.
 
- Public Member Functions inherited from codi::EmptyData
inlinevoid pushData ()
 Add data to the storage allocated by the implementation. The method can only be called after a call to reserveItems and only as often as the number of reserved items.
 
inlinevoid getDataPointers ()
 Get pointers to the data from the storage implementation. The method can only be called after a call to reserveItems() and data can only be accessed from 0 to the number given by reserveItems (excluding). Afterwards, addDataSize() needs to be called with the actual number of elements that have been written.
 
inlinevoid addDataSize (size_t size)
 Add this many items to the data stream, after the data has been manipulated via pointers obtained from getDataPointers().
 
inlineInternalPosHandle reserveItems (size_t const &items)
 Reserve this many items on the data stream. See pushData for details.
 
void resize (size_t const &totalSize)
 
void reset ()
 
void resetHard ()
 
void resetTo (Position const &pos)
 
void erase (Position const &start, Position const &end, bool recursive=true)
 
inlinesize_t getDataSize () const
 
inlinePosition getPosition () const
 
inlinesize_t getPushedDataCount (InternalPosHandle const &startPos)
 
inlinePosition getZeroPosition () const
 
void addToTapeValues (TapeValues &values) const
 Add amount of stored data to the TapeValues object. Not called on the nested vector.
 
template<typename = void>
inlinePosition extractPosition (Position const &pos) const
 Extract the position of a nested DataInterface from the global position object provide by this interface.
 
void setNested (NestedData *v)
 


 
void swap (DataInterface &other)
 
template<int selectedDepth = -1, typename FunctionObject, typename... Args>
inlinevoid evaluateForward (Position const &start, Position const &end, FunctionObject function, Args &&... args)
 Evaluates the function object with segments of continuous and valid data for all nested DataInterfaces.


 
template<int selectedDepth = -1, typename FunctionObject, typename... Args>
inlinevoid evaluateReverse (Position const &start, Position const &end, FunctionObject function, Args &&... args)
 Evaluates the function object with segments of continuous and valid data for all nested DataInterfaces.




 
template<typename FunctionObject, typename... Args>
inlinevoid forEachChunk (FunctionObject &function, bool recursive, Args &&... args)
 Calls the function object for each continuous segment of data.
 
template<typename FunctionObject, typename... Args>
inlinevoid forEachForward (Position const &start, Position const &end, FunctionObject function, Args &&... args)
 Calls the function object for each item in the data stream. This call is not recursive.
 
template<typename FunctionObject, typename... Args>
inlinevoid forEachReverse (Position const &start, Position const &end, FunctionObject function, Args &&... args)
 Calls the function object for each item in the data stream. This call is not recursive.
 
- Public Member Functions inherited from codi::DataInterface< T_NestedData, T_InternalPosHandle >
inlinevoid addDataSize (size_t const &size)
 Add this many items to the data stream, after the data has been manipulated via pointers obtained from getDataPointers().
 
template<typename... Data>
inlinevoid getDataPointers (Data *&... pointers)
 Get pointers to the data from the storage implementation. The method can only be called after a call to reserveItems() and data can only be accessed from 0 to the number given by reserveItems (excluding). Afterwards, addDataSize() needs to be called with the actual number of elements that have been written.
 
template<typename... Data>
inlinevoid pushData (Data const &... data)
 Add data to the storage allocated by the implementation. The method can only be called after a call to reserveItems and only as often as the number of reserved items.
 
inlineInternalPosHandle reserveItems (size_t const &items)
 Reserve this many items on the data stream. See pushData for details.
 
void resize (size_t const &totalSize)
 
void reset ()
 
void resetHard ()
 
void resetTo (Position const &pos)
 
void erase (Position const &start, Position const &end, bool recursive=true)
 
inlinesize_t getDataSize () const
 
inlinePosition getPosition () const
 
inlinesize_t getPushedDataCount (InternalPosHandle const &startPos)
 
inlinePosition getZeroPosition () const
 
void addToTapeValues (TapeValues &values) const
 Add amount of stored data to the TapeValues object. Not called on the nested vector.
 
template<typename TargetPosition>
inlineTargetPosition extractPosition (Position const &pos) const
 Extract the position of a nested DataInterface from the global position object provide by this interface.
 
void setNested (NestedData *v)
 
void swap (DataInterface &other)
 
template<int selectedDepth = -1, typename FunctionObject, typename... Args>
inlinevoid evaluateForward (Position const &start, Position const &end, FunctionObject function, Args &&... args)
 Evaluates the function object with segments of continuous and valid data for all nested DataInterfaces.
 
template<int selectedDepth = -1, typename FunctionObject, typename... Args>
inlinevoid evaluateReverse (Position const &start, Position const &end, FunctionObject function, Args &&... args)
 Evaluates the function object with segments of continuous and valid data for all nested DataInterfaces.
 
template<typename FunctionObject, typename... Args>
inlinevoid forEachChunk (FunctionObject &function, bool recursive, Args &&... args)
 Calls the function object for each continuous segment of data.
 
template<typename FunctionObject, typename... Args>
inlinevoid forEachForward (Position const &start, Position const &end, FunctionObject function, Args &&... args)
 Calls the function object for each item in the data stream. This call is not recursive.
 
template<typename FunctionObject, typename... Args>
inlinevoid forEachReverse (Position const &start, Position const &end, FunctionObject function, Args &&... args)
 Calls the function object for each item in the data stream. This call is not recursive.
 

Static Public Attributes

IndexManagerInterface: Constants
static bool constexpr CopyNeedsStatement = true
 No copy optimization is implemented.
 
static bool constexpr IsLinear = false
 Identifiers are not coupled to statements.
 
static bool constexpr NeedsStaticStorage = true
 Identifiers are managed globally.
 
- Static Public Attributes inherited from codi::IndexManagerInterface< T_Index >
static Index constexpr InactiveIndex = Index(0)
 Default inactive index for all index managers.
 
static Index constexpr InvalidIndex
 Default invalid index for all index mangers (max value for unsigned types).
 
static bool constexpr CopyNeedsStatement
 True if no copy optimization is implemented. See IndexManagerInterface.
 
static bool constexpr IsLinear
 True if identifiers are coupled to the statements. See IndexManagerInterface.
 
static bool constexpr NeedsStaticStorage = false
 True if the index manager is specific to a tape type (and not a tape instance). See IndexManagerInterface.
 

Protected Attributes

size_t indexSizeIncrement
 Block size for index pool enlargement.
 
std::vector< IndexunusedIndices
 Pool of indices that have not been used in this recording yet.
 
size_t unusedIndicesPos
 Number of remaining unused indices.
 
std::vector< IndexusedIndices
 Pool of indices that have already been used in this recording.
 
size_t usedIndicesPos
 Number of remaining used indices.
 
bool valid
 Prevent index free after destruction.
 

Detailed Description

template<typename T_Index, typename T_Impl>
struct codi::ReuseIndexManagerBase< T_Index, T_Impl >

Identifiers are reused. Freed identifiers are assigned to new variables. Variables keep their indices as long as they are active.

This index manager does not implement a copy optimization. Therefore, every copy operation needs a statement, but variables will keep their identifier as long as they are active.

Mathematical and implementational details are explained in SBG2021Index.

For generalization reasons, it also extends from the EmptyData DataInterface.

This class contains the basic logic for index reuse. The implementing class has to add a mechanism to generate new indices.

Template Parameters
T_IndexType for the identifier, usually an integer type.
T_ImplImplementing class.

Constructor & Destructor Documentation

◆ ReuseIndexManagerBase()

template<typename T_Index, typename T_Impl>
codi::ReuseIndexManagerBase< T_Index, T_Impl >::ReuseIndexManagerBase ( )
inline

Constructor The constructor of the implementing class is expected to call generateNewIndices.

Member Function Documentation

◆ addToTapeValues()

template<typename T_Index, typename T_Impl>
void codi::ReuseIndexManagerBase< T_Index, T_Impl >::addToTapeValues ( TapeValues & values) const
inline

Add storage and other information to the tape values.

Parameters
[in,out]valuesWill only create new data entries and no new section.

Implementation: Adds indices stored, memory used, memory allocated.

◆ assignIndex()

template<typename T_Index, typename T_Impl>
template<typename Tape>
inlinebool codi::ReuseIndexManagerBase< T_Index, T_Impl >::assignIndex ( Index & index)
inline

Call on assignment of a primal value, e.g. on w for w = a + b.

Returns
true if new indices have been generated internally.

◆ assignUnusedIndex()

template<typename T_Index, typename T_Impl>
template<typename Tape>
inlinebool codi::ReuseIndexManagerBase< T_Index, T_Impl >::assignUnusedIndex ( Index & index)
inline

Call on registering input values.

Returns
true if new indices have been generated internally.

◆ copyIndex()

template<typename T_Index, typename T_Impl>
template<typename Tape>
inlinevoid codi::ReuseIndexManagerBase< T_Index, T_Impl >::copyIndex ( Index & lhs,
Index const & rhs )
inline

Call on copy of a primal value, e.g. w = a.

◆ freeIndex()

template<typename T_Index, typename T_Impl>
template<typename Tape>
inlinevoid codi::ReuseIndexManagerBase< T_Index, T_Impl >::freeIndex ( Index & index)
inline

Call on destruction of a primal value. Usually called from the destructor.

◆ reset()

template<typename T_Index, typename T_Impl>
inlinevoid codi::ReuseIndexManagerBase< T_Index, T_Impl >::reset ( )
inline

Reset for a new recording.

◆ updateLargestCreatedIndex()

template<typename T_Index, typename T_Impl>
void codi::ReuseIndexManagerBase< T_Index, T_Impl >::updateLargestCreatedIndex ( Index const & index)
inline

Update the largest generated index.


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