/usr/include/openturns/OrthogonalUniVariatePolynomial.hxx is in libopenturns-dev 1.9-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | // -*- C++ -*-
/**
* @brief This is an orthogonal 1D polynomial
*
* Copyright 2005-2017 Airbus-EDF-IMACS-Phimeca
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef OPENTURNS_ORTHOGONALUNIVARIATEPOLYNOMIAL_HXX
#define OPENTURNS_ORTHOGONALUNIVARIATEPOLYNOMIAL_HXX
#include "openturns/UniVariatePolynomialImplementation.hxx"
#include "openturns/Collection.hxx"
#include "openturns/PersistentCollection.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class OrthogonalUniVariatePolynomial
*
* This is an orthogonal 1D polynomial. The polynomial P0 is constant equal to 1.0, and by convention we note P-1(x) the null polynomial. For n>=1 we have: Pn+1(x) = (an * x + bn) * Pn(x) + cn * Pn-1(x)
*/
class OT_API OrthogonalUniVariatePolynomial
: public UniVariatePolynomialImplementation
{
CLASSNAME;
public:
typedef Collection<Coefficients> CoefficientsCollection;
typedef PersistentCollection<Coefficients> CoefficientsPersistentCollection;
/** Default constructor */
OrthogonalUniVariatePolynomial();
/** Constructor from coefficients */
OrthogonalUniVariatePolynomial(const CoefficientsCollection & recurrenceCoefficients);
/** Virtual constructor */
virtual OrthogonalUniVariatePolynomial * clone() const;
/** OrthogonalUniVariatePolynomial are evaluated as functors */
Scalar operator() (const Scalar x) const;
/** Recurrence coefficients accessor */
CoefficientsCollection getRecurrenceCoefficients() const;
/** Roots of the polynomial of degree n as the eigenvalues of the associated Jacobi matrix */
ComplexCollection getRoots() const;
/** Method save() stores the object through the StorageManager */
void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(Advocate & adv);
protected:
friend class OrthogonalUniVariatePolynomialFactory;
/** Constructor from recurrence coefficients and coefficients. It is protected to prevent the end user to give incoherent coefficients. */
OrthogonalUniVariatePolynomial(const CoefficientsCollection & recurrenceCoefficients,
const Coefficients & coefficients);
private:
/** Build the coefficients of the polynomial based on the recurrence coefficients */
Coefficients buildCoefficients(const UnsignedInteger n);
/** The recurrence coefficients (an, bn, cn) that defines the orthogonal polynomial for n >= 0. The polynomial P0 is constant equal to 1.0, and by convention we note P-1(x) the null polynomial. For n>=1 we have: Pn+1(x) = (an * x + bn) * Pn(x) + cn * Pn-1(x). The recurrence coefficients are stored starting with (a1, b1, c1). */
CoefficientsPersistentCollection recurrenceCoefficients_;
} ; /* class OrthogonalUniVariatePolynomial */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_ORTHOGONALUNIVARIATEPOLYNOMIAL_HXX */
|