Sacado::Fad::Exp::StaticStorage< T, Num > Class Template Reference

Derivative array storage class using static memory allocation. More...

#include <Sacado_Fad_Exp_StaticStorage.hpp>

Collaboration diagram for Sacado::Fad::Exp::StaticStorage< T, Num >:

Classes
struct	apply
	Turn StaticStorage into a meta-function class usable with mpl::apply. More...
struct	apply_N
	Replace static derivative length (interpreted as a fixed length) More...

Public Types
typedef std::remove_cv< T >::type	value_type

Public Member Functions
KOKKOS_INLINE_FUNCTION	StaticStorage ()
	Default constructor.
KOKKOS_INLINE_FUNCTION	StaticStorage (const T &x)
	Constructor with value.
KOKKOS_INLINE_FUNCTION	StaticStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size sz. More...
KOKKOS_INLINE_FUNCTION	StaticStorage (const int sz, const int i, const value_type &x)
	Constructor with size sz, index i, and value x. More...
KOKKOS_INLINE_FUNCTION	StaticStorage (const StaticStorage &x)
	Copy constructor.
KOKKOS_INLINE_FUNCTION	StaticStorage (StaticStorage &&x)
	Move constructor.
KOKKOS_INLINE_FUNCTION	~StaticStorage ()
	Destructor.
KOKKOS_INLINE_FUNCTION StaticStorage &	operator= (const StaticStorage &x)
	Assignment.
KOKKOS_INLINE_FUNCTION StaticStorage &	operator= (StaticStorage &&x)
	Move assignment.
KOKKOS_INLINE_FUNCTION int	size () const
	Returns number of derivative components.
KOKKOS_INLINE_FUNCTION int	length () const
	Returns array length.
KOKKOS_INLINE_FUNCTION void	resize (int sz)
	Resize the derivative array to sz.
KOKKOS_INLINE_FUNCTION void	resizeAndZero (int sz)
	Resize the derivative array to sz. More...
KOKKOS_INLINE_FUNCTION void	expand (int sz)
	Expand derivative array to size sz. More...
KOKKOS_INLINE_FUNCTION void	zero ()
	Zero out derivative array.
KOKKOS_INLINE_FUNCTION const T &	val () const
	Returns value.
KOKKOS_INLINE_FUNCTION T &	val ()
	Returns value.
KOKKOS_INLINE_FUNCTION const T *	dx () const
	Returns derivative array.
KOKKOS_INLINE_FUNCTION T	dx (int i) const
	Returns derivative component i with bounds checking.
KOKKOS_INLINE_FUNCTION T &	fastAccessDx (int i)
	Returns derivative component i without bounds checking.
KOKKOS_INLINE_FUNCTION const T &	fastAccessDx (int i) const
	Returns derivative component i without bounds checking.

Static Public Attributes
static constexpr bool	is_statically_sized = false
static constexpr int	static_size = 0
static constexpr bool	is_view = false

Protected Attributes
T	val_
	Value.
T	dx_ [Num]
	Derivative array.
int	sz_
	Size of derivative array.

Detailed Description

template<typename T, int Num>
class Sacado::Fad::Exp::StaticStorage< T, Num >

Derivative array storage class using static memory allocation.

This class uses a statically allocated array whose dimension is fixed by the template parameter Num.

Constructor & Destructor Documentation

template<typename T , int Num>

KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::StaticStorage< T, Num >::StaticStorage ( const int  sz, const T &  x, const DerivInit  zero_out = InitDerivArray  )

inline

Constructor with size sz.

Initializes derivative array 0 of length sz

References Sacado::Fad::Exp::StaticStorage< T, Num >::dx_, Sacado::Fad::Exp::StaticStorage< T, Num >::sz_, and Sacado::ss_array< T, isScalar >::zero().

template<typename T , int Num>

KOKKOS_INLINE_FUNCTION Sacado::Fad::Exp::StaticStorage< T, Num >::StaticStorage ( const int  sz, const int  i, const value_type &  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.

References Sacado::Fad::Exp::StaticStorage< T, Num >::dx_.

Member Function Documentation

template<typename T , int Num>

KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::StaticStorage< T, Num >::expand ( int  sz )

inline

Expand derivative array to size sz.

This method preserves any existing derivative components and sets any that are added to zero.

References Sacado::Fad::Exp::StaticStorage< T, Num >::dx_, Sacado::Fad::Exp::StaticStorage< T, Num >::sz_, and Sacado::ss_array< T, isScalar >::zero().

template<typename T , int Num>

KOKKOS_INLINE_FUNCTION void Sacado::Fad::Exp::StaticStorage< T, Num >::resizeAndZero ( int  sz )

inline

Resize the derivative array to sz.

This method doest not preserve any existing derivative components but sets any that are added to zero.

References Sacado::Fad::Exp::StaticStorage< T, Num >::dx_, Sacado::Fad::Exp::StaticStorage< T, Num >::sz_, and Sacado::ss_array< T, isScalar >::zero().

---

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

• Sacado_Fad_Exp_StaticStorage.hpp