Sacado::Fad::StaticFixedStorage< T, Num > Class Template Reference

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

#include <Sacado_Fad_StaticFixedStorage.hpp>

Classes
struct	apply
	Turn StaticFixedStorage 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
	StaticFixedStorage ()=default
	Default constructor.
	StaticFixedStorage (const T &x)
	Constructor with value.
	StaticFixedStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size sz.
	StaticFixedStorage (const int sz, const int i, const value_type &x)
	Constructor with size sz, index i, and value x.
	StaticFixedStorage (const StaticFixedStorage &x)
	Copy constructor.
	StaticFixedStorage (StaticFixedStorage &&x)
	Move constructor.
	~StaticFixedStorage ()=default
	Destructor.
StaticFixedStorage &	operator= (const StaticFixedStorage &x)
	Assignment.
StaticFixedStorage &	operator= (StaticFixedStorage &&x)
	Move assignment.
constexpr int	size () const
	Returns number of derivative components.
constexpr int	length () const
	Returns array length.
void	resize (int sz)
	Resize the derivative array to sz.
void	resizeAndZero (int sz)
	Resize the derivative array to sz.
void	expand (int sz)
	Expand derivative array to size sz.
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 Attributes
static constexpr bool	is_statically_sized = true
static constexpr int	static_size = Num
static constexpr bool	is_view = false

Protected Attributes
T	dx_ [Num]
	Derivative array.
T	val_
	Value.

Detailed Description

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

Derivative array storage class using static, fixed memory allocation.

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

Constructor & Destructor Documentation

StaticFixedStorage() [1/3]

template<typename T , int Num>

Sacado::Fad::StaticFixedStorage< T, Num >::StaticFixedStorage ( 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::StaticFixedStorage< T, Num >::dx_, and Sacado::ss_array< T, isScalar >::zero().

StaticFixedStorage() [2/3]

template<typename T , int Num>

Sacado::Fad::StaticFixedStorage< T, Num >::StaticFixedStorage ( 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::StaticFixedStorage< T, Num >::dx_.

StaticFixedStorage() [3/3]

template<typename T , int Num>

Sacado::Fad::StaticFixedStorage< T, Num >::StaticFixedStorage ( const StaticFixedStorage< T, Num > &  x )

inline

Copy constructor.

Can't make this " = default" because of scalar types that don't define a const copy consturctor (like Rad). We also can't leave it and let it be implicitly generated because of SACADO_INLINE_FUNCTION.

References Sacado::Fad::StaticFixedStorage< T, Num >::dx_.

Member Function Documentation

operator=()

template<typename T , int Num>

StaticFixedStorage & Sacado::Fad::StaticFixedStorage< T, Num >::operator= ( const StaticFixedStorage< T, Num > &  x )

inline

Assignment.

Can't make this " = default" because of scalar types that don't define a const operator= (like Rad). We also can't leave it and let it be implicitly generated because of SACADO_INLINE_FUNCTION.

References Sacado::Fad::StaticFixedStorage< T, Num >::dx_, and Sacado::Fad::StaticFixedStorage< T, Num >::val_.

---

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

• Sacado_Fad_Kokkos_ThreadLocalScalar.hpp
• Sacado_Fad_StaticFixedStorage.hpp