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

Description not yet available. More...

#include <admodel.h>

Public Member Functions

 param_init_vector ()
 Default constructor. More...
 
virtual void add_value (const dvector &, const dvector &, const int &, const double &, const dvector &)
 
virtual void add_value (const dvector &, const int &)
 
void allocate (int imin, int imax, int phasestart=1, const char *s="UNNAMED")
 Allocate variable vector of parameters, then reads values from input data. More...
 
void allocate (const ad_integer &imin, const ad_integer &imax, const ad_integer &phasestart=1, const char *s="UNNAMED")
 Allocate param_init_vector with dimension imin to imax using specified phase_start. More...
 
void allocate (int imin, int imax, const char *s="UNNAMED")
 
void allocate (int imin, int imax, const ivector &ishare, const char *s="UNNAMED")
 
virtual void bsave_value (uostream &uos)
 
virtual void copy_value_to_vector (const dvector &x, const int &ii)
 
virtual void curv_scale (const dvector &d, const dvector &x, const int &)
 
virtual void dev_correction (const dmatrix &H, const int &ii)
 
virtual void get_jacobian (const dvector &, const dvector &, const int &)
 
shareinfoget_share_flags () const
 
virtual void hess_scale (const dvector &, const dvector &, const int &)
 
virtual const char * label (void)
 
virtual void mc_scale (const dvector &d, const dvector &x, const int &)
 Description not yet available. More...
 
param_init_vectoroperator= (const dvector &)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
param_init_vectoroperator= (const dvar_vector &)
 Assigns values from varvec to param_init_vector. More...
 
param_init_vectoroperator= (const prevariable &)
 Assigns value var to param_init_vector. More...
 
param_init_vectoroperator= (const double &)
 Assigns value val to param_init_vector. More...
 
void pvm_pack (void)
 
void pvm_unpack (void)
 
void report_value (void)
 
virtual void restore_value (const ifstream &ifs)
 
virtual void restore_value_from_vector (const dvector &, const int &)
 
virtual void save_value (ofstream &ofs)
 
virtual void save_value (const ofstream &ofs, int prec)
 Write values of param_init_matrix into output stream _ofs. More...
 
virtual void save_value (const ofstream &ofs, int prec, const dvector &, int &offset)
 Write values of g into output stream _ofs, then update offset index to the next set of data. More...
 
virtual void sd_scale (const dvector &d, const dvector &x, const int &)
 
virtual void sd_vscale (const dvar_vector &d, const dvar_vector &x, const int &ii)
 
virtual void set_simulation_bounds (const dmatrix &symbds, const int &ii)
 
virtual void set_value (const dvar_vector &x, const int &ii, const dvariable &pen)
 
virtual void set_value_inv (const dvector &x, const int &ii)
 
virtual void setshare (const index_type &sf, const index_type &af)
 
virtual void shared_set_value (const dvar_vector &, const int &, const dvariable &pen)
 
virtual void shared_set_value_inv (const dvector &, const int &)
 
virtual int shared_size_count (void)
 
virtual unsigned int size_count () const
 Returns the number of active parameters. More...
 
- Public Member Functions inherited from named_dvar_vector
 named_dvar_vector (void)
 
void allocate (int mmin, int mmax, const char *s)
 
void allocate (const char *s)
 
named_dvar_vectoroperator= (const dvar_vector &m)
 
named_dvar_vectoroperator= (const dvector &m)
 
named_dvar_vectoroperator= (const double m)
 
named_dvar_vectoroperator= (const prevariable &m)
 
- Public Member Functions inherited from dvar_vector
 dvar_vector (const dvar_vector &)
 Copy constructor. More...
 
 dvar_vector (const predvar_vector &)
 Description not yet available. More...
 
 dvar_vector ()
 Default constructor. More...
 
 dvar_vector (int ncl, int ncu)
 Description not yet available. More...
 
 dvar_vector (int ncl, int ncu, kkludge_object)
 Description not yet available. More...
 
 dvar_vector (unsigned int sz, double *x)
 Description not yet available. More...
 
 dvar_vector (const independent_variables &)
 Description not yet available. More...
 
 dvar_vector (const param_init_number_vector &)
 Description not yet available. More...
 
 dvar_vector (const param_init_bounded_number_vector &)
 Description not yet available. More...
 
 dvar_vector (const dvector &)
 Description not yet available. More...
 
 dvar_vector (const char *)
 
 ~dvar_vector ()
 Destructor. More...
 
void allocate (int, int)
 Allocate dvar_vector with indexmin = ncl and indexmax = nch. More...
 
void allocate (void)
 Does not allocate, but initializes dvar_vector to empty. More...
 
void allocate (const dvector &)
 Allocate dvar_vector using indexes from v1. More...
 
void allocate (const dvar_vector &)
 Allocate dvar_vector using indexes from v1. More...
 
void allocate (const ad_integer &, const ad_integer &)
 Description not yet available. More...
 
void allocatec (const dvar_vector &)
 Description not yet available. More...
 
void deallocate ()
 Deallocate dvar_vector memory. More...
 
prevariable elem (int i)
 
prevariable elem (int i) const
 
double & elem_value (int i)
 
double & elem_value (int i) const
 
void fill (const char *)
 Fill variable vector from values in string s. More...
 
void fill_multinomial (const int &seed, const dvector &p)
 Description not yet available. More...
 
void fill_multinomial (const random_number_generator &rng, const dvector &p)
 Description not yet available. More...
 
void fill_randbi (long int &n, double)
 Description not yet available. More...
 
void fill_randbi_ni (long int &n, double)
 Description not yet available. More...
 
void fill_randn (long int &n)
 Description not yet available. More...
 
void fill_randn_ni (long int &n)
 Description not yet available. More...
 
void fill_randnegbinomial (double lambda, double tau, const random_number_generator &rng)
 Description not yet available. More...
 
void fill_randpoisson (double lambda, const random_number_generator &rng)
 Description not yet available. More...
 
void fill_randu (long int &n)
 Description not yet available. More...
 
void fill_randu_ni (long int &n)
 Description not yet available. More...
 
void fill_seqadd (double, double)
 Description not yet available. More...
 
unsigned int get_ncopies () const
 
double_and_intget_va ()
 
double_and_intget_va () const
 
int indexmax () const
 
int indexmin () const
 
void initialize (const dvector &ww)
 Description not yet available. More...
 
void initialize (void)
 Description not yet available. More...
 
double * initpointer (void)
 
const double * initpointer (void) const
 
int operator! (void) const
 
dvar_vector operator() (int lb, int ub)
 
prevariable operator() (int i)
 
const prevariable operator() (int i) const
 
dvar_vector operator() (const lvector &)
 Description not yet available. More...
 
dvar_vector operator() (const ivector &u)
 Description not yet available. More...
 
dvar_vectoroperator*= (const prevariable &d)
 Description not yet available. More...
 
dvar_vectoroperator*= (double d)
 Description not yet available. More...
 
dvar_vectoroperator++ (void)
 
dvar_vectoroperator+= (const prevariable &d)
 Adds d to each element of dvar_vector. More...
 
dvar_vectoroperator+= (double d)
 Adds d to each element of dvar_vector. More...
 
dvar_vectoroperator+= (const dvector &v1)
 Description not yet available. More...
 
dvar_vectoroperator+= (const dvar_vector &v1)
 Description not yet available. More...
 
dvar_vector operator- ()
 Description not yet available. More...
 
dvar_vectoroperator-- (void)
 
dvar_vectoroperator-= (const prevariable &d)
 Substracts d from each element of dvar_vector. More...
 
dvar_vectoroperator-= (double d)
 Substracts d from each element of dvar_vector. More...
 
dvar_vectoroperator-= (const dvector &v1)
 Description not yet available. More...
 
dvar_vectoroperator-= (const dvar_vector &v1)
 Description not yet available. More...
 
dvar_vectoroperator/= (const prevariable &d)
 Description not yet available. More...
 
dvar_vectoroperator/= (double d)
 Description not yet available. More...
 
dvar_vectoroperator= (const dvar_vector &t)
 Assign values from other t to dvar_vector. More...
 
dvar_vectoroperator= (const dvector &t)
 Description not yet available. More...
 
dvar_vectoroperator= (double t)
 Assigns all elements for dvar_vector with t. More...
 
dvar_vectoroperator= (const prevariable &t)
 Assigns all elements for dvar_vector with t. More...
 
prevariable operator[] (int i)
 
const prevariable operator[] (int i) const
 
void read_from (const istream &)
 Description not yet available. More...
 
void read_from (const uistream &)
 Description not yet available. More...
 
void save_dvar_vector_position () const
 Description not yet available. More...
 
void save_dvar_vector_value () const
 Saves the size, address, and value information for a dvar_vector. More...
 
void shallow_copy (const dvar_vector &)
 Shallow copy other data structure pointers. More...
 
dvar_vectorshift (int min)
 Description not yet available. More...
 
unsigned int size () const
 
dvar_vector sub (int lb, int ub)
 
void write_on (const ostream &) const
 Description not yet available. More...
 
void write_on (const uostream &) const
 Description not yet available. More...
 
- Public Member Functions inherited from model_name_tag
 model_name_tag (void)
 
void allocate (const char *s)
 
const char * get_name (void)
 
label_class label (void)
 
- Public Member Functions inherited from initial_params
 initial_params (void)
 Default constructor. More...
 
virtual void add_to_list (void)
 
void allocate (int _phase_start)
 
double get_initial_value (void)
 
int get_phase_start (void)
 
double get_scalefactor ()
 
void restore_phase_start (void)
 
void set_active_flag (void)
 
void set_inactive_flag (void)
 
void set_initial_value (double x)
 
virtual void set_only_random_effects_active ()
 
virtual void set_only_random_effects_inactive ()
 
void set_phase_start (int x)
 
virtual void set_random_effects_active ()
 
virtual void set_random_effects_inactive ()
 
void set_scalefactor (const double)
 

Friends

class param_init_vector_vector
 

Additional Inherited Members

- Static Public Member Functions inherited from initial_params
static void add_random_vector (const dvector &x)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
static void add_random_vector (const dvector &y, const dvector &x, const double &ll, const dvector &diag)
 
static void copy_all_values (const dvector &x, const int &ii)
 
static int correct_for_dev_objects (const dmatrix &H)
 
static void get_jacobian_value (const dvector &y, const dvector &jac)
 
static adstring get_reportfile_name (void)
 
static int montecarlo_scale (const dvector &d, const dvector &x)
 Description not yet available. More...
 
static int num_active_calc (void)
 
static int nvarcalc ()
 
static int nvarcalc_all (void)
 Description not yet available. More...
 
static void read (void)
 
static dvariable reset (const dvar_vector &x)
 
static dvariable reset (const dvector &x)
 
static dvariable reset (const dvar_vector &x, const dvector &pen)
 
static dvariable reset1 (const dvar_vector &x, const dvector &g)
 
static dvariable reset_all (const dvar_vector &x, const dvector &pen)
 Description not yet available. More...
 
static void restore (const ifstream &ifs)
 
static void restore_all_values (const dvector &x, const int &ii)
 
static void restore_start_phase (void)
 
static void save (void)
 
static void save (const ofstream &ofs, int prec)
 Author: David Fournier Copyright (c) 2008-2014 Regents of the University of California. More...
 
static void save_all (const ofstream &_ofs, int prec, const dvector &g)
 Write all values of g into output stream _ofs. More...
 
static void set_active_only_random_effects (void)
 
static void set_active_random_effects (void)
 
static void set_all_simulation_bounds (const dmatrix &symbds)
 
static void set_all_simulation_bounds (const dmatrix &symbds, const dvector &)
 
static void set_inactive_only_random_effects (void)
 
static void set_inactive_random_effects (void)
 
static int stddev_curvscale (const dvector &d, const dvector &x)
 
static int stddev_scale (const dvector &d, const dvector &x)
 
static int stddev_vscale (const dvar_vector &d, const dvar_vector &x)
 
static void xinit (const dvector &x)
 
static void xinit1 (const dvector &x, const dvector &g)
 
static void xinit_all (const dvector &x)
 Description not yet available. More...
 
- Public Attributes inherited from dvar_vector
int index_max
 
int index_min
 
arr_linklink_ptr
 
vector_shapexshape
 
double_and_intva
 
- Public Attributes inherited from initial_params
int phase_save
 
int phase_start
 
int phase_stop
 
- Static Public Attributes inherited from initial_params
static int current_phase =1
 
static bool in_hessian_phase = false
 
static int max_num_initial_params = 0
 
static int max_number_phases =1
 
static int mc_phase =0
 
static int mceval_phase =0
 
static int num_active_initial_params
 
static int num_initial_params = 0
 
static int restart_phase =0
 
static int sd_phase =0
 
static int straight_through_flag =0
 
static adlist_ptr varsptr
 
- Protected Member Functions inherited from initial_params
virtual ~initial_params ()
 Destructor. More...
 
- Protected Attributes inherited from model_name_tag
adstring name
 
- Protected Attributes inherited from initial_params
int active_flag
 
double initial_value
 
int initial_value_flag
 
double scalefactor
 
shareinfoshare_flags
 

Detailed Description

Description not yet available.

Parameters

Definition at line 968 of file admodel.h.

Constructor & Destructor Documentation

param_init_vector::param_init_vector ( )

Default constructor.

Definition at line 730 of file model.cpp.

Member Function Documentation

void param_init_vector::add_value ( const dvector y,
const dvector ndev,
const int &  _ii,
const double &  s,
const dvector diag 
)
virtual

Implements initial_params.

Definition at line 210 of file montebds.cpp.

void param_init_vector::add_value ( const dvector ndev,
const int &  _ii 
)
virtual

Implements initial_params.

Definition at line 33 of file mod_mc1.cpp.

void param_init_vector::allocate ( int  imin,
int  imax,
int  _phase_start = 1,
const char *  s = "UNNAMED" 
)

Allocate variable vector of parameters, then reads values from input data.

Parameters
iminlower vector index
imaxupper vector index
_phase_start
sparameter id

Definition at line 766 of file model.cpp.

Referenced by param_init_vector_vector::allocate().

void param_init_vector::allocate ( const ad_integer imin,
const ad_integer imax,
const ad_integer _phase_start = 1,
const char *  s = "UNNAMED" 
)

Allocate param_init_vector with dimension imin to imax using specified phase_start.

Note: May read values from either global parfile or bparfile.

Parameters
iminlower vector index
imaxupper vector index
phase_startspecified starting phase
sis the id

Definition at line 96 of file model43.cpp.

void param_init_vector::allocate ( int  imin,
int  imax,
const char *  s = "UNNAMED" 
)

Definition at line 859 of file model.cpp.

void param_init_vector::allocate ( int  imin,
int  imax,
const ivector ishare,
const char *  s = "UNNAMED" 
)
void param_init_vector::bsave_value ( uostream uos)
virtual

Implements initial_params.

Definition at line 742 of file model.cpp.

void param_init_vector::copy_value_to_vector ( const dvector x,
const int &  ii 
)
virtual

Implements initial_params.

Definition at line 31 of file model3.cpp.

void param_init_vector::curv_scale ( const dvector d,
const dvector x,
const int &  _ii 
)
virtual

Implements initial_params.

Definition at line 32 of file model19.cpp.

void param_init_vector::dev_correction ( const dmatrix H,
const int &  ii 
)
virtual

Implements initial_params.

Definition at line 36 of file model23.cpp.

void param_init_vector::get_jacobian ( const dvector y,
const dvector ndev,
const int &  _ii 
)
virtual

Implements initial_params.

Definition at line 357 of file montebds.cpp.

shareinfo* param_init_vector::get_share_flags ( ) const
inline

Definition at line 1026 of file admodel.h.

virtual void param_init_vector::hess_scale ( const dvector ,
const dvector ,
const int &   
)
inlinevirtual

Implements initial_params.

Definition at line 1004 of file admodel.h.

const char * param_init_vector::label ( void  )
virtual

Implements initial_params.

Definition at line 252 of file model11.cpp.

Referenced by save_value().

void param_init_vector::mc_scale ( const dvector _v,
const dvector x,
const int &  _ii 
)
virtual

Description not yet available.

Parameters

Implements initial_params.

Definition at line 92 of file mc_scale.cpp.

param_init_vector & param_init_vector::operator= ( const dvector vec)

Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California.

Assigns values from vec to param_init_vector.

Parameters
vecdvector with same dimensions as param_init_vector.
Returns
param_init_vector with same element values as vec.

Definition at line 13 of file model20.cpp.

Referenced by dll_param_init_vector::operator=().

param_init_vector & param_init_vector::operator= ( const dvar_vector varvec)

Assigns values from varvec to param_init_vector.

Parameters
varvecdvar_vector with same dimensions as param_init_vector.
Returns
param_init_vector with same element values as varvec.

Definition at line 24 of file model20.cpp.

param_init_vector & param_init_vector::operator= ( const prevariable var)

Assigns value var to param_init_vector.

Parameters
varvecdvar_vector with same dimensions as param_init_vector.
Returns
param_init_vector with same element values as varvec.

Definition at line 35 of file model20.cpp.

param_init_vector & param_init_vector::operator= ( const double &  val)

Assigns value val to param_init_vector.

Parameters
varvecdvar_vector with same dimensions as param_init_vector.
Returns
param_init_vector with same element values as varvec.

Definition at line 46 of file model20.cpp.

void param_init_vector::pvm_pack ( void  )
inlinevirtual

Implements initial_params.

Definition at line 982 of file admodel.h.

void param_init_vector::pvm_unpack ( void  )
inlinevirtual

Implements initial_params.

Definition at line 983 of file admodel.h.

void param_init_vector::report_value ( void  )
void param_init_vector::restore_value ( const ifstream &  ifs)
virtual

Implements initial_params.

Definition at line 26 of file model13.cpp.

void param_init_vector::restore_value_from_vector ( const dvector x,
const int &  ii 
)
virtual

Implements initial_params.

Definition at line 129 of file model3.cpp.

void param_init_vector::save_value ( ofstream &  ofs)
virtual

Implements initial_params.

Definition at line 736 of file model.cpp.

void param_init_vector::save_value ( const ofstream &  _ofs,
int  precision 
)
virtual

Write values of param_init_matrix into output stream _ofs.

Parameters
_ofsoutput stream
precisionsets the floating point precision

Implements initial_params.

Definition at line 47 of file model12.cpp.

void param_init_vector::save_value ( const ofstream &  _ofs,
int  precision,
const dvector g,
int &  offset 
)
virtual

Write values of g into output stream _ofs, then update offset index to the next set of data.

Parameters
_ofsoutput stream
precisionsets the floating point precision
gthe data to output
offsetbeginning index for g for param_init_matrix

Implements initial_params.

Definition at line 109 of file model12.cpp.

void param_init_vector::sd_scale ( const dvector d,
const dvector x,
const int &  _ii 
)
virtual

Implements initial_params.

Definition at line 51 of file model10.cpp.

void param_init_vector::sd_vscale ( const dvar_vector d,
const dvar_vector x,
const int &  ii 
)
virtual

Implements initial_params.

Definition at line 29 of file model53.cpp.

void param_init_vector::set_simulation_bounds ( const dmatrix symbds,
const int &  ii 
)
virtual

Implements initial_params.

Definition at line 56 of file montebds.cpp.

void param_init_vector::set_value ( const dvar_vector x,
const int &  ii,
const dvariable pen 
)
virtual

Implements initial_params.

Definition at line 688 of file model.cpp.

void param_init_vector::set_value_inv ( const dvector x,
const int &  ii 
)
virtual

Implements initial_params.

Definition at line 697 of file model.cpp.

void param_init_vector::setshare ( const index_type sf,
const index_type af 
)
virtual

Reimplemented from initial_params.

Definition at line 567 of file shared.cpp.

void param_init_vector::shared_set_value ( const dvar_vector _x,
const int &  _ii,
const dvariable pen 
)
virtual

Reimplemented from initial_params.

Definition at line 125 of file shared.cpp.

void param_init_vector::shared_set_value_inv ( const dvector _x,
const int &  _ii 
)
virtual

Reimplemented from initial_params.

Definition at line 70 of file shared.cpp.

int param_init_vector::shared_size_count ( void  )
virtual

Reimplemented from initial_params.

Definition at line 46 of file shared.cpp.

unsigned int param_init_vector::size_count ( ) const
virtual

Returns the number of active parameters.

Implements initial_params.

Definition at line 724 of file model.cpp.

Referenced by dev_correction().

Friends And Related Function Documentation

friend class param_init_vector_vector
friend

Definition at line 1021 of file admodel.h.


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