ADOLC::CP::detail::Infos Struct Reference

Internal checkpointing state shared between the public context and the recorded external function. More...

#include <checkpointing.h>

Collaboration diagram for ADOLC::CP::detail::Infos:

Public Member Functions
	~Infos ()
void	takeSnapshot ()
	Save the current checkpoint state on the internal stack.
void	restore ()
	Restore the current checkpoint state from the top of the stack.
void	release ()
	Drop the most recent checkpoint snapshot.
void	clearStack ()
	Free all stored checkpoint snapshots.
void	tapeStep (int keep) const
	Tape one time step at the current internal state.
void	revolveForward (int keep)
	Run the forward checkpoint schedule for the current state.
void	revolveError ()
	Raise an ADOL-C error for the current revolve status code.

Public Attributes
short	tapeId {0}
TimeStepFunction *	function {nullptr}
TimeStepFunctionDouble *	function_double {nullptr}
SaveFunction *	saveNonAdoubles {nullptr}
RestoreFunction *	restoreNonAdoubles {nullptr}
int	steps {0}
int	checkpoints {0}
short	cpTapeId {0}
bool	retaping {0}
int	dim {0}
adouble *	adp_x {nullptr}
adouble *	adp_y {nullptr}
int	check {0}
int	capo {0}
int	fine {0}
int	info {0}
int	currentCP {0}
double *	dp_internal_for {nullptr}
size_t	index {0}
char *	allmem {nullptr}
std::stack< StackElement >	cpStack

Detailed Description

Internal checkpointing state shared between the public context and the recorded external function.

User code should configure checkpointing through Context instead of touching this struct directly.

Constructor & Destructor Documentation

~Infos()

ADOLC::CP::detail::Infos::~Infos ( )

inline

Member Function Documentation

clearStack()

void ADOLC::CP::detail::Infos::clearStack

(

)

Free all stored checkpoint snapshots.

release()

void ADOLC::CP::detail::Infos::release

(

)

Drop the most recent checkpoint snapshot.

restore()

void ADOLC::CP::detail::Infos::restore

(

)

Restore the current checkpoint state from the top of the stack.

revolveError()

void ADOLC::CP::detail::Infos::revolveError

(

)

Raise an ADOL-C error for the current revolve status code.

revolveForward()

void ADOLC::CP::detail::Infos::revolveForward

(

int

keep

)

Run the forward checkpoint schedule for the current state.

takeSnapshot()

void ADOLC::CP::detail::Infos::takeSnapshot

(

)

Save the current checkpoint state on the internal stack.

tapeStep()

void ADOLC::CP::detail::Infos::tapeStep

(

int

keep

)

const

Tape one time step at the current internal state.

Member Data Documentation

adp_x

adouble* ADOLC::CP::detail::Infos::adp_x {nullptr}

adp_y

adouble* ADOLC::CP::detail::Infos::adp_y {nullptr}

allmem

char* ADOLC::CP::detail::Infos::allmem {nullptr}

capo

int ADOLC::CP::detail::Infos::capo {0}

check

int ADOLC::CP::detail::Infos::check {0}

checkpoints

int ADOLC::CP::detail::Infos::checkpoints {0}

cpStack

std::stack<StackElement> ADOLC::CP::detail::Infos::cpStack

cpTapeId

short ADOLC::CP::detail::Infos::cpTapeId {0}

currentCP

int ADOLC::CP::detail::Infos::currentCP {0}

dim

int ADOLC::CP::detail::Infos::dim {0}

dp_internal_for

double* ADOLC::CP::detail::Infos::dp_internal_for {nullptr}

fine

int ADOLC::CP::detail::Infos::fine {0}

function

TimeStepFunction* ADOLC::CP::detail::Infos::function {nullptr}

function_double

TimeStepFunctionDouble* ADOLC::CP::detail::Infos::function_double {nullptr}

index

size_t ADOLC::CP::detail::Infos::index {0}

info

int ADOLC::CP::detail::Infos::info {0}

restoreNonAdoubles

RestoreFunction* ADOLC::CP::detail::Infos::restoreNonAdoubles {nullptr}

retaping

bool ADOLC::CP::detail::Infos::retaping {0}

saveNonAdoubles

SaveFunction* ADOLC::CP::detail::Infos::saveNonAdoubles {nullptr}

steps

int ADOLC::CP::detail::Infos::steps {0}

tapeId

short ADOLC::CP::detail::Infos::tapeId {0}

---

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

• checkpointing.h