/usr/include/openturns/StrongMaximumTest.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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | // -*- C++ -*-
/**
* @brief StrongMaxTest implements an algorithm to check if a given design point
*
* 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_STRONGMAXTEST_HXX
#define OPENTURNS_STRONGMAXTEST_HXX
#include "openturns/PersistentObject.hxx"
#include "openturns/Point.hxx"
#include "openturns/StandardEvent.hxx"
#include "openturns/Sample.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class StrongMaximumTest
* StrongMaximumTest allows to validate a design point
*/
class OT_API StrongMaximumTest :
public PersistentObject
{
CLASSNAME;
public:
/** Default constructor */
StrongMaximumTest();
/** Standard constructor */
StrongMaximumTest(const StandardEvent & event,
const Point & standardSpaceDesignPoint,
const Scalar importanceLevel,
const Scalar accuracyLevel,
const Scalar confidenceLevel);
/** Standard constructor */
StrongMaximumTest(const StandardEvent & event,
const Point & standardSpaceDesignPoint,
const Scalar importanceLevel,
const Scalar accuracyLevel,
const UnsignedInteger pointNumber);
/** Virtual constructor */
virtual StrongMaximumTest * clone() const;
/** standardSpaceDesignPoint accessor */
Point getStandardSpaceDesignPoint() const;
/** Event accessor */
StandardEvent getEvent() const;
/** ImportanceLevel accessor */
Scalar getImportanceLevel() const;
/** AccuracyLevel accessor */
Scalar getAccuracyLevel() const;
/** ConfidenceLevel accessor */
Scalar getConfidenceLevel() const;
/** DesignPointVicinity accessor */
Scalar getDesignPointVicinity() const;
/** PointNumber accessor */
UnsignedInteger getPointNumber() const;
/** DeltaEpsilon accessor */
Scalar getDeltaEpsilon() const;
/** The function that runs the Strong Max Test */
void run();
/** NearDesignPointVerifyingEventPoints accessor */
Sample getNearDesignPointVerifyingEventPoints() const;
/** FarDesignPointVerifyingEventPoints accessor */
Sample getFarDesignPointVerifyingEventPoints() const;
/** NearDesignPointViolatingEventPoints accessor */
Sample getNearDesignPointViolatingEventPoints() const;
/** FarDesignPointViolatingEventPoints accessor */
Sample getFarDesignPointViolatingEventPoints() const;
/** NearDesignPointVerifyingEventValues accessor */
Sample getNearDesignPointVerifyingEventValues() const;
/** FarDesignPointVerifyingEventValues accessor */
Sample getFarDesignPointVerifyingEventValues() const;
/** NearDesignPointViolatingEventValues accessor */
Sample getNearDesignPointViolatingEventValues() const;
/** FarDesignPointViolatingEventValues accessor */
Sample getFarDesignPointViolatingEventValues() const;
/** 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);
protected:
private:
/** AccuracyLevel accessor */
void setAccuracyLevel(const Scalar accuracyLevel);
/** ConfidenceLevel accessor */
void setConfidenceLevel( const Scalar confidenceLevel);
/** PointNumber accessor */
void setPointNumber(const UnsignedInteger pointNumber);
/** ImportanceLevel accessor */
void setImportanceLevel(const Scalar importanceLevel);
/** standardSpaceDesignPoint accessor */
void setStandardSpaceDesignPoint(const Point & standardSpaceDesignPoint );
/** DesignPointVicinity accessor */
void setDesignPointVicinity(const Scalar designPointVicinity);
/** Event accessor */
void setEvent(const StandardEvent & event);
/** Initialize Strong Max Test Parameters : method 1 */
void initializeParametersGivenConfidenceLevel();
/** Initialize Strong Max Test Parameters : method 2 */
void initializeParametersGivenPointNumber();
/** the function that samples the sphere (radius) with N points */
Sample sampleSphere(const Scalar radius,
const UnsignedInteger dimension,
const UnsignedInteger pointNumber) const;
/** the function that evaluates the HyperSphereSurfaceRatio (see documentation) */
Scalar computeHyperSphereSurfaceRatio();
/** the function that evaluates delta_epsilon (see documentation) */
Scalar computeDeltaEpsilon();
/** the function that evaluates if a point is in the vicinity of the design point */
Bool isInTheVicinityOfTheDesignPoint(const Point & numericalPoint);
StandardEvent event_;
Point standardSpaceDesignPoint_;
Scalar importanceLevel_;
Scalar accuracyLevel_;
Scalar confidenceLevel_;
Scalar designPointVicinity_; // cosinus of the cone around the standard design point
UnsignedInteger pointNumber_;
Scalar deltaEpsilon_;
Sample nearDesignPointVerifyingEventPoints_;
Sample nearDesignPointVerifyingEventValues_;
Sample farDesignPointVerifyingEventPoints_;
Sample farDesignPointVerifyingEventValues_;
Sample nearDesignPointViolatingEventPoints_;
Sample nearDesignPointViolatingEventValues_;
Sample farDesignPointViolatingEventPoints_;
Sample farDesignPointViolatingEventValues_;
}; // class StrongMaximumTest
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_STRONGMAXTEST_HXX */
|