ADMB Documentation  11.1.2490
 All Classes Files Functions Variables Typedefs Friends Defines
Classes | Defines | Typedefs | Functions | Variables
admodel.h File Reference

(* $Id: admodel.h 2488 2014-10-16 22:59:55Z johnoel $)

Description not yet available. More...

#include <fvar.hpp>
#include <cifstrem.h>
#include <adstring.hpp>
#include <unistd.h>
#include "param_init_bounded_number_matrix.h"

Go to the source code of this file.

Classes

class  AD_matherror
 Description not yet available. More...
class  adlist_ptr
 For storing void pointers in a array. More...
class  data_3array
 Description not yet available. More...
class  data_3iarray
class  data_4array
 Description not yet available. More...
class  data_4iarray
class  data_5array
 Description not yet available. More...
class  data_imatrix
 Description not yet available. More...
class  data_int
 Description not yet available. More...
class  data_ivector
 Description not yet available. More...
class  data_matrix
 Description not yet available. More...
class  data_number
 Description not yet available. More...
class  data_vector
 Description not yet available. More...
class  dll_data_3array
 Description not yet available. More...
class  dll_data_int
 Description not yet available. More...
class  dll_data_matrix
 Description not yet available. More...
class  dll_data_number
 Description not yet available. More...
class  dll_data_vector
 Description not yet available. More...
class  dll_named_adstring
 Description not yet available. More...
class  dll_param_d3array
 Description not yet available. More...
class  dll_param_init_bounded_number
 Description not yet available. More...
class  dll_param_init_bounded_vector
 Description not yet available. More...
class  dll_param_init_d3array
 Description not yet available. More...
class  dll_param_init_matrix
 Description not yet available. More...
class  dll_param_init_number
 Description not yet available. More...
class  dll_param_init_vector
 Description not yet available. More...
class  dll_param_matrix
 Description not yet available. More...
class  dll_param_number
 Description not yet available. More...
class  dll_param_vector
 Description not yet available. More...
class  equality_constraint_vector
 Description not yet available. More...
class  function_minimizer
 Description not yet available. More...
class  inequality_constraint_vector
 Description not yet available. More...
class  init_adstring
 Description not yet available. More...
class  init_line_adstring
 Description not yet available. More...
class  initial_params
 Description not yet available. More...
class  label_class
 Description not yet available. More...
class  likeprof_params
 Description not yet available. More...
class  matrix_kludge
 Description not yet available. More...
class  model_name_tag
 Description not yet available. More...
class  named_adstring
 Description not yet available. More...
class  named_d3_array
 Description not yet available. More...
class  named_d4_array
 Description not yet available. More...
class  named_d5_array
 Description not yet available. More...
class  named_d6_array
 Description not yet available. More...
class  named_d7_array
 Description not yet available. More...
class  named_dmatrix
 Description not yet available. More...
class  named_dvar3_array
 Description not yet available. More...
class  named_dvar4_array
 Description not yet available. More...
class  named_dvar5_array
 Description not yet available. More...
class  named_dvar6_array
 Description not yet available. More...
class  named_dvar7_array
 Description not yet available. More...
class  named_dvar_matrix
 Description not yet available. More...
class  named_dvar_vector
 Description not yet available. More...
class  named_dvariable
 Description not yet available. More...
class  named_dvector
 Description not yet available. More...
class  named_i3_array
 Description not yet available. More...
class  named_i4_array
class  named_imatrix
 Description not yet available. More...
class  named_ivector
 Description not yet available. More...
class  named_line_adstring
 Description not yet available. More...
class  objective_function_value
 Description not yet available. More...
class  param_init_bounded_dev_vector
 Description not yet available. More...
class  param_init_bounded_matrix
 Description not yet available. More...
class  param_init_bounded_matrix_vector
 Description not yet available. More...
class  param_init_bounded_number
 Description not yet available. More...
class  param_init_bounded_number_vector
class  param_init_bounded_vector
 Description not yet available. More...
class  param_init_bounded_vector_vector
 Description not yet available. More...
class  param_init_d3array
 Description not yet available. More...
class  param_init_matrix
 Description not yet available. More...
class  param_init_matrix_vector
 Description not yet available. More...
class  param_init_number
 Description not yet available. More...
class  param_init_number_vector
 Description not yet available. More...
class  param_init_vector
 Description not yet available. More...
class  param_init_vector_vector
 Description not yet available. More...
class  param_likeprof_number
 Description not yet available. More...
class  param_stddev_matrix
 Description not yet available. More...
class  param_stddev_number
 Description not yet available. More...
class  param_stddev_vector
 Description not yet available. More...
class  pvm_int
 Description not yet available. More...
class  pvm_number
 Description not yet available. More...
class  pvm_params
 Description not yet available. More...
class  shareinfo
 Description not yet available. More...
class  stddev_params
 Description not yet available. More...
class  vector_kludge
 Description not yet available. More...

Defines

#define __MINI_MAX__
#define BIG_INIT_PARAMS
#define param_3array   named_dvar3_array
#define param_4array   named_dvar4_array
#define param_5array   named_dvar5_array
#define param_6array   named_dvar6_array
#define param_7array   named_dvar7_array
#define param_matrix   named_dvar_matrix
#define param_number   named_dvariable
#define param_vector   named_dvar_vector
#define SPparam_3array   SPnamed_dvar3_array
#define SPparam_4array   SPnamed_dvar4_array
#define SPparam_matrix   SPnamed_dvar_matrix
#define SPparam_number   SPnamed_dvariable
#define SPparam_vector   SPnamed_dvar_vector
#define USE_SHARE_FLAGS

Typedefs

typedef initial_paramspinitial_params
typedef dvariable(model_parameters::* PMF )(const dvariable &)
typedef dvariable(model_parameters::* PMFI )(const dvariable &, int n)
typedef dvariable(model_parameters::* PMFVI )(const dvar_vector &, int n)
typedef void(model_parameters::* PMFVIV4 )(const dvar_vector &, int n, dvariable &f1, const dvariable &f2, const dvariable &f3, const dvariable &f4)
typedef void * ptovoid

Functions

int ad_get_commandline_option (const char *option_label, const int &option_value, const char *error_message)
void ad_make_code_reentrant (void)
void adwait (double)
dvector bounded_multivariate_normal (int nvar, const dvector &a1, const dvector &b1, dmatrix &ch, const double &_wght, const random_number_generator &rng)
dvector bounded_multivariate_normal (int nvar, const dvector &a1, const dvector &b1, dmatrix &ch, const double &lprob, random_number_generator &rng)
void bounded_multivariate_normal_mcmc (int nvar, const dvector &a1, const dvector &b1, dmatrix &ch, const double &wght, const dvector &y, const random_number_generator &rng)
dvector bounded_multivariate_normal_sobol (int nvar, const dvector &a1, const dvector &b1, dmatrix &ch, const double &lprob, const random_number_generator &rng)
dvector bounded_multivariate_uniform (int nvar, const dvector &a1, const dvector &b1, dmatrix &ch, const double &lprob, random_number_generator &rng)
void bounded_multivariate_uniform_mcmc (int nvar, const dvector &a1, const dvector &b1, dmatrix &ch, const double &wght, const dvector &y, const random_number_generator &rng)
dvector bounded_robust_multivariate_normal (int nvar, const dvector &a1, const dvector &b1, dmatrix &ch, const dmatrix &ch3, double contaminant, const double &_wght, random_number_generator &rng)
void check_datafile_pointer (void *p)
void cleanup_argv (int nopt, char ***pa)
void cleanup_laplace_stuff (laplace_approximation_calculator *)
 Description not yet available.
void copy_value_from_vector (const double &_sd, const dvector &x, const int &_ii)
void copy_value_from_vector (const dvector &_sd, const dvector &x, const int &_ii)
void copy_value_from_vector (const dmatrix &_sd, const dvector &x, const int &_ii)
void copy_value_to_vector (const prevariable &x, const dvector &v, const int &ii)
void copy_value_to_vector (const dvar_vector &x, const dvector &v, const int &ii)
void copy_value_to_vector (const dvar_matrix &x, const dvector &v, const int &ii)
void copy_value_to_vector (const dvar3_array &x, const dvector &v, const int &ii)
double cumd_cauchy (const double &x)
 Description not yet available.
double cumd_exp (double x)
double cumd_mixture (const double &x)
double cumd_mixture_02 (const double &x)
double density_cauchy (const double &x)
 Description not yet available.
void do_dll_housekeeping (int argc, char **argv)
double ffmax (double a, double b)
double ffmin (double a, double b)
adstring get_reportfile_name (void)
void get_sp_printf (void)
double inv_cumd_cauchy (const double &x)
 Description not yet available.
double inv_cumd_exp (double x)
double inv_cumd_mixture (const double &y)
double inv_cumd_mixture_02 (const double &y)
double log_density_cauchy (const double &x)
 Description not yet available.
double mfexp (const double)
 Robust exponential function for constant argument > 60 or < -60.
dvariable mfexp (const prevariable &v1)
 Robust exponential function for variable argument > 60 or < -60.
dvar_vector mfexp (const dvar_vector &)
 Description not yet available.
dvector mfexp (const dvector &)
 Safe version of exp that interpolates values greater than equal to 60 in each element of a vector v1.
double ndfboundp (double x, double fmin, double fmax, const double &fpen)
 Derivatative code for double nd2fboundp( double x, double fmin, double fmax,const double& fpen)
double ndfboundp_mc (double x, double fmin, double fmax, const double &fpen)
 Description not yet available.
char ** no_dll_options (char *pname, const int &argc)
ostream & operator<< (const ostream &s, const label_class &lc)
cifstreamoperator>> (const cifstream &s, const param_init_number &x)
cifstreamoperator>> (const cifstream &s, const param_init_vector &v)
cifstreamoperator>> (const cifstream &s, const param_init_matrix &m)
char ** parse_dll_options (char *pname, const int &argc, char *dll_options)
void parse_dll_options (char *pname, const int &argc, char *dll_options, char ***pargv)
dvector probing_bounded_multivariate_normal (int nvar, const dvector &a1, const dvector &b1, dmatrix &ch, const double &lprob, double pprobe, const random_number_generator &rng)
void probing_bounded_multivariate_normal_mcmc (int nvar, const dvector &a1, const dvector &b1, dmatrix &ch, const double &wght, const dvector &v, double pprobe, const random_number_generator &rng)
void pvm_pack (const dvar_vector &)
void pvm_pack (const prevariable &)
void pvm_pack (const dvar_matrix &)
void pvm_unpack (const dvar_vector &)
void pvm_unpack (const prevariable &)
void pvm_unpack (const dvar_matrix &)
void read_covariance_matrix (const dmatrix &S, int nvar, int &hbf, dvector &sscale)
dvector read_old_scale (int &old_nvar)
void restore_value_from_vector (const prevariable &x, const dvector &v, const int &ii)
void restore_value_from_vector (const dvar_vector &x, const dvector &v, const int &ii)
void restore_value_from_vector (const dvar_matrix &x, const dvector &v, const int &ii)
void restore_value_from_vector (dvar3_array &x, const dvector &v, const int &ii)
void set_covariance_matrix (const dll_data_matrix &m)
void set_covariance_matrix (const dmatrix &m)
void set_gauss_covariance_matrix (const dll_data_matrix &m)
void set_gauss_covariance_matrix (const dmatrix &m)
double set_value_inv_mc (double v, double fmin, double fmax)
double set_value_inv_mc (const prevariable &v, double fmin, double fmax)
void set_value_inv_mc (const dvar_vector &x, const dvector &v, const int &ii, const double fmin, const double fmax)
void set_value_mc (const dvar_vector &x, const dvar_vector &v, const int &ii, const double fmin, const double fmax)
double set_value_mc (double z, double min, double max)
void tracing_message (int traceflag, const char *s, int *pn)
 Description not yet available.
void tracing_message (int traceflag, const char *s, double *pn)
 Description not yet available.
dvector value (const param_init_number_vector &t)
dvector value (const param_init_bounded_number_vector &t)
int withinbound (int lb, int n, int ub)

Variables

int AD_gaussflag
int ADqd_flag
function_minimizerpfm
int traceflag

Detailed Description

Description not yet available.

Definition in file admodel.h.


Define Documentation

#define __MINI_MAX__

Definition at line 50 of file admodel.h.

#define BIG_INIT_PARAMS

Definition at line 55 of file admodel.h.

Definition at line 76 of file admodel.h.

Definition at line 77 of file admodel.h.

Definition at line 78 of file admodel.h.

Definition at line 79 of file admodel.h.

Definition at line 80 of file admodel.h.

Definition at line 73 of file admodel.h.

Definition at line 75 of file admodel.h.

Definition at line 74 of file admodel.h.

#define SPparam_3array   SPnamed_dvar3_array

Definition at line 85 of file admodel.h.

#define SPparam_4array   SPnamed_dvar4_array

Definition at line 86 of file admodel.h.

#define SPparam_matrix   SPnamed_dvar_matrix

Definition at line 82 of file admodel.h.

#define SPparam_number   SPnamed_dvariable

Definition at line 84 of file admodel.h.

#define SPparam_vector   SPnamed_dvar_vector

Definition at line 83 of file admodel.h.

#define USE_SHARE_FLAGS

Definition at line 48 of file admodel.h.


Typedef Documentation

Definition at line 757 of file admodel.h.

typedef dvariable(model_parameters::* PMF)(const dvariable &)

Definition at line 1777 of file admodel.h.

typedef dvariable(model_parameters::* PMFI)(const dvariable &, int n)

Definition at line 1778 of file admodel.h.

typedef dvariable(model_parameters::* PMFVI)(const dvar_vector &, int n)

Definition at line 1779 of file admodel.h.

typedef void(model_parameters::* PMFVIV4)(const dvar_vector &, int n, dvariable &f1, const dvariable &f2, const dvariable &f3, const dvariable &f4)

Definition at line 1780 of file admodel.h.

typedef void* ptovoid

Definition at line 759 of file admodel.h.


Function Documentation

int ad_get_commandline_option ( const char *  option_label,
const int &  option_value,
const char *  error_message 
)
void ad_make_code_reentrant ( void  )

Definition at line 9 of file model33.cpp.

void adwait ( double  )

Definition at line 31 of file model34.cpp.

Referenced by write_banner_stuff().

dvector bounded_multivariate_normal ( int  nvar,
const dvector a1,
const dvector b1,
dmatrix ch,
const double &  _wght,
const random_number_generator rng 
)
dvector bounded_multivariate_normal ( int  nvar,
const dvector a1,
const dvector b1,
dmatrix ch,
const double &  lprob,
random_number_generator rng 
)

Definition at line 52 of file monte.cpp.

void bounded_multivariate_normal_mcmc ( int  nvar,
const dvector a1,
const dvector b1,
dmatrix ch,
const double &  wght,
const dvector y,
const random_number_generator rng 
)

Definition at line 14 of file xmonte2.cpp.

Referenced by function_minimizer::mcmc_routine().

dvector bounded_multivariate_normal_sobol ( int  nvar,
const dvector a1,
const dvector b1,
dmatrix ch,
const double &  lprob,
const random_number_generator rng 
)
dvector bounded_multivariate_uniform ( int  nvar,
const dvector a1,
const dvector b1,
dmatrix ch,
const double &  lprob,
random_number_generator rng 
)

Definition at line 205 of file monte.cpp.

Referenced by function_minimizer::mcmc_routine().

void bounded_multivariate_uniform_mcmc ( int  nvar,
const dvector a1,
const dvector b1,
dmatrix ch,
const double &  wght,
const dvector y,
const random_number_generator rng 
)

Definition at line 130 of file xmonte2.cpp.

Referenced by function_minimizer::mcmc_routine().

dvector bounded_robust_multivariate_normal ( int  nvar,
const dvector a1,
const dvector b1,
dmatrix ch,
const dmatrix ch3,
double  contaminant,
const double &  _wght,
random_number_generator rng 
)

Definition at line 245 of file monte.cpp.

void check_datafile_pointer ( void *  p)
void cleanup_argv ( int  nopt,
char ***  pa 
)

Definition at line 127 of file model33.cpp.

Description not yet available.

Parameters:

Definition at line 2109 of file df1b2lap.cpp.

void copy_value_from_vector ( const double &  _sd,
const dvector x,
const int &  _ii 
)
void copy_value_from_vector ( const dvector _sd,
const dvector x,
const int &  _ii 
)

Definition at line 16 of file model42.cpp.

void copy_value_from_vector ( const dmatrix _sd,
const dvector x,
const int &  _ii 
)

Definition at line 26 of file model42.cpp.

void copy_value_to_vector ( const prevariable x,
const dvector v,
const int &  ii 
)

Definition at line 47 of file model3.cpp.

Referenced by copy_value_to_vector().

void copy_value_to_vector ( const dvar_vector x,
const dvector v,
const int &  ii 
)

Definition at line 55 of file model3.cpp.

void copy_value_to_vector ( const dvar_matrix x,
const dvector v,
const int &  ii 
)

Definition at line 71 of file model3.cpp.

void copy_value_to_vector ( const dvar3_array x,
const dvector v,
const int &  ii 
)

Definition at line 83 of file model3.cpp.

double cumd_cauchy ( const double &  x)

Description not yet available.

Parameters:

Definition at line 17 of file cumd_cau.cpp.

double cumd_exp ( double  x)

Definition at line 40 of file monte.cpp.

double cumd_mixture ( const double &  x)

Definition at line 529 of file nmonte.cpp.

Referenced by get_bounded_mixture().

double cumd_mixture_02 ( const double &  x)

Definition at line 517 of file nmonte.cpp.

double density_cauchy ( const double &  x)

Description not yet available.

Parameters:

Definition at line 29 of file cumd_cau.cpp.

void do_dll_housekeeping ( int  argc,
char **  argv 
)

Definition at line 162 of file model33.cpp.

double ffmax ( double  a,
double  b 
)

Definition at line 14 of file monte.cpp.

Referenced by bounded_multivariate_uniform(), and bounded_multivariate_uniform_mcmc().

double ffmin ( double  a,
double  b 
)

Definition at line 19 of file monte.cpp.

Referenced by bounded_multivariate_uniform(), and bounded_multivariate_uniform_mcmc().

void get_sp_printf ( void  )

Referenced by do_dll_housekeeping().

double inv_cumd_cauchy ( const double &  x)

Description not yet available.

Parameters:

Definition at line 49 of file cumd_cau.cpp.

double inv_cumd_exp ( double  x)

Definition at line 28 of file monte.cpp.

double inv_cumd_mixture ( const double &  y)

Definition at line 556 of file nmonte.cpp.

Referenced by get_bounded_mixture(), and inv_cumd_mixture().

double inv_cumd_mixture_02 ( const double &  y)

Definition at line 609 of file nmonte.cpp.

Referenced by inv_cumd_mixture_02().

double log_density_cauchy ( const double &  x)
dvar_vector mfexp ( const dvar_vector v1)

Description not yet available.

Parameters:

Definition at line 19 of file fvar_a50.cpp.

dvector mfexp ( const dvector v1)

Safe version of exp that interpolates values greater than equal to 60 in each element of a vector v1.

Parameters:
v1a data vector

Definition at line 18 of file dvect19.cpp.

double ndfboundp ( double  x,
double  fmin,
double  fmax,
const double &  fpen 
)

Derivatative code for double nd2fboundp( double x, double fmin, double fmax,const double& fpen)

Parameters:
xVariable to be scaled
fminLower bound of x
fminUpper bound of x
fpenUnchanged on return.
Returns:
Derivative of scaled variable

Definition at line 216 of file boundfun.cpp.

Referenced by param_init_bounded_vector::mc_scale(), param_init_bounded_number::mc_scale(), param_init_bounded_matrix::mc_scale(), param_init_bounded_vector::sd_scale(), param_init_bounded_number::sd_scale(), param_init_bounded_matrix::sd_scale(), df1b2_init_bounded_number::sd_scale(), df1b2_init_bounded_vector::sd_scale(), and df1b2_init_bounded_matrix::sd_scale().

double ndfboundp_mc ( double  x,
double  fmin,
double  fmax,
const double &  fpen 
)
char** no_dll_options ( char *  pname,
const int &  argc 
)

Definition at line 113 of file model33.cpp.

ostream& operator<< ( const ostream &  s,
const label_class lc 
)

Definition at line 43 of file model11.cpp.

cifstream& operator>> ( const cifstream s,
const param_init_number x 
)

Definition at line 11 of file model11.cpp.

cifstream& operator>> ( const cifstream s,
const param_init_vector v 
)

Definition at line 18 of file model11.cpp.

cifstream& operator>> ( const cifstream s,
const param_init_matrix m 
)

Definition at line 36 of file model11.cpp.

char** parse_dll_options ( char *  pname,
const int &  argc,
char *  dll_options 
)

Definition at line 437 of file model33.cpp.

void parse_dll_options ( char *  pname,
const int &  argc,
char *  dll_options,
char ***  pargv 
)

Definition at line 48 of file model33.cpp.

dvector probing_bounded_multivariate_normal ( int  nvar,
const dvector a1,
const dvector b1,
dmatrix ch,
const double &  lprob,
double  pprobe,
const random_number_generator rng 
)
void probing_bounded_multivariate_normal_mcmc ( int  nvar,
const dvector a1,
const dvector b1,
dmatrix ch,
const double &  wght,
const dvector v,
double  pprobe,
const random_number_generator rng 
)

Definition at line 79 of file xmonte2.cpp.

void pvm_pack ( const dvar_vector )
void pvm_pack ( const prevariable )
void pvm_pack ( const dvar_matrix )
void pvm_unpack ( const dvar_vector )
void pvm_unpack ( const prevariable )
void pvm_unpack ( const dvar_matrix )
void read_covariance_matrix ( const dmatrix S,
int  nvar,
int &  hbf,
dvector sscale 
)
dvector read_old_scale ( int &  old_nvar)

Definition at line 1646 of file xxmcmc.cpp.

Referenced by function_minimizer::hybrid_mcmc_routine().

void restore_value_from_vector ( const prevariable x,
const dvector v,
const int &  ii 
)

Definition at line 137 of file model3.cpp.

Referenced by restore_value_from_vector().

void restore_value_from_vector ( const dvar_vector x,
const dvector v,
const int &  ii 
)

Definition at line 146 of file model3.cpp.

void restore_value_from_vector ( const dvar_matrix x,
const dvector v,
const int &  ii 
)

Definition at line 163 of file model3.cpp.

void restore_value_from_vector ( dvar3_array x,
const dvector v,
const int &  ii 
)

Definition at line 177 of file model3.cpp.

Definition at line 25 of file mod_sd.cpp.

void set_covariance_matrix ( const dmatrix m)

Definition at line 30 of file mod_sd.cpp.

Definition at line 15 of file mod_sd.cpp.

void set_gauss_covariance_matrix ( const dmatrix m)

Definition at line 20 of file mod_sd.cpp.

double set_value_inv_mc ( double  v,
double  fmin,
double  fmax 
)
double set_value_inv_mc ( const prevariable v,
double  fmin,
double  fmax 
)

Definition at line 113 of file mod_mc3.cpp.

void set_value_inv_mc ( const dvar_vector x,
const dvector v,
const int &  ii,
const double  fmin,
const double  fmax 
)

Definition at line 137 of file mod_mc3.cpp.

void set_value_mc ( const dvar_vector x,
const dvar_vector v,
const int &  ii,
const double  fmin,
const double  fmax 
)
double set_value_mc ( double  z,
double  min,
double  max 
)

Definition at line 130 of file mod_mc3.cpp.

void tracing_message ( int  traceflag,
const char *  s,
int *  pn 
)

Description not yet available.

Parameters:

Definition at line 98 of file newfmin.cpp.

void tracing_message ( int  traceflag,
const char *  s,
double *  pd 
)

Description not yet available.

Parameters:

Definition at line 113 of file newfmin.cpp.

Definition at line 85 of file model47.cpp.

Definition at line 98 of file model47.cpp.

int withinbound ( int  lb,
int  n,
int  ub 
)

Variable Documentation

int ADqd_flag
int traceflag

Definition at line 2788 of file admodel.h.