/usr/include/openturns/NearestPointAlgorithmImplementationResult.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 | // -*- C++ -*-
/**
* @file NearestPointAlgorithmImplementationResult.hxx
* @brief NearestPointAlgorithmImplementationResult 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: dutka $
* @date: $LastChangedDate: 2010-02-04 16:44:49 +0100 (jeu. 04 févr. 2010) $
* Id: $Id: NearestPointAlgorithmImplementationResult.hxx 1473 2010-02-04 15:44:49Z dutka $
*/
#ifndef OPENTURNS_NEARESTPOINTALGORITHMIMPLEMENTATIONRESULT_HXX
#define OPENTURNS_NEARESTPOINTALGORITHMIMPLEMENTATIONRESULT_HXX
#include "OTprivate.hxx"
#include "Threadable.hxx"
#include "PersistentObject.hxx"
#include "NumericalMathFunction.hxx"
#include "Exception.hxx"
namespace OpenTURNS
{
namespace Base
{
namespace Optim
{
/**
* @class NearestPointAlgorithmImplementationResult
* NearestPointAlgorithmImplementationResult stores the optimization result
*/
class NearestPointAlgorithmImplementationResult
: public Common::PersistentObject
{
CLASSNAME;
public:
typedef Type::NumericalPoint NumericalPoint;
typedef Base::Common::StorageManager StorageManager;
/** Default constructor */
explicit NearestPointAlgorithmImplementationResult();
/** Standard constructor */
NearestPointAlgorithmImplementationResult(const NumericalPoint & minimizer,
const UnsignedLong iterationsNumber,
const NumericalScalar absoluteError,
const NumericalScalar relativeError,
const NumericalScalar residualError,
const NumericalScalar constraintError);
/** Virtual constructor */
virtual NearestPointAlgorithmImplementationResult * clone() const;
/** Minimizer accessors */
NumericalPoint getMinimizer() const;
/** Iterations number accessor */
UnsignedLong getIterationsNumber() const;
/** Absolute error accessor */
NumericalScalar getAbsoluteError() const;
/** Relative error accessor */
NumericalScalar getRelativeError() const;
/** Residual error accessor */
NumericalScalar getResidualError() const;
/** Constraint error accessor */
NumericalScalar getConstraintError() const;
/** String converter */
virtual String __repr__() const;
/** Method save() stores the object through the StorageManager */
void save(StorageManager::Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(StorageManager::Advocate & adv);
protected:
/** Minimizer accessors */
void setMinimizer(const NumericalPoint & minimizer);
/** Iterations number accessor */
void setIterationsNumber(const UnsignedLong iterationsNumber);
/** Absolute error accessor */
void setAbsoluteError(const NumericalScalar absoluteError);
/** Relative error accessor */
void setRelativeError(const NumericalScalar relativeError);
/** Residual error accessor */
void setResidualError(const NumericalScalar residualError);
/** Constraint error accessor */
void setConstraintError(const NumericalScalar constraintError);
private:
NumericalPoint minimizer_;
UnsignedLong iterationsNumber_; /**< Number of outermost iterations (in case of nested iterations) */
NumericalScalar absoluteError_; /**< Value of ||x_n - x_{n-1}|| */
NumericalScalar relativeError_; /**< Value of ||x_n - x_{n-1}|| / ||x_n|| */
NumericalScalar residualError_; /**< Value of ||objectiveFunction(x_n) - objectiveFunction(x_{n-1})|| */
NumericalScalar constraintError_; /**< Value of ||constraints(x_n)|| for the active constraints */
}; // class NearestPointAlgorithmImplementationResult
} /* namespace Optim */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_NEARESTPOINTALGORITHMIMPLEMENTATIONRESULT_HXX */
|