param_init_bounded_number Class Reference

Description not yet available. More...

#include <admodel.h>

Public Member Functions
	param_init_bounded_number ()
	Default constructor. More...
	param_init_bounded_number (const double new_initial_value, const double bounds_min, const double bounds_max, const int phase_start, const char *name)
	param_init_bounded_number (const double new_initial_value, const double bounds_min, const double bounds_max, 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 (double _minb, double _maxb, int phase_start=1, const char *s="UNNAMED")
void	allocate (double _minb, double _maxb, const char *s="UNNAMED")
void	allocate (const data_vector &v, const char *s="UNNAMED")
	Use a data_vector to allocate an init_bounded_number. More...
void	allocate (init_xml_doc &, const char *s="UNNAMED")
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 &)
double	get_maxb () const
	Returns maximum bounds value for param_init_bounded_number. More...
double	get_minb (void)
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_bounded_number &	operator= (const double m)
param_init_bounded_number &	operator= (const prevariable &m)
void	pvm_pack (void)
void	pvm_unpack (void)
void	report_value (void)
virtual void	restore_value_from_vector (const dvector &, const int &)
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)
void	set_maxb (double b)
	Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
void	set_minb (double b)
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)
Public Member Functions inherited from param_init_number
	param_init_number ()
	param_init_number (const char *name)
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	dev_correction (const dmatrix &, const int &)
param_init_number &	operator= (const double m)
param_init_number &	operator= (const prevariable &m)
void	report_value (void)
virtual void	restore_value (const ifstream &ifs)
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 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_dvariable &	operator= (const prevariable &m)
named_dvariable &	operator= (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...
dvariable &	operator= (const double x)
	Assigns a value to a dvariable object. More...
dvariable &	operator= (const prevariable &other)
	Assigns a value to a dvariable object. More...
dvariable &	operator= (const dvariable &other)
dvariable &	operator= (const df1_one_variable &)
dvariable &	operator= (const df1_two_variable &)
dvariable &	operator= (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_int *	get_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...
prevariable &	operator+= (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...
prevariable &	operator= (const prevariable &)
	Assigns a value to a prevariable object. More...
prevariable &	operator= (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)

Public Attributes
double	maxb
double	minb
Public Attributes inherited from prevariable
double_and_int *	v
	pointer to the data More...
Public Attributes inherited from initial_params
int	phase_save
int	phase_start
int	phase_stop

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...
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
shareinfo *	share_flags

Detailed Description

Description not yet available.

Parameters

\author

Dave Founier & Steve Martell Overloaded allocate function to recieve a data_vector from an input file.

Definition at line 1228 of file admodel.h.

Constructor & Destructor Documentation

param_init_bounded_number::param_init_bounded_number

(

)

Default constructor.

Definition at line 924 of file model.cpp.

param_init_bounded_number::param_init_bounded_number ( const double  new_initial_value, const double  bounds_min, const double  bounds_max, const int  phase_start, const char *  name  )

inline

Definition at line 1249 of file admodel.h.

param_init_bounded_number::param_init_bounded_number ( const double  new_initial_value, const double  bounds_min, const double  bounds_max, const char *  name  )

inline

Definition at line 1261 of file admodel.h.

Member Function Documentation

void param_init_bounded_number::add_value ( const dvector &  _y, const dvector &  ndev, const int &  _ii, const double &  s, const dvector &  diag  )

virtual

Reimplemented from param_init_number.

Definition at line 202 of file montebds.cpp.

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

virtual

Reimplemented from param_init_number.

Definition at line 26 of file mod_mc1.cpp.

void param_init_bounded_number::allocate	(	double	_minb,
		double	_maxb,
		int	phase_start = 1,
		const char *	s = "UNNAMED"
	)

Definition at line 489 of file model.cpp.

Referenced by allocate(), param_init_bounded_number_vector::allocate(), and param_init_bounded_number().

void param_init_bounded_number::allocate	(	double	_minb,
		double	_maxb,
		const char *	s = "UNNAMED"
	)

Definition at line 551 of file model.cpp.

void param_init_bounded_number::allocate	(	const data_vector &	_v,
		const char *	_s = "UNNAMED"
	)

Use a data_vector to allocate an init_bounded_number.

Author

Steve Martell

Parameters

_v	vector containing the lower bound, upper bound, and phase of estimation.

Definition at line 479 of file model.cpp.

void param_init_bounded_number::allocate	(	init_xml_doc &	,
		const char *	s = "UNNAMED"
	)

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

virtual

Reimplemented from param_init_number.

Definition at line 25 of file model3.cpp.

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

virtual

Reimplemented from param_init_number.

Definition at line 18 of file model19.cpp.

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

virtual

Reimplemented from param_init_number.

Definition at line 349 of file montebds.cpp.

double param_init_bounded_number::get_maxb

(

)

const

Returns maximum bounds value for param_init_bounded_number.

Definition at line 20 of file model50.cpp.

Referenced by check_for_params_on_bounds().

double param_init_bounded_number::get_minb

(

void

)

Definition at line 162 of file model10.cpp.

Referenced by check_for_params_on_bounds().

virtual void param_init_bounded_number::hess_scale ( const dvector &  , const dvector &  , const int &    )

inlinevirtual

Reimplemented from param_init_number.

Definition at line 1287 of file admodel.h.

const char * param_init_bounded_number::label ( void  )

virtual

Reimplemented from param_init_number.

Definition at line 240 of file model11.cpp.

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

virtual

Description not yet available.

Parameters

Reimplemented from param_init_number.

Definition at line 44 of file mc_scale.cpp.

param_init_bounded_number & param_init_bounded_number::operator=

(

const double

m

)

Definition at line 221 of file model11.cpp.

param_init_bounded_number & param_init_bounded_number::operator=

(

const prevariable &

m

)

Definition at line 227 of file model11.cpp.

void param_init_bounded_number::pvm_pack ( void  )

inlinevirtual

Reimplemented from param_init_number.

Definition at line 1245 of file admodel.h.

void param_init_bounded_number::pvm_unpack ( void  )

inlinevirtual

Reimplemented from param_init_number.

Definition at line 1246 of file admodel.h.

void param_init_bounded_number::report_value

(

void

)

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

virtual

Reimplemented from param_init_number.

Definition at line 123 of file model3.cpp.

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

virtual

Reimplemented from param_init_number.

Definition at line 26 of file model10.cpp.

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

virtual

Reimplemented from param_init_number.

Definition at line 20 of file model53.cpp.

void param_init_bounded_number::set_maxb

(

double

val

)

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

Set maximum bounds value for param_init_bounded_number.

Parameters

val

double

Definition at line 13 of file model50.cpp.

void param_init_bounded_number::set_minb

(

double

b

)

Definition at line 157 of file model10.cpp.

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

virtual

Reimplemented from param_init_number.

Definition at line 46 of file montebds.cpp.

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

virtual

Reimplemented from param_init_number.

Definition at line 535 of file model.cpp.

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

virtual

Reimplemented from param_init_number.

Definition at line 544 of file model.cpp.

Member Data Documentation

double param_init_bounded_number::maxb

Definition at line 1236 of file admodel.h.

Referenced by add_value(), allocate(), dll_param_init_bounded_number::allocate(), curv_scale(), get_maxb(), mc_scale(), sd_scale(), sd_vscale(), set_maxb(), set_simulation_bounds(), set_value(), and set_value_inv().

double param_init_bounded_number::minb

Definition at line 1235 of file admodel.h.

Referenced by add_value(), allocate(), dll_param_init_bounded_number::allocate(), curv_scale(), get_minb(), mc_scale(), sd_scale(), sd_vscale(), set_minb(), set_simulation_bounds(), set_value(), and set_value_inv().

---

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

• admodel.h (Last Changed on May 13, 2022 for git-revision 4aafc7ceeb108263fdf90577fb213d3829bc3084.)
• mc_scale.cpp (Last Changed on April 05, 2018 for git-revision d973ebba3bce19abddbc095f97cad763cea4cca2.)
• mod_mc1.cpp (Last Changed on July 20, 2022 for git-revision bd28a66207f41224474ff575abe83a0ba117fb05.)
• model.cpp (Last Changed on June 29, 2022 for git-revision be1526a357a87937cf302cae3cdbcf78712362c7.)
• model10.cpp (Last Changed on November 07, 2014 for git-revision b6779ed31e6fd3ec8d3084569c73588040e52337.)
• model11.cpp (Last Changed on May 04, 2017 for git-revision da41c0affdc41dae2dbe43eff36d44ada1993ffd.)
• model19.cpp (Last Changed on April 22, 2014 for git-revision 219a09ff06fd9cee4c006dd85abbefca00beea03.)
• model3.cpp (Last Changed on July 18, 2022 for git-revision d963619c1b384bec88930e89fe8e139f0b075620.)
• model50.cpp (Last Changed on June 01, 2017 for git-revision b98b70d73d5ba290f29385a8c3ddb760ef598f83.)
• model53.cpp (Last Changed on April 22, 2014 for git-revision 219a09ff06fd9cee4c006dd85abbefca00beea03.)
• montebds.cpp (Last Changed on July 20, 2022 for git-revision bd28a66207f41224474ff575abe83a0ba117fb05.)