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

Description not yet available. More...

#include <admodel.h>

Public Member Functions

 param_init_matrix (void)
 
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 rmin, int rmax, int cmin, int cmax, int phase_start=1, const char *="UNNAMED")
 
void allocate (int rmin, int rmax, int cmin, int cmax, const char *="UNNAMED")
 
void allocate (const ad_integer &imin, const ad_integer &imax, const index_type &imin2, const index_type &imax2, const ad_integer &phase_start, const char *s)
 Allocates matrix with row dimensions imin to imax and column dimensions imin2 to imax2 using specified phase_start. More...
 
void allocate (const ad_integer &rmin, const ad_integer &rmax, const index_type &cmin, const index_type &cmax, const char *="UNNAMED")
 Allocates matrix with row dimensions rmin to rmax and column dimensions cmin to cmax with phase_start defaulting to 1. More...
 
void allocate (const ad_integer &rmin, const ad_integer &rmax, const index_type &cmin, const index_type &cmax, int phase_start=1, const char *="UNNAMED")
 Allocates matrix with row dimensions rmin to rmax and column dimensions cmin to cmax using specified phase_start. More...
 
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 get_jacobian (const dvector &, const dvector &, const int &)
 
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_matrixoperator= (const dmatrix &m)
 Assigns values from mat to param_init_matrix. More...
 
param_init_matrixoperator= (const dvar_matrix &m)
 Assigns values from _m to param_init_matrix. More...
 
param_init_matrixoperator= (const dvariable &m)
 Assigns value d to all elements of param_init_matrix. More...
 
param_init_matrixoperator= (const double &m)
 Assigns value d to all elements of param_init_matrix. More...
 
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, 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 save_value (const ofstream &ofs, int prec)
 Write values of param_init_matrix into output stream _ofs. More...
 
virtual void sd_scale (const dvector &d, const dvector &x, const int &ii)
 
virtual void sd_vscale (const dvar_vector &d, const dvar_vector &x, 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 unsigned int size_count () const
 Returns the number of active parameters. More...
 
- Public Member Functions inherited from named_dvar_matrix
 named_dvar_matrix (void)
 
void allocate (int rmin, int rmax, int cmin, int cmax, const char *s)
 
void allocate (int rmin, int rmax, const char *s)
 
void allocate (const char *s)
 
void allocate (int rmin, int rmax, const index_type &cmin, const index_type &cmax, const char *s)
 
named_dvar_matrixoperator= (const double m)
 Assign named_dvar_matrix with value. More...
 
named_dvar_matrixoperator= (const dmatrix &m)
 Assigns named_dvar_matrix with values from dmatrix dm. More...
 
named_dvar_matrixoperator= (const dvar_matrix &m)
 Assign named_dvar_matrix with values. More...
 
named_dvar_matrixoperator= (const dvariable &m)
 Assign named_dvar_matrix with value. More...
 
- Public Member Functions inherited from dvar_matrix
 dvar_matrix ()
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
 dvar_matrix (const banded_symmetric_dvar_matrix &v)
 Description not yet available. More...
 
 dvar_matrix (const banded_lower_triangular_dvar_matrix &v)
 Description not yet available. More...
 
 dvar_matrix (const param_init_vector_vector &)
 
 dvar_matrix (const param_init_bounded_vector_vector &)
 
 dvar_matrix (const param_init_bounded_number_matrix &)
 Description not yet available. More...
 
 dvar_matrix (const ad_integer &nrl, const ad_integer &nrh, const index_type &ncl, const index_type &nch)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
 dvar_matrix (int, int, int, int)
 Constructs AD variable matrix with dimensions nrl to nrh by ncl to nch. More...
 
 dvar_matrix (int, int)
 Description not yet available. More...
 
 dvar_matrix (int, int, kkludge_object kk)
 Description not yet available. More...
 
 dvar_matrix (int, int, const ivector &, const ivector &)
 Description not yet available. More...
 
 dvar_matrix (int, int, int, const ivector &)
 Description not yet available. More...
 
 dvar_matrix (const dvar_matrix &)
 Copy constructor. More...
 
 dvar_matrix (const dmatrix &)
 Copy constructor. More...
 
 ~dvar_matrix ()
 Destructor. More...
 
void allocate (int nrl, int nrh, int ncl, int nch)
 Allocates AD variable matrix with dimensions nrl to nrh by ncl to nch. More...
 
void allocate (int nrl, int nrh)
 Allocate variable matrix with dimension [nrl to nrh] where columns are empty. More...
 
void allocate (ad_integer nrl, ad_integer nrh)
 Allocate variable matrix with dimension [nrl to nrh] where columns are empty. More...
 
void allocate (const dmatrix &m1)
 Allocate variable matrix using the same dimensions as m1. More...
 
void allocate (const dvar_matrix &m1)
 Allocate variable matrix using the same dimensions as m1. More...
 
void allocate (int nrl, int nrh, const ivector &ncl, const ivector &nch)
 Allocate variable matrix with dimensions [nrl to nrh] x [ncl to nch] where ncl and nch. More...
 
void allocate (int nrl, int nrh, int ncl, const ivector &nch)
 Allocate variable matrix with dimensions [nrl to nrh] x [ncl to nch] where nch is a vector of indexes. More...
 
void allocate (int nrl, int nrh, const ivector &ncl, int nch)
 Allocate variable matrix with dimensions [nrl to nrh] x [ncl to nch] where ncl is a vector of indexes. More...
 
void allocate (void)
 Does not allocate, but initializes members. More...
 
void allocate (const ad_integer &nrl, const ad_integer &nrh, const index_type &ncl, const index_type &nch)
 Allocates AD variable matrix with dimensions nrl to nrh by ncl to nch. More...
 
void colfill (int j, const dvar_vector &v)
 Fills column of a matrix with a vector (supplied) More...
 
void colfill_randn (const int &j, long int &n)
 Description not yet available. More...
 
void colfill_randn_ni (const int &j, long int &n)
 Description not yet available. More...
 
void colfill_randu (const int &j, long int &n)
 Description not yet available. More...
 
void colfill_randu_ni (const int &j, long int &n)
 Description not yet available. More...
 
void colfill_seqadd (const int &, double, double)
 Fills column of a matrix with a sequence of the form base, base+offset, base+2*offset,... More...
 
void colfill_seqadd_ni (const int &, double, double)
 
int colmax (void) const
 
int colmin (void) const
 
void colshift (int min)
 Description not yet available. More...
 
unsigned int colsize () const
 
void deallocate ()
 Deallocate dvar_matrix memory. More...
 
dvar_vectorelem (int i)
 
prevariable elem (int i, int j)
 
dvar_vectorelem (int i) const
 
prevariable elem (int i, int j) const
 
double & elem_value (int i, int j)
 
const double & elem_value (int i, int j) const
 
void fill (const char *)
 Fill values of dvar_matrix with text input from s with format rowmin...rowmax where ith row is {colmin,...,colmax}. 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_randu (long int &n)
 Description not yet available. More...
 
void fill_randu_ni (long int &n)
 Description not yet available. More...
 
double fill_seqadd (double, double)
 Description not yet available. More...
 
unsigned int get_ncopies () const
 
int indexmax (void) const
 
int indexmin (void) const
 
void initialize (void)
 Zero initialize allocated dvar_matrix, then saves adjoint function and position data. More...
 
int operator! (void) const
 
dvar_vectoroperator() (int i)
 
const dvar_vectoroperator() (int i) const
 
prevariable operator() (int i, int j)
 
prevariable operator() (int i, int j) const
 
dvar_matrixoperator*= (const prevariable &t)
 Description not yet available. More...
 
dvar_matrixoperator*= (double t)
 Description not yet available. More...
 
dvar_matrixoperator++ (void)
 
dvar_matrixoperator+= (const dvar_matrix &x)
 Description not yet available. More...
 
dvar_matrixoperator+= (const dmatrix &x)
 Description not yet available. More...
 
dvar_matrixoperator-- (void)
 
dvar_matrixoperator-= (const dvar_matrix &x)
 Description not yet available. More...
 
dvar_matrixoperator-= (const dmatrix &x)
 Description not yet available. More...
 
dvar_matrixoperator/= (const prevariable &t)
 Description not yet available. More...
 
dvar_matrixoperator/= (double t)
 Description not yet available. More...
 
dvar_matrixoperator= (const dvar_matrix &)
 Assigns other values to dvar_matrix. More...
 
dvar_matrixoperator= (const dmatrix &)
 Assigns scalar matrix values to dvar_matrix. More...
 
dvar_matrixoperator= (double t)
 Description not yet available. More...
 
dvar_matrixoperator= (const prevariable &t)
 Description not yet available. More...
 
dvar_vectoroperator[] (int)
 
const dvar_vectoroperator[] (int) const
 
void read_from (const istream &)
 Read values to dvar_matrix from input istream s. More...
 
void read_from (const uistream &)
 Read values to dvar_matrix from input stream s. More...
 
void rowfill (int j, const dvar_vector &v)
 Fills row of a matrix with a vector (supplied) More...
 
void rowfill_randn (const int &i, long int &n)
 Description not yet available. More...
 
void rowfill_randn_ni (const int &i, long int &n)
 Description not yet available. More...
 
void rowfill_randu (const int &i, long int &n)
 Description not yet available. More...
 
void rowfill_randu_ni (const int &i, long int &n)
 Description not yet available. More...
 
void rowfill_seqadd (const int &, double, double)
 Fills vector with a sequence of the form base, base+offset, base+2*offset,... More...
 
int rowmax (void) const
 
int rowmin (void) const
 
void rowshift (int min)
 Description not yet available. More...
 
unsigned int rowsize () const
 
void save_dvar_matrix_position () const
 Description not yet available. More...
 
void save_dvar_matrix_value () const
 Saves the size, address, and value information for a dvar_matrix. More...
 
void shallow_copy (const dvar_matrix &)
 Shallow copy other data structure pointers. More...
 
dvar_matrix sub (int, int)
 Description not yet available. More...
 
void write_on (const ostream &) const
 Description not yet available. More...
 
void write_on (const uostream &) const
 Write values from dvar_matrix to output stream s. 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)
 

Private Member Functions

virtual void dev_correction (const dmatrix &, const int &)
 
void pvm_pack (void)
 
void pvm_unpack (void)
 
virtual void set_simulation_bounds (const dmatrix &symbds, const int &ii)
 
virtual void shared_set_value (const dvar_vector &, const int &, const dvariable &pen)
 
virtual void shared_set_value_inv (const dvector &x, const int &ii)
 
virtual int shared_size_count (void)
 

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 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 1316 of file admodel.h.

Constructor & Destructor Documentation

param_init_matrix::param_init_matrix ( void  )

Definition at line 1016 of file model.cpp.

Member Function Documentation

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

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 259 of file montebds.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 60 of file mod_mc1.cpp.

void param_init_matrix::allocate ( int  rmin,
int  rmax,
int  cmin,
int  cmax,
int  phase_start = 1,
const char *  s = "UNNAMED" 
)

Definition at line 821 of file model.cpp.

Referenced by param_init_matrix_vector::allocate().

void param_init_matrix::allocate ( int  rmin,
int  rmax,
int  cmin,
int  cmax,
const char *  s = "UNNAMED" 
)

Definition at line 806 of file model.cpp.

void param_init_matrix::allocate ( const ad_integer imin,
const ad_integer imax,
const index_type imin2,
const index_type imax2,
const ad_integer phase_start,
const char *  s 
)

Allocates matrix with row dimensions imin to imax and column dimensions imin2 to imax2 using specified phase_start.

Definition at line 73 of file model44.cpp.

void param_init_matrix::allocate ( const ad_integer rmin,
const ad_integer rmax,
const index_type cmin,
const index_type cmax,
const char *  s = "UNNAMED" 
)

Allocates matrix with row dimensions rmin to rmax and column dimensions cmin to cmax with phase_start defaulting to 1.

Definition at line 40 of file model30.cpp.

void param_init_matrix::allocate ( const ad_integer rmin,
const ad_integer rmax,
const index_type cmin,
const index_type cmax,
int  phase_start = 1,
const char *  s = "UNNAMED" 
)

Allocates matrix with row dimensions rmin to rmax and column dimensions cmin to cmax using specified phase_start.

Definition at line 13 of file model30.cpp.

void param_init_matrix::bsave_value ( uostream uos)
virtual

Implements initial_params.

Definition at line 1036 of file model.cpp.

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

Implements initial_params.

Definition at line 42 of file model3.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 45 of file model19.cpp.

void param_init_matrix::dev_correction ( const dmatrix H,
const int &  _ii 
)
privatevirtual

Implements initial_params.

Definition at line 24 of file model23.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 370 of file montebds.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 1355 of file admodel.h.

const char * param_init_matrix::label ( void  )
virtual

Implements initial_params.

Definition at line 234 of file model11.cpp.

Referenced by save_value().

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

Description not yet available.

Parameters

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 109 of file mc_scale.cpp.

param_init_matrix & param_init_matrix::operator= ( const dmatrix mat)

Assigns values from mat to param_init_matrix.

Parameters
matdmatrix with same dimensions
Returns
set with assigned values from mat

Definition at line 81 of file model20.cpp.

Referenced by dll_param_init_matrix::operator=().

param_init_matrix & param_init_matrix::operator= ( const dvar_matrix varmat)

Assigns values from _m to param_init_matrix.

Parameters
varmatdvar_matrix with same dimensions
Returns
set with assigned values from varmat

Definition at line 92 of file model20.cpp.

param_init_matrix & param_init_matrix::operator= ( const dvariable var)

Assigns value d to all elements of param_init_matrix.

Parameters
vardvariable
Returns
set with assigned value from var

Definition at line 103 of file model20.cpp.

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

Assigns value d to all elements of param_init_matrix.

Parameters
valscalar
Returns
set with assigned value from val

Definition at line 114 of file model20.cpp.

void param_init_matrix::pvm_pack ( void  )
inlineprivatevirtual

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 1327 of file admodel.h.

void param_init_matrix::pvm_unpack ( void  )
inlineprivatevirtual

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 1328 of file admodel.h.

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

Implements initial_params.

Definition at line 36 of file model13.cpp.

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

Implements initial_params.

Definition at line 141 of file model3.cpp.

void param_init_matrix::save_value ( ofstream &  ofs)
virtual

Implements initial_params.

Definition at line 1030 of file model.cpp.

void param_init_matrix::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 187 of file model12.cpp.

void param_init_matrix::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 73 of file model12.cpp.

void param_init_matrix::sd_scale ( const dvector d,
const dvector x,
const int &  ii 
)
virtual

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 69 of file model10.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 47 of file model53.cpp.

void param_init_matrix::set_simulation_bounds ( const dmatrix symbds,
const int &  ii 
)
privatevirtual

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 93 of file montebds.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 998 of file model.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 1008 of file model.cpp.

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

Reimplemented from initial_params.

Definition at line 596 of file shared.cpp.

void param_init_matrix::shared_set_value ( const dvar_vector _x,
const int &  _ii,
const dvariable pen 
)
privatevirtual

Reimplemented from initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 99 of file shared.cpp.

void param_init_matrix::shared_set_value_inv ( const dvector x,
const int &  ii 
)
privatevirtual

Reimplemented from initial_params.

Reimplemented in param_init_bounded_matrix.

Definition at line 55 of file shared.cpp.

int param_init_matrix::shared_size_count ( void  )
privatevirtual

Reimplemented from initial_params.

Definition at line 37 of file shared.cpp.

unsigned int param_init_matrix::size_count ( ) const
virtual

Returns the number of active parameters.

Implements initial_params.

Definition at line 1025 of file model.cpp.

Referenced by dev_correction().


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