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

Fundamental data type for reverse mode automatic differentiation. More...

#include <fvar.hpp>

Public Member Functions

 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 ()
 

Additional Inherited Members

- Public Attributes inherited from prevariable
double_and_intv
 pointer to the data More...
 
- Protected Member Functions inherited from prevariable
 prevariable ()=delete
 Default constructor. More...
 
 prevariable (double_and_int *u)
 

Detailed Description

Fundamental data type for reverse mode automatic differentiation.

Definition at line 1518 of file fvar.hpp.

Constructor & Destructor Documentation

dvariable::dvariable ( )
inline

Default constructor.

Creates new zero value dvariable object.

Definition at line 1526 of file fvar.hpp.

Referenced by param_init_number::restore_value(), param_init_number::save_value(), param_stddev_number::set_dependent_variables(), and param_likeprof_number::variable().

dvariable::dvariable ( const dvariable t)
inline

Copy constructor for dvariable object; deep copy.

Allocates memory and assigns value of argument to new object.

Parameters
tconstant devariable object

Definition at line 1540 of file fvar.hpp.

dvariable::dvariable ( const double  t)
inline

Creates dvariable instance from a double constant.

Creates new dvariable object, Sets Value to the argument and initializes derivative information.

Parameters
tconstant double passed by value.

Definition at line 1552 of file fvar.hpp.

dvariable::dvariable ( const int &  t)
inline

Creates dvariable instance from a int constant.

Creates new dvariable object, Sets value to the argument and initializes derivatve information.

Parameters
tconstant integer passed by reference.

Definition at line 1565 of file fvar.hpp.

dvariable::dvariable ( kkludge_object  )
inline

Specialized constructor that does not create unnecessary entries in the gradient structure; see function nograd_assign.

Definition at line 1570 of file fvar.hpp.

dvariable::dvariable ( const prevariable t)
inline

Constructor for dvariable object from its base class; deep copy.

Allocates memory and assigns value of argument to new object.

Parameters
tconstant prevariable object

Definition at line 1579 of file fvar.hpp.

virtual dvariable::~dvariable ( )
inlinevirtual

Destructor; frees memory on gradient stack.

Definition at line 1587 of file fvar.hpp.

Member Function Documentation

dvariable& dvariable::operator= ( const double  x)
inline

Assigns a value to a dvariable object.

Parameters
tconstant object of type double.
Returns
prevariable reference

Definition at line 1595 of file fvar.hpp.

Referenced by dll_param_number::operator=(), param_init_number::operator=(), dll_param_init_number::operator=(), param_init_bounded_number::operator=(), and funnel_dvariable::operator=().

dvariable& dvariable::operator= ( const prevariable other)
inline

Assigns a value to a dvariable object.

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

Definition at line 1606 of file fvar.hpp.

dvariable& dvariable::operator= ( const dvariable other)
inline

Definition at line 1611 of file fvar.hpp.

dvariable& dvariable::operator= ( const df1_one_variable )
dvariable& dvariable::operator= ( const df1_two_variable )
dvariable & dvariable::operator= ( const df1_three_variable v)

Description not yet available.

Parameters

Definition at line 967 of file df13fun.cpp.


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