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>

List of all members.

Public Types

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

Public Member Functions

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

Protected Attributes

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

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 55 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 59 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 62 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 70 of file Sacado_Fad_Vector.hpp.

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

Destructor.

Definition at line 73 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 76 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 83 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 86 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 89 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 92 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 95 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 98 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 103 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 106 of file Sacado_Fad_Vector.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:19:44 2011 for Sacado Package Browser (Single Doxygen Collection) by  doxygen 1.6.3