Sacado::PCE::Hermite< T > Class Template Reference

Hermite polynomial chaos expansion class. More...

#include <Sacado_PCE_Hermite.hpp>

Collaboration diagram for Sacado::PCE::Hermite< T >:

[legend]List of all members.

Public Types
typedef T	value_type
	Typename of values.
typedef Workspace< HermiteEBasis< T > >	ws_type
	Workspace type.
Public Member Functions
	Hermite ()
	Default constructor.
	Hermite (const T &x)
	Constructor with supplied value x.
	Hermite (unsigned int d, const T &x)
	Constructor with degree d and value x.
	Hermite (unsigned int d)
	Constructor with degree d.
	Hermite (const Hermite &x)
	Copy constructor.
	~Hermite ()
	Destructor.
void	resize (unsigned int d, bool keep_coeffs)
	Resize polynomial to degree d.
void	reserve (unsigned int d)
	Reserve space for a degree d polynomial.
void	copyForWrite ()
	Prepare polynomial for writing.
StandardPoly< T >	toStandardBasis () const
	Write coefficients in standard basis.
Assignment operators
Hermite< T > &	operator= (const T &val)
	Assignment operator with constant right-hand-side.
Hermite< T > &	operator= (const Hermite< T > &x)
	Assignment with Hermite right-hand-side.
Value accessor methods
const T &	val () const
	Returns value.
T &	val ()
	Returns value.
Hermite coefficient accessor methods
unsigned int	degree () const
	Returns degree of polynomial.
bool	hasFastAccess (unsigned int d) const
	Returns true if polynomial has degree >= d.
const T *	coeff () const
	Returns Hermite coefficient array.
T *	coeff ()
	Returns Hermite coefficient array.
T	coeff (unsigned int i) const
	Returns degree i term with bounds checking.
T &	fastAccessCoeff (unsigned int i)
	Returns degree i term without bounds checking.
T	fastAccessCoeff (unsigned int i) const
	Returns degree i term without bounds checking.
Unary operators
Hermite< T >	operator+ () const
	Unary-plus operator.
Hermite< T >	operator- () const
	Unary-minus operator.
Hermite< T > &	operator+= (const T &x)
	Addition-assignment operator with constant right-hand-side.
Hermite< T > &	operator-= (const T &x)
	Subtraction-assignment operator with constant right-hand-side.
Hermite< T > &	operator *= (const T &x)
	Multiplication-assignment operator with constant right-hand-side.
Hermite< T > &	operator/= (const T &x)
	Division-assignment operator with constant right-hand-side.
Hermite< T > &	operator+= (const Hermite< T > &x)
	Addition-assignment operator with Hermite right-hand-side.
Hermite< T > &	operator-= (const Hermite< T > &x)
	Subtraction-assignment operator with Hermite right-hand-side.
Hermite< T > &	operator *= (const Hermite< T > &x)
	Multiplication-assignment operator with Hermite right-hand-side.
Hermite< T > &	operator/= (const Hermite< T > &x)
	Division-assignment operator with Hermite right-hand-side.
Static Public Member Functions
static void	initWorkspace (unsigned int d)
	Initialize workspace.
Static Public Attributes
static ws_type	workspace
	Workspace.
Protected Member Functions
unsigned int	length () const
	Return length of array.
void	resizeCoeffs (unsigned int len)
	Resize coefficient array to new size.
Protected Attributes
Sacado::Handle< HermiteData >	th
Classes
struct	HermiteData

---

Detailed Description

template<typename T>
class Sacado::PCE::Hermite< T >

Hermite polynomial chaos expansion class.

Uses a handle and a "copy-on-write" strategy for efficient copying, but no expression templating.

---

Constructor & Destructor Documentation

template<typename T>

Sacado::PCE::Hermite< T >::Hermite

(

const T &

x

)

Constructor with supplied value x.

Sets the first coefficient to x

template<typename T>

Sacado::PCE::Hermite< T >::Hermite	(	unsigned int	d,
		const T &	x
	)

Constructor with degree d and value x.

Initializes first coeffienct to x and of a polynomial of degree d

template<typename T>

Sacado::PCE::Hermite< T >::Hermite

(

unsigned int

d

)

Constructor with degree d.

Initializes all components to zero

---

Member Function Documentation

template<typename T>

void Sacado::PCE::Hermite< T >::copyForWrite

(

)

[inline]

Prepare polynomial for writing.

This method prepares the polynomial for writing through coeff() and fastAccessCoeff() member functions. It ensures the handle for the Hermite coefficients is not shared among any other Hermite polynomial objects. If the handle is not shared it does nothing, so there is no cost in calling this method in this case. If the handle is shared and this method is not called, any changes to the coefficients by coeff() or fastAccessCoeff() may change other polynomial objects.

template<typename T>

void Sacado::PCE::Hermite< T >::initWorkspace

(

unsigned int

d

)

[static]

Initialize workspace.

Intializes static workspace data.

template<typename T>

void Sacado::PCE::Hermite< T >::reserve

(

unsigned int

d

)

Reserve space for a degree d polynomial.

Coefficients are preserved.

template<typename T>

void Sacado::PCE::Hermite< T >::resize	(	unsigned int	d,
		bool	keep_coeffs
	)

Resize polynomial to degree d.

Coefficients are preserved if keep_coeffs is true, otherwise all coefficients are reset to zero.

---

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

• Sacado_PCE_Hermite.hpp
• Sacado_PCE_HermiteImp.hpp

---