/usr/include/openturns/NearestPointAlgorithm.hxx is in libopenturns-dev 1.5-7build2.
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 | // -*- C++ -*-
/**
* @file NearestPointAlgorithm.hxx
* @brief NearestPointAlgorithm implements an algorithm for finding the
*
* Copyright 2005-2015 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/>.
*
* @author schueller
* @date 2012-07-16 10:12:54 +0200 (Mon, 16 Jul 2012)
*/
#ifndef OPENTURNS_NEARESTPOINTALGORITHM_HXX
#define OPENTURNS_NEARESTPOINTALGORITHM_HXX
#include "OTprivate.hxx"
#include "TypedInterfaceObject.hxx"
#include "NumericalMathFunction.hxx"
#include "NearestPointAlgorithmImplementation.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class NearestPointAlgorithm
* NearestPointAlgorithm implements an interface to an algorithm for finding the
* point of a manifold defined implicitely the nearest to the origin
*/
class OT_API NearestPointAlgorithm
: public TypedInterfaceObject<NearestPointAlgorithmImplementation>
{
CLASSNAME;
public:
typedef Pointer<NearestPointAlgorithmImplementation> Implementation;
typedef NearestPointAlgorithmImplementationResult Result;
/** Default constructor */
NearestPointAlgorithm();
/** Constructor from an implementation */
NearestPointAlgorithm(const NearestPointAlgorithmImplementation & implementation);
/** Constructor from a Pointer to an implementation */
NearestPointAlgorithm(const Implementation & p_implementation);
/** Constructor with parameters */
explicit NearestPointAlgorithm(const NumericalMathFunction & levelFunction);
/** Performs the actual computation. Must be overloaded by the actual optimisation algorithm */
virtual void run();
/** 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 */
UnsignedInteger getMaximumIterationsNumber() const;
/** Maximum iterations number accessor */
void setMaximumIterationsNumber(const UnsignedInteger 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 */
virtual String __repr__() const;
/** String converter */
virtual String __str__(const String & offset = "") const;
/** Verbose accessor */
Bool getVerbose() const;
void setVerbose(const Bool verbose);
} ; /* class NearestPointAlgorithm */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_NEARESTPOINTALGORITHM_HXX */
|