/usr/include/openturns/LinearCombinationEvaluation.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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 | // -*- C++ -*-
/**
* @brief The evaluation part of linear combination of polynomials
*
* 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_LINEARCOMBINATIONEVALUATION_HXX
#define OPENTURNS_LINEARCOMBINATIONEVALUATION_HXX
#include "openturns/EvaluationImplementation.hxx"
#include "openturns/Collection.hxx"
#include "openturns/PersistentCollection.hxx"
#include "openturns/Function.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class LinearCombinationEvaluation
*
* The evaluation part of linear combination of polynomials
*/
class OT_API LinearCombinationEvaluation
: public EvaluationImplementation
{
CLASSNAME;
public:
typedef Collection<Function> FunctionCollection;
typedef PersistentCollection<Function> FunctionPersistentCollection;
// friend class Factory<LinearCombinationEvaluation>;
/** Default constructor */
LinearCombinationEvaluation();
public:
/** Parameter constructor */
LinearCombinationEvaluation(const FunctionCollection & functionsCollection,
const Point & coefficients);
/** Virtual constructor */
virtual LinearCombinationEvaluation * clone() const;
/** String converter */
String __repr__() const;
String __str__(const String & offset = "") const;
/** Evaluation operator */
Point operator () (const Point & inP) const;
Sample operator () (const Sample & inS) const;
/** Coefficients accessor */
Point getCoefficients() const;
/** Functions accessor */
FunctionCollection getFunctionsCollection() const;
void setFunctionsCollectionAndCoefficients(const FunctionCollection & functionsCollection,
const Point & coefficients);
/** Input dimension accessor */
UnsignedInteger getInputDimension() const;
/** Output dimension accessor */
UnsignedInteger getOutputDimension() const;
/** Gradient according to the marginal parameters */
Matrix parameterGradient(const Point & inP) const;
/** Parameters value accessor */
void setParameter(const Point & parameter);
Point getParameter() const;
/** Parameters description accessor */
virtual Description getParameterDescription() const;
/** Get the i-th marginal function */
Implementation getMarginal(const UnsignedInteger i) const;
/** Get the function corresponding to indices components */
Implementation getMarginal(const Indices & indices) 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:
private:
// Make the gradient and the hessian friend classes of the evaluation in order to share the functions and the coefficients
friend class LinearCombinationGradient;
friend class LinearCombinationHessian;
friend struct LinearCombinationEvaluationPointFunctor;
// The functions of the combination
FunctionPersistentCollection functionsCollection_;
// The coefficients of the combination
Point coefficients_;
// The flag telling if the combination reduces to zero
Bool isZero_;
} ; /* class LinearCombinationEvaluation */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_LINEARCOMBINATIONEVALUATION_HXX */
|