Sacado Package Browser (Single Doxygen Collection)  Version of the Day
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | Private Attributes | List of all members
Sacado::Fad::MemPoolStorage< T > Class Template Reference

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

#include <Sacado_Fad_MemPoolStorage.hpp>

Public Types

typedef T value_type
 

Public Member Functions

template<typename S >
 MemPoolStorage (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
 Default constructor. More...
 
 MemPoolStorage (const int sz, const T &x, const DerivInit zero_out=InitDerivArray)
 Constructor with size sz. More...
 
 MemPoolStorage (const MemPoolStorage &x)
 Copy constructor. More...
 
 ~MemPoolStorage ()
 Destructor. More...
 
MemPoolStorageoperator= (const MemPoolStorage &x)
 Assignment. More...
 
int size () const
 Returns number of derivative components. More...
 
void resize (int sz)
 Resize the derivative array to sz. More...
 
void resizeAndZero (int sz)
 Resize the derivative array to sz. More...
 
void expand (int sz)
 Expand derivative array to size sz. More...
 
void zero ()
 Zero out derivative array. More...
 
const Tval () const
 Returns value. More...
 
Tval ()
 Returns value. More...
 
const Tdx () const
 Returns derivative array. More...
 
T dx (int i) const
 Returns derivative component i with bounds checking. More...
 
TfastAccessDx (int i)
 Returns derivative component i without bounds checking. More...
 
const TfastAccessDx (int i) const
 Returns derivative component i without bounds checking. More...
 
template<>
Sacado::Fad::MemPooldefaultPool_
 
template<>
Sacado::Fad::MemPooldefaultPool_
 
template<>
Sacado::Fad::MemPooldefaultPool_
 
template<>
Sacado::Fad::MemPooldefaultPool_
 
template<>
Sacado::Fad::MemPooldefaultPool_
 
template<>
Sacado::Fad::MemPooldefaultPool_
 
template<>
Sacado::Fad::MemPooldefaultPool_
 
template<>
Sacado::Fad::MemPooldefaultPool_
 
template<>
Sacado::Fad::MemPooldefaultPool_
 
template<>
Sacado::Fad::MemPooldefaultPool_
 

Static Public Attributes

static MemPooldefaultPool_
 Default memory pool. More...
 

Protected Attributes

MemPoolmyPool_
 Memory pool. More...
 

Private Attributes

T val_
 Value. More...
 
int sz_
 Derivative array size. More...
 
int len_
 Derivative array length. More...
 
Tdx_
 Derivative array. More...
 

Detailed Description

template<typename T>
class Sacado::Fad::MemPoolStorage< T >

Derivative array storage class using dynamic memory allocation.

Definition at line 177 of file Sacado_Fad_MemPoolStorage.hpp.

Member Typedef Documentation

◆ value_type

template<typename T >
typedef T Sacado::Fad::MemPoolStorage< T >::value_type

Definition at line 181 of file Sacado_Fad_MemPoolStorage.hpp.

Constructor & Destructor Documentation

◆ MemPoolStorage() [1/3]

template<typename T >
template<typename S >
Sacado::Fad::MemPoolStorage< T >::MemPoolStorage ( const S &  x,
SACADO_ENABLE_VALUE_CTOR_DECL   
)
inline

Default constructor.

Definition at line 185 of file Sacado_Fad_MemPoolStorage.hpp.

◆ MemPoolStorage() [2/3]

template<typename T >
Sacado::Fad::MemPoolStorage< T >::MemPoolStorage ( 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 192 of file Sacado_Fad_MemPoolStorage.hpp.

◆ MemPoolStorage() [3/3]

template<typename T >
Sacado::Fad::MemPoolStorage< T >::MemPoolStorage ( const MemPoolStorage< T > &  x)
inline

Copy constructor.

Definition at line 201 of file Sacado_Fad_MemPoolStorage.hpp.

◆ ~MemPoolStorage()

template<typename T >
Sacado::Fad::MemPoolStorage< T >::~MemPoolStorage ( )
inline

Destructor.

Definition at line 207 of file Sacado_Fad_MemPoolStorage.hpp.

Member Function Documentation

◆ operator=()

template<typename T >
MemPoolStorage& Sacado::Fad::MemPoolStorage< T >::operator= ( const MemPoolStorage< T > &  x)
inline

Assignment.

Definition at line 213 of file Sacado_Fad_MemPoolStorage.hpp.

◆ size()

template<typename T >
int Sacado::Fad::MemPoolStorage< T >::size ( ) const
inline

Returns number of derivative components.

Definition at line 235 of file Sacado_Fad_MemPoolStorage.hpp.

◆ resize()

template<typename T >
void Sacado::Fad::MemPoolStorage< T >::resize ( int  sz)
inline

Resize the derivative array to sz.

Note: This does not necessarily preserve derivative components.

Definition at line 241 of file Sacado_Fad_MemPoolStorage.hpp.

◆ resizeAndZero()

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

Definition at line 257 of file Sacado_Fad_MemPoolStorage.hpp.

◆ expand()

template<typename T >
void Sacado::Fad::MemPoolStorage< T >::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 275 of file Sacado_Fad_MemPoolStorage.hpp.

◆ zero()

template<typename T >
void Sacado::Fad::MemPoolStorage< T >::zero ( )
inline

Zero out derivative array.

Definition at line 290 of file Sacado_Fad_MemPoolStorage.hpp.

◆ val() [1/2]

template<typename T >
const T& Sacado::Fad::MemPoolStorage< T >::val ( ) const
inline

Returns value.

Definition at line 295 of file Sacado_Fad_MemPoolStorage.hpp.

◆ val() [2/2]

template<typename T >
T& Sacado::Fad::MemPoolStorage< T >::val ( )
inline

Returns value.

Definition at line 298 of file Sacado_Fad_MemPoolStorage.hpp.

◆ dx() [1/2]

template<typename T >
const T* Sacado::Fad::MemPoolStorage< T >::dx ( ) const
inline

Returns derivative array.

Definition at line 301 of file Sacado_Fad_MemPoolStorage.hpp.

◆ dx() [2/2]

template<typename T >
T Sacado::Fad::MemPoolStorage< T >::dx ( int  i) const
inline

Returns derivative component i with bounds checking.

Definition at line 304 of file Sacado_Fad_MemPoolStorage.hpp.

◆ fastAccessDx() [1/2]

template<typename T >
T& Sacado::Fad::MemPoolStorage< T >::fastAccessDx ( int  i)
inline

Returns derivative component i without bounds checking.

Definition at line 307 of file Sacado_Fad_MemPoolStorage.hpp.

◆ fastAccessDx() [2/2]

template<typename T >
const T& Sacado::Fad::MemPoolStorage< T >::fastAccessDx ( int  i) const
inline

Returns derivative component i without bounds checking.

Definition at line 310 of file Sacado_Fad_MemPoolStorage.hpp.

◆ defaultPool_() [1/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< double >::defaultPool_ ( )

Definition at line 49 of file dmfad_example.cpp.

◆ defaultPool_() [2/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< double >::defaultPool_ ( )

Definition at line 47 of file fad_expr.cpp.

◆ defaultPool_() [3/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< double >::defaultPool_ ( )

Definition at line 41 of file fad_fe_jac_fill.cpp.

◆ defaultPool_() [4/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< double >::defaultPool_ ( )

Definition at line 46 of file fad_lj_grad.cpp.

◆ defaultPool_() [5/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< double >::defaultPool_ ( )

Definition at line 44 of file TraitsTests.cpp.

◆ defaultPool_() [6/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< Sacado::Fad::DMFad< double > >::defaultPool_ ( )

Definition at line 46 of file TraitsTests.cpp.

◆ defaultPool_() [7/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< double >::defaultPool_ ( )

Definition at line 250 of file ConversionTests.cpp.

◆ defaultPool_() [8/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< Sacado::Fad::DMFad< double > >::defaultPool_ ( )

Definition at line 252 of file ConversionTests.cpp.

◆ defaultPool_() [9/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< double >::defaultPool_ ( )

Definition at line 432 of file Fad_SerializationTests.cpp.

◆ defaultPool_() [10/10]

template<>
Sacado::Fad::MemPool * Sacado::Fad::MemPoolStorage< Sacado::Fad::DMFad< double > >::defaultPool_ ( )

Definition at line 434 of file Fad_SerializationTests.cpp.

Member Data Documentation

◆ val_

template<typename T >
T Sacado::Fad::MemPoolStorage< T >::val_
private

Value.

Definition at line 315 of file Sacado_Fad_MemPoolStorage.hpp.

◆ sz_

template<typename T >
int Sacado::Fad::MemPoolStorage< T >::sz_
private

Derivative array size.

Definition at line 318 of file Sacado_Fad_MemPoolStorage.hpp.

◆ len_

template<typename T >
int Sacado::Fad::MemPoolStorage< T >::len_
private

Derivative array length.

Definition at line 321 of file Sacado_Fad_MemPoolStorage.hpp.

◆ dx_

template<typename T >
T* Sacado::Fad::MemPoolStorage< T >::dx_
private

Derivative array.

Definition at line 324 of file Sacado_Fad_MemPoolStorage.hpp.

◆ defaultPool_

template<typename T >
MemPool* Sacado::Fad::MemPoolStorage< T >::defaultPool_
static

Default memory pool.

Definition at line 329 of file Sacado_Fad_MemPoolStorage.hpp.

◆ myPool_

template<typename T >
MemPool* Sacado::Fad::MemPoolStorage< T >::myPool_
protected

Memory pool.

Definition at line 334 of file Sacado_Fad_MemPoolStorage.hpp.


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