/usr/include/openturns/OptimizationResult.hxx is in libopenturns-dev 1.9-5.
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 | // -*- C++ -*-
/**
* @brief OptimizationResult implements the result of an algorithm for solving an optimization problem
*
* Copyright 2005-2017 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 "openturns/OTprivate.hxx"
#include "openturns/PersistentObject.hxx"
#include "openturns/Function.hxx"
#include "openturns/Compact.hxx"
#include "openturns/OptimizationProblem.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class OptimizationResult
* OptimizationResult stores the optimization result
*/
class OT_API OptimizationResult
: public PersistentObject
{
CLASSNAME;
// Make the OptimizationAlgorithmImplementation class friend in order to allow them to use protected methods
friend class OptimizationAlgorithmImplementation;
public:
/** Default constructor */
OptimizationResult();
/** Standard constructor */
OptimizationResult(const Point & optimalPoint,
const Point & optimalValue,
const UnsignedInteger iterationNumber,
const Scalar absoluteError,
const Scalar relativeError,
const Scalar residualError,
const Scalar constraintError,
const OptimizationProblem & problem);
/** Virtual constructor */
virtual OptimizationResult * clone() const;
/** OptimalPoint accessors */
void setOptimalPoint(const Point & optimalPoint);
Point getOptimalPoint() const;
/** Optimal value accessor */
void setOptimalValue(const Point & optimalValue);
Point getOptimalValue() const;
/** Iteration number accessor */
void setIterationNumber(const UnsignedInteger iterationNumber);
UnsignedInteger getIterationNumber() const;
/** Absolute error accessor */
Scalar getAbsoluteError() const;
Sample getAbsoluteErrorHistory() const;
/** Relative error accessor */
Scalar getRelativeError() const;
Sample getRelativeErrorHistory() const;
/** Residual error accessor */
Scalar getResidualError() const;
Sample getResidualErrorHistory() const;
/** Constraint error accessor */
Scalar getConstraintError() const;
Sample getConstraintErrorHistory() const;
/** Input / output sample accessor */
Sample getInputSample() const;
Sample getOutputSample() const;
/** Problem accessor */
void setProblem(const OptimizationProblem & problem);
OptimizationProblem getProblem() const;
/** Lagrange multipliers accessor */
void setLagrangeMultipliers(const Point & lagrangeMultipliers);
Point getLagrangeMultipliers() 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);
/** Incremental history storage */
void store(const Point & inP,
const Point & outP,
const Scalar absoluteError,
const Scalar relativeError,
const Scalar residualError,
const Scalar constraintError);
/** Draw error history graph */
Graph drawErrorHistory() const;
/** Draw optimal value graph */
Graph drawOptimalValueHistory() const;
protected:
/** Absolute error accessor */
void setAbsoluteError(const Scalar absoluteError);
void setAbsoluteErrorHistory(const Sample & absoluteError);
/** Relative error accessor */
void setRelativeError(const Scalar relativeError);
void setRelativeErrorHistory(const Sample & relativeError);
/** Residual error accessor */
void setResidualError(const Scalar residualError);
void setResidualErrorHistory(const Sample & residualError);
/** Constraint error accessor */
void setConstraintError(const Scalar constraintError);
void setConstraintErrorHistory(const Sample & constraintError);
private:
Point optimalPoint_;
Point optimalValue_;
UnsignedInteger iterationNumber_; /**< Number of outermost iterations (in case of nested iterations) */
Scalar absoluteError_; /**< Value of ||x_n - x_{n-1}|| */
Scalar relativeError_; /**< Value of ||x_n - x_{n-1}|| / ||x_n|| */
Scalar residualError_; /**< Value of ||objectiveFunction(x_n) - objectiveFunction(x_{n-1})|| */
Scalar constraintError_; /**< Value of ||constraints(x_n)|| for the active constraints */
Point lagrangeMultipliers_;
Compact absoluteErrorHistory_;
Compact relativeErrorHistory_;
Compact residualErrorHistory_;
Compact constraintErrorHistory_;
Compact inputHistory_;
Compact outputHistory_;
OptimizationProblem problem_;
}; // class OptimizationResult
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_OPTIMIZATIONRESULT_HXX */
|