Sacado Development
Loading...
Searching...
No Matches
Sacado::Fad::VectorDynamicStorage< T, U > Class Template Reference

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

#include <Sacado_Fad_VectorDynamicStorage.hpp>

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

Public Types

typedef T value_type

Public Member Functions

template<typename S>
 VectorDynamicStorage (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
 Default constructor.
 VectorDynamicStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
 Constructor with size sz.
 VectorDynamicStorage (const int sz, T *x, U *dx_p, const int stride, bool zero_out)
 Constructor with supplied memory.
 VectorDynamicStorage (const VectorDynamicStorage &x)
 Copy constructor.
 ~VectorDynamicStorage ()
 Destructor.
VectorDynamicStorageoperator= (const VectorDynamicStorage &x)
 Assignment.
int size () const
 Returns number of derivative components.
int length () const
 Returns array length.
void resize (int sz)
 Resize the derivative array to sz.
void resizeAndZero (int sz)
 Resize the derivative array to sz.
void expand (int sz)
 Expand derivative array to size sz.
void zero ()
 Zero out derivative array.
void setMemory (int sz, T *x, U *dx_p, int stride)
 Set value/derivative array memory.
const T & val () const
 Returns value.
T & val ()
 Returns value.
const U * dx () const
 Returns derivative array.
dx (int i) const
 Returns derivative component i with bounds checking.
U & fastAccessDx (int i)
 Returns derivative component i without bounds checking.
const U & fastAccessDx (int i) const
 Returns derivative component i without bounds checking.

Detailed Description

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

Derivative array storage class using dynamic memory allocation.

Constructor & Destructor Documentation

◆ VectorDynamicStorage()

template<typename T, typename U = T>
Sacado::Fad::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

Member Function Documentation

◆ expand()

template<typename T, typename U = T>
void Sacado::Fad::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.

◆ resize()

template<typename T, typename U = T>
void Sacado::Fad::VectorDynamicStorage< T, U >::resize ( int sz)
inline

Resize the derivative array to sz.

Note: This does not necessarily preserve derivative components.

◆ resizeAndZero()

template<typename T, typename U = T>
void Sacado::Fad::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.


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