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 >:

Public Types
typedef T	value_type

Public Member Functions
template<typename S>
	DynamicStorage (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Default constructor.
	DynamicStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size sz.
	DynamicStorage (const DynamicStorage &x)
	Copy constructor.
	~DynamicStorage ()
	Destructor.
DynamicStorage &	operator= (const DynamicStorage &x)
	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.

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()

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

Member Function Documentation

dx()

template<typename T, typename U = T>

const U * Sacado::Fad::DynamicStorage< T, U >::dx ( ) const

inline

Returns derivative array.

Referenced by Sacado::Fad::SimpleFad< T >::isEqualTo().

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.

fastAccessDx()

template<typename T, typename U = T>

U & Sacado::Fad::DynamicStorage< T, U >::fastAccessDx ( int i )

inline

Returns derivative component i without bounds checking.

Referenced by Sacado::Fad::SimpleFad< T >::SimpleFad().

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.

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.

size()

template<typename T, typename U = T>

int Sacado::Fad::DynamicStorage< T, U >::size ( ) const

inline

Returns number of derivative components.

Referenced by Sacado::Fad::SimpleFad< T >::isEqualTo().

val()

template<typename T, typename U = T>

const T & Sacado::Fad::DynamicStorage< T, U >::val ( ) const

inline

Returns value.

Referenced by Sacado::Fad::SimpleFad< T >::isEqualTo().

Member Data Documentation

dx_

template<typename T, typename U = T>

U* Sacado::Fad::DynamicStorage< T, U >::dx_

protected

Derivative array.

Referenced by Sacado::Fad::DynamicStorage< ValueT >::DynamicStorage(), and Sacado::Fad::DynamicStorage< ValueT >::operator=().

sz_

template<typename T, typename U = T>

int Sacado::Fad::DynamicStorage< T, U >::sz_

protected

Derivative array size.

Referenced by Sacado::Fad::DynamicStorage< ValueT >::operator=().

val_

template<typename T, typename U = T>

T Sacado::Fad::DynamicStorage< T, U >::val_

protected

Value.

Referenced by Sacado::Fad::DynamicStorage< ValueT >::operator=().

---

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

• Sacado_Fad_DynamicStorage.hpp