Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Teuchos_PolynomialTraits.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Teuchos: Common Tools Package
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef TEUCHOS_POLYNOMIAL_TRAITS_HPP
43#define TEUCHOS_POLYNOMIAL_TRAITS_HPP
44
45#include "Teuchos_RCP.hpp"
46
47namespace Teuchos {
48
50
57 template <typename Scalar>
59 public:
60
63
66
68 static inline Teuchos::RCP<coeff_type> clone(const coeff_type& c) {
69 return Teuchos::rcp(new coeff_type(c));
70 }
71
73 static inline void copy(const coeff_type& x, coeff_type* y) {
74 *y = x;
75 }
76
78 static inline void assign(coeff_type* y, const scalar_type& alpha) {
79 *y = alpha;
80 }
81
83 static inline void update(coeff_type* y, const coeff_type& x,
84 const scalar_type& beta) {
85 *y = x + beta*(*y);
86 }
87
88 }; // class PolynomialTraits
89
90} // end namespace Teuchos
91
92#endif // TEUCHOS_POLYNOMIAL_TRAITS_HPP
Reference-counted pointer class and non-member templated function implementations.
Traits class for polynomial coefficients in Teuchos::Polynomial.
Scalar coeff_type
Typename of coefficients.
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
Scalar scalar_type
Typename of scalars.
static void copy(const coeff_type &x, coeff_type *y)
Copy a coefficient.
static Teuchos::RCP< coeff_type > clone(const coeff_type &c)
Clone a coefficient.
Smart reference counting pointer class for automatic garbage collection.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Deprecated.