Sacado Package Browser (Single Doxygen Collection)
Version of the Day
|
Expression template forward-mode AD class with static memory allocation. More...
#include <Sacado_Fad_SFad.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... | |
typedef SFad< value_type, Num > | base_expr_type |
Typename of base-expressions. More... | |
Public Member Functions | |
template<typename S > | |
SACADO_INLINE_FUNCTION | SACADO_ENABLE_VALUE_FUNC (Expr &) operator |
Assignment operator with constant right-hand-side. More... | |
Public Attributes | |
T | val_ |
Value. More... | |
Initialization methods | |
SACADO_INLINE_FUNCTION | Expr () |
Default constructor. More... | |
template<typename S > | |
SACADO_INLINE_FUNCTION | Expr (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL) |
Constructor with supplied value x . More... | |
SACADO_INLINE_FUNCTION | Expr (const int sz, const T &x, const DerivInit zero_out=InitDerivArray) |
Constructor with size sz and value x . More... | |
SACADO_INLINE_FUNCTION | Expr (const int sz, const int i, const T &x) |
Constructor with size sz , index i , and value x . More... | |
SACADO_INLINE_FUNCTION | Expr (const Expr &x) |
Copy constructor. More... | |
template<typename S > | |
SACADO_INLINE_FUNCTION | Expr (const Expr< S > &x, SACADO_ENABLE_EXPR_CTOR_DECL) |
Copy constructor from any Expression object. More... | |
SACADO_INLINE_FUNCTION | ~Expr () |
Destructor. More... | |
SACADO_INLINE_FUNCTION void | diff (const int ith, const int n) |
Set Fad object as the ith independent variable. More... | |
SACADO_INLINE_FUNCTION void | resize (int sz) |
Resize derivative array to length sz . More... | |
SACADO_INLINE_FUNCTION void | expand (int sz) |
Expand derivative array to size sz. More... | |
SACADO_INLINE_FUNCTION void | zero () |
Zero out the derivative array. 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... | |
Value accessor methods | |
SACADO_INLINE_FUNCTION const T & | val () const |
Returns value. More... | |
SACADO_INLINE_FUNCTION T & | val () |
Returns value. More... | |
Derivative accessor methods | |
SACADO_INLINE_FUNCTION int | size () const |
Returns number of derivative components. More... | |
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... | |
SACADO_INLINE_FUNCTION const T * | dx () const |
Returns derivative array. More... | |
SACADO_INLINE_FUNCTION const T & | dx (int i) const |
Returns derivative component i with bounds checking. More... | |
SACADO_INLINE_FUNCTION T & | fastAccessDx (int i) |
Returns derivative component i without bounds checking. More... | |
SACADO_INLINE_FUNCTION const T & | fastAccessDx (int i) const |
Returns derivative component i without bounds checking. More... | |
Expression template forward-mode AD class with static memory allocation.
This classes specializes Expr to SFad expressions.
Definition at line 110 of file Sacado_Fad_SFad.hpp.
typedef RemoveConst<T>::type Sacado::Fad::Expr< SFadExprTag< T, Num >, ExprSpecDefault >::value_type |
Typename of values.
Definition at line 115 of file Sacado_Fad_SFad.hpp.
typedef ScalarType<value_type>::type Sacado::Fad::Expr< SFadExprTag< T, Num >, ExprSpecDefault >::scalar_type |
Typename of scalar's (which may be different from T)
Definition at line 118 of file Sacado_Fad_SFad.hpp.
typedef SFad<value_type,Num> Sacado::Fad::Expr< SFadExprTag< T, Num >, ExprSpecDefault >::base_expr_type |
Typename of base-expressions.
Definition at line 121 of file Sacado_Fad_SFad.hpp.
|
inline |
Default constructor.
Definition at line 130 of file Sacado_Fad_SFad.hpp.
|
inline |
Constructor with supplied value x
.
Initializes value to x
and derivative array is empty
Definition at line 139 of file Sacado_Fad_SFad.hpp.
|
inline |
Constructor with size sz
and value x
.
Initializes value to x
and derivative array 0 of length sz
Definition at line 149 of file Sacado_Fad_SFad.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 165 of file Sacado_Fad_SFad.hpp.
|
inline |
Copy constructor.
Definition at line 180 of file Sacado_Fad_SFad.hpp.
|
inline |
Copy constructor from any Expression object.
Definition at line 189 of file Sacado_Fad_SFad.hpp.
|
inline |
Destructor.
Definition at line 203 of file Sacado_Fad_SFad.hpp.
|
inline |
Set Fad 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 213 of file Sacado_Fad_SFad.hpp.
|
inline |
Resize derivative array to length sz
.
Since the derivative array length is not dynamic, this method throws an error if compiled with SACADO_DEBUG defined.
Definition at line 229 of file Sacado_Fad_SFad.hpp.
|
inline |
Expand derivative array to size sz.
Since the derivative array length is not dynamic, this method throws an error if compiled with SACADO_DEBUG defined.
Definition at line 242 of file Sacado_Fad_SFad.hpp.
|
inline |
Zero out the derivative array.
Definition at line 246 of file Sacado_Fad_SFad.hpp.
|
inline |
Set whether this Fad object should update values.
Definition at line 250 of file Sacado_Fad_SFad.hpp.
|
inline |
Return whether this Fad object has an updated value.
Definition at line 254 of file Sacado_Fad_SFad.hpp.
|
inline |
Cache values.
Definition at line 258 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns whether two Fad objects have the same values.
Definition at line 263 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns value.
Definition at line 281 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns value.
Definition at line 285 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns number of derivative components.
Definition at line 296 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns number of derivative components that can be stored without reallocation.
Definition at line 303 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns true if derivative array is not empty.
Definition at line 307 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns true if derivative array is empty.
Definition at line 311 of file Sacado_Fad_SFad.hpp.
|
inline |
Set whether variable is constant.
Definition at line 315 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns derivative array.
Definition at line 319 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns derivative component i
with bounds checking.
Definition at line 323 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns derivative component i
without bounds checking.
Definition at line 327 of file Sacado_Fad_SFad.hpp.
|
inline |
Returns derivative component i
without bounds checking.
Definition at line 331 of file Sacado_Fad_SFad.hpp.
SACADO_INLINE_FUNCTION Sacado::Fad::Expr< SFadExprTag< T, Num >, ExprSpecDefault >::SACADO_ENABLE_VALUE_FUNC | ( | Expr< SFadExprTag< T, Num >, ExprSpecDefault > & | ) |
Assignment operator with constant right-hand-side.
T Sacado::Fad::Expr< SFadExprTag< T, Num >, ExprSpecDefault >::val_ |
Definition at line 503 of file Sacado_Fad_SFad.hpp.