Sacado Package Browser (Single Doxygen Collection) Version of the Day
Classes | Public Types | Public Member Functions
Sacado::Tay::CacheTaylor< T > Class Template Reference

Forward-mode AD class using dynamic memory allocation. More...

#include <Sacado_Tay_CacheTaylor.hpp>

Inheritance diagram for Sacado::Tay::CacheTaylor< T >:
Inheritance graph
[legend]

List of all members.

Classes

struct  apply
 Turn CacheTaylor into a meta-function class usable with mpl::apply. More...

Public Types

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

 ~CacheTaylor ()
 Destructor.

Initialization methods

 CacheTaylor ()
 Default constructor.
 CacheTaylor (const T &x)
 Constructor with supplied value x.
 CacheTaylor (const typename dummy< value_type, scalar_type >::type &x)
 Constructor with supplied value x.
 CacheTaylor (unsigned int d, const T &x)
 Constructor with degree d and value x.
 CacheTaylor (const CacheTaylor &x)
 Copy constructor.
template<typename S >
 CacheTaylor (const Expr< S > &x)
 Copy constructor from any Expression object.

Assignment operators

CacheTaylor< T > & operator= (const T &v)
 Assignment operator with constant right-hand-side.
CacheTaylor< T > & operator= (const typename dummy< value_type, scalar_type >::type &val)
 Assignment operator with constant right-hand-side.
CacheTaylor< T > & operator= (const CacheTaylor< T > &x)
 Assignment with CacheTaylor right-hand-side.
template<typename S >
CacheTaylor< T > & operator= (const Expr< S > &x)
 Assignment operator with any expression right-hand-side.

Unary operators

Expr< UnaryExpr< CacheTaylor
< T >, UnaryPlusOp > > 
operator+ () const
 Unary-plus operator.
Expr< UnaryExpr< CacheTaylor
< T >, UnaryMinusOp > > 
operator- () const
 Unary-minus operator.
CacheTaylor< T > & operator+= (const T &x)
 Addition-assignment operator with constant right-hand-side.
CacheTaylor< T > & operator-= (const T &x)
 Subtraction-assignment operator with constant right-hand-side.
CacheTaylor< T > & operator*= (const T &x)
 Multiplication-assignment operator with constant right-hand-side.
CacheTaylor< T > & operator/= (const T &x)
 Division-assignment operator with constant right-hand-side.
template<typename S >
CacheTaylor< T > & operator+= (const S &x)
 Addition-assignment operator with Taylor right-hand-side.
template<typename S >
CacheTaylor< T > & operator-= (const S &x)
 Subtraction-assignment operator with Taylor right-hand-side.
template<typename S >
CacheTaylor< T > & operator*= (const S &x)
 Multiplication-assignment operator with Taylor right-hand-side.
template<typename S >
CacheTaylor< T > & operator/= (const S &x)
 Division-assignment operator with Taylor right-hand-side.

Detailed Description

template<typename T>
class Sacado::Tay::CacheTaylor< T >

Forward-mode AD class using dynamic memory allocation.

This class provides the user interface of the Taylor object. Class CacheTaylorImplementation provides the implementation.

Definition at line 219 of file Sacado_Tay_CacheTaylor.hpp.


Member Typedef Documentation

template<typename T>
typedef T Sacado::Tay::CacheTaylor< T >::value_type

Typename of values.

Reimplemented from Sacado::Tay::CacheTaylorImplementation< T >.

Definition at line 224 of file Sacado_Tay_CacheTaylor.hpp.

template<typename T>
typedef ScalarType<T>::type Sacado::Tay::CacheTaylor< T >::scalar_type

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

Definition at line 227 of file Sacado_Tay_CacheTaylor.hpp.


Constructor & Destructor Documentation

template<typename T>
Sacado::Tay::CacheTaylor< T >::CacheTaylor ( ) [inline]

Default constructor.

Definition at line 241 of file Sacado_Tay_CacheTaylor.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T >::CacheTaylor ( const T &  x) [inline]

Constructor with supplied value x.

Sets the first coefficient to x

Definition at line 247 of file Sacado_Tay_CacheTaylor.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T >::CacheTaylor ( const typename dummy< value_type, scalar_type >::type &  x) [inline]

Constructor with supplied value x.

Sets the first coefficient to x. Creates a dummy overload when ValueT and ScalarT are the same type.

Definition at line 254 of file Sacado_Tay_CacheTaylor.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T >::CacheTaylor ( unsigned 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 261 of file Sacado_Tay_CacheTaylor.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T >::CacheTaylor ( const CacheTaylor< T > &  x) [inline]

Copy constructor.

Definition at line 265 of file Sacado_Tay_CacheTaylor.hpp.

template<typename T >
template<typename S >
Sacado::Tay::CacheTaylor< T >::CacheTaylor ( const Expr< S > &  x) [inline]

Copy constructor from any Expression object.

Definition at line 34 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T >::~CacheTaylor ( ) [inline]

Destructor.

Definition at line 273 of file Sacado_Tay_CacheTaylor.hpp.


Member Function Documentation

template<typename T>
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator= ( const T &  v) [inline]

Assignment operator with constant right-hand-side.

Definition at line 55 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T>
CacheTaylor<T>& Sacado::Tay::CacheTaylor< T >::operator= ( const typename dummy< value_type, scalar_type >::type &  val) [inline]

Assignment operator with constant right-hand-side.

Creates a dummy overload when value_type and scalar_type are the same type.

Definition at line 289 of file Sacado_Tay_CacheTaylor.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator= ( const CacheTaylor< T > &  x) [inline]

Assignment with CacheTaylor right-hand-side.

Definition at line 67 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T >
template<typename S >
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator= ( const Expr< S > &  x) [inline]

Assignment operator with any expression right-hand-side.

Definition at line 79 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T>
Expr< UnaryExpr< CacheTaylor<T>, UnaryPlusOp > > Sacado::Tay::CacheTaylor< T >::operator+ ( ) const [inline]

Unary-plus operator.

Definition at line 308 of file Sacado_Tay_CacheTaylor.hpp.

template<typename T>
Expr< UnaryExpr< CacheTaylor<T>, UnaryMinusOp > > Sacado::Tay::CacheTaylor< T >::operator- ( ) const [inline]

Unary-minus operator.

Definition at line 315 of file Sacado_Tay_CacheTaylor.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator+= ( const T &  x) [inline]

Addition-assignment operator with constant right-hand-side.

Definition at line 110 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator-= ( const T &  x) [inline]

Subtraction-assignment operator with constant right-hand-side.

Definition at line 119 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator*= ( const T &  x) [inline]

Multiplication-assignment operator with constant right-hand-side.

Definition at line 128 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T>
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator/= ( const T &  x) [inline]

Division-assignment operator with constant right-hand-side.

Definition at line 137 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T >
template<typename S >
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator+= ( const S &  x) [inline]

Addition-assignment operator with Taylor right-hand-side.

Definition at line 147 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T >
template<typename S >
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator-= ( const S &  x) [inline]

Subtraction-assignment operator with Taylor right-hand-side.

Definition at line 173 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T >
template<typename S >
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator*= ( const S &  x) [inline]

Multiplication-assignment operator with Taylor right-hand-side.

Definition at line 199 of file Sacado_Tay_CacheTaylorImp.hpp.

template<typename T >
template<typename S >
Sacado::Tay::CacheTaylor< T > & Sacado::Tay::CacheTaylor< T >::operator/= ( const S &  x) [inline]

Division-assignment operator with Taylor right-hand-side.

Definition at line 249 of file Sacado_Tay_CacheTaylorImp.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines