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 > >:

[legend]

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.

	Vector (OrdinalType vec_size, OrdinalType deriv_sz, 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.

Sacado::Fad::DVFad< ValueType > &	operator[] (OrdinalType i)
	Array access.

const Sacado::Fad::DVFad< ValueType > &	operator[] (OrdinalType i) const
	Array access.

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.

OrdinalType	deriv_size_
	Size of derivative array.

std::vector< Sacado::Fad::DVFad< ValueType > >	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).

Definition at line 117 of file Sacado_Fad_Vector.hpp.

Member Typedef Documentation

◆ FadType

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.

◆ ValueType

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

Typename of values.

Definition at line 59 of file Sacado_Fad_Vector.hpp.

Constructor & Destructor Documentation

◆ Vector() [1/4]

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 35 of file Sacado_Fad_VectorImp.hpp.

◆ Vector() [2/4]

template<typename OrdinalType, typename ValueType>

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

Copy constructor.

◆ ~Vector() [1/2]

template<typename OrdinalType, typename ValueType>

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

Destructor.

Definition at line 88 of file Sacado_Fad_VectorImp.hpp.

◆ Vector() [3/4]

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

inline

Constructor.

Definition at line 62 of file Sacado_Fad_Vector.hpp.

◆ Vector() [4/4]

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

inline

Copy constructor.

Definition at line 70 of file Sacado_Fad_Vector.hpp.

◆ ~Vector() [2/2]

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

inline

Destructor.

Definition at line 73 of file Sacado_Fad_Vector.hpp.

Member Function Documentation

◆ operator=() [1/2]

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 104 of file Sacado_Fad_VectorImp.hpp.

◆ size() [1/2]

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.

◆ deriv_size() [1/2]

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.

◆ deriv_stride() [1/2]

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.

◆ deriv_orientation() [1/2]

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.

◆ operator[]() [1/4]

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.

◆ operator[]() [2/4]

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.

◆ vals() [1/2]

template<typename OrdinalType, typename ValueType>

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

Pointer to values.

Definition at line 113 of file Sacado_Fad_VectorImp.hpp.

◆ vals() [2/2]

template<typename OrdinalType, typename ValueType>

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

Pointer to values.

Definition at line 123 of file Sacado_Fad_VectorImp.hpp.

◆ dx() [1/2]

template<typename OrdinalType, typename ValueType>

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

Pointer to derivatives.

Definition at line 133 of file Sacado_Fad_VectorImp.hpp.

◆ dx() [2/2]

template<typename OrdinalType, typename ValueType>

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

Pointer to values.

Definition at line 143 of file Sacado_Fad_VectorImp.hpp.

◆ operator=() [2/2]

Vector & Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::operator= ( const Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > > & fv )

inline

Assignment.

Definition at line 76 of file Sacado_Fad_Vector.hpp.

◆ size() [2/2]

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

inline

Vector size.

Definition at line 83 of file Sacado_Fad_Vector.hpp.

◆ deriv_size() [2/2]

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

inline

Derivative size.

Definition at line 86 of file Sacado_Fad_Vector.hpp.

◆ deriv_stride() [2/2]

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

inline

Derivative array stride.

Definition at line 89 of file Sacado_Fad_Vector.hpp.

◆ deriv_orientation() [2/2]

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

inline

Derivative array orientation.

Definition at line 92 of file Sacado_Fad_Vector.hpp.

◆ operator[]() [3/4]

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

inline

Array access.

Definition at line 95 of file Sacado_Fad_Vector.hpp.

◆ operator[]() [4/4]

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

inline

Array access.

Definition at line 98 of file Sacado_Fad_Vector.hpp.

Member Data Documentation

◆ deriv_size_ [1/2]

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.

◆ orient_

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.

◆ stride_

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.

◆ vec_ [1/2]

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.

◆ deriv_size_ [2/2]

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

protected

Size of derivative array.

Definition at line 103 of file Sacado_Fad_Vector.hpp.

◆ vec_ [2/2]

std::vector<Sacado::Fad::DVFad< ValueType >> Sacado::Fad::Vector< OrdinalType, Sacado::Fad::DVFad< ValueType > >::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 files:

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ FadType

◆ ValueType

Constructor & Destructor Documentation

◆ Vector() [1/4]

◆ Vector() [2/4]

◆ ~Vector() [1/2]

◆ Vector() [3/4]

◆ Vector() [4/4]

◆ ~Vector() [2/2]

Member Function Documentation

◆ operator=() [1/2]

◆ size() [1/2]

◆ deriv_size() [1/2]

◆ deriv_stride() [1/2]

◆ deriv_orientation() [1/2]

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ vals() [1/2]

◆ vals() [2/2]

◆ dx() [1/2]

◆ dx() [2/2]

◆ operator=() [2/2]

◆ size() [2/2]

◆ deriv_size() [2/2]

◆ deriv_stride() [2/2]

◆ deriv_orientation() [2/2]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

Member Data Documentation

◆ deriv_size_ [1/2]

◆ orient_

◆ stride_

◆ vec_ [1/2]

◆ deriv_size_ [2/2]

◆ vec_ [2/2]