Sacado Package Browser (Single Doxygen Collection): Sacado::Tay::Expr< CacheTaylorImplementation< T > > Class Template Reference

Sacado Package Browser (Single Doxygen Collection) Version of the Day

Loading...

Searching...

No Matches

CacheTaylor expression template specialization. More...

#include <Sacado_Tay_CacheTaylor.hpp>

Inheritance diagram for Sacado::Tay::Expr< CacheTaylorImplementation< T > >:

Inheritance graph

Public Types
typedef CacheTaylor< T >	base_expr_type
	Typename of base-expressions.

typedef CacheTaylorImplementation< T >::value_type	value_type
	Typename of values.

typedef CacheTaylorImplementation< T >::scalar_type	scalar_type
	Typename of scalar's (which may be different from value_type)

typedef CacheTaylorImplementation< T >::base_expr_type	base_expr_type
	Typename of base-expressions.

Public Types inherited from Sacado::Tay::CacheTaylorImplementation< T >
typedef T	value_type
	Typename of values.

typedef ScalarType< T >::type	scalar_type
	Typename of scalar's (which may be different from ValueT)

Public Member Functions
	Expr ()
	Default constructor.

	Expr (const T &x)
	Constructor with supplied value `x`.

	Expr (int d, const T &x)
	Constructor with degree d and value `x`.

	Expr (const Expr &x)
	Copy constructor.

	Expr (const CacheTaylorImplementation< T > &expr)
	Constructor with given expression `expr`.

void	allocateCache (unsigned int d) const
	Allocate coefficient cache.

unsigned int	degree () const
	Return degree of polynomial.

bool	hasFastAccess (unsigned int d) const
	Return if expression has fast access.

value_type	coeff (unsigned int i) const
	Return degree `i` term of expression.

value_type	fastAccessCoeff (unsigned int i) const
	Return degree `i` term of expression.

Public Member Functions inherited from Sacado::Tay::CacheTaylorImplementation< T >
	CacheTaylorImplementation ()
	Default constructor.

	CacheTaylorImplementation (const T &x)
	Constructor with supplied value `x`.

	CacheTaylorImplementation (int d, const T &x)
	Constructor with degree d and value `x`.

	CacheTaylorImplementation (const CacheTaylorImplementation &x)
	Copy constructor.

	~CacheTaylorImplementation ()
	Destructor.

void	resize (int d, bool keep_coeffs)
	Resize polynomial to degree d.

int	degree () const
	Returns degree of polynomial.

bool	hasFastAccess (int d) const
	Returns true if polynomial has degree >= d.

const std::valarray< T > &	coeff () const
	Returns Taylor coefficient array.

const T	coeff (int i) const
	Returns degree `i` term with bounds checking.

T	coeff (int i)
	Returns degree `i` term with bounds checking.

T &	fastAccessCoeff (int i)
	Returns degree `i` term without bounds checking.

const T &	fastAccessCoeff (int i) const
	Returns degree `i` term without bounds checking.

void	allocateCache (int d) const
	Allocate coefficient cache.

template<typename S>
bool	isEqualTo (const Expr< S > &x) const
	Returns whether two Taylor objects have the same values.

const T &	val () const
	Returns value.

T &	val ()
	Returns value.

Protected Member Functions
	Expr ()
	Disallow default constructor.

void	resizeCoeffs (int dnew)
	Resize coefficient array to new size.

int	coeff_size () const

Protected Attributes
CacheTaylorImplementation< T >	expr_
	Expression.

std::valarray< T >	coeff_
	Taylor polynomial coefficients.

Detailed Description

template<typename T>
class Sacado::Tay::Expr< CacheTaylorImplementation< T > >

CacheTaylor expression template specialization.

This template class represents a simple CacheTaylor expression.

Definition at line 194 of file Sacado_Tay_CacheTaylor.hpp.

Member Typedef Documentation

◆ base_expr_type [1/2]

template<typename T>

typedef CacheTaylor<T> Sacado::Tay::Expr< CacheTaylorImplementation< T > >::base_expr_type

Typename of base-expressions.

Definition at line 200 of file Sacado_Tay_CacheTaylor.hpp.

◆ value_type

typedef CacheTaylorImplementation< T >::value_type Sacado::Tay::Expr< CacheTaylorImplementation< T > >::value_type

Typename of values.

Definition at line 50 of file Sacado_Tay_CacheTaylorExpr.hpp.

◆ scalar_type

typedef CacheTaylorImplementation< T >::scalar_type Sacado::Tay::Expr< CacheTaylorImplementation< T > >::scalar_type

Typename of scalar's (which may be different from value_type)

Definition at line 53 of file Sacado_Tay_CacheTaylorExpr.hpp.

◆ base_expr_type [2/2]

typedef CacheTaylorImplementation< T >::base_expr_type Sacado::Tay::Expr< CacheTaylorImplementation< T > >::base_expr_type

Typename of base-expressions.

Definition at line 56 of file Sacado_Tay_CacheTaylorExpr.hpp.

Constructor & Destructor Documentation

◆ Expr() [1/6]

template<typename T>

Sacado::Tay::Expr< CacheTaylorImplementation< T > >::Expr ( )

inline

Default constructor.

Definition at line 203 of file Sacado_Tay_CacheTaylor.hpp.

◆ Expr() [2/6]

template<typename T>

Sacado::Tay::Expr< CacheTaylorImplementation< T > >::Expr ( const T & x )

inline

Constructor with supplied value x.

Sets the first coefficient to x

Definition at line 209 of file Sacado_Tay_CacheTaylor.hpp.

◆ Expr() [3/6]

template<typename T>

Sacado::Tay::Expr< CacheTaylorImplementation< T > >::Expr	(	int	d,
		const T &	x )

inline

Constructor with degree d and value x.

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

Definition at line 215 of file Sacado_Tay_CacheTaylor.hpp.

◆ Expr() [4/6]

template<typename T>

Sacado::Tay::Expr< CacheTaylorImplementation< T > >::Expr ( const Expr< CacheTaylorImplementation< T > > & x )

inline

Copy constructor.

Definition at line 218 of file Sacado_Tay_CacheTaylor.hpp.

◆ Expr() [5/6]

Sacado::Tay::Expr< CacheTaylorImplementation< T > >::Expr ( const CacheTaylorImplementation< T > & expr )

inlineexplicit

Constructor with given expression expr.

Definition at line 59 of file Sacado_Tay_CacheTaylorExpr.hpp.

◆ Expr() [6/6]

Sacado::Tay::Expr< CacheTaylorImplementation< T > >::Expr ( )

inlineprotected

Disallow default constructor.

Definition at line 81 of file Sacado_Tay_CacheTaylorExpr.hpp.

Member Function Documentation

◆ allocateCache()

void Sacado::Tay::Expr< CacheTaylorImplementation< T > >::allocateCache ( unsigned int d ) const

inline

Allocate coefficient cache.

Definition at line 62 of file Sacado_Tay_CacheTaylorExpr.hpp.

◆ degree()

unsigned int Sacado::Tay::Expr< CacheTaylorImplementation< T > >::degree ( ) const

inline

Return degree of polynomial.

Definition at line 65 of file Sacado_Tay_CacheTaylorExpr.hpp.

◆ hasFastAccess()

bool Sacado::Tay::Expr< CacheTaylorImplementation< T > >::hasFastAccess ( unsigned int d ) const

inline

Return if expression has fast access.

Definition at line 68 of file Sacado_Tay_CacheTaylorExpr.hpp.

◆ coeff()

value_type Sacado::Tay::Expr< CacheTaylorImplementation< T > >::coeff ( unsigned int i ) const

inline

Return degree i term of expression.

Definition at line 72 of file Sacado_Tay_CacheTaylorExpr.hpp.

◆ fastAccessCoeff()

value_type Sacado::Tay::Expr< CacheTaylorImplementation< T > >::fastAccessCoeff ( unsigned int i ) const

inline

Return degree i term of expression.

Definition at line 75 of file Sacado_Tay_CacheTaylorExpr.hpp.

Member Data Documentation

◆ expr_

CacheTaylorImplementation< T > Sacado::Tay::Expr< CacheTaylorImplementation< T > >::expr_

protected

Expression.

Definition at line 84 of file Sacado_Tay_CacheTaylorExpr.hpp.

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

Sacado_Tay_CacheTaylor.hpp