Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_OrthogPolyApprox.hpp
Go to the documentation of this file.
1// $Id$
2// $Source$
3// @HEADER
4// ***********************************************************************
5//
6// Stokhos Package
7// Copyright (2009) Sandia Corporation
8//
9// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
10// license for use of this work by or on behalf of the U.S. Government.
11//
12// Redistribution and use in source and binary forms, with or without
13// modification, are permitted provided that the following conditions are
14// met:
15//
16// 1. Redistributions of source code must retain the above copyright
17// notice, this list of conditions and the following disclaimer.
18//
19// 2. Redistributions in binary form must reproduce the above copyright
20// notice, this list of conditions and the following disclaimer in the
21// documentation and/or other materials provided with the distribution.
22//
23// 3. Neither the name of the Corporation nor the names of the
24// contributors may be used to endorse or promote products derived from
25// this software without specific prior written permission.
26//
27// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38//
39// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
40//
41// ***********************************************************************
42// @HEADER
43
44#ifndef STOKHOS_ORTHOGPOLYAPPROX_HPP
45#define STOKHOS_ORTHOGPOLYAPPROX_HPP
46
47#include "Teuchos_RCP.hpp" // class data member
48#include "Stokhos_OrthogPolyBasis.hpp" // class data member
49#include <ostream> // for std::ostream
50
53
54namespace Stokhos {
55
60 template <typename ordinal_type, typename value_type,
62 value_type> >
64 public:
65
70
72
79 const Teuchos::RCP<const Stokhos::OrthogPolyBasis<ordinal_type, value_type> >& basis = Teuchos::null,
80 ordinal_type sz = 0,
81 const value_type* vals = NULL);
82
85
88
91
93 OrthogPolyApprox& operator=(const value_type& v);
94
96 void init(const value_type& v);
97
99 void init(const value_type* v);
100
102 template <typename S>
104 coeff_.init(v.coeff());
105 }
106
108 void load(value_type* v);
109
111 template <typename S>
113 coeff_.load(v.coeff());
114 }
115
117 Teuchos::RCP<const Stokhos::OrthogPolyBasis<ordinal_type, value_type> >
118 basis() const;
119
121
124 void reset(const Teuchos::RCP<const Stokhos::OrthogPolyBasis<ordinal_type, value_type> >& new_basis, ordinal_type sz = 0);
125
127 void resize(ordinal_type sz);
128
130 ordinal_type size() const;
131
133 pointer coeff();
134
136 const_pointer coeff() const;
137
139 reference operator[](ordinal_type i);
140
142 const_reference operator[](ordinal_type i) const;
143
145 reference term(ordinal_type dimension, ordinal_type order);
146
148 const_reference term(ordinal_type dimension, ordinal_type order) const;
149
151 const MultiIndex<ordinal_type>& order(ordinal_type term) const;
152
154 value_type evaluate(const Teuchos::Array<value_type>& point) const;
155
157 value_type evaluate(const Teuchos::Array<value_type>& point,
158 const Teuchos::Array<value_type>& basis_vals) const;
159
161 value_type mean() const;
162
164 value_type standard_deviation() const;
165
167 value_type two_norm() const;
168
170 value_type two_norm_squared() const;
171
173 value_type inner_product(const OrthogPolyApprox& b) const;
174
176 std::ostream& print(std::ostream& os) const;
177
178 protected:
179
181 Teuchos::RCP<const Stokhos::OrthogPolyBasis<ordinal_type, value_type> > basis_;
182
185
186 }; // class OrthogPolyApprox
187
189 template <typename ordinal_type, typename value_type, typename node_type>
190 std::ostream&
191 operator << (std::ostream& os,
193
194} // namespace Stokhos
195
197
198#endif // STOKHOS_ORTHOGPOLYAPPROX_HPP
A multidimensional index.
Class to store coefficients of a projection onto an orthogonal polynomial basis.
storage_type::reference reference
void reset(const Teuchos::RCP< const Stokhos::OrthogPolyBasis< ordinal_type, value_type > > &new_basis, ordinal_type sz=0)
Reset to a new basis.
value_type inner_product(const OrthogPolyApprox &b) const
Compute the L2 inner product of 2 PCEs.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< ordinal_type, value_type > > basis_
Basis expansion is relative to.
value_type mean() const
Compute mean of expansion.
storage_type::const_reference const_reference
std::ostream & print(std::ostream &os) const
Print approximation in basis.
void init(const value_type &v)
Initialize coefficients to value.
value_type two_norm() const
Compute the two-norm of expansion.
OrthogPolyApprox & operator=(const OrthogPolyApprox &x)
Assignment operator (deep copy)
value_type standard_deviation() const
Compute standard deviation of expansion.
storage_type coeff_
OrthogPolyApprox coefficients.
void resize(ordinal_type sz)
Resize coefficient array (coefficients are preserved)
void load(OrthogPolyApprox< ordinal_type, value_type, S > &v)
Load coefficients into an OrthogPolyApprox with different storage.
const MultiIndex< ordinal_type > & order(ordinal_type term) const
Get orders for a given term.
void load(value_type *v)
Load coefficients to an array of values.
reference operator[](ordinal_type i)
Array access.
pointer coeff()
Return coefficient array.
void init(const OrthogPolyApprox< ordinal_type, value_type, S > &v)
Initialize coefficients from an OrthogPolyApprox with different storage.
value_type two_norm_squared() const
Compute the squared two-norm of expansion.
storage_type::const_pointer const_pointer
reference term(ordinal_type dimension, ordinal_type order)
Get coefficient term for given dimension and order.
ordinal_type size() const
Return size.
value_type evaluate(const Teuchos::Array< value_type > &point) const
Evaluate polynomial approximation at a point.
Teuchos::RCP< const Stokhos::OrthogPolyBasis< ordinal_type, value_type > > basis() const
Return basis.
OrthogPolyApprox(const OrthogPolyApprox &x)
Copy constructor.
Abstract base class for multivariate orthogonal polynomials.
void load(pointer v)
Load values to an array of values.
void init(const_reference v)
Initialize values to a constant value.
Top-level namespace for Stokhos classes and functions.
std::ostream & operator<<(std::ostream &os, const ProductContainer< coeff_type > &vec)