Sacado Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
Sacado::Fad::Vector< OrdinalType, FadType > Class Template Reference

A class for storing a contiguously allocated array of Fad objects. This is a general definition that will work for all Fad types, and is merely a wrapper around std::vector. A specialization for Sacado::Fad::DVFad providing contiguous allocation of values and derivatives is below. More...

#include <Sacado_Fad_Vector.hpp>

Public Types

typedef Sacado::ValueType
< FadType >::type 
ValueType
 Typename of values. More...
 

Public Member Functions

 Vector (OrdinalType vec_size, OrdinalType deriv_sz, VectorDerivOrientation orient=Row)
 Constructor. More...
 
 Vector (const Vector &fv)
 Copy constructor. More...
 
 ~Vector ()
 Destructor. More...
 
Vectoroperator= (const Vector &fv)
 Assignment. More...
 
OrdinalType size () const
 Vector size. More...
 
OrdinalType deriv_size () const
 Derivative size. More...
 
OrdinalType deriv_stride () const
 Derivative array stride. More...
 
VectorDerivOrientation deriv_orientation () const
 Derivative array orientation. More...
 
FadTypeoperator[] (OrdinalType i)
 Array access. More...
 
const FadTypeoperator[] (OrdinalType i) const
 Array access. More...
 

Protected Attributes

OrdinalType deriv_size_
 Size of derivative array. More...
 
std::vector< FadTypevec_
 Vector of Fad's. More...
 

Detailed Description

template<typename OrdinalType, typename FadType>
class Sacado::Fad::Vector< OrdinalType, FadType >

A class for storing a contiguously allocated array of Fad objects. This is a general definition that will work for all Fad types, and is merely a wrapper around std::vector. A specialization for Sacado::Fad::DVFad providing contiguous allocation of values and derivatives is below.

Definition at line 33 of file Sacado_Fad_Vector.hpp.

Member Typedef Documentation

template<typename OrdinalType, typename FadType>
typedef Sacado::ValueType<FadType>::type Sacado::Fad::Vector< OrdinalType, FadType >::ValueType

Typename of values.

Definition at line 37 of file Sacado_Fad_Vector.hpp.

Constructor & Destructor Documentation

template<typename OrdinalType, typename FadType>
Sacado::Fad::Vector< OrdinalType, FadType >::Vector ( OrdinalType  vec_size,
OrdinalType  deriv_sz,
VectorDerivOrientation  orient = Row 
)
inline

Constructor.

Definition at line 40 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType, typename FadType>
Sacado::Fad::Vector< OrdinalType, FadType >::Vector ( const Vector< OrdinalType, FadType > &  fv)
inline

Copy constructor.

Definition at line 48 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >
Sacado::Fad::Vector< OrdinalType, ValueType >::~Vector ( )
inline

Destructor.

Definition at line 51 of file Sacado_Fad_Vector.hpp.

Member Function Documentation

template<typename OrdinalType, typename FadType>
Vector& Sacado::Fad::Vector< OrdinalType, FadType >::operator= ( const Vector< OrdinalType, FadType > &  fv)
inline

Assignment.

Definition at line 54 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType, typename FadType>
OrdinalType Sacado::Fad::Vector< OrdinalType, FadType >::size ( ) const
inline

Vector size.

Definition at line 61 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType, typename FadType>
OrdinalType Sacado::Fad::Vector< OrdinalType, FadType >::deriv_size ( ) const
inline

Derivative size.

Definition at line 64 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType, typename FadType>
OrdinalType Sacado::Fad::Vector< OrdinalType, FadType >::deriv_stride ( ) const
inline

Derivative array stride.

Definition at line 67 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType, typename FadType>
VectorDerivOrientation Sacado::Fad::Vector< OrdinalType, FadType >::deriv_orientation ( ) const
inline

Derivative array orientation.

Definition at line 70 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType, typename FadType>
FadType& Sacado::Fad::Vector< OrdinalType, FadType >::operator[] ( OrdinalType  i)
inline

Array access.

Definition at line 73 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType, typename FadType>
const FadType& Sacado::Fad::Vector< OrdinalType, FadType >::operator[] ( OrdinalType  i) const
inline

Array access.

Definition at line 76 of file Sacado_Fad_Vector.hpp.

Member Data Documentation

template<typename OrdinalType, typename FadType>
OrdinalType Sacado::Fad::Vector< OrdinalType, FadType >::deriv_size_
protected

Size of derivative array.

Definition at line 81 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType, typename FadType>
std::vector<FadType> Sacado::Fad::Vector< OrdinalType, FadType >::vec_
protected

Vector of Fad's.

Definition at line 84 of file Sacado_Fad_Vector.hpp.


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