ADMB Documentation  11.1.1952
 All Classes Files Functions Variables Typedefs Friends Defines
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
model_parameters Class Reference

Data structure that holds objects defined in the PARAMETER_SECTION of the tpl-file. More...

#include <tpl2cpp_output.hpp>

Public Member Functions

 model_parameters (int sz, int argc, char *argv[])
 Allocate and initialize model parameters defined in the PARAMETER_SECTION of the tpl-file.
 ~model_parameters ()
virtual void final_calcs (void)
 Performes calculations defined in the FINAL_SECTION of the tpl-file.
virtual void initializationfunction (void)
 Performes initilizations declared in the INITIALIZATION_SECTION of the tpl-file.
void my_function (void)
 Example of user defined function resulting from a FUNCTION section in the tpl-file.
virtual void * mycast (void)
void preliminary_calculations (void)
 Performes calculations defined in the PRELIMINARY_CALCS_SECTION of the tpl-file.
virtual void report (void)
 Performes calculations defined in the REPORT_SECTION of the tpl-file.
void set_runtime (void)
 Performes calculations defined in the PROCEDURE_SECTION of the tpl-file.
virtual void userfunction (void)
 Performes calculations defined in the PROCEDURE_SECTION of the tpl-file.

Static Public Member Functions

static prevariable current_feval (void)
static int current_phase (void)
static int last_phase (void)
static int mc_phase (void)
static int mceval_phase (void)
static int sd_phase (void)

Private Member Functions

void between_phases_calculations (void)
 Performes calculations defined in the BETWEEN_PHASES_SECTION of the tpl-file.

Private Attributes

param_init_vector alpha
param_init_bounded_vector beta
dvector double_control_flags
param_init_bounded_number gamma
ivector integer_control_flags
objective_function_value l
param_number likelihood_function_value
param_number prior_function_value
param_number x1
param_vector x2
param_stddev_vector x3

Detailed Description

Data structure that holds objects defined in the PARAMETER_SECTION of the tpl-file.

Definition at line 38 of file tpl2cpp_output.hpp.


Constructor & Destructor Documentation

model_parameters::model_parameters ( int  sz,
int  argc,
char *  argv[] 
)

Allocate and initialize model parameters defined in the PARAMETER_SECTION of the tpl-file.

Parameters:
argcnumber of command line arguments (in a standard C sense)
argvstring of command line arguments (in a standard C sense)

Definition at line 50 of file tpl2cpp_output.cpp.


Member Function Documentation

void model_parameters::between_phases_calculations ( void  ) [private, virtual]

Performes calculations defined in the BETWEEN_PHASES_SECTION of the tpl-file.

Reimplemented from function_minimizer.

Definition at line 81 of file tpl2cpp_output.cpp.

static prevariable model_parameters::current_feval ( void  ) [inline, static]

Definition at line 67 of file tpl2cpp_output.hpp.

static int model_parameters::current_phase ( void  ) [inline, static]

Definition at line 58 of file tpl2cpp_output.hpp.

Referenced by between_phases_calculations().

void model_parameters::final_calcs ( void  ) [virtual]

Performes calculations defined in the FINAL_SECTION of the tpl-file.

Parameters:

Reimplemented from function_minimizer.

Definition at line 133 of file tpl2cpp_output.cpp.

void model_parameters::initializationfunction ( void  ) [virtual]

Performes initilizations declared in the INITIALIZATION_SECTION of the tpl-file.

Definition at line 39 of file tpl2cpp_output.cpp.

Referenced by model_parameters().

static int model_parameters::last_phase ( void  ) [inline, static]

Definition at line 62 of file tpl2cpp_output.hpp.

static int model_parameters::mc_phase ( void  ) [inline, static]

Definition at line 46 of file tpl2cpp_output.hpp.

static int model_parameters::mceval_phase ( void  ) [inline, static]

Definition at line 50 of file tpl2cpp_output.hpp.

Example of user defined function resulting from a FUNCTION section in the tpl-file.

Definition at line 110 of file tpl2cpp_output.cpp.

Referenced by userfunction().

virtual void* model_parameters::mycast ( void  ) [inline, virtual]

Reimplemented from function_minimizer.

Definition at line 45 of file tpl2cpp_output.hpp.

Performes calculations defined in the PRELIMINARY_CALCS_SECTION of the tpl-file.

Definition at line 71 of file tpl2cpp_output.cpp.

Referenced by main().

void model_parameters::report ( void  ) [virtual]

Performes calculations defined in the REPORT_SECTION of the tpl-file.

Parameters:

Definition at line 141 of file tpl2cpp_output.cpp.

static int model_parameters::sd_phase ( void  ) [inline, static]

Definition at line 54 of file tpl2cpp_output.hpp.

void model_parameters::set_runtime ( void  ) [virtual]

Performes calculations defined in the PROCEDURE_SECTION of the tpl-file.

Parameters:

Reimplemented from function_minimizer.

Definition at line 119 of file tpl2cpp_output.cpp.

void model_parameters::userfunction ( void  ) [virtual]

Performes calculations defined in the PROCEDURE_SECTION of the tpl-file.

The initialization "l=0.0" of the objective function is autogenerated by tpl2cpp.

Implements function_minimizer.

Definition at line 99 of file tpl2cpp_output.cpp.


Member Data Documentation

Definition at line 74 of file tpl2cpp_output.hpp.

Referenced by model_parameters().

Definition at line 75 of file tpl2cpp_output.hpp.

Referenced by model_parameters(), and userfunction().

Definition at line 73 of file tpl2cpp_output.hpp.

Definition at line 76 of file tpl2cpp_output.hpp.

Referenced by initializationfunction(), and model_parameters().

Definition at line 72 of file tpl2cpp_output.hpp.

Definition at line 82 of file tpl2cpp_output.hpp.

Referenced by model_parameters(), and userfunction().

Definition at line 81 of file tpl2cpp_output.hpp.

Referenced by model_parameters().

Definition at line 80 of file tpl2cpp_output.hpp.

Referenced by model_parameters().

Definition at line 77 of file tpl2cpp_output.hpp.

Referenced by model_parameters(), and my_function().

Definition at line 78 of file tpl2cpp_output.hpp.

Referenced by model_parameters(), and dfunction_tweaker::operator()().

Definition at line 79 of file tpl2cpp_output.hpp.

Referenced by model_parameters(), and dfunction_tweaker::operator()().

List of all members.


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