Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > > Class Template Reference

A class for storing a contiguously allocated array of Fad objects where the values and derivative arrays for each Fad object are stored in contiguous memory. To preserve this structure, many vector operations aren't supported (like resizing). More...

#include <Sacado_Fad_Vector.hpp>

Public Types
typedef Sacado::Fad::DVFad < ValueType >	FadType
	Synonym for Fad type. More...

Public Member Functions
	Vector (OrdinalType vec_size, OrdinalType deriv_size, VectorDerivOrientation orient=Row)
	Constructor. More...
	Vector (const Vector &fv)
	Copy constructor. More...
	~Vector ()
	Destructor. More...
Vector &	operator= (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...
FadType &	operator[] (OrdinalType i)
	Array access. More...
const FadType &	operator[] (OrdinalType i) const
	Array access. More...
ValueType *	vals ()
	Pointer to values. More...
const ValueType *	vals () const
	Pointer to values. More...
ValueType *	dx ()
	Pointer to derivatives. More...
const ValueType *	dx () const
	Pointer to values. More...

Protected Attributes
OrdinalType	deriv_size_
	Size of derivative array. More...
VectorDerivOrientation	orient_
	Derivative array orientation. More...
OrdinalType	stride_
	Derivative array stride. More...
std::vector< FadType >	vec_
	Vector of Fad's. More...

Detailed Description

template<typename OrdinalType, typename ValueType>
class Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >

A class for storing a contiguously allocated array of Fad objects where the values and derivative arrays for each Fad object are stored in contiguous memory. To preserve this structure, many vector operations aren't supported (like resizing).

Definition at line 117 of file Sacado_Fad_Vector.hpp.

Member Typedef Documentation

template<typename OrdinalType , typename ValueType >

typedef Sacado::Fad::DVFad<ValueType> Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::FadType

Synonym for Fad type.

Definition at line 121 of file Sacado_Fad_Vector.hpp.

Constructor & Destructor Documentation

template<typename OrdinalType , typename ValueType >

Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::Vector	(	OrdinalType	vec_size,
		OrdinalType	deriv_size,
		VectorDerivOrientation	orient = Row
	)

Constructor.

Definition at line 36 of file Sacado_Fad_VectorImp.hpp.

template<typename OrdinalType , typename ValueType >

Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::Vector

(

const Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > > &

fv

)

Copy constructor.

template<typename OrdinalType , typename ValueType >

Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::~Vector

(

)

Destructor.

Definition at line 89 of file Sacado_Fad_VectorImp.hpp.

Member Function Documentation

template<typename OrdinalType , typename ValueType >

Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > > & Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::operator=

(

const Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > > &

fv

)

Assignment.

Definition at line 105 of file Sacado_Fad_VectorImp.hpp.

template<typename OrdinalType , typename ValueType >

OrdinalType Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::size ( ) const

inline

Vector size.

Definition at line 137 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >

OrdinalType Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::deriv_size ( ) const

inline

Derivative size.

Definition at line 140 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >

OrdinalType Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::deriv_stride ( ) const

inline

Derivative array stride.

Definition at line 143 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >

VectorDerivOrientation Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::deriv_orientation ( ) const

inline

Derivative array orientation.

Definition at line 146 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >

FadType& Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::operator[] ( OrdinalType  i )

inline

Array access.

Definition at line 149 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >

const FadType& Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::operator[] ( OrdinalType  i ) const

inline

Array access.

Definition at line 152 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >

ValueType * Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::vals

(

)

Pointer to values.

Definition at line 114 of file Sacado_Fad_VectorImp.hpp.

template<typename OrdinalType , typename ValueType >

const ValueType * Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::vals

(

)

const

Pointer to values.

Definition at line 124 of file Sacado_Fad_VectorImp.hpp.

template<typename OrdinalType , typename ValueType >

ValueType * Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::dx

(

)

Pointer to derivatives.

Definition at line 134 of file Sacado_Fad_VectorImp.hpp.

template<typename OrdinalType , typename ValueType >

const ValueType * Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::dx

(

)

const

Pointer to values.

Definition at line 144 of file Sacado_Fad_VectorImp.hpp.

Member Data Documentation

template<typename OrdinalType , typename ValueType >

OrdinalType Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::deriv_size_

protected

Size of derivative array.

Definition at line 169 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >

VectorDerivOrientation Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::orient_

protected

Derivative array orientation.

Definition at line 172 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >

OrdinalType Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::stride_

protected

Derivative array stride.

Definition at line 175 of file Sacado_Fad_Vector.hpp.

template<typename OrdinalType , typename ValueType >

std::vector<FadType> Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::vec_

protected

Vector of Fad's.

Definition at line 178 of file Sacado_Fad_Vector.hpp.

---

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

• Sacado_Fad_Vector.hpp
• Sacado_Fad_VectorImp.hpp