Sacado::FAD_NS::SFad< ValueT, Num > Class Template Reference

Forward-mode AD class using static memory allocation. More...

#include <Sacado_Fad_SFad_tmpl.hpp>

Inherits Expr< SFadExprTag< ValueT, Num > >.

Classes
struct	apply
	Turn SFad into a meta-function class usable with mpl::apply. More...
struct	apply_N
	Replace static derivative length. More...

Public Types
typedef Expr< SFadExprTag < ValueT, Num > >	ExprType
	Base classes. More...
typedef ExprType::value_type	value_type
	Typename of values. More...
typedef ExprType::scalar_type	scalar_type
	Typename of scalar's (which may be different from value_type) More...
typedef ScalarType< ValueT >::type	ScalarT
	Typename of scalar's (which may be different from ValueT) More...

Public Member Functions
KOKKOS_INLINE_FUNCTION	~SFad ()
	Destructor. More...

Initialization methods
KOKKOS_INLINE_FUNCTION	SFad ()
	Default constructor. More...
template<typename S >
KOKKOS_INLINE_FUNCTION	SFad (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Constructor with supplied value x convertible to ValueT. More...
KOKKOS_INLINE_FUNCTION	SFad (const int sz, const ValueT &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size sz and value x. More...
KOKKOS_INLINE_FUNCTION	SFad (const int sz, const int i, const ValueT &x)
	Constructor with size sz, index i, and value x. More...
KOKKOS_INLINE_FUNCTION	SFad (const SFad &x)
	Copy constructor. More...
template<typename S >
KOKKOS_INLINE_FUNCTION	SFad (const Expr< S > &x, SACADO_ENABLE_EXPR_CTOR_DECL)
	Copy constructor from any Expression object. More...

Detailed Description

template<typename ValueT, int Num>
class Sacado::FAD_NS::SFad< ValueT, Num >

Forward-mode AD class using static memory allocation.

This is the user-level class for forward mode AD with static memory allocation, and is appropriate for whenever the number of derivative components is known at compile time. The size of the derivative array is fixed by the template parameter Num.

Definition at line 47 of file Sacado_Fad_SFad_tmpl.hpp.

Member Typedef Documentation

template<typename ValueT , int Num>

typedef Expr< SFadExprTag<ValueT,Num > > Sacado::FAD_NS::SFad< ValueT, Num >::ExprType

Base classes.

Definition at line 53 of file Sacado_Fad_SFad_tmpl.hpp.

template<typename ValueT , int Num>

typedef ExprType::value_type Sacado::FAD_NS::SFad< ValueT, Num >::value_type

Typename of values.

Definition at line 56 of file Sacado_Fad_SFad_tmpl.hpp.

template<typename ValueT , int Num>

typedef ExprType::scalar_type Sacado::FAD_NS::SFad< ValueT, Num >::scalar_type

Typename of scalar's (which may be different from value_type)

Definition at line 59 of file Sacado_Fad_SFad_tmpl.hpp.

template<typename ValueT , int Num>

typedef ScalarType<ValueT>::type Sacado::FAD_NS::SFad< ValueT, Num >::ScalarT

Typename of scalar's (which may be different from ValueT)

Definition at line 62 of file Sacado_Fad_SFad_tmpl.hpp.

Constructor & Destructor Documentation

template<typename ValueT , int Num>

KOKKOS_INLINE_FUNCTION Sacado::FAD_NS::SFad< ValueT, Num >::SFad ( )

inline

Default constructor.

Initializes value to 0 and derivative array is empty

Definition at line 86 of file Sacado_Fad_SFad_tmpl.hpp.

template<typename ValueT , int Num>

template<typename S >

KOKKOS_INLINE_FUNCTION Sacado::FAD_NS::SFad< ValueT, Num >::SFad ( const S &  x, SACADO_ENABLE_VALUE_CTOR_DECL    )

inline

Constructor with supplied value x convertible to ValueT.

Initializes value to ValueT(x) and derivative array is empty.

Definition at line 95 of file Sacado_Fad_SFad_tmpl.hpp.

template<typename ValueT , int Num>

KOKKOS_INLINE_FUNCTION Sacado::FAD_NS::SFad< ValueT, Num >::SFad ( const int  sz, const ValueT &  x, const DerivInit  zero_out = InitDerivArray  )

inline

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

Definition at line 103 of file Sacado_Fad_SFad_tmpl.hpp.

template<typename ValueT , int Num>

KOKKOS_INLINE_FUNCTION Sacado::FAD_NS::SFad< ValueT, Num >::SFad ( const int  sz, const int  i, const ValueT &  x  )

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 113 of file Sacado_Fad_SFad_tmpl.hpp.

template<typename ValueT , int Num>

KOKKOS_INLINE_FUNCTION Sacado::FAD_NS::SFad< ValueT, Num >::SFad ( const SFad< ValueT, Num > &  x )

inline

Copy constructor.

Definition at line 118 of file Sacado_Fad_SFad_tmpl.hpp.

template<typename ValueT , int Num>

template<typename S >

KOKKOS_INLINE_FUNCTION Sacado::FAD_NS::SFad< ValueT, Num >::SFad ( const Expr< S > &  x, SACADO_ENABLE_EXPR_CTOR_DECL    )

inline

Copy constructor from any Expression object.

Definition at line 124 of file Sacado_Fad_SFad_tmpl.hpp.

template<typename ValueT , int Num>

KOKKOS_INLINE_FUNCTION Sacado::FAD_NS::SFad< ValueT, Num >::~SFad ( )

inline

Destructor.

Definition at line 131 of file Sacado_Fad_SFad_tmpl.hpp.

---

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

• Sacado_Fad_SFad_tmpl.hpp