/usr/include/openturns/RootStrategyImplementation.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 | // -*- C++ -*-
/**
* @brief
*
* 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_ROOTSTRATEGYIMPLEMENTATION_HXX
#define OPENTURNS_ROOTSTRATEGYIMPLEMENTATION_HXX
#include "openturns/PersistentObject.hxx"
#include "openturns/Solver.hxx"
#include "openturns/Collection.hxx"
#include "openturns/PersistentObject.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class RootStrategyImplementation
*/
class OT_API RootStrategyImplementation
: public PersistentObject
{
CLASSNAME;
public:
typedef Collection<Scalar> ScalarCollection;
/** Default constructor with Brent solver */
RootStrategyImplementation();
/** Constructor with parameters */
explicit RootStrategyImplementation(const Solver & solver);
/** Constructor with parameters */
RootStrategyImplementation(const Solver & solver,
const Scalar maximumDistance,
const Scalar stepSize);
/** Virtual constructor */
virtual RootStrategyImplementation * clone() const;
/** Solve gives all the roots found applying the root strategy */
virtual ScalarCollection solve(const Function & function,
const Scalar value);
/** Solver accessor */
void setSolver(const Solver & solver);
Solver getSolver() const;
/** Maximum distance accessor */
void setMaximumDistance(const Scalar maximumDistance);
Scalar getMaximumDistance() const;
/** Step size accessor */
void setStepSize(const Scalar stepSize);
Scalar getStepSize() const;
/** Value of the performance function at the origin accessor */
void setOriginValue(const Scalar originValue);
Scalar getOriginValue() const;
/** String converter */
virtual String __repr__() 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:
/** Univariate root solver for the localization of zeros along a ray */
Solver solver_;
/** Distance beyond which the density is negligible */
Scalar maximumDistance_;
/** Size of the intervals in which we look for zeros */
Scalar stepSize_;
/** Flag to avoid repeated evaluations of the model at the origin */
mutable Bool isAlreadyComputedOriginValue_;
/** Value of the model at the origin */
Scalar originValue_;
} ; /* class RootStrategyImplementation */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_ROOTSTRATEGYIMPLEMENTATION_HXX */
|