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

#include <Sacado_Fad_Exp_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
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`.

SACADO_INLINE_FUNCTION	StaticFixedStorage (const int sz, const int i, const value_type &x)
	Constructor with size `sz`, index `i`, and value `x`.

SACADO_INLINE_FUNCTION	StaticFixedStorage (const StaticFixedStorage &x)
	Copy constructor.

SACADO_INLINE_FUNCTION	StaticFixedStorage (StaticFixedStorage &&x)
	Move constructor.

SACADO_DEFAULTED_FUNCTION	~StaticFixedStorage ()=default
	Destructor.

SACADO_INLINE_FUNCTION StaticFixedStorage &	operator= (const StaticFixedStorage &x)
	Assignment.

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.

Definition at line 50 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

Member Typedef Documentation

◆ value_type

template<typename T , int Num>

typedef std::remove_cv<T>::type Sacado::Fad::Exp::StaticFixedStorage< T, Num >::value_type

Definition at line 54 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

Constructor & Destructor Documentation

◆ StaticFixedStorage() [1/6]

template<typename T , int Num>

SACADO_DEFAULTED_FUNCTION Sacado::Fad::Exp::StaticFixedStorage< T, Num >::StaticFixedStorage ( )

default

Default constructor.

◆ StaticFixedStorage() [2/6]

template<typename T , int Num>

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

inline

Constructor with value.

Definition at line 85 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ StaticFixedStorage() [3/6]

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

Definition at line 95 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ StaticFixedStorage() [4/6]

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.

Definition at line 113 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ StaticFixedStorage() [5/6]

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.

Definition at line 125 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ StaticFixedStorage() [6/6]

template<typename T , int Num>

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

inline

Move constructor.

Definition at line 133 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ ~StaticFixedStorage()

template<typename T , int Num>

SACADO_DEFAULTED_FUNCTION Sacado::Fad::Exp::StaticFixedStorage< T, Num >::~StaticFixedStorage ( )

default

Destructor.

Member Function Documentation

◆ operator=() [1/2]

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.

Definition at line 150 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.