/usr/include/openturns/NearestPointAlgorithmImplementation.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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | // -*- C++ -*-
/**
* @file NearestPointAlgorithmImplementation.hxx
* @brief NearestPointAlgorithmImplementation implements an algorithm for
* finding the point of an implicitely defined manifold the nearest
* to the origin.
*
* (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: NearestPointAlgorithmImplementation.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_NEARESTPOINTALGORITHMIMPLEMENTATION_HXX
#define OPENTURNS_NEARESTPOINTALGORITHMIMPLEMENTATION_HXX
#include "OTprivate.hxx"
#include "Threadable.hxx"
#include "PersistentObject.hxx"
#include "NumericalMathFunction.hxx"
#include "Exception.hxx"
#include "NearestPointAlgorithmImplementationResult.hxx"
namespace OpenTURNS
{
namespace Base
{
namespace Optim
{
/**
* @class NearestPointAlgorithmImplementation
* NearestPointAlgorithmImplementation implements an algorithm for finding the
* point the nearest to the origin of an implicitely defined manifold
*/
class NearestPointAlgorithmImplementation
: public Common::PersistentObject,
public Common::Threadable
{
static const NumericalScalar DefaultLevelValue;
static const UnsignedLong DefaultMaximumIterationsNumber;
static const NumericalScalar DefaultMaximumAbsoluteError;
static const NumericalScalar DefaultMaximumRelativeError;
static const NumericalScalar DefaultMaximumResidualError;
static const NumericalScalar DefaultMaximumConstraintError;
CLASSNAME;
public:
typedef Type::NumericalPoint NumericalPoint;
typedef Func::NumericalMathFunction NumericalMathFunction;
typedef Common::InternalException InternalException;
typedef Base::Common::StorageManager StorageManager;
typedef NearestPointAlgorithmImplementationResult Result;
/** Default constructor */
explicit NearestPointAlgorithmImplementation();
/** Constructor with parameters */
NearestPointAlgorithmImplementation(const NumericalMathFunction & levelFunction,
const Bool verbose = false);
/** Virtual constructor */
virtual NearestPointAlgorithmImplementation * clone() const;
/** Performs the actual computation. Must be overloaded by the actual optimisation algorithm */
virtual void run()
/* throw(InternalException) */;
/** Starting point accessor */
NumericalPoint getStartingPoint() const;
/** Starting point accessor */
void setStartingPoint(const NumericalPoint & startingPoint);
/** Level function accessor */
NumericalMathFunction getLevelFunction() const;
/** Level function accessor */
void setLevelFunction(const NumericalMathFunction & levelFunction);
/** Level value accessor */
NumericalScalar getLevelValue() const;
/** Level value accessor */
void setLevelValue(const NumericalScalar levelValue);
/** Result accessor */
Result getResult() const;
/** Result accessor */
void setResult(const Result & result);
/** Maximum iterations number accessor */
UnsignedLong getMaximumIterationsNumber() const;
/** Maximum iterations number accessor */
void setMaximumIterationsNumber(const UnsignedLong maximumIterationsNumber);
/** Maximum absolute error accessor */
NumericalScalar getMaximumAbsoluteError() const;
/** Maximum absolute error accessor */
void setMaximumAbsoluteError(const NumericalScalar maximumAbsoluteError);
/** Maximum relative error accessor */
NumericalScalar getMaximumRelativeError() const;
/** Maximum relative error accessor */
void setMaximumRelativeError(const NumericalScalar maximumRelativeError);
/** Maximum residual error accessor */
NumericalScalar getMaximumResidualError() const;
/** Maximum residual error accessor */
void setMaximumResidualError(const NumericalScalar maximumResidualError);
/** Maximum constraint error accessor */
NumericalScalar getMaximumConstraintError() const;
/** Maximum constraint error accessor */
void setMaximumConstraintError(const NumericalScalar maximumConstraintError);
/** String converter */
String __repr__() const;
/** Verbose accessor */
Bool getVerbose() const;
void setVerbose(const Bool verbose);
protected:
private:
NumericalMathFunction levelFunction_;
NumericalPoint startingPoint_;
NumericalScalar levelValue_;
UnsignedLong maximumIterationsNumber_; /**< Number of outermost iterations (in case of nested iterations) */
NumericalScalar maximumAbsoluteError_; /**< Value of ||x_n - x_{n-1}|| */
NumericalScalar maximumRelativeError_; /**< Value of ||x_n - x_{n-1}|| / ||x_n|| */
NumericalScalar maximumResidualError_; /**< Value of ||objectiveFunction(x_n) - objectiveFunction(x_{n-1})|| */
NumericalScalar maximumConstraintError_; /**< Value of ||constraints(x_n)|| for the active constraints */
Result result_;
Bool verbose_;
} ; /* class NearestPointAlgorithmImplementation */
} /* namespace Optim */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_NEARESTPOINTALGORITHMIMPLEMENTATION_HXX */
|