Sacado Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
Sacado::Fad::Exp::StaticFixedStorage< T, Num > Class Template Reference

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

#include <Sacado_Fad_Exp_StaticFixedStorage.hpp>

Classes

struct  apply
 Turn StaticFixedStorage 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_DEFAULTED_FUNCTION StaticFixedStorage ()=default
 Default constructor.
 
SACADO_INLINE_FUNCTION StaticFixedStorage (const T &x)
 Constructor with value.
 
SACADO_INLINE_FUNCTION StaticFixedStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
 Constructor with size sz.
 
SACADO_INLINE_FUNCTION StaticFixedStorage (const int sz, const int i, const value_type &x)
 Constructor with size sz, index i, and value x.
 
SACADO_INLINE_FUNCTION StaticFixedStorage (const StaticFixedStorage &x)
 Copy constructor.
 
SACADO_INLINE_FUNCTION StaticFixedStorage (StaticFixedStorage &&x)
 Move constructor.
 
SACADO_DEFAULTED_FUNCTION ~StaticFixedStorage ()=default
 Destructor.
 
SACADO_INLINE_FUNCTION StaticFixedStorageoperator= (const StaticFixedStorage &x)
 Assignment.
 
SACADO_INLINE_FUNCTION StaticFixedStorageoperator= (StaticFixedStorage &&x)
 Move assignment.
 
SACADO_INLINE_FUNCTION constexpr int size () const
 Returns number of derivative components.
 
SACADO_INLINE_FUNCTION constexpr int length () const
 Returns array length.
 
SACADO_INLINE_FUNCTION void resize (int sz)
 Resize the derivative array to sz.
 
SACADO_INLINE_FUNCTION void resizeAndZero (int sz)
 Resize the derivative array to sz.
 
SACADO_INLINE_FUNCTION void expand (int sz)
 Expand derivative array to size sz.
 
SACADO_INLINE_FUNCTION void zero ()
 Zero out derivative array.
 
SACADO_INLINE_FUNCTION const Tval () const
 Returns value.
 
SACADO_INLINE_FUNCTION Tval ()
 Returns value.
 
SACADO_INLINE_FUNCTION const Tdx () const
 Returns derivative array.
 
SACADO_INLINE_FUNCTION T dx (int i) const
 Returns derivative component i with bounds checking.
 
SACADO_INLINE_FUNCTION TfastAccessDx (int i)
 Returns derivative component i without bounds checking.
 
SACADO_INLINE_FUNCTION const TfastAccessDx (int i) const
 Returns derivative component i without bounds checking.
 

Static Public Attributes

static constexpr bool is_statically_sized = true
 
static constexpr int static_size = Num
 
static constexpr bool is_view = false
 

Protected Attributes

T val_
 Value.
 
T dx_ [Num]
 Derivative array.
 

Detailed Description

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

Derivative array storage class using static, fixed memory allocation.

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

Definition at line 50 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

Member Typedef Documentation

◆ value_type

template<typename T , int Num>
typedef std::remove_cv<T>::type Sacado::Fad::Exp::StaticFixedStorage< T, Num >::value_type

Definition at line 54 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

Constructor & Destructor Documentation

◆ StaticFixedStorage() [1/6]

template<typename T , int Num>
SACADO_DEFAULTED_FUNCTION Sacado::Fad::Exp::StaticFixedStorage< T, Num >::StaticFixedStorage ( )
default

Default constructor.

◆ StaticFixedStorage() [2/6]

template<typename T , int Num>
SACADO_INLINE_FUNCTION Sacado::Fad::Exp::StaticFixedStorage< T, Num >::StaticFixedStorage ( const T x)
inline

Constructor with value.

Definition at line 85 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ StaticFixedStorage() [3/6]

template<typename T , int Num>
SACADO_INLINE_FUNCTION Sacado::Fad::Exp::StaticFixedStorage< T, Num >::StaticFixedStorage ( 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 95 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ StaticFixedStorage() [4/6]

template<typename T , int Num>
SACADO_INLINE_FUNCTION Sacado::Fad::Exp::StaticFixedStorage< T, Num >::StaticFixedStorage ( 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 113 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ StaticFixedStorage() [5/6]

template<typename T , int Num>
SACADO_INLINE_FUNCTION Sacado::Fad::Exp::StaticFixedStorage< T, Num >::StaticFixedStorage ( const StaticFixedStorage< T, Num > &  x)
inline

Copy constructor.

Can't make this " = default" because of scalar types that don't define a const copy consturctor (like Rad). We also can't leave it and let it be implicitly generated because of SACADO_INLINE_FUNCTION.

Definition at line 125 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ StaticFixedStorage() [6/6]

template<typename T , int Num>
SACADO_INLINE_FUNCTION Sacado::Fad::Exp::StaticFixedStorage< T, Num >::StaticFixedStorage ( StaticFixedStorage< T, Num > &&  x)
inline

Move constructor.

Definition at line 133 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ ~StaticFixedStorage()

template<typename T , int Num>
SACADO_DEFAULTED_FUNCTION Sacado::Fad::Exp::StaticFixedStorage< T, Num >::~StaticFixedStorage ( )
default

Destructor.

Member Function Documentation

◆ operator=() [1/2]

template<typename T , int Num>
SACADO_INLINE_FUNCTION StaticFixedStorage & Sacado::Fad::Exp::StaticFixedStorage< T, Num >::operator= ( const StaticFixedStorage< T, Num > &  x)
inline

Assignment.

Can't make this " = default" because of scalar types that don't define a const operator= (like Rad). We also can't leave it and let it be implicitly generated because of SACADO_INLINE_FUNCTION.

Definition at line 150 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ operator=() [2/2]

template<typename T , int Num>
SACADO_INLINE_FUNCTION StaticFixedStorage & Sacado::Fad::Exp::StaticFixedStorage< T, Num >::operator= ( StaticFixedStorage< T, Num > &&  x)
inline

Move assignment.

Definition at line 161 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ size()

template<typename T , int Num>
SACADO_INLINE_FUNCTION constexpr int Sacado::Fad::Exp::StaticFixedStorage< T, Num >::size ( ) const
inlineconstexpr

Returns number of derivative components.

Definition at line 172 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ length()

template<typename T , int Num>
SACADO_INLINE_FUNCTION constexpr int Sacado::Fad::Exp::StaticFixedStorage< T, Num >::length ( ) const
inlineconstexpr

Returns array length.

Definition at line 176 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ resize()

template<typename T , int Num>
SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::StaticFixedStorage< T, Num >::resize ( int  sz)
inline

Resize the derivative array to sz.

Definition at line 180 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ resizeAndZero()

template<typename T , int Num>
SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::StaticFixedStorage< T, Num >::resizeAndZero ( int  sz)
inline

Resize the derivative array to sz.

Definition at line 194 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ expand()

template<typename T , int Num>
SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::StaticFixedStorage< T, Num >::expand ( int  sz)
inline

Expand derivative array to size sz.

Definition at line 204 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ zero()

template<typename T , int Num>
SACADO_INLINE_FUNCTION void Sacado::Fad::Exp::StaticFixedStorage< T, Num >::zero ( )
inline

Zero out derivative array.

Definition at line 214 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ val() [1/2]

template<typename T , int Num>
SACADO_INLINE_FUNCTION const T & Sacado::Fad::Exp::StaticFixedStorage< T, Num >::val ( ) const
inline

Returns value.

Definition at line 218 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ val() [2/2]

template<typename T , int Num>
SACADO_INLINE_FUNCTION T & Sacado::Fad::Exp::StaticFixedStorage< T, Num >::val ( )
inline

Returns value.

Definition at line 222 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ dx() [1/2]

template<typename T , int Num>
SACADO_INLINE_FUNCTION const T * Sacado::Fad::Exp::StaticFixedStorage< T, Num >::dx ( ) const
inline

Returns derivative array.

Definition at line 226 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ dx() [2/2]

template<typename T , int Num>
SACADO_INLINE_FUNCTION T Sacado::Fad::Exp::StaticFixedStorage< T, Num >::dx ( int  i) const
inline

Returns derivative component i with bounds checking.

Definition at line 230 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ fastAccessDx() [1/2]

template<typename T , int Num>
SACADO_INLINE_FUNCTION T & Sacado::Fad::Exp::StaticFixedStorage< T, Num >::fastAccessDx ( int  i)
inline

Returns derivative component i without bounds checking.

Definition at line 234 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ fastAccessDx() [2/2]

template<typename T , int Num>
SACADO_INLINE_FUNCTION const T & Sacado::Fad::Exp::StaticFixedStorage< T, Num >::fastAccessDx ( int  i) const
inline

Returns derivative component i without bounds checking.

Definition at line 238 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

Member Data Documentation

◆ is_statically_sized

template<typename T , int Num>
constexpr bool Sacado::Fad::Exp::StaticFixedStorage< T, Num >::is_statically_sized = true
staticconstexpr

Definition at line 55 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ static_size

template<typename T , int Num>
constexpr int Sacado::Fad::Exp::StaticFixedStorage< T, Num >::static_size = Num
staticconstexpr

Definition at line 56 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ is_view

template<typename T , int Num>
constexpr bool Sacado::Fad::Exp::StaticFixedStorage< T, Num >::is_view = false
staticconstexpr

Definition at line 57 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ val_

template<typename T , int Num>
T Sacado::Fad::Exp::StaticFixedStorage< T, Num >::val_
protected

Value.

Definition at line 243 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.

◆ dx_

template<typename T , int Num>
T Sacado::Fad::Exp::StaticFixedStorage< T, Num >::dx_[Num]
protected

Derivative array.

Definition at line 246 of file Sacado_Fad_Exp_StaticFixedStorage.hpp.


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