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>
Classes | |
| struct | apply |
| Turn ViewStorage 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 |
| typedef U | base_fad_type |
Public Member Functions | |
| ViewStorage () | |
| Default constructor (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. | |
| template<typename TT > | |
| ViewStorage (const ViewStorage< TT, static_length, static_stride, U > &x, typename std::enable_if< std::is_same< TT, T >::value||std::is_same< const TT, T >::value >::type *=0) | |
| Copy constructor. | |
| ~ViewStorage () | |
| Destructor. | |
| ViewStorage & | operator= (const ViewStorage &x) |
| Assignment. | |
| constexpr int | size () const |
| Returns number of derivative components. | |
| constexpr 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. | |
| const T & | val () const |
| Returns value. | |
| T & | val () |
| Returns value. | |
| const T * | dx () const |
| Returns derivative array. | |
| T | 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. | |
| ViewFadPtr< T, static_length, static_stride, U > | operator& () const |
| Overload of addressof operator. | |
Static Public Attributes | |
| static constexpr bool | is_statically_sized = (static_length > 0) |
| static constexpr int | static_size = static_length |
| static constexpr bool | is_view = true |
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
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.
Constructor & Destructor Documentation
◆ ViewStorage()
|
inline |
Copy constructor.
Allow, e.g., ViewStorage<double,...>(ViewStorage<double,...>), ViewStorage<const double,...>(ViewStorage<double,...>), and ViewStorage<const double,...>(ViewStorage<const double,...>) but not ViewStorage<double,...>(ViewStorage<const double,...>).
Member Function Documentation
◆ resize()
|
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_.
◆ resizeAndZero()
|
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:
- Sacado_Fad_ViewStorage.hpp
