Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
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.
 
typedef Scalar scalar_type
 Typename of scalars.
 

Static Public Member Functions

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

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 58 of file Teuchos_PolynomialTraits.hpp.

Member Typedef Documentation

◆ coeff_type

Typename of coefficients.

Definition at line 62 of file Teuchos_PolynomialTraits.hpp.

◆ scalar_type

Typename of scalars.

Definition at line 65 of file Teuchos_PolynomialTraits.hpp.

Member Function Documentation

◆ clone()

Clone a coefficient.

Definition at line 68 of file Teuchos_PolynomialTraits.hpp.

◆ copy()

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

Copy a coefficient.

Definition at line 73 of file Teuchos_PolynomialTraits.hpp.

◆ assign()

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 78 of file Teuchos_PolynomialTraits.hpp.

◆ update()

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 83 of file Teuchos_PolynomialTraits.hpp.


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