Sacado Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions | Private Attributes
Sacado::Fad::StaticStorage< T, Num > Class Template Reference

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

#include <Sacado_Fad_StaticStorage.hpp>

List of all members.

Public Member Functions

 StaticStorage (const T &x)
 Default constructor.
 StaticStorage (const int sz, const T &x)
 Constructor with size sz.
 StaticStorage (const StaticStorage &x)
 Copy constructor.
 ~StaticStorage ()
 Destructor.
StaticStorageoperator= (const StaticStorage &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 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.

Private Attributes

val_
 Value.
dx_ [Num]
 Derivative array.
int sz_
 Size of derivative array.

Detailed Description

template<typename T, int Num>
class Sacado::Fad::StaticStorage< T, Num >

Derivative array storage class using static memory allocation.

This class uses a statically allocated array whose dimension is fixed by the template parameter Num.

Definition at line 48 of file Sacado_Fad_StaticStorage.hpp.


Constructor & Destructor Documentation

template<typename T , int Num>
Sacado::Fad::StaticStorage< T, Num >::StaticStorage ( const T &  x) [inline]

Default constructor.

Definition at line 53 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
Sacado::Fad::StaticStorage< T, Num >::StaticStorage ( const int  sz,
const T &  x 
) [inline]

Constructor with size sz.

Initializes derivative array 0 of length sz

Definition at line 59 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
Sacado::Fad::StaticStorage< T, Num >::StaticStorage ( const StaticStorage< T, Num > &  x) [inline]

Copy constructor.

Definition at line 68 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
Sacado::Fad::StaticStorage< T, Num >::~StaticStorage ( ) [inline]

Destructor.

Definition at line 76 of file Sacado_Fad_StaticStorage.hpp.


Member Function Documentation

template<typename T , int Num>
StaticStorage& Sacado::Fad::StaticStorage< T, Num >::operator= ( const StaticStorage< T, Num > &  x) [inline]

Assignment.

Definition at line 79 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
int Sacado::Fad::StaticStorage< T, Num >::size ( ) const [inline]

Returns number of derivative components.

Definition at line 89 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
int Sacado::Fad::StaticStorage< T, Num >::length ( ) const [inline]

Returns array length.

Definition at line 92 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
void Sacado::Fad::StaticStorage< T, Num >::resize ( int  sz) [inline]

Resize the derivative array to sz.

Definition at line 95 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
void Sacado::Fad::StaticStorage< T, Num >::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 108 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
void Sacado::Fad::StaticStorage< T, Num >::zero ( ) [inline]

Zero out derivative array.

Definition at line 120 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
const T& Sacado::Fad::StaticStorage< T, Num >::val ( ) const [inline]

Returns value.

Definition at line 123 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
T& Sacado::Fad::StaticStorage< T, Num >::val ( ) [inline]

Returns value.

Definition at line 126 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
const T* Sacado::Fad::StaticStorage< T, Num >::dx ( ) const [inline]

Returns derivative array.

Definition at line 129 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
T Sacado::Fad::StaticStorage< T, Num >::dx ( int  i) const [inline]

Returns derivative component i with bounds checking.

Definition at line 132 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
T& Sacado::Fad::StaticStorage< T, Num >::fastAccessDx ( int  i) [inline]

Returns derivative component i without bounds checking.

Definition at line 135 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
const T& Sacado::Fad::StaticStorage< T, Num >::fastAccessDx ( int  i) const [inline]

Returns derivative component i without bounds checking.

Definition at line 138 of file Sacado_Fad_StaticStorage.hpp.


Member Data Documentation

template<typename T , int Num>
T Sacado::Fad::StaticStorage< T, Num >::val_ [private]

Value.

Definition at line 143 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
T Sacado::Fad::StaticStorage< T, Num >::dx_[Num] [private]

Derivative array.

Definition at line 146 of file Sacado_Fad_StaticStorage.hpp.

template<typename T , int Num>
int Sacado::Fad::StaticStorage< T, Num >::sz_ [private]

Size of derivative array.

Definition at line 149 of file Sacado_Fad_StaticStorage.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines