CppAD: A C++ Algorithmic Differentiation Package  20171217
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
CppAD::local::player< Base > Class Template Reference

Class used to store and play back an operation sequence recording. More...

Public Member Functions

void check_dag (void)
 Check arguments that are variables, to make sure the have value less than or equal to the previously created variable. More...
 
void check_inv_op (size_t n_ind)
 Check that InvOp operators start with second operator and are contiguous, and there are n_ind of them. More...
 
void Erase (void)
 Erase the recording stored in the player. More...
 
void get (recorder< Base > &rec, size_t n_ind)
 Moving an operation sequence from a recorder to this player. More...
 
void get_op_info (size_t op_index, OpCode &op, const addr_t *&op_arg, size_t &var_index) const
 fetch the information corresponding to an operator More...
 
atomic_base< Base > * get_user_info (const OpCode op, const addr_t *op_arg, size_t &user_old, size_t &user_m, size_t &user_n) const
 unpack extra information corresponding to a UserOp More...
 
OpCode GetOp (size_t i) const
 fetch an operator from the recording. More...
 
Base GetPar (size_t i) const
 Fetch a parameter from the recording. More...
 
const Base * GetPar (void) const
 Fetch entire parameter vector from the recording. More...
 
const char * GetTxt (size_t i) const
 Fetch a '\0' terminated string from the recording. More...
 
size_t GetVecInd (size_t i) const
 Fetch a VecAD index from the recording. More...
 
size_t Memory (void) const
 Fetch a rough measure of amount of memory used to store recording using just lengths, not capacities; see the heading size_op_arg in the file seq_property.omh. More...
 
size_t num_load_op_rec (void) const
 Fetch number of vecad load operations. More...
 
size_t num_op_arg_rec (void) const
 Fetch number of argument indices in the recording. More...
 
size_t num_op_rec (void) const
 Fetch number of operators in the recording. More...
 
size_t num_par_rec (void) const
 Fetch number of parameters in the recording. More...
 
size_t num_text_rec (void) const
 Fetch number of characters (representing strings) in the recording. More...
 
size_t num_var_rec (void) const
 Fetch number of variables in the recording. More...
 
size_t num_vec_ind_rec (void) const
 Fetch number of VecAD indices in the recording. More...
 
size_t num_vecad_vec_rec (void) const
 Fetch number of VecAD vectors in the recording. More...
 
void operator= (const player &play)
 Copying an operation sequence from another player to this one. More...
 
 player (void)
 constructor More...
 
size_t var2op (size_t var_index) const
 fetch the operator corresponding to a primary variable More...
 
 ~player (void)
 destructor More...
 

Private Attributes

pod_vector< addr_targ_vec_
 The operation argument indices in the recording. More...
 
size_t num_load_op_rec_
 number of vecad load opeations in the reconding More...
 
size_t num_var_rec_
 Number of variables in the recording. More...
 
size_t num_vecad_vec_rec_
 Number of VecAD vectors in the recording. More...
 
pod_vector< addr_top2arg_vec_
 index in arg_vec_ corresonding to the first argument for each operator More...
 
pod_vector< addr_top2var_vec_
 Index of the result variable for each operator. More...
 
pod_vector< OpCodeop_vec_
 The operators in the recording. More...
 
pod_vector< Base > par_vec_
 The parameters in the recording. Note that Base may not be plain old data, so use false in consructor. More...
 
pod_vector< char > text_vec_
 Character strings ('\0' terminated) in the recording. More...
 
pod_vector< addr_tvar2op_vec_
 Mapping from primary variable index to corresponding operator index. This is used to traverse sub-graphs of the operation sequence. This value is valid (invalid) for primary (auxillary) variables. More...
 
pod_vector< addr_tvecad_ind_vec_
 The VecAD indices in the recording. More...
 

Detailed Description

template<class Base>
class CppAD::local::player< Base >

Class used to store and play back an operation sequence recording.

Template Parameters
BaseThese were AD< Base > operations when recorded. Operations during playback are done using the type Base .

Definition at line 27 of file declare_ad.hpp.


The documentation for this class was generated from the following files: