Sacado Package Browser (Single Doxygen Collection): Sacado::Fad::StaticStorage< T, Num > 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 static memory allocation. More...

#include <Sacado_Fad_StaticStorage.hpp>

Public Types
typedef T	value_type

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

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

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

SACADO_INLINE_FUNCTION	~StaticStorage ()
	Destructor. More...

SACADO_INLINE_FUNCTION StaticStorage &	operator= (const StaticStorage &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 T *	dx () const
	Returns derivative array. More...

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

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

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

Protected Attributes
T	val_
	Value. More...

T	dx_ [Num]
	Derivative array. More...

int	sz_
	Size of derivative array. More...

Detailed Description

template<typename T, int Num>
class Sacado::Fad::StaticStorage< T, Num >

Derivative array storage class using static memory allocation.

This class uses a statically allocated array whose dimension is fixed by the template parameter Num.

Definition at line 43 of file Sacado_Fad_StaticStorage.hpp.

Member Typedef Documentation

template<typename T , int Num>

typedef T Sacado::Fad::StaticStorage< T, Num >::value_type

Definition at line 47 of file Sacado_Fad_StaticStorage.hpp.

Constructor & Destructor Documentation

template<typename T , int Num>

template<typename S >

SACADO_INLINE_FUNCTION Sacado::Fad::StaticStorage< T, Num >::StaticStorage	(	const S &	x,
		SACADO_ENABLE_VALUE_CTOR_DECL
	)

inline

Default constructor.

Definition at line 52 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION Sacado::Fad::StaticStorage< T, Num >::StaticStorage	(	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 60 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Copy constructor.

Definition at line 72 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION Sacado::Fad::StaticStorage< T, Num >::~StaticStorage ( )

inline

Destructor.

Definition at line 81 of file Sacado_Fad_StaticStorage.hpp.

Member Function Documentation

template<typename T , int Num>

SACADO_INLINE_FUNCTION StaticStorage& Sacado::Fad::StaticStorage< T, Num >::operator= ( const StaticStorage< T, Num > & x )

inline

Assignment.

Definition at line 85 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION int Sacado::Fad::StaticStorage< T, Num >::size ( ) const

inline

Returns number of derivative components.

Definition at line 98 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION int Sacado::Fad::StaticStorage< T, Num >::length ( ) const

inline

Returns array length.

Definition at line 102 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION void Sacado::Fad::StaticStorage< T, Num >::resize ( int sz )

inline

Resize the derivative array to sz.

Definition at line 106 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION void Sacado::Fad::StaticStorage< T, Num >::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 120 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION void Sacado::Fad::StaticStorage< T, Num >::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 136 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION void Sacado::Fad::StaticStorage< T, Num >::zero ( )

inline

Zero out derivative array.

Definition at line 149 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION const T& Sacado::Fad::StaticStorage< T, Num >::val ( ) const

inline

Returns value.

Definition at line 153 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION T& Sacado::Fad::StaticStorage< T, Num >::val ( )

inline

Returns value.

Definition at line 157 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION const T* Sacado::Fad::StaticStorage< T, Num >::dx ( ) const

inline

Returns derivative array.

Definition at line 161 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION T Sacado::Fad::StaticStorage< T, Num >::dx ( int i ) const

inline

Returns derivative component i with bounds checking.

Definition at line 165 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION T& Sacado::Fad::StaticStorage< T, Num >::fastAccessDx ( int i )

inline

Returns derivative component i without bounds checking.

Definition at line 169 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION const T& Sacado::Fad::StaticStorage< T, Num >::fastAccessDx ( int i ) const

inline

Returns derivative component i without bounds checking.

Definition at line 173 of file Sacado_Fad_StaticStorage.hpp.

Member Data Documentation

template<typename T , int Num>

T Sacado::Fad::StaticStorage< T, Num >::val_

protected

Definition at line 178 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

T Sacado::Fad::StaticStorage< T, Num >::dx_[Num]

protected

Derivative array.

Definition at line 181 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>

int Sacado::Fad::StaticStorage< T, Num >::sz_

protected

Size of derivative array.

Definition at line 184 of file Sacado_Fad_StaticStorage.hpp.

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

Sacado_Fad_StaticStorage.hpp