Sacado Package Browser (Single Doxygen Collection): Sacado::Fad::Exp::VectorDynamicStorage< 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_VectorDynamicStorage.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	VectorDynamicStorage ()
	Default constructor. More...

SACADO_INLINE_FUNCTION	VectorDynamicStorage (const T &x)
	Constructor with value. More...

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

SACADO_INLINE_FUNCTION	VectorDynamicStorage (const int sz, const int i, const value_type &x)
	Constructor with size `sz`, index `i`, and value `x`. More...

SACADO_INLINE_FUNCTION	VectorDynamicStorage (const int sz, T x, U dx_p, const int stride, bool zero_out)
	Constructor with supplied memory. More...

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

SACADO_INLINE_FUNCTION	~VectorDynamicStorage ()
	Destructor. More...

SACADO_INLINE_FUNCTION VectorDynamicStorage &	operator= (const VectorDynamicStorage &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 void	setMemory (int sz, T x, U dx_p, int stride)
	Set value/derivative array memory. 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

Private Attributes
T	v_

bool	owns_mem
	Do we own the val/dx storage. More...

int	sz_
	Derivative array size. More...

int	len_
	Derivative array length. More...

int	stride_
	Derivative array stride. More...

T *	val_
	Value. More...

U *	dx_
	Derivative array. More...

Detailed Description

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

Derivative array storage class using dynamic memory allocation.

Definition at line 46 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

Member Typedef Documentation

template<typename T , typename U = T>

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

Definition at line 50 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

Constructor & Destructor Documentation

template<typename T , typename U = T>

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

inline

Default constructor.

Definition at line 69 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Constructor with value.

Definition at line 76 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

SACADO_INLINE_FUNCTION Sacado::Fad::Exp::VectorDynamicStorage< T, U >::VectorDynamicStorage	(	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 86 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

SACADO_INLINE_FUNCTION Sacado::Fad::Exp::VectorDynamicStorage< T, U >::VectorDynamicStorage	(	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 102 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

SACADO_INLINE_FUNCTION Sacado::Fad::Exp::VectorDynamicStorage< T, U >::VectorDynamicStorage	(	const int	sz,
		T *	x,
		U *	dx_p,
		const int	stride,
		bool	zero_out
	)

inline

Constructor with supplied memory.

Definition at line 109 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Copy constructor.

Definition at line 119 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Destructor.

Definition at line 131 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

Member Function Documentation

template<typename T , typename U = T>

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

inline

Assignment.

Definition at line 140 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns number of derivative components.

Definition at line 170 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns array length.

Definition at line 174 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Resize the derivative array to sz.

Note: This does not necessarily preserve derivative components.

Definition at line 181 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::VectorDynamicStorage< 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 201 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::VectorDynamicStorage< 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 223 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Zero out derivative array.

Definition at line 243 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::VectorDynamicStorage< T, U >::setMemory	(	int	sz,
		T *	x,
		U *	dx_p,
		int	stride
	)

inline

Set value/derivative array memory.

Definition at line 249 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns value.

Definition at line 268 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns value.

Definition at line 272 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns derivative array.

Definition at line 276 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns derivative component i with bounds checking.

Definition at line 280 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns derivative component i without bounds checking.

Definition at line 284 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

inline

Returns derivative component i without bounds checking.

Definition at line 288 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

Member Data Documentation

template<typename T , typename U = T>

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

static

Definition at line 51 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

static

Definition at line 52 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

static

Definition at line 53 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

T Sacado::Fad::Exp::VectorDynamicStorage< T, U >::v_

private

Definition at line 292 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

bool Sacado::Fad::Exp::VectorDynamicStorage< T, U >::owns_mem

private

Do we own the val/dx storage.

Definition at line 297 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

private

Derivative array size.

Definition at line 300 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

private

Derivative array length.

Definition at line 303 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

int Sacado::Fad::Exp::VectorDynamicStorage< T, U >::stride_

private

Derivative array stride.

Definition at line 306 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

T* Sacado::Fad::Exp::VectorDynamicStorage< T, U >::val_

private

Definition at line 309 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

template<typename T , typename U = T>

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

private

Derivative array.

Definition at line 312 of file Sacado_Fad_Exp_VectorDynamicStorage.hpp.

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

Sacado_Fad_Exp_VectorDynamicStorage.hpp