Sacado  Development
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
Sacado::Fad::ViewStorage< T, static_length, static_stride, U > Class Template Reference

Derivative array storage class that is a view into a contiguous memory allocation. It does not provide proper value semantics and thus should not be used in a general-purpose scalar type. More...

#include <Sacado_Fad_ViewStorage.hpp>

Collaboration diagram for Sacado::Fad::ViewStorage< T, static_length, static_stride, U >:
Collaboration graph
[legend]

Public Types

typedef T value_type
 

Public Member Functions

template<typename S >
 ViewStorage (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
 Default constructor (needed to satisfy interface)
 
 ViewStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
 Constructor with size sz (needed to satisfy interface)
 
 ViewStorage (T *v, const int arg_size=0, const int arg_stride=0)
 Constructor.
 
 ViewStorage (T *arg_dx, T *arg_val, const int arg_size=0, const int arg_stride=0)
 Constructor.
 
 ViewStorage (const ViewStorage &x)
 Copy constructor.
 
 ~ViewStorage ()
 Destructor.
 
ViewStorageoperator= (const ViewStorage &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. More...
 
void resizeAndZero (int)
 Resize the derivative array to sz. More...
 
void expand (int sz)
 Expand derivative array to size sz.
 
void zero ()
 Zero out derivative array.
 
const T & val () const
 Returns value.
 
T & val ()
 Returns value.
 
const T * dx () const
 Returns derivative array.
 
dx (int i) const
 Returns derivative component i with bounds checking.
 
T & fastAccessDx (int i)
 Returns derivative component i without bounds checking.
 
const T & fastAccessDx (int i) const
 Returns derivative component i without bounds checking.
 

Protected Attributes

const
mpl::integral_nonzero_constant
< int, static_length > 
sz_
 Derivative array size.
 
const
mpl::integral_nonzero_constant
< int, static_stride > 
stride_
 Derivative array stride.
 
T * val_
 Value.
 
T * dx_
 Derivative array.
 

Detailed Description

template<typename T, unsigned static_length, unsigned static_stride, typename U>
class Sacado::Fad::ViewStorage< T, static_length, static_stride, U >

Derivative array storage class that is a view into a contiguous memory allocation. It does not provide proper value semantics and thus should not be used in a general-purpose scalar type.

Member Function Documentation

template<typename T , unsigned static_length, unsigned static_stride, typename U >
void Sacado::Fad::ViewStorage< T, static_length, static_stride, U >::resize ( int  sz)
inline

Resize the derivative array to sz.

Since we can't actually resize, we check for resizes to zero, which signify assigning a constant. Thus we zero out the derivative components.

References Sacado::Fad::ViewStorage< T, static_length, static_stride, U >::dx_, Sacado::Fad::ViewStorage< T, static_length, static_stride, U >::stride_, Sacado::ds_array< T, isScalar >::strided_zero(), and Sacado::Fad::ViewStorage< T, static_length, static_stride, U >::sz_.

template<typename T , unsigned static_length, unsigned static_stride, typename U >
void Sacado::Fad::ViewStorage< T, static_length, static_stride, U >::resizeAndZero ( int  )
inline

Resize the derivative array to sz.

We don't do anything here as this is used in the context of resizing the derivative array to zero and then back to some size > 0. Instead we zero out components when it is resized to zero above.


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