Sacado Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | List of all members
Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename > Class Template Reference

Forward-mode AD class using dynamic memory allocation and expression templates. More...

#include <Sacado_Fad_DFad_tmpl.hpp>

Inheritance diagram for Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >:
Inheritance graph
[legend]

Classes

struct  apply
 Turn ViewFad into a meta-function class usable with mpl::apply. More...
 

Public Types

typedef Fad::ViewStorage
< ValueT, length, stride,
BaseFadT > 
StorageType
 Base classes. More...
 
typedef GeneralFad< ValueT,
StorageType
GeneralFadType
 
typedef Expr< GeneralFadTypeExprType
 
typedef ExprType::value_type value_type
 Typename of values. More...
 
typedef ExprType::scalar_type scalar_type
 Typename of scalar's (which may be different from value_type) More...
 
typedef ScalarType< ValueT >::type ScalarT
 Typename of scalar's (which may be different from ValueT) More...
 
typedef BaseFadT base_fad_type
 Fad type view is based on. More...
 

Public Member Functions

SACADO_INLINE_FUNCTION ~ViewFad ()
 Destructor. More...
 

Initialization methods

SACADO_INLINE_FUNCTION ViewFad (const StorageType &s)
 Constructor with supplied storage s. More...
 
SACADO_INLINE_FUNCTION ViewFad (ValueT *v, const int arg_size=0, const int arg_stride=0)
 View-specific constructor. More...
 
SACADO_INLINE_FUNCTION ViewFad (ValueT *dx_ptr, ValueT *val_ptr, const int arg_size=0, const int arg_stride=0)
 View-specific constructor. More...
 

Detailed Description

template<typename, unsigned, unsigned, typename>
class Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >

Forward-mode AD class using dynamic memory allocation and expression templates.

This is the user-level class for forward mode AD with dynamic memory allocation, and is appropriate for whenever the number of derivative components is not known at compile time. The user interface is provided by Sacado::FAD_NS::GeneralFad.

Definition at line 271 of file Sacado_Fad_DFad_tmpl.hpp.

Member Typedef Documentation

template<typename , unsigned , unsigned , typename >
typedef Fad::ViewStorage<ValueT,length,stride,BaseFadT> Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::StorageType

Base classes.

Definition at line 45 of file Sacado_Fad_ViewFad_tmpl.hpp.

template<typename , unsigned , unsigned , typename >
typedef GeneralFad<ValueT,StorageType> Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::GeneralFadType

Definition at line 46 of file Sacado_Fad_ViewFad_tmpl.hpp.

template<typename , unsigned , unsigned , typename >
typedef Expr<GeneralFadType> Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::ExprType

Definition at line 47 of file Sacado_Fad_ViewFad_tmpl.hpp.

template<typename , unsigned , unsigned , typename >
typedef ExprType::value_type Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::value_type

Typename of values.

Definition at line 50 of file Sacado_Fad_ViewFad_tmpl.hpp.

template<typename , unsigned , unsigned , typename >
typedef ExprType::scalar_type Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::scalar_type

Typename of scalar's (which may be different from value_type)

Definition at line 53 of file Sacado_Fad_ViewFad_tmpl.hpp.

template<typename , unsigned , unsigned , typename >
typedef ScalarType<ValueT>::type Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::ScalarT

Typename of scalar's (which may be different from ValueT)

Definition at line 56 of file Sacado_Fad_ViewFad_tmpl.hpp.

template<typename , unsigned , unsigned , typename >
typedef BaseFadT Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::base_fad_type

Fad type view is based on.

Definition at line 59 of file Sacado_Fad_ViewFad_tmpl.hpp.

Constructor & Destructor Documentation

template<typename , unsigned , unsigned , typename >
SACADO_INLINE_FUNCTION Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::ViewFad ( const StorageType s)
inline

Constructor with supplied storage s.

Definition at line 80 of file Sacado_Fad_ViewFad_tmpl.hpp.

template<typename , unsigned , unsigned , typename >
SACADO_INLINE_FUNCTION Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::ViewFad ( ValueT *  v,
const int  arg_size = 0,
const int  arg_stride = 0 
)
inline

View-specific constructor.

Definition at line 85 of file Sacado_Fad_ViewFad_tmpl.hpp.

template<typename , unsigned , unsigned , typename >
SACADO_INLINE_FUNCTION Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::ViewFad ( ValueT *  dx_ptr,
ValueT *  val_ptr,
const int  arg_size = 0,
const int  arg_stride = 0 
)
inline

View-specific constructor.

Definition at line 90 of file Sacado_Fad_ViewFad_tmpl.hpp.

template<typename , unsigned , unsigned , typename >
SACADO_INLINE_FUNCTION Sacado::FAD_NS::ViewFad< typename, unsigned, unsigned, typename >::~ViewFad ( )
inline

Destructor.

Definition at line 98 of file Sacado_Fad_ViewFad_tmpl.hpp.


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