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

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

#include <Sacado_Fad_Exp_StaticFixedStorage.hpp>

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

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
SACADO_DEFAULTED_FUNCTION	StaticFixedStorage ()=default
	Default constructor.
SACADO_INLINE_FUNCTION	StaticFixedStorage (const T &x)
	Constructor with value.
SACADO_INLINE_FUNCTION	StaticFixedStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size sz. More...
SACADO_INLINE_FUNCTION	StaticFixedStorage (const int sz, const int i, const value_type &x)
	Constructor with size sz, index i, and value x. More...
SACADO_INLINE_FUNCTION	StaticFixedStorage (const StaticFixedStorage &x)
	Copy constructor. More...
SACADO_INLINE_FUNCTION	StaticFixedStorage (StaticFixedStorage &&x)
	Move constructor.
SACADO_DEFAULTED_FUNCTION	~StaticFixedStorage ()=default
	Destructor.
SACADO_INLINE_FUNCTION StaticFixedStorage &	operator= (const StaticFixedStorage &x)
	Assignment. More...
SACADO_INLINE_FUNCTION StaticFixedStorage &	operator= (StaticFixedStorage &&x)
	Move assignment.
SACADO_INLINE_FUNCTION constexpr int	size () const
	Returns number of derivative components.
SACADO_INLINE_FUNCTION constexpr int	length () const
	Returns array length.
SACADO_INLINE_FUNCTION void	resize (int sz)
	Resize the derivative array to sz.
SACADO_INLINE_FUNCTION void	resizeAndZero (int sz)
	Resize the derivative array to sz.
SACADO_INLINE_FUNCTION void	expand (int sz)
	Expand derivative array to size sz.
SACADO_INLINE_FUNCTION void	zero ()
	Zero out derivative array.
SACADO_INLINE_FUNCTION const T &	val () const
	Returns value.
SACADO_INLINE_FUNCTION T &	val ()
	Returns value.
SACADO_INLINE_FUNCTION const T *	dx () const
	Returns derivative array.
SACADO_INLINE_FUNCTION T	dx (int i) const
	Returns derivative component i with bounds checking.
SACADO_INLINE_FUNCTION T &	fastAccessDx (int i)
	Returns derivative component i without bounds checking.
SACADO_INLINE_FUNCTION 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	val_
	Value.
T	dx_ [Num]
	Derivative array.

Detailed Description

template<typename T, int Num>
class Sacado::Fad::Exp::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

template<typename T , int Num>

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

template<typename T , int Num>

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

template<typename T , int Num>

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

Member Function Documentation

template<typename T , int Num>

SACADO_INLINE_FUNCTION StaticFixedStorage& Sacado::Fad::Exp::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::Exp::StaticFixedStorage< T, Num >::dx_, and Sacado::Fad::Exp::StaticFixedStorage< T, Num >::val_.

---

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

• Sacado_Fad_Exp_StaticFixedStorage.hpp