Sacado Package Browser (Single Doxygen Collection): Sacado::Fad::DynamicStorage< T, U > Class Template Reference

Sacado Package Browser (Single Doxygen Collection) Version of the Day

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

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

#include <Sacado_Fad_DynamicStorage.hpp>

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

Inheritance graph

Public Types
typedef T	value_type

Public Member Functions
template<typename S >
SACADO_INLINE_FUNCTION	DynamicStorage (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Default constructor. More...

SACADO_INLINE_FUNCTION	DynamicStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size `sz`. More...

SACADO_INLINE_FUNCTION	DynamicStorage (const DynamicStorage &x)
	Copy constructor. More...

SACADO_INLINE_FUNCTION	~DynamicStorage ()
	Destructor. More...

SACADO_INLINE_FUNCTION DynamicStorage &	operator= (const DynamicStorage &x)
	Assignment. More...

SACADO_INLINE_FUNCTION int	size () const
	Returns number of derivative components. More...

SACADO_INLINE_FUNCTION int	length () const
	Returns array length. More...

SACADO_INLINE_FUNCTION void	resize (int sz)
	Resize the derivative array to sz. More...

SACADO_INLINE_FUNCTION void	resizeAndZero (int sz)
	Resize the derivative array to sz. More...

SACADO_INLINE_FUNCTION void	expand (int sz)
	Expand derivative array to size sz. More...

SACADO_INLINE_FUNCTION void	zero ()
	Zero out derivative array. More...

SACADO_INLINE_FUNCTION const T &	val () const
	Returns value. More...

SACADO_INLINE_FUNCTION T &	val ()
	Returns value. More...

SACADO_INLINE_FUNCTION const U *	dx () const
	Returns derivative array. More...

SACADO_INLINE_FUNCTION U	dx (int i) const
	Returns derivative component `i` with bounds checking. More...

SACADO_INLINE_FUNCTION U &	fastAccessDx (int i)
	Returns derivative component `i` without bounds checking. More...

SACADO_INLINE_FUNCTION const U &	fastAccessDx (int i) const
	Returns derivative component `i` without bounds checking. More...

Protected Attributes
T	val_
	Value. More...

int	sz_
	Derivative array size. More...

int	len_
	Derivative array length. More...

U *	dx_
	Derivative array. More...

Detailed Description

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

Derivative array storage class using dynamic memory allocation.

Definition at line 39 of file Sacado_Fad_DynamicStorage.hpp.

Member Typedef Documentation

template<typename T, typename U = T>

typedef T Sacado::Fad::DynamicStorage< T, U >::value_type

Definition at line 43 of file Sacado_Fad_DynamicStorage.hpp.

Constructor & Destructor Documentation

template<typename T, typename U = T>

template<typename S >

SACADO_INLINE_FUNCTION Sacado::Fad::DynamicStorage< T, U >::DynamicStorage	(	const S &	x,
		SACADO_ENABLE_VALUE_CTOR_DECL
	)

inline

Default constructor.

Definition at line 48 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

SACADO_INLINE_FUNCTION 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

Definition at line 56 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

inline

Copy constructor.

Definition at line 66 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

SACADO_INLINE_FUNCTION Sacado::Fad::DynamicStorage< T, U >::~DynamicStorage ( )

inline

Destructor.

Definition at line 73 of file Sacado_Fad_DynamicStorage.hpp.

Member Function Documentation

template<typename T, typename U = T>

SACADO_INLINE_FUNCTION DynamicStorage& Sacado::Fad::DynamicStorage< T, U >::operator= ( const DynamicStorage< T, U > & x )

inline

Assignment.

Definition at line 80 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

inline

Returns number of derivative components.

Definition at line 102 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

inline

Returns array length.

Definition at line 106 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

inline

Resize the derivative array to sz.

Note: This does not necessarily preserve derivative components.

Definition at line 113 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

SACADO_INLINE_FUNCTION 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.

Definition at line 129 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

SACADO_INLINE_FUNCTION 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.

Definition at line 147 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

SACADO_INLINE_FUNCTION void Sacado::Fad::DynamicStorage< T, U >::zero ( )

inline

Zero out derivative array.

Definition at line 163 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

inline

Returns value.

Definition at line 169 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

inline

Returns value.

Definition at line 173 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

inline

Returns derivative array.

Definition at line 177 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

SACADO_INLINE_FUNCTION U Sacado::Fad::DynamicStorage< T, U >::dx ( int i ) const

inline

Returns derivative component i with bounds checking.

Definition at line 197 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

inline

Returns derivative component i without bounds checking.

Definition at line 201 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

inline

Returns derivative component i without bounds checking.

Definition at line 205 of file Sacado_Fad_DynamicStorage.hpp.

Member Data Documentation

template<typename T, typename U = T>

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

protected

Definition at line 212 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

protected

Derivative array size.

Definition at line 215 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

protected

Derivative array length.

Definition at line 218 of file Sacado_Fad_DynamicStorage.hpp.

template<typename T, typename U = T>

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

protected

Derivative array.

Definition at line 221 of file Sacado_Fad_DynamicStorage.hpp.

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

Sacado_Fad_DynamicStorage.hpp