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_number Class Reference

Description not yet available. More...

#include <admodel.h>

Public Member Functions

 param_init_number ()
 
 param_init_number (const char *name)
 
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 phase_start=1, const char *s="UNNAMED")
 
void allocate (const char *s="UNNAMED")
 
void allocate (init_xml_doc &, 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 &, 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_numberoperator= (const double m)
 
param_init_numberoperator= (const prevariable &m)
 
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 (const ofstream &ofs, int prec)
 Write values of param_init_number 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 save_value (ofstream &ofs)
 Saves value param_init_number to 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_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 unsigned int size_count () const
 Returns number of active paramters. More...
 
- Public Member Functions inherited from named_dvariable
 named_dvariable (void)
 
void allocate (const char *s)
 
named_dvariableoperator= (const prevariable &m)
 
named_dvariableoperator= (const double m)
 
- Public Member Functions inherited from dvariable
 dvariable ()
 Default constructor. More...
 
 dvariable (const dvariable &t)
 Copy constructor for dvariable object; deep copy. More...
 
 dvariable (const double t)
 Creates dvariable instance from a double constant. More...
 
 dvariable (const int &t)
 Creates dvariable instance from a int constant. More...
 
 dvariable (kkludge_object)
 Specialized constructor that does not create unnecessary entries in the gradient structure; see function nograd_assign. More...
 
 dvariable (const prevariable &t)
 Constructor for dvariable object from its base class; deep copy. More...
 
virtual ~dvariable ()
 Destructor; frees memory on gradient stack. More...
 
dvariableoperator= (const double x)
 Assigns a value to a dvariable object. More...
 
dvariableoperator= (const prevariable &other)
 Assigns a value to a dvariable object. More...
 
dvariableoperator= (const dvariable &other)
 
dvariableoperator= (const df1_one_variable &)
 
dvariableoperator= (const df1_two_variable &)
 
dvariableoperator= (const df1_three_variable &)
 Description not yet available. More...
 
- Public Member Functions inherited from prevariable
 prevariable (const prevariable &other)
 Copy Constructor. More...
 
double_and_int *& get_v ()
 
double_and_intget_v () const
 
void initialize (void)
 Description not yet available. More...
 
int operator!= (const prevariable &v1) const
 Description not yet available. More...
 
int operator!= (double v1) const
 Description not yet available. More...
 
void operator*= (const prevariable &v1)
 Description not yet available. More...
 
void operator*= (double v1)
 Description not yet available. More...
 
prevariableoperator+= (const prevariable &)
 Prevariable addition assignment operator. More...
 
void operator+= (double t1)
 Description not yet available. More...
 
void operator-= (const prevariable &t1)
 Description not yet available. More...
 
void operator-= (double t1)
 Description not yet available. More...
 
void operator/= (const prevariable &v1)
 Description not yet available. More...
 
void operator/= (double v1)
 Description not yet available. More...
 
int operator< (const prevariable &v1) const
 Description not yet available. More...
 
int operator< (double v1) const
 Description not yet available. More...
 
int operator<= (const prevariable &v1) const
 Description not yet available. More...
 
int operator<= (double v1) const
 Description not yet available. More...
 
prevariableoperator= (const prevariable &)
 Assigns a value to a prevariable object. More...
 
prevariableoperator= (double)
 Assigns a value to a prevariable object. More...
 
int operator== (const prevariable &v1) const
 Description not yet available. More...
 
int operator== (double v1) const
 Description not yet available. More...
 
int operator> (const prevariable &v1) const
 Description not yet available. More...
 
int operator> (double v1) const
 Description not yet available. More...
 
int operator>= (const prevariable &v1) const
 Description not yet available. More...
 
int operator>= (double v1) const
 Description not yet available. More...
 
double restore_prevariable_derivative (void)
 
prevariable_position restore_prevariable_position (void)
 
double restore_prevariable_value (void)
 
void save_prevariable_position () const
 Description not yet available. More...
 
void save_prevariable_value () const
 Description not yet available. More...
 
double * xadr ()
 
double & xval ()
 
- 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)
 
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)
 

Friends

class param_init_number_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 prevariable
double_and_intv
 pointer to the data 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 prevariable
 prevariable ()=delete
 Default constructor. More...
 
 prevariable (double_and_int *u)
 
- 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 1151 of file admodel.h.

Constructor & Destructor Documentation

param_init_number::param_init_number ( )

Definition at line 459 of file model.cpp.

param_init_number::param_init_number ( const char *  name)
inline

Definition at line 1194 of file admodel.h.

Member Function Documentation

void param_init_number::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_number.

Definition at line 133 of file montebds.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 19 of file mod_mc1.cpp.

void param_init_number::allocate ( int  phase_start = 1,
const char *  s = "UNNAMED" 
)

Definition at line 629 of file model.cpp.

Referenced by allocate(), param_init_number_vector::allocate(), and param_init_number().

void param_init_number::allocate ( const char *  s = "UNNAMED")

Definition at line 659 of file model.cpp.

void param_init_number::allocate ( init_xml_doc &  ,
const char *  s = "UNNAMED" 
)
void param_init_number::bsave_value ( uostream uos)
virtual

Implements initial_params.

Definition at line 682 of file model.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 21 of file model3.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 9 of file model19.cpp.

void param_init_number::dev_correction ( const dmatrix H,
const int &  _ii 
)
virtual

Implements initial_params.

Definition at line 18 of file model23.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 341 of file montebds.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 1185 of file admodel.h.

const char * param_init_number::label ( void  )
virtual

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 258 of file model11.cpp.

Referenced by save_value().

void param_init_number::mc_scale ( const dvector _d,
const dvector x,
const int &  _ii 
)
virtual

Description not yet available.

Parameters

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 31 of file mc_scale.cpp.

param_init_number & param_init_number::operator= ( const double  m)

Definition at line 209 of file model11.cpp.

param_init_number & param_init_number::operator= ( const prevariable m)

Definition at line 215 of file model11.cpp.

void param_init_number::pvm_pack ( void  )
inlinevirtual

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 1158 of file admodel.h.

void param_init_number::pvm_unpack ( void  )
inlinevirtual

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 1159 of file admodel.h.

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

Implements initial_params.

Definition at line 17 of file model13.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 117 of file model3.cpp.

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

Write values of param_init_number into output stream _ofs.

Parameters
_ofsoutput stream
precisionsets the floating point precision

Implements initial_params.

Definition at line 30 of file model12.cpp.

void param_init_number::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 89 of file model12.cpp.

void param_init_number::save_value ( ofstream &  ofs)
virtual

Saves value param_init_number to output stream ofs.

Parameters
ofsoutput stream

Implements initial_params.

Definition at line 669 of file model.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 16 of file model10.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 11 of file model53.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 36 of file montebds.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 442 of file model.cpp.

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

Implements initial_params.

Reimplemented in param_init_bounded_number.

Definition at line 451 of file model.cpp.

unsigned int param_init_number::size_count ( ) const
virtual

Returns number of active paramters.

Implements initial_params.

Definition at line 468 of file model.cpp.

Friends And Related Function Documentation

friend class param_init_number_vector
friend

Definition at line 1192 of file admodel.h.


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