Sacado::Fad::Exp::MemPoolStorage< T > Class Template Reference

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

#include <Sacado_Fad_Exp_MemPoolStorage.hpp>

Collaboration diagram for Sacado::Fad::Exp::MemPoolStorage< T >:

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

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

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

Static Public Member Functions
static void	setDefaultPool (MemPool *pool)
	Set the default memory pool for new objects.

Static Public Attributes
static constexpr bool	is_statically_sized = false
static constexpr int	static_size = 0
static MemPool *	defaultPool_
	Default memory pool.

Protected Attributes
MemPool *	myPool_
	Memory pool.

Detailed Description

template<typename T>
class Sacado::Fad::Exp::MemPoolStorage< T >

Derivative array storage class using dynamic memory allocation.

Constructor & Destructor Documentation

template<typename T >

Sacado::Fad::Exp::MemPoolStorage< T >::MemPoolStorage ( const int  sz, const T &  x, const DerivInit  zero_out  )

inline

Constructor with size sz.

Initializes derivative array 0 of length sz

References Sacado::Fad::Exp::mp_array< T, isScalar >::get(), Sacado::Fad::Exp::mp_array< T, isScalar >::get_and_fill(), and Sacado::Fad::Exp::MemPoolStorage< T >::myPool_.

Member Function Documentation

template<typename T >

void Sacado::Fad::Exp::MemPoolStorage< T >::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::mp_array< T, isScalar >::copy(), Sacado::Fad::Exp::mp_array< T, isScalar >::destroy_and_release(), Sacado::Fad::Exp::mp_array< T, isScalar >::get_and_fill(), Sacado::Fad::Exp::MemPoolStorage< T >::myPool_, and Sacado::Fad::Exp::mp_array< T, isScalar >::zero().

template<typename T >

void Sacado::Fad::Exp::MemPoolStorage< T >::resize ( int  sz )

inline

Resize the derivative array to sz.

Note: This does not necessarily preserve derivative components.

References Sacado::Fad::Exp::MemPoolStorage< T >::defaultPool_, Sacado::Fad::Exp::mp_array< T, isScalar >::destroy_and_release(), Sacado::Fad::Exp::mp_array< T, isScalar >::get_and_fill(), and Sacado::Fad::Exp::MemPoolStorage< T >::myPool_.

template<typename T >

void Sacado::Fad::Exp::MemPoolStorage< T >::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::MemPoolStorage< T >::defaultPool_, Sacado::Fad::Exp::mp_array< T, isScalar >::destroy_and_release(), Sacado::Fad::Exp::mp_array< T, isScalar >::get_and_fill(), Sacado::Fad::Exp::MemPoolStorage< T >::myPool_, and Sacado::Fad::Exp::mp_array< T, isScalar >::zero().

---

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

• Sacado_Fad_Exp_MemPoolStorage.hpp