Sacado Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
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.
 

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

◆ ValueType

Typename of values.

Definition at line 59 of file Sacado_Fad_Vector.hpp.

Constructor & Destructor Documentation

◆ Vector() [1/2]

Constructor.

Definition at line 62 of file Sacado_Fad_Vector.hpp.

◆ Vector() [2/2]

Copy constructor.

Definition at line 70 of file Sacado_Fad_Vector.hpp.

◆ ~Vector()

Destructor.

Definition at line 73 of file Sacado_Fad_Vector.hpp.

Member Function Documentation

◆ operator=()

Assignment.

Definition at line 76 of file Sacado_Fad_Vector.hpp.

◆ size()

Vector size.

Definition at line 83 of file Sacado_Fad_Vector.hpp.

◆ deriv_size()

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

Derivative size.

Definition at line 86 of file Sacado_Fad_Vector.hpp.

◆ deriv_stride()

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

Derivative array stride.

Definition at line 89 of file Sacado_Fad_Vector.hpp.

◆ deriv_orientation()

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

Derivative array orientation.

Definition at line 92 of file Sacado_Fad_Vector.hpp.

◆ operator[]() [1/2]

Array access.

Definition at line 95 of file Sacado_Fad_Vector.hpp.

◆ operator[]() [2/2]

Array access.

Definition at line 98 of file Sacado_Fad_Vector.hpp.

Member Data Documentation

◆ deriv_size_

Size of derivative array.

Definition at line 103 of file Sacado_Fad_Vector.hpp.

◆ vec_

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: