/usr/include/openturns/OptimizationResult.hxx is in libopenturns-dev 1.7-3.
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 | // -*- C++ -*-
/**
* @brief OptimizationResult implements the result of an algorithm for solving an optimization problem
*
* 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/>.
*
*/
#ifndef OPENTURNS_OPTIMIZATIONRESULT_HXX
#define OPENTURNS_OPTIMIZATIONRESULT_HXX
#include "OTprivate.hxx"
#include "PersistentObject.hxx"
#include "NumericalMathFunction.hxx"
#include "Compact.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class OptimizationResult
* OptimizationResult stores the optimization result
*/
class OT_API OptimizationResult
: public PersistentObject
{
CLASSNAME;
public:
/** Default constructor */
OptimizationResult();
/** Standard constructor */
OptimizationResult(const NumericalPoint & optimalPoint,
const NumericalPoint & optimalValue,
const UnsignedInteger iterationNumber,
const NumericalScalar absoluteError,
const NumericalScalar relativeError,
const NumericalScalar residualError,
const NumericalScalar constraintError);
/** Virtual constructor */
virtual OptimizationResult * clone() const;
/** OptimalPoint accessors */
NumericalPoint getOptimalPoint() const;
/** Optimal value accessor */
NumericalPoint getOptimalValue() const;
/** Iteration number accessor */
UnsignedInteger getIterationNumber() const;
/** Absolute error accessor */
NumericalScalar getAbsoluteError() const;
NumericalSample getAbsoluteErrorHistory() const;
/** Relative error accessor */
NumericalScalar getRelativeError() const;
NumericalSample getRelativeErrorHistory() const;
/** Residual error accessor */
NumericalScalar getResidualError() const;
NumericalSample getResidualErrorHistory() const;
/** Constraint error accessor */
NumericalScalar getConstraintError() const;
NumericalSample getConstraintErrorHistory() const;
/** Input / output sample accessor */
NumericalSample getInputSample() const;
NumericalSample getOutputSample() 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);
/** Update current state */
void update(const NumericalPoint & optimalPoint, UnsignedInteger iterationNumber);
/** Incremental history storage */
void store(const NumericalPoint & inP,
const NumericalPoint & outP,
const NumericalScalar absoluteError,
const NumericalScalar relativeError,
const NumericalScalar residualError,
const NumericalScalar constraintError);
/** Draw error history graph */
Graph drawErrorHistory() const;
protected:
/** OptimalPoint accessors */
void setOptimalPoint(const NumericalPoint & optimalPoint);
/** Iteration number accessor */
void setIterationNumber(const UnsignedInteger iterationNumber);
/** Optimal value accessor */
void setOptimalValue(const NumericalPoint & optimalValue);
/** Absolute error accessor */
void setAbsoluteError(const NumericalScalar absoluteError);
void setAbsoluteErrorHistory(const NumericalSample & absoluteError);
/** Relative error accessor */
void setRelativeError(const NumericalScalar relativeError);
void setRelativeErrorHistory(const NumericalSample & relativeError);
/** Residual error accessor */
void setResidualError(const NumericalScalar residualError);
void setResidualErrorHistory(const NumericalSample & residualError);
/** Constraint error accessor */
void setConstraintError(const NumericalScalar constraintError);
void setConstraintErrorHistory(const NumericalSample & constraintError);
private:
NumericalPoint optimalPoint_;
NumericalPoint optimalValue_;
UnsignedInteger iterationNumber_; /**< 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 */
Compact absoluteErrorHistory_;
Compact relativeErrorHistory_;
Compact residualErrorHistory_;
Compact constraintErrorHistory_;
Compact inputHistory_;
Compact outputHistory_;
}; // class OptimizationResult
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_OPTIMIZATIONRESULT_HXX */
|