ADMB Documentation  11.1.1920
 All Classes Files Functions Variables Typedefs Friends Defines
Public Member Functions | Public Attributes | Protected Member Functions | Friends
prevariable Class Reference

Base class for dvariable. More...

#include <fvar.hpp>

Public Member Functions

double_and_int *& get_v ()
double_and_intget_v () const
void initialize (void)
 Description not yet available.
int operator!= (const prevariable &v1) const
 Description not yet available.
int operator!= (double v1) const
 Description not yet available.
void operator*= (const prevariable &v1)
 Description not yet available.
void operator*= (double v1)
 Description not yet available.
void operator+= (const prevariable &t1)
 Description not yet available.
void operator+= (double t1)
 Description not yet available.
void operator-= (const prevariable &t1)
 Description not yet available.
void operator-= (double t1)
 Description not yet available.
void operator/= (const prevariable &v1)
 Description not yet available.
void operator/= (double v1)
 Description not yet available.
int operator< (const prevariable &v1) const
 Description not yet available.
int operator< (double v1) const
 Description not yet available.
int operator<= (const prevariable &v1) const
 Description not yet available.
int operator<= (double v1) const
 Description not yet available.
prevariableoperator= (const prevariable &)
 Assigns a value to a prevariable object.
prevariableoperator= (double)
 Assigns a value to a prevariable object.
int operator== (const prevariable &v1) const
 Description not yet available.
int operator== (double v1) const
 Description not yet available.
int operator> (const prevariable &v1) const
 Description not yet available.
int operator> (double v1) const
 Description not yet available.
int operator>= (const prevariable &v1) const
 Description not yet available.
int operator>= (double v1) const
 Description not yet available.
double restore_prevariable_derivative (void)
prevariable_position restore_prevariable_position (void)
double restore_prevariable_value (void)
void save_prevariable_position (void) const
 Description not yet available.
void save_prevariable_value (void) const
 Description not yet available.
double * xadr ()
double & xval ()

Public Attributes

double_and_intv
 pointer to the data

Protected Member Functions

 prevariable (void)
 prevariable (double_and_int *u)

Friends

prevariableacos (const prevariable &t1)
 Description not yet available.
double * address (const prevariable &v1)
prevariableasin (const prevariable &t1)
 Description not yet available.
prevariableatan (const prevariable &t1)
 Description not yet available.
prevariableatan2 (const prevariable &t1, const prevariable &t2)
 Description not yet available.
prevariableatan2 (const prevariable &t1, double t2)
 Description not yet available.
prevariableatan2 (double t1, const prevariable &t2)
 Description not yet available.
class banded_lower_triangular_dvar_matrix
class banded_symmetric_dvar_matrix
prevariablecos (const prevariable &t1)
 Description not yet available.
prevariablecosh (const prevariable &t1)
 Description not yet available.
class dvar3_array
class dvar_matrix
class dvar_vector
class dvar_vector_iterator
prevariableexp (const prevariable &t1)
 Description not yet available.
prevariablefabs (const prevariable &t1)
 Absolute value.
char * fform (const char *, const prevariable &)
class gradient_structure
double_and_intgradnew ()
 Creates an entry in the gradient structure linked list.
class indvar_offset_list
prevariableldexp (const prevariable &, const int &)
 Description not yet available.
prevariablelog (const prevariable &t1)
 Description not yet available.
prevariablelog10 (const prevariable &t1)
 Description not yet available.
void make_indvar_list (int, dvariable *)
prevariableoperator* (const prevariable &v1, const prevariable &v2)
 Description not yet available.
prevariableoperator* (double v1, const prevariable &v2)
 Description not yet available.
prevariableoperator* (const prevariable &v1, double v2)
 Description not yet available.
prevariableoperator+ (const prevariable &v1, const prevariable &v2)
 Description not yet available.
prevariableoperator+ (double v1, const prevariable &v2)
 Description not yet available.
prevariableoperator+ (const prevariable &v1, double v2)
 Description not yet available.
prevariableoperator- (const prevariable &v1)
 Description not yet available.
prevariableoperator- (const prevariable &v1, const prevariable &v2)
 Description not yet available.
prevariableoperator- (double v1, const prevariable &v2)
 Description not yet available.
prevariableoperator- (const prevariable &v1, double v2)
 Description not yet available.
prevariableoperator/ (const prevariable &t1, const prevariable &t2)
 Description not yet available.
prevariableoperator/ (double t1, const prevariable &t2)
 Description not yet available.
prevariableoperator/ (const prevariable &t1, double t2)
 Description not yet available.
prevariablepow (const prevariable &t1, const prevariable &t2)
 Description not yet available.
prevariablepow (const prevariable &t1, double t2)
 Description not yet available.
prevariablepow (double t1, const prevariable &t2)
 Description not yet available.
prevariablesfabs (const prevariable &t1)
 Smooth absolute value.
prevariablesigmoid (const prevariable &t1)
 Description not yet available.
prevariablesin (const prevariable &t1)
 Description not yet available.
prevariablesinh (const prevariable &t1)
 Description not yet available.
prevariablesqr (const prevariable &t1)
 Description not yet available.
prevariablesqrt (const prevariable &t1)
 Description not yet available.
prevariabletan (const prevariable &t1)
 Description not yet available.
prevariabletanh (const prevariable &t1)
 Description not yet available.
double & value (const prevariable &v1)

Detailed Description

Base class for dvariable.

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

Definition at line 1638 of file fvar.hpp.


Constructor & Destructor Documentation

prevariable::prevariable ( void  ) [inline, protected]

Definition at line 1642 of file fvar.hpp.

prevariable::prevariable ( double_and_int u) [inline, protected]

Definition at line 1647 of file fvar.hpp.


Member Function Documentation

double_and_int*& prevariable::get_v ( void  ) [inline]
double_and_int* prevariable::get_v ( void  ) const [inline]

Definition at line 1743 of file fvar.hpp.

void prevariable::initialize ( void  )

Description not yet available.

Parameters:

Definition at line 57 of file fvar_fn.cpp.

int prevariable::operator!= ( const prevariable v1) const

Description not yet available.

Parameters:

Definition at line 127 of file fvar_opr.cpp.

int prevariable::operator!= ( double  v1) const

Description not yet available.

Parameters:

Definition at line 78 of file fvar_op3.cpp.

void prevariable::operator*= ( const prevariable v1)

Description not yet available.

Parameters:

Definition at line 120 of file fvar_op5.cpp.

void prevariable::operator*= ( double  v1)

Description not yet available.

Parameters:

Definition at line 131 of file fvar_op5.cpp.

void prevariable::operator+= ( const prevariable v1)

Description not yet available.

Parameters:

Definition at line 35 of file fvar_op9.cpp.

void prevariable::operator+= ( double  uu)

Description not yet available.

Parameters:

Definition at line 34 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  uu)

Description not yet available.

Parameters:

Definition at line 43 of file fvar_opr.cpp.

void prevariable::operator/= ( const prevariable v1)

Description not yet available.

Parameters:

Definition at line 98 of file fvar_op5.cpp.

void prevariable::operator/= ( double  v1)

Description not yet available.

Parameters:

Definition at line 109 of file fvar_op5.cpp.

int prevariable::operator< ( const prevariable v1) const

Description not yet available.

Parameters:

Definition at line 100 of file fvar_opr.cpp.

int prevariable::operator< ( double  v1) const

Description not yet available.

Parameters:

Definition at line 51 of file fvar_op3.cpp.

int prevariable::operator<= ( const prevariable v1) const

Description not yet available.

Parameters:

Definition at line 91 of file fvar_opr.cpp.

int prevariable::operator<= ( double  v1) const

Description not yet available.

Parameters:

Definition at line 42 of file fvar_op3.cpp.

prevariable & prevariable::operator= ( const prevariable t)

Assigns a value to a prevariable object.

Parameters:
tconstant reference to an object of type prevariable.
Returns:
prevariable reference

Reimplemented in objective_function_value, param_likeprof_number, param_stddev_number, funnel_dvariable, dvariable, param_init_bounded_number, dll_param_init_number, param_init_number, dll_param_number, and named_dvariable.

Definition at line 65 of file fvar_o10.cpp.

Referenced by objective_function_value::operator=().

prevariable & prevariable::operator= ( double  t)

Assigns a value to a prevariable object.

Parameters:
tconstant object of type double.
Returns:
prevariable reference

Reimplemented in objective_function_value, param_likeprof_number, param_stddev_number, dvariable, param_init_bounded_number, dll_param_init_number, param_init_number, dll_param_number, and named_dvariable.

Definition at line 104 of file fvar_o10.cpp.

int prevariable::operator== ( const prevariable v1) const

Description not yet available.

Parameters:

Definition at line 82 of file fvar_opr.cpp.

int prevariable::operator== ( double  v1) const

Description not yet available.

Parameters:

Definition at line 33 of file fvar_op3.cpp.

int prevariable::operator> ( const prevariable v1) const

Description not yet available.

Parameters:

Definition at line 109 of file fvar_opr.cpp.

int prevariable::operator> ( double  v1) const

Description not yet available.

Parameters:

Definition at line 60 of file fvar_op3.cpp.

int prevariable::operator>= ( const prevariable v1) const

Description not yet available.

Parameters:

Definition at line 118 of file fvar_opr.cpp.

int prevariable::operator>= ( double  v1) const

Description not yet available.

Parameters:

Definition at line 69 of file fvar_op3.cpp.

void prevariable::save_prevariable_value ( void  ) const

Description not yet available.

Parameters:

Definition at line 61 of file cmpdif8.cpp.

Referenced by operator*(), operator/(), dvar_vector::operator/=(), and pow().

double* prevariable::xadr ( ) [inline]

Definition at line 1730 of file fvar.hpp.

double& prevariable::xval ( ) [inline]

Definition at line 1734 of file fvar.hpp.


Friends And Related Function Documentation

prevariable& acos ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 146 of file fvar_fn1.cpp.

double* address ( const prevariable v1) [friend]

Definition at line 1832 of file fvar.hpp.

prevariable& asin ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 161 of file fvar_fn1.cpp.

prevariable& atan ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 43 of file fvar_fn1.cpp.

prevariable& atan2 ( const prevariable t1,
const prevariable t2 
) [friend]

Description not yet available.

Parameters:

Definition at line 239 of file fvar_fn1.cpp.

prevariable& atan2 ( const prevariable t1,
double  t2 
) [friend]

Description not yet available.

Parameters:

Definition at line 259 of file fvar_fn1.cpp.

prevariable& atan2 ( double  t1,
const prevariable t2 
) [friend]

Description not yet available.

Parameters:

Definition at line 279 of file fvar_fn1.cpp.

friend class banded_lower_triangular_dvar_matrix [friend]

Definition at line 1666 of file fvar.hpp.

friend class banded_symmetric_dvar_matrix [friend]

Definition at line 1665 of file fvar.hpp.

prevariable& cos ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 190 of file fvar_fn.cpp.

prevariable& cosh ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 225 of file fvar_fn1.cpp.

friend class dvar3_array [friend]

Definition at line 1658 of file fvar.hpp.

friend class dvar_matrix [friend]

Definition at line 1657 of file fvar.hpp.

friend class dvar_vector [friend]

Definition at line 1656 of file fvar.hpp.

friend class dvar_vector_iterator [friend]

Definition at line 1655 of file fvar.hpp.

prevariable& exp ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 28 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:
v1Indpendent variable $x$
Returns:
$|x|$

Definition at line 105 of file fvar_fn.cpp.

char* fform ( const char *  ,
const prevariable  
) [friend]
friend class gradient_structure [friend]

Definition at line 1661 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 33 of file fvar2.cpp.

Referenced by dvariable::dvariable().

friend class indvar_offset_list [friend]

Definition at line 1660 of file fvar.hpp.

prevariable& ldexp ( const prevariable v1,
const int &  exponent 
) [friend]

Description not yet available.

Parameters:

Definition at line 58 of file fvar_fn1.cpp.

prevariable& log ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 205 of file fvar_fn.cpp.

prevariable& log10 ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 220 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 67 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 85 of file fvar_op5.cpp.

prevariable& operator+ ( const prevariable v1,
const prevariable v2 
) [friend]

Description not yet available.

Parameters:

Definition at line 52 of file fvar_opr.cpp.

prevariable& operator+ ( double  v1,
const prevariable v2 
) [friend]

Description not yet available.

Parameters:

Definition at line 41 of file fvar_op2.cpp.

prevariable& operator+ ( const prevariable v1,
double  v2 
) [friend]

Description not yet available.

Parameters:

Definition at line 56 of file fvar_op2.cpp.

prevariable& operator- ( const prevariable v1) [friend]

Description not yet available.

Parameters:

Definition at line 113 of file fvar_op2.cpp.

prevariable& operator- ( const prevariable v1,
const prevariable v2 
) [friend]

Description not yet available.

Parameters:

Definition at line 71 of file fvar_op2.cpp.

prevariable& operator- ( double  v1,
const prevariable v2 
) [friend]

Description not yet available.

Parameters:

Definition at line 99 of file fvar_op2.cpp.

prevariable& operator- ( const prevariable v1,
double  v2 
) [friend]

Description not yet available.

Parameters:

Definition at line 85 of file fvar_op2.cpp.

prevariable& operator/ ( const prevariable t1,
const prevariable t2 
) [friend]

Description not yet available.

Parameters:

Definition at line 127 of file fvar_op2.cpp.

prevariable& operator/ ( double  t1,
const prevariable t2 
) [friend]

Description not yet available.

Parameters:

Definition at line 144 of file fvar_op2.cpp.

prevariable& operator/ ( const prevariable t1,
double  t2 
) [friend]

Description not yet available.

Parameters:

Definition at line 163 of file fvar_op2.cpp.

prevariable& pow ( const prevariable t1,
const prevariable t2 
) [friend]

Description not yet available.

Parameters:

Definition at line 176 of file fvar_fn1.cpp.

prevariable& pow ( const prevariable t1,
double  t2 
) [friend]

Description not yet available.

Parameters:

Definition at line 33 of file fvar_fn.cpp.

prevariable& pow ( double  t1,
const prevariable t2 
) [friend]

Description not yet available.

Parameters:

Definition at line 194 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:
v1Indpendent variable $x$
Returns:
$|x|$

Definition at line 135 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 66 of file fvar_fn.cpp.

prevariable& sinh ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 211 of file fvar_fn1.cpp.

prevariable& sqr ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 94 of file fvar_fn1.cpp.

prevariable& sqrt ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 72 of file fvar_fn1.cpp.

prevariable& tan ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 116 of file fvar_fn1.cpp.

prevariable& tanh ( const prevariable t1) [friend]

Description not yet available.

Parameters:

Definition at line 131 of file fvar_fn1.cpp.

double& value ( const prevariable v1) [friend]

Member Data Documentation

List of all members.


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