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

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
SACADO_INLINE_FUNCTION	DynamicStorage ()
	Default constructor. More...

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

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

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

SACADO_INLINE_FUNCTION	~DynamicStorage ()
	Destructor. More...

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

SACADO_INLINE_FUNCTION DynamicStorage &	operator= (DynamicStorage &&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 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...

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

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::Exp::DynamicStorage< T, U >

Derivative array storage class using dynamic memory allocation.

Definition at line 26 of file Sacado_Fad_Exp_DynamicStorage.hpp.

Member Typedef Documentation

template<typename T , typename U = T>

typedef std::remove_cv<T>::type Sacado::Fad::Exp::DynamicStorage< T, U >::value_type

Definition at line 30 of file Sacado_Fad_Exp_DynamicStorage.hpp.

Constructor & Destructor Documentation

template<typename T , typename U = T>

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

inline

Default constructor.

Definition at line 49 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Constructor with value.

Definition at line 54 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

template<typename T , typename U = T>

SACADO_INLINE_FUNCTION Sacado::Fad::Exp::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.

Definition at line 78 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Copy constructor.

Definition at line 85 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Move constructor.

Definition at line 92 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Destructor.

Definition at line 101 of file Sacado_Fad_Exp_DynamicStorage.hpp.

Member Function Documentation

template<typename T , typename U = T>

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

inline

Assignment.

Definition at line 108 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Move assignment.

Definition at line 130 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns number of derivative components.

Definition at line 144 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns array length.

Definition at line 148 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Resize the derivative array to sz.

Note: This does not necessarily preserve derivative components.

Definition at line 155 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

template<typename T , typename U = T>

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

template<typename T , typename U = T>

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

inline

Zero out derivative array.

Definition at line 205 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns value.

Definition at line 211 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns value.

Definition at line 215 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns derivative array.

Definition at line 219 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns derivative component i with bounds checking.

Definition at line 239 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns derivative component i without bounds checking.

Definition at line 243 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns derivative component i without bounds checking.

Definition at line 247 of file Sacado_Fad_Exp_DynamicStorage.hpp.

Member Data Documentation

template<typename T , typename U = T>

constexpr bool Sacado::Fad::Exp::DynamicStorage< T, U >::is_statically_sized = false

static

Definition at line 31 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

constexpr int Sacado::Fad::Exp::DynamicStorage< T, U >::static_size = 0

static

Definition at line 32 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

constexpr bool Sacado::Fad::Exp::DynamicStorage< T, U >::is_view = false

static

Definition at line 33 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

protected

Definition at line 254 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

protected

Derivative array size.

Definition at line 257 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

protected

Derivative array length.

Definition at line 260 of file Sacado_Fad_Exp_DynamicStorage.hpp.

template<typename T , typename U = T>

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

protected

Derivative array.

Definition at line 263 of file Sacado_Fad_Exp_DynamicStorage.hpp.

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

Sacado_Fad_Exp_DynamicStorage.hpp