/usr/include/openturns/LHSResult.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 | // -*- C++ -*-
/**
* @brief LHSResult
*
* 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_LHSRESULT_HXX
#define OPENTURNS_LHSRESULT_HXX
#include "openturns/PersistentObject.hxx"
#include "openturns/StorageManager.hxx"
#include "openturns/SpaceFilling.hxx"
#include "openturns/LHSResult.hxx"
#include "openturns/PersistentCollection.hxx"
#include "openturns/Sample.hxx"
#include "openturns/Interval.hxx"
#include "openturns/Graph.hxx"
namespace OT
{
/**
* @class LHSResult
*
* LHSResult is the interface class for temperature profile computation for SimulatedAnnealing
*/
class OT_API LHSResult
: public PersistentObject
{
CLASSNAME;
public:
typedef PersistentCollection<Sample> SamplePersistentCollection;
/** Default constructor */
LHSResult();
/** Default constructor */
explicit LHSResult(const SpaceFilling & spaceFilling, UnsignedInteger restart = 0);
/** Virtual constructor */
virtual LHSResult * clone() const;
/** Accessors */
UnsignedInteger getNumberOfRestarts() const;
/** Attributes for getting elements of result */
Sample getOptimalDesign() const;
Sample getOptimalDesign(UnsignedInteger restart) const;
Scalar getOptimalValue() const;
Scalar getOptimalValue(UnsignedInteger restart) const;
Sample getAlgoHistory() const;
Sample getAlgoHistory(UnsignedInteger restart) const;
Scalar getC2() const;
Scalar getC2(UnsignedInteger restart) const;
Scalar getPhiP() const;
Scalar getPhiP(UnsignedInteger restart) const;
Scalar getMinDist() const;
Scalar getMinDist(UnsignedInteger restart) const;
/** Graphical methods - Draw criterion history */
Graph drawHistoryCriterion(const String & title = "") const;
Graph drawHistoryCriterion(UnsignedInteger restart, const String & title = "") const;
Graph drawHistoryProbability(const String & title = "") const;
Graph drawHistoryProbability(UnsignedInteger restart, const String & title = "") const;
Graph drawHistoryTemperature(const String & title = "") const;
Graph drawHistoryTemperature(UnsignedInteger restart, const String & title = "") const;
/** Add an optimal design with its history */
void add(const Sample & optimalDesign, Scalar criterion,
Scalar C2, Scalar PhiP, Scalar MinDist,
const Sample & algoHistory);
/** String converter */
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);
private:
/** Method that draw data */
Graph drawCurveData(const Sample & data, const String & title) const;
/** Method to extract field index from data */
UnsignedInteger findDescription(const char *text) const;
private:
/** Space filling criterion */
SpaceFilling spaceFilling_;
/** Number of restarts */
UnsignedInteger restart_;
/** Best criterion value */
mutable Scalar optimalCriterion_;
/** Index of the best designs in all restarts */
mutable UnsignedInteger optimalIndex_;
/** Collection of best designs (size 1+restart_)*/
SamplePersistentCollection collDesigns_;
/** Collection of algo histories (size 1+restart_, dimension depending on algorithm)*/
SamplePersistentCollection collAlgoHistory_;
/** Collection of all result criteria (size 1+restart_, dimension 4)*/
Sample criteria_;
}; /* class LHSResult */
} /* namespace OT */
#endif /* OT_LHSRESULT_HXX */
|