/usr/include/openturns/RootStrategyImplementation.hxx is in libopenturns-dev 0.15-2.
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 | // -*- C++ -*-
/**
* @file RootStrategyImplementation.hxx
* @brief
*
* (C) Copyright 2005-2011 EDF-EADS-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 2.1 of the License.
*
* 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
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: schueller $
* @date: $LastChangedDate: 2011-04-11 12:32:27 +0200 (Mon, 11 Apr 2011) $
* Id: $Id: RootStrategyImplementation.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_ROOTSTRATEGYIMPLEMENTATION_HXX
#define OPENTURNS_ROOTSTRATEGYIMPLEMENTATION_HXX
#include "PersistentObject.hxx"
#include "Solver.hxx"
#include "Collection.hxx"
#include "Exception.hxx"
#include "PersistentObject.hxx"
namespace OpenTURNS
{
namespace Uncertainty
{
namespace Algorithm
{
/**
* @class RootStrategyImplementation
*/
class RootStrategyImplementation
: public Base::Common::PersistentObject
{
/** Distance from the origin at which the radial density is negligible */
static const NumericalScalar DefaultMaximumDistance;
/** Step-size for the detection of the sign changes along a direction */
static const NumericalScalar DefaultStepSize;
CLASSNAME;
public:
typedef Base::Common::InvalidArgumentException InvalidArgumentException;
typedef Base::Common::NotDefinedException NotDefinedException;
typedef Base::Type::Collection<NumericalScalar> NumericalScalarCollection;
typedef Base::Solver::Solver Solver;
typedef Solver::NumericalMathFunction NumericalMathFunction;
typedef Solver::InternalException InternalException;
typedef Solver::InvalidDimensionException InvalidDimensionException;
/** Default constructor with Brent solver */
explicit RootStrategyImplementation();
/** Constructor with parameters */
RootStrategyImplementation(const Solver & solver);
/** Constructor with parameters */
RootStrategyImplementation(const Solver & solver,
const NumericalScalar maximumDistance,
const NumericalScalar stepSize);
/** Virtual constructor */
virtual RootStrategyImplementation * clone() const;
/** Solve gives all the roots found applying the root strategy */
virtual NumericalScalarCollection solve(const NumericalMathFunction & function,
const NumericalScalar value);
/** Solver accessor */
void setSolver(const Solver & solver);
Solver getSolver() const;
/** Maximum distance accessor */
void setMaximumDistance(const NumericalScalar maximumDistance);
NumericalScalar getMaximumDistance() const;
/** Step size accessor */
void setStepSize(const NumericalScalar stepSize);
NumericalScalar getStepSize() const;
/** Value of the performance function at the origin accessor */
void setOriginValue(const NumericalScalar originValue);
NumericalScalar getOriginValue() const;
/** String converter */
virtual String __repr__() const;
protected:
private:
Solver solver_;
NumericalScalar maximumDistance_;
NumericalScalar stepSize_;
mutable Bool isAlreadyComputedOriginValue_;
NumericalScalar originValue_;
} ; /* class RootStrategyImplementation */
} /* namespace Algorithm */
} /* namespace Uncertainty */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_ROOTSTRATEGYIMPLEMENTATION_HXX */
|