ADOL-C: Automatic Differentiation in C/C++ 2.7.3
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
TapeInfos Struct Reference

Identity, statistics, file names, and recording metadata of one tape. More...

#include <tapeinfos.h>

Collaboration diagram for TapeInfos:
Collaboration graph
[legend]

Public Types

enum  StatEntries {
  NUM_INDEPENDENTS , NUM_DEPENDENTS , NUM_MAX_LIVES , NUM_TAYS ,
  OP_BUFFER_SIZE , NUM_OPERATIONS , OP_FILE_ACCESS , NUM_LOCATIONS ,
  LOC_FILE_ACCESS , NUM_VALUES , VAL_FILE_ACCESS , LOC_BUFFER_SIZE ,
  VAL_BUFFER_SIZE , TAY_BUFFER_SIZE , NUM_EQ_PROD , NO_MIN_MAX ,
  NUM_SWITCHES , NUM_PARAM , STAT_SIZE
}
 
enum  FILES { OPERATIONS_FILE , LOCATIONS_FILE , VALUES_FILE , TAYLORS_FILE }
 
enum  TAPENAMES { LOCATIONS_TAPE , VALUES_TAPE , OPERATIONS_TAPE , TAYLORS_TAPE }
 
using StatArray = std::array< size_t, STAT_SIZE >
 

Public Member Functions

 ~TapeInfos ()
 
 TapeInfos ()=default
 
 TapeInfos (short tapeId)
 
 TapeInfos (short tapeId, std::array< std::string, 4 > &&tapeBaseNames)
 
 TapeInfos (const TapeInfos &)=delete
 
TapeInfos & operator= (const TapeInfos &)=delete
 
 TapeInfos (TapeInfos &&other) noexcept
 
TapeInfos & operator= (TapeInfos &&other) noexcept
 
int getThreadIndex ()
 Generates an id for the thread within the function is called.
 
char * createFileName (short tapeId, int tapeType)
 

Static Public Member Functions

static char * duplicatestr (const char *instr)
 

Public Attributes

StatArray stats {}
 
std::array< char *, 4 > fileNames {}
 
std::array< std::string, 4 > tapeBaseNames_
 
short tapeId_ {-1}
 
int keepTape {0}
 
int skipFileCleanup {0}
 

Static Public Attributes

static constexpr size_t maxLocsPerOp {10}
 

Detailed Description

Identity, statistics, file names, and recording metadata of one tape.

This movable metadata object records buffer sizes, independent/dependent counts, file-backed tape names, trace flags, and related configuration. Buffer ownership and evaluation synchronization live in ValueTape and its recording/evaluation contexts instead.

Member Typedef Documentation

◆ StatArray

using TapeInfos::StatArray = std::array<size_t, STAT_SIZE>

Member Enumeration Documentation

◆ FILES

Enumerator
OPERATIONS_FILE 
LOCATIONS_FILE 
VALUES_FILE 
TAYLORS_FILE 

◆ StatEntries

Enumerator
NUM_INDEPENDENTS 
NUM_DEPENDENTS 
NUM_MAX_LIVES 
NUM_TAYS 
OP_BUFFER_SIZE 
NUM_OPERATIONS 
OP_FILE_ACCESS 
NUM_LOCATIONS 
LOC_FILE_ACCESS 
NUM_VALUES 
VAL_FILE_ACCESS 
LOC_BUFFER_SIZE 
VAL_BUFFER_SIZE 
TAY_BUFFER_SIZE 
NUM_EQ_PROD 
NO_MIN_MAX 
NUM_SWITCHES 
NUM_PARAM 
STAT_SIZE 

◆ TAPENAMES

Enumerator
LOCATIONS_TAPE 
VALUES_TAPE 
OPERATIONS_TAPE 
TAYLORS_TAPE 

Constructor & Destructor Documentation

◆ ~TapeInfos()

TapeInfos::~TapeInfos ( )
inline

◆ TapeInfos() [1/5]

TapeInfos::TapeInfos ( )
default

◆ TapeInfos() [2/5]

TapeInfos::TapeInfos ( short  tapeId)
inlineexplicit

◆ TapeInfos() [3/5]

TapeInfos::TapeInfos ( short  tapeId,
std::array< std::string, 4 > &&  tapeBaseNames 
)
inline

◆ TapeInfos() [4/5]

TapeInfos::TapeInfos ( const TapeInfos &  )
delete

◆ TapeInfos() [5/5]

TapeInfos::TapeInfos ( TapeInfos &&  other)
inlinenoexcept

Member Function Documentation

◆ createFileName()

char * TapeInfos::createFileName ( short  tapeId,
int  tapeType 
)
inline

◆ duplicatestr()

static char * TapeInfos::duplicatestr ( const char *  instr)
inlinestatic

◆ getThreadIndex()

int TapeInfos::getThreadIndex ( )
inline

Generates an id for the thread within the function is called.

Returns
id of the current thread

◆ operator=() [1/2]

TapeInfos & TapeInfos::operator= ( const TapeInfos &  )
delete

◆ operator=() [2/2]

TapeInfos & TapeInfos::operator= ( TapeInfos &&  other)
inlinenoexcept

Member Data Documentation

◆ fileNames

std::array<char *, 4> TapeInfos::fileNames {}

◆ keepTape

int TapeInfos::keepTape {0}

◆ maxLocsPerOp

constexpr size_t TapeInfos::maxLocsPerOp {10}
staticconstexpr

◆ skipFileCleanup

int TapeInfos::skipFileCleanup {0}

◆ stats

StatArray TapeInfos::stats {}

◆ tapeBaseNames_

std::array<std::string, 4> TapeInfos::tapeBaseNames_

◆ tapeId_

short TapeInfos::tapeId_ {-1}

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