Sacado Package Browser (Single Doxygen Collection): Sacado::Fad::Exp::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_Exp_StaticStorage.hpp>

Classes
struct	apply
	Turn StaticStorage into a meta-function class usable with mpl::apply. More...

struct	apply_N
	Replace static derivative length (interpreted as a fixed length) More...

Public Types
typedef std::remove_cv< T >::type	value_type

Public Member Functions
SACADO_INLINE_FUNCTION	StaticStorage ()
	Default constructor. More...

SACADO_INLINE_FUNCTION	StaticStorage (const T &x)
	Constructor with value. 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 int sz, const int i, const value_type &x)
	Constructor with size `sz`, index `i`, and value `x`. More...

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

SACADO_INLINE_FUNCTION	StaticStorage (StaticStorage &&x)
	Move constructor. More...

SACADO_INLINE_FUNCTION	~StaticStorage ()
	Destructor. More...

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

SACADO_INLINE_FUNCTION StaticStorage &	operator= (StaticStorage &&x)
	Move 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...

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

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

int	sz_
	Size of derivative array. More...

Detailed Description

template<typename T, int Num>
class Sacado::Fad::Exp::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 30 of file Sacado_Fad_Exp_StaticStorage.hpp.

Member Typedef Documentation

template<typename T , int Num>

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

Definition at line 34 of file Sacado_Fad_Exp_StaticStorage.hpp.

Constructor & Destructor Documentation

template<typename T , int Num>

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

inline

Default constructor.

Definition at line 53 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Constructor with value.

Definition at line 58 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION Sacado::Fad::Exp::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 66 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

template<typename T , int Num>

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

inline

Copy constructor.

Definition at line 91 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Move constructor.

Definition at line 100 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Destructor.

Definition at line 108 of file Sacado_Fad_Exp_StaticStorage.hpp.

Member Function Documentation

template<typename T , int Num>

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

inline

Assignment.

Definition at line 112 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Move assignment.

Definition at line 125 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Returns number of derivative components.

Definition at line 137 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Returns array length.

Definition at line 141 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Resize the derivative array to sz.

Definition at line 145 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::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 159 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::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 175 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Zero out derivative array.

Definition at line 188 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Returns value.

Definition at line 192 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Returns value.

Definition at line 196 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Returns derivative array.

Definition at line 200 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Returns derivative component i with bounds checking.

Definition at line 204 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Returns derivative component i without bounds checking.

Definition at line 208 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

inline

Returns derivative component i without bounds checking.

Definition at line 212 of file Sacado_Fad_Exp_StaticStorage.hpp.

Member Data Documentation

template<typename T , int Num>

constexpr bool Sacado::Fad::Exp::StaticStorage< T, Num >::is_statically_sized = false

static

Definition at line 35 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

constexpr int Sacado::Fad::Exp::StaticStorage< T, Num >::static_size = 0

static

Definition at line 36 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

constexpr bool Sacado::Fad::Exp::StaticStorage< T, Num >::is_view = false

static

Definition at line 37 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

protected

Definition at line 217 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

protected

Derivative array.

Definition at line 220 of file Sacado_Fad_Exp_StaticStorage.hpp.

template<typename T , int Num>

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

protected

Size of derivative array.

Definition at line 223 of file Sacado_Fad_Exp_StaticStorage.hpp.

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

Sacado_Fad_Exp_StaticStorage.hpp