prevariable Class Reference

Base class for dvariable. More...

#include <fvar.hpp>

Public Member Functions
	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 Attributes
double_and_int *	v
	pointer to the data More...

Protected Member Functions
	prevariable ()=delete
	Default constructor. More...
	prevariable (double_and_int *u)

Friends
prevariable &	acos (const prevariable &t1)
	Description not yet available. More...
double *	address (const prevariable &v1)
prevariable &	asin (const prevariable &t1)
	Description not yet available. More...
prevariable &	atan (const prevariable &t1)
	Description not yet available. More...
prevariable &	atan2 (const prevariable &t1, const prevariable &t2)
	Description not yet available. More...
prevariable &	atan2 (const prevariable &t1, double t2)
	Description not yet available. More...
prevariable &	atan2 (double t1, const prevariable &t2)
	Description not yet available. More...
class	banded_lower_triangular_dvar_matrix
class	banded_symmetric_dvar_matrix
prevariable &	cos (const prevariable &t1)
	Description not yet available. More...
prevariable &	cosh (const prevariable &t1)
	Description not yet available. More...
class	dvar3_array
class	dvar_matrix
class	dvar_vector
class	dvar_vector_iterator
prevariable &	exp (const prevariable &t1)
	Compute exponential variable. More...
prevariable &	fabs (const prevariable &t1)
	Absolute value. More...
char *	fform (const char *, const prevariable &)
class	gradient_structure
double_and_int *	gradnew ()
	Creates an entry in the gradient structure linked list. More...
class	indvar_offset_list
prevariable &	ldexp (const prevariable &, const int &)
	Description not yet available. More...
prevariable &	log (const prevariable &t1)
	Description not yet available. More...
prevariable &	log10 (const prevariable &t1)
	Description not yet available. More...
void	make_indvar_list (int, dvariable *)
prevariable &	operator* (const prevariable &v1, const prevariable &v2)
	Description not yet available. More...
prevariable &	operator* (double v1, const prevariable &v2)
	Description not yet available. More...
prevariable &	operator* (const prevariable &v1, double v2)
	Description not yet available. More...
prevariable &	operator+ (const prevariable &v1, const prevariable &v2)
	Description not yet available. More...
prevariable &	operator+ (double v1, const prevariable &v2)
	Description not yet available. More...
prevariable &	operator+ (const prevariable &v1, double v2)
	Description not yet available. More...
prevariable &	operator- (const prevariable &v1)
	Description not yet available. More...
prevariable &	operator- (const prevariable &v1, const prevariable &v2)
	Description not yet available. More...
prevariable &	operator- (double v1, const prevariable &v2)
	Description not yet available. More...
prevariable &	operator- (const prevariable &v1, double v2)
	Description not yet available. More...
prevariable &	operator/ (const prevariable &t1, const prevariable &t2)
	Description not yet available. More...
prevariable &	operator/ (double t1, const prevariable &t2)
	Description not yet available. More...
prevariable &	operator/ (const prevariable &t1, double t2)
	Description not yet available. More...
prevariable &	pow (const prevariable &t1, const prevariable &t2)
	Description not yet available. More...
prevariable &	pow (const prevariable &t1, double t2)
	Description not yet available. More...
prevariable &	pow (double t1, const prevariable &t2)
	Description not yet available. More...
prevariable &	sfabs (const prevariable &t1)
	Smooth absolute value. More...
prevariable &	sigmoid (const prevariable &t1)
	Description not yet available. More...
prevariable &	sin (const prevariable &t1)
	Description not yet available. More...
prevariable &	sinh (const prevariable &t1)
	Description not yet available. More...
prevariable &	sqr (const prevariable &t1)
	Returns the square of v1. More...
prevariable &	sqrt (const prevariable &t1)
	Description not yet available. More...
prevariable &	tan (const prevariable &t1)
	Description not yet available. More...
prevariable &	tanh (const prevariable &t1)
	Description not yet available. More...
double &	value (const prevariable &v1)

Detailed Description

Base class for dvariable.

Principle role is to avoid calling a destructor when a pevariable or dvariable object is passed on the stack. (There is no destructor, ~prevariable().)

Definition at line 1315 of file fvar.hpp.

Constructor & Destructor Documentation

prevariable::prevariable ( )

protecteddelete

Default constructor.

prevariable::prevariable ( double_and_int *  u )

inlineprotected

Definition at line 1320 of file fvar.hpp.

prevariable::prevariable ( const prevariable &  other )

inline

Copy Constructor.

Note - Shallow copy is the same as 12.3 where copy constructor is not declared.

Definition at line 1331 of file fvar.hpp.

Member Function Documentation

double_and_int*& prevariable::get_v ( void  )

inline

Definition at line 1419 of file fvar.hpp.

Referenced by prevariable_position::prevariable_position(), and DF_FILE::save_prevariable_position().

double_and_int* prevariable::get_v ( void  ) const

inline

Definition at line 1423 of file fvar.hpp.

void prevariable::initialize

(

void

)

Description not yet available.

Parameters

Definition at line 56 of file fvar_fn.cpp.

int prevariable::operator!=

(

const prevariable &

v1

)

const

Description not yet available.

Parameters

Definition at line 128 of file fvar_opr.cpp.

int prevariable::operator!=

(

double

v1

)

const

Description not yet available.

Parameters

Definition at line 76 of file fvar_op3.cpp.

void prevariable::operator*=

(

const prevariable &

v1

)

Description not yet available.

Parameters

Definition at line 122 of file fvar_op5.cpp.

void prevariable::operator*=

(

double

v1

)

Description not yet available.

Parameters

Definition at line 133 of file fvar_op5.cpp.

prevariable & prevariable::operator+=

(

const prevariable &

other

)

Prevariable addition assignment operator.

Parameters

other

add to prevariable

Definition at line 36 of file fvar_op9.cpp.

void prevariable::operator+=

(

double

t1

)

Description not yet available.

Parameters

Definition at line 32 of file fvar_opr.cpp.

void prevariable::operator-=

(

const prevariable &

v1

)

Description not yet available.

Parameters

Definition at line 34 of file fvar_o11.cpp.

void prevariable::operator-=

(

double

t1

)

Description not yet available.

Parameters

Definition at line 41 of file fvar_opr.cpp.

void prevariable::operator/=

(

const prevariable &

v1

)

Description not yet available.

Parameters

Definition at line 100 of file fvar_op5.cpp.

void prevariable::operator/=

(

double

v1

)

Description not yet available.

Parameters

Definition at line 111 of file fvar_op5.cpp.

int prevariable::operator<

(

const prevariable &

v1

)

const

Description not yet available.

Parameters

Definition at line 101 of file fvar_opr.cpp.

int prevariable::operator<

(

double

v1

)

const

Description not yet available.

Parameters

Definition at line 49 of file fvar_op3.cpp.

int prevariable::operator<=

(

const prevariable &

v1

)

const

Description not yet available.

Parameters

Definition at line 92 of file fvar_opr.cpp.

int prevariable::operator<=

(

double

v1

)

const

Description not yet available.

Parameters

Definition at line 40 of file fvar_op3.cpp.

prevariable & prevariable::operator=

(

const prevariable &

t

)

Assigns a value to a prevariable object.

Parameters

t	constant reference to an object of type prevariable.

Returns

prevariable reference

Definition at line 61 of file fvar_o10.cpp.

Referenced by param_init_number::allocate(), param_init_bounded_number::allocate(), dll_param_init_bounded_number::allocate(), named_dvariable::operator=(), dvariable::operator=(), param_stddev_number::operator=(), and objective_function_value::operator=().

prevariable & prevariable::operator=

(

double

t

)

Assigns a value to a prevariable object.

Parameters

t	constant object of type double.

Returns

prevariable reference

Definition at line 75 of file fvar_o10.cpp.

int prevariable::operator==

(

const prevariable &

v1

)

const

Description not yet available.

Parameters

Definition at line 83 of file fvar_opr.cpp.

int prevariable::operator==

(

double

v1

)

const

Description not yet available.

Parameters

Definition at line 31 of file fvar_op3.cpp.

int prevariable::operator>

(

const prevariable &

v1

)

const

Description not yet available.

Parameters

Definition at line 110 of file fvar_opr.cpp.

int prevariable::operator>

(

double

v1

)

const

Description not yet available.

Parameters

Definition at line 58 of file fvar_op3.cpp.

int prevariable::operator>=

(

const prevariable &

v1

)

const

Description not yet available.

Parameters

Definition at line 119 of file fvar_opr.cpp.

int prevariable::operator>=

(

double

v1

)

const

Description not yet available.

Parameters

Definition at line 67 of file fvar_op3.cpp.

double prevariable::restore_prevariable_derivative

(

void

)

prevariable_position prevariable::restore_prevariable_position

(

void

)

double prevariable::restore_prevariable_value

(

void

)

void prevariable::save_prevariable_position

(

)

const

Description not yet available.

Parameters

Definition at line 56 of file cmpdif8.cpp.

void prevariable::save_prevariable_value

(

)

const

Description not yet available.

Parameters

Definition at line 72 of file cmpdif8.cpp.

double* prevariable::xadr ( )

inline

Definition at line 1410 of file fvar.hpp.

double& prevariable::xval ( )

inline

Definition at line 1414 of file fvar.hpp.

Friends And Related Function Documentation

prevariable& acos ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 175 of file fvar_fn1.cpp.

double* address ( const prevariable &  v1 )

friend

Definition at line 1500 of file fvar.hpp.

prevariable& asin ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 191 of file fvar_fn1.cpp.

prevariable& atan ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 64 of file fvar_fn1.cpp.

prevariable& atan2 ( const prevariable &  t1, const prevariable &  t2  )

friend

Description not yet available.

Parameters

Definition at line 274 of file fvar_fn1.cpp.

prevariable& atan2 ( const prevariable &  t1, double  t2  )

friend

Description not yet available.

Parameters

Definition at line 294 of file fvar_fn1.cpp.

prevariable& atan2 ( double  t1, const prevariable &  t2  )

friend

Description not yet available.

Parameters

Definition at line 314 of file fvar_fn1.cpp.

friend class banded_lower_triangular_dvar_matrix

friend

Definition at line 1346 of file fvar.hpp.

friend class banded_symmetric_dvar_matrix

friend

Definition at line 1345 of file fvar.hpp.

prevariable& cos ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 178 of file fvar_fn.cpp.

prevariable& cosh ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 259 of file fvar_fn1.cpp.

friend class dvar3_array

friend

Definition at line 1338 of file fvar.hpp.

friend class dvar_matrix

friend

Definition at line 1337 of file fvar.hpp.

friend class dvar_vector

friend

Definition at line 1336 of file fvar.hpp.

friend class dvar_vector_iterator

friend

Definition at line 1335 of file fvar.hpp.

prevariable& exp ( const prevariable &  t1 )

friend

Compute exponential variable.

Parameters

v1	is the input value.

Returns

exponential variable of v1.

Definition at line 22 of file fvar_fn1.cpp.

prevariable& fabs ( const prevariable &  t1 )

friend

Absolute value.

Simple overload of standard C library function. Not differentiable and should not be used in cases where an independent variable is expected to change sign. Use sfabs in such cases.

Parameters

v1	Indpendent variable

Returns

Definition at line 105 of file fvar_fn.cpp.

char* fform ( const char *  , const prevariable &    )

friend

friend class gradient_structure

friend

Definition at line 1341 of file fvar.hpp.

double_and_int* gradnew ( )

friend

Creates an entry in the gradient structure linked list.

Returns

Pointer instance of class double_and_int

Definition at line 36 of file fvar2.cpp.

friend class indvar_offset_list

friend

Definition at line 1340 of file fvar.hpp.

prevariable& ldexp ( const prevariable &  v1, const int &  exponent  )

friend

Description not yet available.

Parameters

Definition at line 80 of file fvar_fn1.cpp.

prevariable& log ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 194 of file fvar_fn.cpp.

prevariable& log10 ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 210 of file fvar_fn.cpp.

void make_indvar_list ( int  , dvariable *    )

friend

prevariable& operator* ( const prevariable &  v1, const prevariable &  v2  )

friend

Description not yet available.

Parameters

Definition at line 65 of file fvar_opr.cpp.

prevariable& operator* ( double  v1, const prevariable &  v2  )

friend

Description not yet available.

Parameters

Definition at line 72 of file fvar_op5.cpp.

prevariable& operator* ( const prevariable &  v1, double  v2  )

friend

Description not yet available.

Parameters

Definition at line 86 of file fvar_op5.cpp.

prevariable& operator+ ( const prevariable &  v1, const prevariable &  v2  )

friend

Description not yet available.

Parameters

Definition at line 50 of file fvar_opr.cpp.

prevariable& operator+ ( double  v1, const prevariable &  v2  )

friend

Description not yet available.

Parameters

Definition at line 33 of file fvar_op2.cpp.

prevariable& operator+ ( const prevariable &  v1, double  v2  )

friend

Description not yet available.

Parameters

Definition at line 48 of file fvar_op2.cpp.

prevariable& operator- ( const prevariable &  v1 )

friend

Description not yet available.

Parameters

Definition at line 108 of file fvar_op2.cpp.

prevariable& operator- ( const prevariable &  v1, const prevariable &  v2  )

friend

Description not yet available.

Parameters

Definition at line 63 of file fvar_op2.cpp.

prevariable& operator- ( double  v1, const prevariable &  v2  )

friend

Description not yet available.

Parameters

Definition at line 93 of file fvar_op2.cpp.

prevariable& operator- ( const prevariable &  v1, double  v2  )

friend

Description not yet available.

Parameters

Definition at line 78 of file fvar_op2.cpp.

prevariable& operator/ ( const prevariable &  t1, const prevariable &  t2  )

friend

Description not yet available.

Parameters

Definition at line 123 of file fvar_op2.cpp.

prevariable& operator/ ( double  t1, const prevariable &  t2  )

friend

Description not yet available.

Parameters

Definition at line 140 of file fvar_op2.cpp.

prevariable& operator/ ( const prevariable &  t1, double  t2  )

friend

Description not yet available.

Parameters

Definition at line 158 of file fvar_op2.cpp.

prevariable& pow ( const prevariable &  t1, const prevariable &  t2  )

friend

Description not yet available.

Parameters

Definition at line 207 of file fvar_fn1.cpp.

prevariable& pow ( const prevariable &  t1, double  t2  )

friend

Description not yet available.

Parameters

Definition at line 31 of file fvar_fn.cpp.

prevariable& pow ( double  t1, const prevariable &  t2  )

friend

Description not yet available.

Parameters

Definition at line 227 of file fvar_fn1.cpp.

prevariable& sfabs ( const prevariable &  t1 )

friend

Smooth absolute value.

Uses thrid order polynomial to interpolate between += 0.001. Derivatives correct for all values of indpendent variable != 0.

Parameters

v1	Indpendent variable

Returns

Definition at line 125 of file fvar_fn.cpp.

prevariable& sigmoid ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 80 of file fvar_fn.cpp.

prevariable& sin ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 65 of file fvar_fn.cpp.

prevariable& sinh ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 244 of file fvar_fn1.cpp.

prevariable& sqr ( const prevariable &  t1 )

friend

Returns the square of v1.

Parameters

v1

variable

Definition at line 119 of file fvar_fn1.cpp.

prevariable& sqrt ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 95 of file fvar_fn1.cpp.

prevariable& tan ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 144 of file fvar_fn1.cpp.

prevariable& tanh ( const prevariable &  t1 )

friend

Description not yet available.

Parameters

Definition at line 160 of file fvar_fn1.cpp.

double& value ( const prevariable &  v1 )

friend

Definition at line 1495 of file fvar.hpp.

Referenced by param_init_bounded_number::add_value(), param_init_number::allocate(), param_init_bounded_number::allocate(), param_likeprof_number::get_value(), operator!=(), operator<(), operator<=(), dvariable::operator=(), operator==(), operator>(), operator>=(), param_init_bounded_number::set_simulation_bounds(), dll_param_init_bounded_number::~dll_param_init_bounded_number(), dll_param_init_number::~dll_param_init_number(), and dll_param_number::~dll_param_number().

Member Data Documentation

double_and_int* prevariable::v

pointer to the data

Definition at line 1333 of file fvar.hpp.

Referenced by acos(), address(), asin(), atan(), bounded_cumd_norm(), cos(), cosh(), cube(), cumd_norm(), dvariable::dvariable(), exp(), fabs(), fourth(), gammlnguts(), get_v(), inv_cumd_gamma(), inv_cumd_norm_inner(), ldexp(), log(), log10(), operator!=(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/=(), operator<(), operator<=(), operator=(), operator==(), operator>(), operator>=(), pow(), sfabs(), sigmoid(), sin(), sinh(), sqrt(), square(), tan(), tanh(), value(), xadr(), xval(), and dvariable::~dvariable().

---

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

• fvar.hpp (Last Changed on August 07, 2022 for git-revision 0a920593f1602d0b526036677a330e80065904b7.)
• cmpdif8.cpp (Last Changed on August 06, 2022 for git-revision 808780089317c67198079de06b64df009a4a6543.)
• fvar_fn.cpp (Last Changed on August 01, 2022 for git-revision c159956c7a1088d1ddf4d0b926b1fcb26294216a.)
• fvar_o10.cpp (Last Changed on August 04, 2022 for git-revision 7cd7318784353148c6e529535a342d1f397cf38b.)
• fvar_o11.cpp (Last Changed on August 01, 2022 for git-revision c159956c7a1088d1ddf4d0b926b1fcb26294216a.)
• fvar_op3.cpp (Last Changed on February 21, 2020 for git-revision c76a43895bfab9a6330523a83ac76b3707baeb9e.)
• fvar_op5.cpp (Last Changed on August 01, 2022 for git-revision c159956c7a1088d1ddf4d0b926b1fcb26294216a.)
• fvar_op9.cpp (Last Changed on August 01, 2022 for git-revision c159956c7a1088d1ddf4d0b926b1fcb26294216a.)
• fvar_opr.cpp (Last Changed on August 06, 2022 for git-revision 808780089317c67198079de06b64df009a4a6543.)