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

Link list. More...

#include <fvar.hpp>

Public Member Functions

 dlist ()
 Default constructor.
 ~dlist ()
 Destructor.
dlinkappend (dlink *link)
 Append link to list.
void check_list (void)
 Check link list integrity.
dlinkcreate ()
 Create unlinked new node.
void initialize ()
dlinklast_remove ()
 If list is not empty, pop and return last node.
void restore_variables ()
 Restore variables from buffer.
void save_variables ()
 Save variables to a buffer.
size_t total_addresses () const
 Get total addresses stored.

Private Attributes

char * ddlist_space
dlink ** dlink_addresses
dlinklast
unsigned int nlinks
double * variables_save

Friends

void allocate_dvariable_space (void)
 Description not yet available.
void df_check_derivative_values (void)
 Description not yet available.
void df_check_derivative_values_indexed (void)
 Description not yet available.
void df_check_derivative_values_indexed_break (void)
 Description not yet available.
void funnel_derivatives (void)
 Description not yet available.
void funnel_gradcalc (void)
 Description not yet available.
void gradcalc (int nvar, const dvector &g)
 Compute the gradient from the data stored in the global gradient_structure.
void gradient_structure::jacobcalc (int nvar, const dmatrix &jac)
void gradient_structure::jacobcalc (int nvar, const ofstream &jac)
void gradient_structure::jacobcalc (int nvar, const uostream &jac)
void gradient_structure::restore_variables ()
void gradient_structure::save_variables ()
void gradloop ()
double_and_intgradnew ()
 Creates an entry in the gradient structure linked list.
void slave_gradcalc (void)

Detailed Description

Link list.

Definition at line 797 of file fvar.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 17 of file ddlist.cpp.

Destructor.

Definition at line 54 of file ddlist.cpp.


Member Function Documentation

dlink * dlist::append ( dlink link)

Append link to list.

Parameters:
linknode

Definition at line 116 of file ddlist.cpp.

Referenced by gradfree().

void dlist::check_list ( void  )

Check link list integrity.

Definition at line 183 of file ddlist.cpp.

Create unlinked new node.

Definition at line 75 of file ddlist.cpp.

Referenced by gradnew().

void dlist::initialize ( void  )

Definition at line 128 of file ddlist.cpp.

Referenced by funnel_gradcalc(), and gradcalc().

If list is not empty, pop and return last node.

Returns:
0 empty list.

Definition at line 101 of file ddlist.cpp.

Referenced by gradnew().

Restore variables from buffer.

Definition at line 154 of file ddlist.cpp.

Save variables to a buffer.

Definition at line 140 of file ddlist.cpp.

size_t dlist::total_addresses ( ) const

Get total addresses stored.

Definition at line 168 of file ddlist.cpp.


Friends And Related Function Documentation

void allocate_dvariable_space ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 223 of file gradstrc.cpp.

void df_check_derivative_values ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 376 of file newdar.cpp.

void df_check_derivative_values_indexed ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 440 of file newdar.cpp.

void df_check_derivative_values_indexed_break ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 489 of file newdar.cpp.

void funnel_derivatives ( void  ) [friend]

Description not yet available.

Parameters:
void funnel_gradcalc ( void  ) [friend]

Description not yet available.

Parameters:

Definition at line 83 of file xgradclc.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.

void gradient_structure::jacobcalc ( int  nvar,
const dmatrix jac 
) [friend]
void gradient_structure::jacobcalc ( int  nvar,
const ofstream &  jac 
) [friend]
void gradient_structure::jacobcalc ( int  nvar,
const uostream jac 
) [friend]
void gradloop ( ) [friend]
double_and_int* gradnew ( ) [friend]

Creates an entry in the gradient structure linked list.

Returns:
Pointer instance of class double_and_int

Definition at line 33 of file fvar2.cpp.

void slave_gradcalc ( void  ) [friend]

Member Data Documentation

char* dlist::ddlist_space [private]

Definition at line 802 of file fvar.hpp.

Referenced by create(), dlist(), and ~dlist().

dlink* dlist::last [private]

Definition at line 799 of file fvar.hpp.

Referenced by allocate_dvariable_space(), append(), check_list(), dlist(), and last_remove().

unsigned int dlist::nlinks [private]
double* dlist::variables_save [private]

Definition at line 803 of file fvar.hpp.

Referenced by dlist(), restore_variables(), save_variables(), and ~dlist().

List of all members.


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