Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Static Public Member Functions | List of all members
Teuchos::PolynomialTraits< Scalar > Class Template Reference

Traits class for polynomial coefficients in Teuchos::Polynomial. More...

#include <Teuchos_PolynomialTraits.hpp>

Public Types

typedef Scalar coeff_type
 Typename of coefficients. More...
 
typedef Scalar scalar_type
 Typename of scalars. More...
 

Static Public Member Functions

static Teuchos::RCP< coeff_typeclone (const coeff_type &c)
 Clone a coefficient. More...
 
static void copy (const coeff_type &x, coeff_type *y)
 Copy a coefficient. More...
 
static void assign (coeff_type *y, const scalar_type &alpha)
 Assign a scalar to a coefficient. More...
 
static void update (coeff_type *y, const coeff_type &x, const scalar_type &beta)
 y = x + beta*y More...
 

Detailed Description

template<typename Scalar>
class Teuchos::PolynomialTraits< Scalar >

Traits class for polynomial coefficients in Teuchos::Polynomial.

This class provides traits for implementing Teuchos::Polynomial. The default template definition here will work for any scalar type. Any other coefficient type for Teuchos::Polynomial should provide a specialization of this traits class for that type that mirrors the default definition below.

Definition at line 26 of file Teuchos_PolynomialTraits.hpp.

Member Typedef Documentation

template<typename Scalar>
typedef Scalar Teuchos::PolynomialTraits< Scalar >::coeff_type

Typename of coefficients.

Definition at line 30 of file Teuchos_PolynomialTraits.hpp.

template<typename Scalar>
typedef Scalar Teuchos::PolynomialTraits< Scalar >::scalar_type

Typename of scalars.

Definition at line 33 of file Teuchos_PolynomialTraits.hpp.

Member Function Documentation

template<typename Scalar>
static Teuchos::RCP<coeff_type> Teuchos::PolynomialTraits< Scalar >::clone ( const coeff_type c)
inlinestatic

Clone a coefficient.

Definition at line 36 of file Teuchos_PolynomialTraits.hpp.

template<typename Scalar>
static void Teuchos::PolynomialTraits< Scalar >::copy ( const coeff_type x,
coeff_type y 
)
inlinestatic

Copy a coefficient.

Definition at line 41 of file Teuchos_PolynomialTraits.hpp.

template<typename Scalar>
static void Teuchos::PolynomialTraits< Scalar >::assign ( coeff_type y,
const scalar_type alpha 
)
inlinestatic

Assign a scalar to a coefficient.

Definition at line 46 of file Teuchos_PolynomialTraits.hpp.

template<typename Scalar>
static void Teuchos::PolynomialTraits< Scalar >::update ( coeff_type y,
const coeff_type x,
const scalar_type beta 
)
inlinestatic

y = x + beta*y

Definition at line 51 of file Teuchos_PolynomialTraits.hpp.


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