ADMB Documentation  -a65f1c97
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | Private Attributes | List of all members
DF_FILE Class Reference

Stores the adjoint gradient data that will be processed by gradcalc. More...

#include <gradient_structure.h>

Public Member Functions

 DF_FILE ()
 Default uses gradient_structure::CMPDIF_BUFFER_SIZE. More...
 
 DF_FILE (const DF_FILE &)=delete
 Do not allow copy contructor. More...
 
 DF_FILE (const size_t nbytes)
 User defined size with default id. More...
 
 DF_FILE (const size_t nbytes, const unsigned int id)
 Constructor to allocate buffer and storage output file. More...
 
 ~DF_FILE ()
 Destructor. More...
 
void fread (void *s, const size_t num_bytes)
 Reads num_bytes from buffer and copies to s. More...
 
void fread (const int &)
 Read _x from buffer. More...
 
void fread (const double &)
 Description not yet available. More...
 
void fread (void *&ptr)
 Description not yet available. More...
 
void fwrite (const void *s, const size_t num_bytes)
 Reads num_bytes from s and writes to buffer. More...
 
void fwrite (const int &)
 Write _x to buffer. More...
 
void fwrite (double)
 Description not yet available. More...
 
void fwrite (void *ptr)
 Description not yet available. More...
 
DF_FILEoperator= (const DF_FILE &)=delete
 Do not allow assignment operator. More...
 
void read_cmpdif_stack_buffer (OFF_T &lpos)
 Description not yet available. More...
 
d3_array_position restore_d3_array_position ()
 
d3_array restore_d3_array_value (const d3_array_position &mpos)
 
dmatrix_position restore_dmatrix_position ()
 
dmatrix restore_dmatrix_value (const dmatrix_position &mpos)
 
double restore_double_value ()
 
dvar_matrix_position restore_dvar_matrix_position ()
 
dmatrix restore_dvar_matrix_value (const dvar_matrix_position &mpos)
 
dvar_vector_position restore_dvar_vector_position ()
 
dvector restore_dvar_vector_value (const dvar_vector_position &tmp)
 
dvector_position restore_dvector_position ()
 
dvector restore_dvector_value (const dvector_position &tmp)
 
imatrix_position restore_imatrix_position ()
 
imatrix restore_imatrix_value (const imatrix_position &mpos)
 
int restore_int_value ()
 
ivector_position restore_ivector_position ()
 
ivector restore_ivector_value (const ivector_position &tmp)
 
void * restore_pointer_value ()
 
double restore_prevariable_derivative ()
 
prevariable_position restore_prevariable_position ()
 
double restore_prevariable_value ()
 
void save_d3_array_position (const d3_array &a)
 
void save_d3_array_value (const d3_array &a)
 
void save_dmatrix_position (const dmatrix &m)
 
void save_dmatrix_value (const dmatrix &m)
 
void save_double_value (double x)
 
void save_dvar_matrix_position (const dvar_matrix &m)
 
void save_dvar_matrix_value (const dvar_matrix &m)
 
void save_dvar_vector_position (const dvar_vector &v)
 
void save_dvar_vector_value (const dvar_vector &v)
 
void save_dvector_position (const dvector &v)
 
void save_dvector_value (const dvector &v)
 
void save_imatrix_position (const imatrix &m)
 
void save_imatrix_value (const imatrix &m)
 
void save_int_value (int x)
 
void save_ivector_position (const ivector &v)
 
void save_ivector_value (const ivector &v)
 
void save_pointer_value (void *ptr)
 
void save_prevariable_position (const prevariable &v)
 
void save_prevariable_value (const prevariable &v)
 
void write_cmpdif_stack_buffer ()
 Description not yet available. More...
 

Public Attributes

union {
   char   fourb [sizeof(OFF_T)]
 
   OFF_T   offset
 
}; 
 
char * buff
 
char cmpdif_file_name [81]
 
int file_ptr
 
OFF_T toffset
 

Private Attributes

OFF_T buff_end
 
size_t buff_size
 

Detailed Description

Stores the adjoint gradient data that will be processed by gradcalc.

Definition at line 283 of file gradient_structure.h.

Constructor & Destructor Documentation

DF_FILE::DF_FILE ( )
inline

Default uses gradient_structure::CMPDIF_BUFFER_SIZE.

Definition at line 287 of file gradient_structure.h.

DF_FILE::DF_FILE ( const DF_FILE )
delete

Do not allow copy contructor.

DF_FILE::DF_FILE ( const size_t  nbytes)
inline

User defined size with default id.

Definition at line 291 of file gradient_structure.h.

DF_FILE::DF_FILE ( const size_t  nbytes,
const unsigned int  id 
)

Constructor to allocate buffer and storage output file.

Parameters
nbytessize of buffer
idadded to filename if greater than default zero.

Definition at line 97 of file df_file.cpp.

DF_FILE::~DF_FILE ( )

Destructor.

Definition at line 233 of file df_file.cpp.

Member Function Documentation

void DF_FILE::fread ( void *  s,
const size_t  num_bytes 
)
void DF_FILE::fread ( const int &  _x)

Read _x from buffer.

Parameters
xint to read.

Definition at line 138 of file df_file2.cpp.

void DF_FILE::fread ( const double &  _x)

Description not yet available.

Parameters

Definition at line 66 of file df_file2.cpp.

void DF_FILE::fread ( void *&  x)

Description not yet available.

Parameters

Definition at line 91 of file df_file2.cpp.

void DF_FILE::fwrite ( const void *  s,
const size_t  num_bytes 
)
void DF_FILE::fwrite ( const int &  x)

Write _x to buffer.

Parameters
xint to write.

Definition at line 162 of file df_file2.cpp.

void DF_FILE::fwrite ( double  x)

Description not yet available.

Parameters

Definition at line 114 of file df_file2.cpp.

void DF_FILE::fwrite ( void *  ptr)

Description not yet available.

Parameters

Definition at line 186 of file df_file2.cpp.

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

Do not allow assignment operator.

void DF_FILE::read_cmpdif_stack_buffer ( OFF_T lpos)

Description not yet available.

Parameters

Definition at line 328 of file df_file.cpp.

Referenced by fread(), and gradient_structure::jacobcalc().

d3_array_position DF_FILE::restore_d3_array_position ( )

Definition at line 93 of file cmpdif6.cpp.

Referenced by restore_d3_array_position().

d3_array DF_FILE::restore_d3_array_value ( const d3_array_position mpos)

Definition at line 127 of file cmpdif5.cpp.

Referenced by restore_d3_array_value().

dmatrix_position DF_FILE::restore_dmatrix_position ( )
dmatrix DF_FILE::restore_dmatrix_value ( const dmatrix_position mpos)
double DF_FILE::restore_double_value ( )
dvar_matrix_position DF_FILE::restore_dvar_matrix_position ( )
dmatrix DF_FILE::restore_dvar_matrix_value ( const dvar_matrix_position mpos)
dvar_vector_position DF_FILE::restore_dvar_vector_position ( void  )
dvector DF_FILE::restore_dvar_vector_value ( const dvar_vector_position tmp)

Definition at line 231 of file cmpdif4.cpp.

Referenced by restore_dvar_matrix_value(), and restore_dvar_vector_value().

dvector_position DF_FILE::restore_dvector_position ( )
dvector DF_FILE::restore_dvector_value ( const dvector_position tmp)
imatrix_position DF_FILE::restore_imatrix_position ( )

Definition at line 63 of file cmpdif9.cpp.

Referenced by dfempirical_covarv_partial(), and restore_imatrix_position().

imatrix DF_FILE::restore_imatrix_value ( const imatrix_position mpos)

Definition at line 89 of file cmpdif9.cpp.

Referenced by dfempirical_covarv_partial(), and restore_imatrix_value().

int DF_FILE::restore_int_value ( )
ivector_position DF_FILE::restore_ivector_position ( )
ivector DF_FILE::restore_ivector_value ( const ivector_position tmp)

Definition at line 202 of file cmpdif4.cpp.

Referenced by restore_imatrix_value(), and restore_ivector_value().

void * DF_FILE::restore_pointer_value ( )

Definition at line 216 of file cmpdif8.cpp.

Referenced by restore_pointer_value().

double DF_FILE::restore_prevariable_derivative ( void  )
prevariable_position DF_FILE::restore_prevariable_position ( void  )
double DF_FILE::restore_prevariable_value ( void  )
void DF_FILE::save_d3_array_position ( const d3_array a)

Definition at line 63 of file cmpdif6.cpp.

Referenced by d3_array::save_d3_array_position().

void DF_FILE::save_d3_array_value ( const d3_array a)

Definition at line 50 of file cmpdif5.cpp.

Referenced by d3_array::save_d3_array_value().

void DF_FILE::save_dmatrix_position ( const dmatrix m)
void DF_FILE::save_dmatrix_value ( const dmatrix m)
void DF_FILE::save_double_value ( double  x)
void DF_FILE::save_dvar_matrix_position ( const dvar_matrix m)
void DF_FILE::save_dvar_matrix_value ( const dvar_matrix m)
void DF_FILE::save_dvar_vector_position ( const dvar_vector v)
void DF_FILE::save_dvar_vector_value ( const dvar_vector v)
void DF_FILE::save_dvector_position ( const dvector v)
void DF_FILE::save_dvector_value ( const dvector v)
void DF_FILE::save_imatrix_position ( const imatrix m)

Definition at line 39 of file cmpdif9.cpp.

Referenced by empirical_covariance(), and imatrix::save_imatrix_position().

void DF_FILE::save_imatrix_value ( const imatrix m)

Definition at line 24 of file cmpdif9.cpp.

Referenced by empirical_covariance(), and imatrix::save_imatrix_value().

void DF_FILE::save_int_value ( int  x)
void DF_FILE::save_ivector_position ( const ivector v)
void DF_FILE::save_ivector_value ( const ivector v)
void DF_FILE::save_pointer_value ( void *  ptr)

Definition at line 122 of file cmpdif8.cpp.

Referenced by save_pointer_value().

void DF_FILE::save_prevariable_position ( const prevariable v)
void DF_FILE::save_prevariable_value ( const prevariable v)
void DF_FILE::write_cmpdif_stack_buffer ( void  )

Description not yet available.

Parameters

Definition at line 350 of file df_file.cpp.

Referenced by fwrite(), and gradient_structure::jacobcalc().

Member Data Documentation

union { ... }
char* DF_FILE::buff
OFF_T DF_FILE::buff_end
private
size_t DF_FILE::buff_size
private
char DF_FILE::cmpdif_file_name[81]
int DF_FILE::file_ptr
char DF_FILE::fourb[sizeof(OFF_T)]

Definition at line 303 of file gradient_structure.h.

Referenced by read_cmpdif_stack_buffer(), and write_cmpdif_stack_buffer().

OFF_T DF_FILE::offset
OFF_T DF_FILE::toffset

Definition at line 299 of file gradient_structure.h.

Referenced by DF_FILE(), fread(), fwrite(), and gradient_structure::jacobcalc().


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