Sacado::Fad::DynamicStorage< T, U > Class Template Reference

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

#include <Sacado_Fad_DynamicStorage.hpp>

Inheritance diagram for Sacado::Fad::DynamicStorage< T, U >:

Classes
struct	apply
	Turn DynamicStorage 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
	DynamicStorage ()
	Default constructor.
	DynamicStorage (const T &x)
	Constructor with value.
	DynamicStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size sz.
	DynamicStorage (const int sz, const int i, const value_type &x)
	Constructor with size sz, index i, and value x.
	DynamicStorage (const DynamicStorage &x)
	Copy constructor.
	DynamicStorage (DynamicStorage &&x)
	Move constructor.
	~DynamicStorage ()
	Destructor.
DynamicStorage &	operator= (const DynamicStorage &x)
	Assignment.
DynamicStorage &	operator= (DynamicStorage &&x)
	Move assignment.
int	size () const
	Returns number of derivative components.
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 U *	dx () const
	Returns derivative array.
U	dx (int i) const
	Returns derivative component i with bounds checking.
U &	fastAccessDx (int i)
	Returns derivative component i without bounds checking.
const U &	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.
int	sz_
	Derivative array size.
int	len_
	Derivative array length.
U *	dx_
	Derivative array.

Detailed Description

template<typename T, typename U = T>
class Sacado::Fad::DynamicStorage< T, U >

Derivative array storage class using dynamic memory allocation.

Constructor & Destructor Documentation

DynamicStorage() [1/2]

template<typename T , typename U = T>

Sacado::Fad::DynamicStorage< T, U >::DynamicStorage ( 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::DynamicStorage< T, U >::dx_, Sacado::ds_array< T, isScalar >::get(), Sacado::ds_array< T, isScalar >::get_and_fill(), and Sacado::Fad::DynamicStorage< T, U >::sz_.

DynamicStorage() [2/2]

template<typename T , typename U = T>

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

Member Function Documentation

expand()

template<typename T , typename U = T>

void Sacado::Fad::DynamicStorage< T, U >::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::ds_array< T, isScalar >::copy(), Sacado::ds_array< T, isScalar >::destroy_and_release(), Sacado::Fad::DynamicStorage< T, U >::dx_, Sacado::ds_array< T, isScalar >::get_and_fill(), Sacado::Fad::DynamicStorage< T, U >::len_, Sacado::Fad::DynamicStorage< T, U >::sz_, and Sacado::ds_array< T, isScalar >::zero().

resize()

template<typename T , typename U = T>

void Sacado::Fad::DynamicStorage< T, U >::resize ( int  sz )

inline

Resize the derivative array to sz.

Note: This does not necessarily preserve derivative components.

References Sacado::ds_array< T, isScalar >::destroy_and_release(), Sacado::Fad::DynamicStorage< T, U >::dx_, Sacado::ds_array< T, isScalar >::get_and_fill(), Sacado::Fad::DynamicStorage< T, U >::len_, and Sacado::Fad::DynamicStorage< T, U >::sz_.

resizeAndZero()

template<typename T , typename U = T>

void Sacado::Fad::DynamicStorage< T, U >::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::ds_array< T, isScalar >::destroy_and_release(), Sacado::Fad::DynamicStorage< T, U >::dx_, Sacado::ds_array< T, isScalar >::get_and_fill(), Sacado::Fad::DynamicStorage< T, U >::len_, Sacado::Fad::DynamicStorage< T, U >::sz_, and Sacado::ds_array< T, isScalar >::zero().

---

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

• Sacado_Fad_DynamicStorage.hpp