ADMB Documentation  11.2.2818
 All Classes Files Functions Variables Typedefs Friends Defines
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | Friends
grad_stack Class Reference

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions

 grad_stack ()
 Default constructor.
 ~grad_stack ()
 Destructor.
int decrement_current_gradfile_ptr (void)
 If there is a previous file set the handle to point to it otherwise return a -1.
char * get_gradfile_name ()
 Description not yet available.
int & gradfile_handle ()
void increment_current_gradfile_ptr (void)
 If there is another file set the handle to point to it otherwise we are out of room.
ostream & operator<< (grad_stack)
void print ()
int read_grad_stack_buffer (off_t &lpos)
 Description not yet available.
void set_gbuffer_pointers (void)
 Description not yet available.
void set_gradient_stack (void(*func)(void), double *dep_addr, double *ind_addr1=NULL, double mult1=0, double *ind_addr2=NULL, double mult2=0)
 Description not yet available.
void set_gradient_stack (void(*func)(void), double *dep_addr, double *ind_addr1, double *ind_addr2)
 Description not yet available.
void set_gradient_stack (void(*func)(void), double *dep_addr, double *ind_addr1, double mult1, double *ind_addr2, double mult2, double *ind_addr3, double mult3, double *ind_addr4, double mult4)
 Description not yet available.
void set_gradient_stack (void(*func)(void), double *dep_addr, double *ind_addr1, double mult1, double *ind_addr2, double mult2, double *ind_addr3, double mult3)
 Description not yet available.
void set_gradient_stack (void(*ptr)(void))
 Description not yet available.
void set_gradient_stack0 (void(*func)(void), double *dep_addr)
 Description not yet available.
void set_gradient_stack1 (void(*func)(void), double *dep_addr, double *ind_addr1)
 Sets the gradient stack entry for a function or operator with a single independent variable.
void set_gradient_stack2 (void(*func)(void), double *dep_addr, double *ind_addr1, double mult1)
 Description not yet available.
void set_gradient_stack4 (void(*func)(void), double *dep_addr, double *ind_addr1, double *ind_addr2)
 Description not yet available.
void write_grad_stack_buffer (void)
 Description not yet available.

Public Attributes

grad_stack_entryptr

Private Member Functions

void create_gradfile ()
 Description not yet available.

Private Attributes

int _GRADFILE_PTR
int _GRADFILE_PTR1
int _GRADFILE_PTR2
int _VARSSAV_PTR
off_t end_pos
off_t end_pos1
off_t end_pos2
char gradfile_name [61]
char gradfile_name1 [61]
char gradfile_name2 [61]
size_t length
grad_stack_entryptr_first
grad_stack_entryptr_last
dmatrixtable
size_t true_length
grad_stack_entrytrue_ptr_first
char var_store_file_name [61]

Friends

void cleanup_temporary_files ()
 Close gradient and variable files.
void default_evaluation (void)
 Description not yet available.
void default_evaluation3ind (void)
 Description not yet available.
void default_evaluation4ind (void)
 Description not yet available.
void funnel_gradcalc (void)
 Description not yet available.
void grad_chk (void)
 Description not yet available.
void gradcalc (int nvar, const dvector &g)
 Compute the gradient from the data stored in the global gradient_structure.
class gradient_structure
void gradloop ()
void reset_gradient_stack (void)
 Rewind buffer.
void slave_gradcalc (void)

Detailed Description

Description not yet available.

Parameters:

Definition at line 879 of file fvar.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 106 of file gradstak.cpp.

Destructor.

Definition at line 234 of file gradstak.cpp.


Member Function Documentation

void grad_stack::create_gradfile ( ) [private]

Description not yet available.

Parameters:

Definition at line 368 of file gradstak.cpp.

If there is a previous file set the handle to point to it otherwise return a -1.

Definition at line 455 of file gradstak.cpp.

Description not yet available.

Parameters:

Definition at line 479 of file gradstak.cpp.

Referenced by read_grad_stack_buffer().

Definition at line 470 of file gradstak.cpp.

Referenced by funnel_gradcalc(), and gradcalc().

If there is another file set the handle to point to it otherwise we are out of room.

Definition at line 439 of file gradstak.cpp.

ostream& grad_stack::operator<< ( grad_stack  )
int grad_stack::read_grad_stack_buffer ( off_t &  lpos)

Description not yet available.

Parameters:

Definition at line 78 of file gst_read.cpp.

Referenced by default_evaluation3ind(), default_evaluation4ind(), funnel_gradcalc(), gradcalc(), and gradient_structure::jacobcalc().

Description not yet available.

Parameters:

Definition at line 487 of file gradstak.cpp.

void grad_stack::set_gradient_stack ( void(*)(void)  func,
double *  dep_addr,
double *  ind_addr1 = NULL,
double  mult1 = 0,
double *  ind_addr2 = NULL,
double  mult2 = 0 
) [inline]
void grad_stack::set_gradient_stack ( void(*)(void)  func,
double *  dep_addr,
double *  ind_addr1,
double *  ind_addr2 
) [inline]

Description not yet available.

Parameters:

Definition at line 1118 of file fvar.hpp.

void grad_stack::set_gradient_stack ( void(*)(void)  func,
double *  dep_addr,
double *  ind_addr1,
double  mult1,
double *  ind_addr2,
double  mult2,
double *  ind_addr3,
double  mult3,
double *  ind_addr4,
double  mult4 
) [inline]

Description not yet available.

Parameters:

Definition at line 1075 of file fvar.hpp.

void grad_stack::set_gradient_stack ( void(*)(void)  func,
double *  dep_addr,
double *  ind_addr1,
double  mult1,
double *  ind_addr2,
double  mult2,
double *  ind_addr3,
double  mult3 
) [inline]

Description not yet available.

Parameters:

Definition at line 1035 of file fvar.hpp.

void grad_stack::set_gradient_stack ( void(*)(void)  func) [inline]

Description not yet available.

Parameters:

Definition at line 1199 of file fvar.hpp.

void grad_stack::set_gradient_stack0 ( void(*)(void)  func,
double *  dep_addr 
)

Description not yet available.

Parameters:

Definition at line 501 of file gradstak.cpp.

Referenced by dvariable::dvariable().

void grad_stack::set_gradient_stack1 ( void(*)(void)  func,
double *  dep_addr,
double *  ind_addr1 
)

Sets the gradient stack entry for a function or operator with a single independent variable.

Parameters:
funcPointer to function to compute the derivative of the dependent variable with respect to the independent variable. Function prototype: void func(void);
dep_addrAddress of dependent variable; pointer to double.
ind_addr1Address of independent variable; pointer to double

Definition at line 435 of file sgradclc.cpp.

Referenced by prevariable::operator+=().

void grad_stack::set_gradient_stack2 ( void(*)(void)  func,
double *  dep_addr,
double *  ind_addr1,
double  mult1 
) [inline]

Description not yet available.

Parameters:

Definition at line 1145 of file fvar.hpp.

void grad_stack::set_gradient_stack4 ( void(*)(void)  func,
double *  dep_addr,
double *  ind_addr1,
double *  ind_addr2 
) [inline]

Description not yet available.

Parameters:

Definition at line 1172 of file fvar.hpp.

Referenced by operator+().

Description not yet available.

Parameters:

Definition at line 281 of file gradstak.cpp.

Referenced by set_gradient_stack(), set_gradient_stack2(), and set_gradient_stack4().


Friends And Related Function Documentation

void cleanup_temporary_files ( ) [friend]

Close gradient and variable files.

Free gradient structure memory.

Definition at line 177 of file gradstrc.cpp.

void default_evaluation ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 66 of file def_eval.cpp.

void default_evaluation3ind ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 179 of file def_eval.cpp.

void default_evaluation4ind ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 212 of file def_eval.cpp.

void funnel_gradcalc ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 83 of file xgradclc.cpp.

void grad_chk ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 20 of file gradchk.cpp.

void gradcalc ( int  nvar,
const dvector g 
) [friend]

Compute the gradient from the data stored in the global gradient_structure.

Parameters:
nvarNumber of variables in the gradient.
_gVector from 1 to nvar. On return contains the gradient.

Definition at line 86 of file sgradclc.cpp.

friend class gradient_structure [friend]

Definition at line 978 of file fvar.hpp.

void gradloop ( ) [friend]
void reset_gradient_stack ( void  ) [friend]

Rewind buffer.

Definition at line 417 of file sgradclc.cpp.

void slave_gradcalc ( void  ) [friend]

Member Data Documentation

Definition at line 897 of file fvar.hpp.

Definition at line 898 of file fvar.hpp.

int grad_stack::_VARSSAV_PTR [private]

Definition at line 899 of file fvar.hpp.

off_t grad_stack::end_pos [private]

Definition at line 910 of file fvar.hpp.

off_t grad_stack::end_pos1 [private]

Definition at line 911 of file fvar.hpp.

off_t grad_stack::end_pos2 [private]

Definition at line 912 of file fvar.hpp.

char grad_stack::gradfile_name[61] [private]

Definition at line 900 of file fvar.hpp.

char grad_stack::gradfile_name1[61] [private]

Definition at line 901 of file fvar.hpp.

Referenced by cleanup_temporary_files().

char grad_stack::gradfile_name2[61] [private]

Definition at line 902 of file fvar.hpp.

Referenced by cleanup_temporary_files().

size_t grad_stack::length [private]

Definition at line 883 of file fvar.hpp.

Referenced by set_gradient_stack(), set_gradient_stack2(), and set_gradient_stack4().

Definition at line 914 of file fvar.hpp.

size_t grad_stack::true_length [private]

Definition at line 889 of file fvar.hpp.

Definition at line 881 of file fvar.hpp.

Referenced by gradient_structure::gradient_structure().

char grad_stack::var_store_file_name[61] [private]

Definition at line 903 of file fvar.hpp.

Referenced by cleanup_temporary_files().

List of all members.


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