|
Sacado Package Browser (Single Doxygen Collection)
Version of the Day
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Sacado Package Browser (Single Doxygen Collection)
Version of the Day
|
Forward-mode AD class templated on the storage for the derivative array. More...
#include <Sacado_CacheFad_GeneralFad.hpp>
Public Types | |
| typedef RemoveConst< T >::type | value_type |
| Typename of values. More... | |
| typedef ScalarType< value_type > ::type | scalar_type |
| Typename of scalar's (which may be different from T) More... | |
Initialization methods | |
| SACADO_INLINE_FUNCTION | GeneralFad () |
| Default constructor. More... | |
| template<typename S > | |
| SACADO_INLINE_FUNCTION | GeneralFad (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL) |
Constructor with supplied value x. More... | |
| SACADO_INLINE_FUNCTION | GeneralFad (const int sz, const T &x, const DerivInit zero_out=InitDerivArray) |
Constructor with size sz and value x. More... | |
| SACADO_INLINE_FUNCTION | GeneralFad (const int sz, const int i, const T &x) |
Constructor with size sz, index i, and value x. More... | |
| SACADO_INLINE_FUNCTION | GeneralFad (const Storage &s) |
Constructor with supplied storage s. More... | |
| SACADO_INLINE_FUNCTION | GeneralFad (const GeneralFad &x) |
| Copy constructor. More... | |
| template<typename S > | |
| SACADO_INLINE_FUNCTION | GeneralFad (const Expr< S > &x, SACADO_ENABLE_EXPR_CTOR_DECL) |
| Copy constructor from any Expression object. More... | |
| SACADO_INLINE_FUNCTION | ~GeneralFad () |
| Destructor. More... | |
| SACADO_INLINE_FUNCTION void | diff (const int ith, const int n) |
Set GeneralFad object as the ith independent variable. More... | |
| SACADO_INLINE_FUNCTION void | setUpdateValue (bool update_val) |
| Set whether this Fad object should update values. More... | |
| SACADO_INLINE_FUNCTION bool | updateValue () const |
| Return whether this Fad object has an updated value. More... | |
| SACADO_INLINE_FUNCTION void | cache () const |
| Cache values. More... | |
| template<typename S > | |
| SACADO_INLINE_FUNCTION | SACADO_ENABLE_EXPR_FUNC (bool) isEqualTo(const Expr< S > &x) const |
| Returns whether two Fad objects have the same values. More... | |
Derivative accessor methods | |
| SACADO_INLINE_FUNCTION int | availableSize () const |
| Returns number of derivative components that can be stored without reallocation. More... | |
| SACADO_INLINE_FUNCTION bool | hasFastAccess () const |
| Returns true if derivative array is not empty. More... | |
| SACADO_INLINE_FUNCTION bool | isPassive () const |
| Returns true if derivative array is empty. More... | |
| SACADO_INLINE_FUNCTION void | setIsConstant (bool is_const) |
| Set whether variable is constant. More... | |
Forward-mode AD class templated on the storage for the derivative array.
This class provides a general forward mode AD implementation for any type of derivative array storage. It does not incorporate expression templates.
This version of GeneralFad is virtually identical to Sacado::Fad::GeneralFad, with small differences in the implementations of some of the methods to support caching of "values" of intermediate operations in an expression, recognizing that the "this" object might also be on the right-hand-side of an expression.
Definition at line 56 of file Sacado_CacheFad_GeneralFad.hpp.
| typedef RemoveConst<T>::type Sacado::CacheFad::GeneralFad< T, Storage >::value_type |
Typename of values.
Definition at line 61 of file Sacado_CacheFad_GeneralFad.hpp.
| typedef ScalarType<value_type>::type Sacado::CacheFad::GeneralFad< T, Storage >::scalar_type |
Typename of scalar's (which may be different from T)
Definition at line 64 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Default constructor.
Definition at line 73 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Constructor with supplied value x.
Initializes value to x and derivative array is empty
Definition at line 81 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Constructor with size sz and value x.
Initializes value to x and derivative array 0 of length sz
Definition at line 89 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Constructor with size sz, index i, and value x.
Initializes value to x and derivative array of length sz as row i of the identity matrix, i.e., sets derivative component i to 1 and all other's to zero.
Definition at line 99 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Constructor with supplied storage s.
Definition at line 106 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Copy constructor.
Definition at line 110 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Copy constructor from any Expression object.
Definition at line 116 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Destructor.
Definition at line 136 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Set GeneralFad object as the ith independent variable.
Sets the derivative array of length n to the ith row of the identity matrix and has the same affect as the Implementation(const int sz, const int i, const T & x) constructor.
Definition at line 146 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Set whether this Fad object should update values.
Definition at line 156 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Return whether this Fad object has an updated value.
Definition at line 160 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Cache values.
Definition at line 164 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Returns whether two Fad objects have the same values.
Definition at line 169 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Returns number of derivative components that can be stored without reallocation.
Definition at line 190 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Returns true if derivative array is not empty.
Definition at line 194 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Returns true if derivative array is empty.
Definition at line 198 of file Sacado_CacheFad_GeneralFad.hpp.
|
inline |
Set whether variable is constant.
Definition at line 202 of file Sacado_CacheFad_GeneralFad.hpp.
1.8.5