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>

Inheritance diagram for Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >:

Collaboration diagram for Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >:

Public Types
typedef Sacado::Fad::DVFad< ValueType >	FadType
	Synonym for Fad type.
typedef Sacado::ValueType< Sacado::Fad::DVFad< ValueType > >::type	ValueType
	Typename of values.

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

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

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).

Constructor & Destructor Documentation

Vector() [1/2]

template<typename OrdinalType, typename ValueType>

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

Constructor.

References deriv_size_, Sacado::ds_array< T, isScalar >::get_and_fill(), orient_, stride_, and vec_.

Referenced by Vector().

Vector() [2/2]

template<typename OrdinalType, typename ValueType>

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

(

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

fv

)

Copy constructor.

References operator=(), and Vector().

~Vector()

template<typename OrdinalType, typename ValueType>

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

(

)

Destructor.

References deriv_size_, Sacado::ds_array< T, isScalar >::destroy_and_release(), dx(), vals(), and vec_.

Member Function Documentation

deriv_orientation()

template<typename OrdinalType, typename ValueType>

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

inline

Derivative array orientation.

References orient_.

deriv_size()

template<typename OrdinalType, typename ValueType>

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

inline

Derivative size.

References deriv_size_.

deriv_stride()

template<typename OrdinalType, typename ValueType>

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

inline

Derivative array stride.

References stride_.

dx() [1/2]

template<typename OrdinalType, typename ValueType>

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

(

)

Pointer to derivatives.

References deriv_size_, and vec_.

Referenced by ~Vector().

dx() [2/2]

template<typename OrdinalType, typename ValueType>

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

(

)

const

Pointer to values.

References deriv_size_, and vec_.

operator=()

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.

References vec_.

Referenced by Vector().

operator[]() [1/2]

template<typename OrdinalType, typename ValueType>

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

inline

Array access.

References vec_.

operator[]() [2/2]

template<typename OrdinalType, typename ValueType>

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

inline

Array access.

References vec_.

size()

template<typename OrdinalType, typename ValueType>

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

inline

Vector size.

References vec_.

vals() [1/2]

template<typename OrdinalType, typename ValueType>

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

(

)

Pointer to values.

References vec_.

Referenced by ~Vector().

vals() [2/2]

template<typename OrdinalType, typename ValueType>

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

(

)

const

Pointer to values.

References vec_.

Member Data Documentation

deriv_size_

template<typename OrdinalType, typename ValueType>

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

protected

Size of derivative array.

Referenced by deriv_size(), dx(), dx(), Vector(), and ~Vector().

orient_

template<typename OrdinalType, typename ValueType>

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

protected

Derivative array orientation.

Referenced by deriv_orientation(), and Vector().

stride_

template<typename OrdinalType, typename ValueType>

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

protected

Derivative array stride.

Referenced by deriv_stride(), and Vector().

vec_

template<typename OrdinalType, typename ValueType>

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

protected

Vector of Fad's.

Referenced by dx(), dx(), operator=(), operator[](), operator[](), size(), vals(), vals(), Vector(), and ~Vector().

---

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

• Sacado_Fad_Vector.hpp
• Sacado_Fad_VectorImp.hpp