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, 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< ValueTypeFadType
 Synonym for Fad type.
 

Public Member Functions

 Vector (OrdinalType vec_size, OrdinalType deriv_size, 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.
 
ValueTypevals ()
 Pointer to values.
 
const ValueTypevals () const
 Pointer to values.
 
ValueTypedx ()
 Pointer to derivatives.
 
const ValueTypedx () 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< FadTypevec_
 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

Synonym for Fad type.

Definition at line 121 of file Sacado_Fad_Vector.hpp.

Constructor & Destructor Documentation

◆ Vector() [1/2]

Constructor.

Definition at line 35 of file Sacado_Fad_VectorImp.hpp.

◆ Vector() [2/2]

Copy constructor.

◆ ~Vector()

Destructor.

Definition at line 88 of file Sacado_Fad_VectorImp.hpp.

Member Function Documentation

◆ operator=()

Assignment.

Definition at line 104 of file Sacado_Fad_VectorImp.hpp.

◆ size()

Vector size.

Definition at line 137 of file Sacado_Fad_Vector.hpp.

◆ deriv_size()

Derivative size.

Definition at line 140 of file Sacado_Fad_Vector.hpp.

◆ deriv_stride()

Derivative array stride.

Definition at line 143 of file Sacado_Fad_Vector.hpp.

◆ deriv_orientation()

Derivative array orientation.

Definition at line 146 of file Sacado_Fad_Vector.hpp.

◆ operator[]() [1/2]

Array access.

Definition at line 149 of file Sacado_Fad_Vector.hpp.

◆ operator[]() [2/2]

Array access.

Definition at line 152 of file Sacado_Fad_Vector.hpp.

◆ vals() [1/2]

Pointer to values.

Definition at line 113 of file Sacado_Fad_VectorImp.hpp.

◆ vals() [2/2]

Pointer to values.

Definition at line 123 of file Sacado_Fad_VectorImp.hpp.

◆ dx() [1/2]

Pointer to derivatives.

Definition at line 133 of file Sacado_Fad_VectorImp.hpp.

◆ dx() [2/2]

Pointer to values.

Definition at line 143 of file Sacado_Fad_VectorImp.hpp.

Member Data Documentation

◆ deriv_size_

Size of derivative array.

Definition at line 169 of file Sacado_Fad_Vector.hpp.

◆ orient_

Derivative array orientation.

Definition at line 172 of file Sacado_Fad_Vector.hpp.

◆ stride_

Derivative array stride.

Definition at line 175 of file Sacado_Fad_Vector.hpp.

◆ vec_

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: