Differentiation::AD::types Namespace Reference

Typedefs
using	tape_index = unsigned short
using	tape_buffer_sizes = unsigned int

Variables
static const types::tape_index	invalid_tape_index = 0
static const types::tape_index	max_tape_index = TBUFNUM

Detailed Description

A collection of types used within the context of auto-differentiable numbers.

Typedef Documentation

using Differentiation::AD::types::tape_index = typedef unsigned short

Typedef for tape indices. ADOL-C uses short integers, so we restrict outselves to similar types.

Definition at line 104 of file ad_drivers.h.

using Differentiation::AD::types::tape_buffer_sizes = typedef unsigned int

Typedef for tape buffer sizes.

Definition at line 109 of file ad_drivers.h.

Variable Documentation

const types::tape_index Differentiation::AD::types::invalid_tape_index = 0

static

A tape index that is unusable and can be used to invalidate recording operations.

Note

ADOL-C doesn't allow us to record to this reserved tape (i.e. can't write it to file), so we can safely use it as an invalidation case. In general, we want the user to be able to record to a tape if they'd like.

Definition at line 120 of file ad_drivers.h.

const types::tape_index Differentiation::AD::types::max_tape_index = TBUFNUM

static

The maximum number of tapes that can be written on one process.

Definition at line 131 of file ad_drivers.h.