/usr/include/openturns/SimulationSensitivityAnalysis.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 | // -*- C++ -*-
/**
* @brief Implementation of SimulationResult
*
* 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_SIMULATIONSENSITIVITYANALYSIS_HXX
#define OPENTURNS_SIMULATIONSENSITIVITYANALYSIS_HXX
#include <cmath>
#include "PersistentObject.hxx"
#include "NumericalSample.hxx"
#include "NumericalPointWithDescription.hxx"
#include "ComparisonOperator.hxx"
#include "NumericalMathFunction.hxx"
#include "Graph.hxx"
#include "Event.hxx"
#include "SpecFunc.hxx"
#include "SimulationResult.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class SimulationSensitivityAnalysis
* Implementation of Simulation sensitivity analysis, it means computation of standardized importance factors
*/
class OT_API SimulationSensitivityAnalysis
: public PersistentObject
{
CLASSNAME;
public:
typedef NumericalMathFunction IsoProbabilisticTransformation;
/** Default constructor */
SimulationSensitivityAnalysis();
/** Standard constructor */
SimulationSensitivityAnalysis(const NumericalSample & inputSample,
const NumericalSample & outputSample,
const IsoProbabilisticTransformation & transformation,
const ComparisonOperator & comparisonOperator,
const NumericalScalar threshold);
/** Standard constructor */
explicit SimulationSensitivityAnalysis(const Event & event);
/** Standard constructor */
explicit SimulationSensitivityAnalysis(const SimulationResult & result);
/** Virtual constructor */
virtual SimulationSensitivityAnalysis * clone() const;
/** Mean point in event domain computation */
NumericalPoint computeMeanPointInEventDomain() const;
NumericalPoint computeMeanPointInEventDomain(const NumericalScalar threshold) const;
/** Importance factors computation */
NumericalPointWithDescription computeImportanceFactors() const;
NumericalPointWithDescription computeImportanceFactors(const NumericalScalar threshold) const;
public:
/** Importance factors drawing */
Graph drawImportanceFactors() const;
Graph drawImportanceFactorsRange(const Bool probabilityScale = true,
const NumericalScalar lower = -SpecFunc::MaxNumericalScalar,
const NumericalScalar upper = SpecFunc::MaxNumericalScalar) const;
/** Input sample accessors */
NumericalSample getInputSample() const;
/** Output sample accessors */
NumericalSample getOutputSample() const;
/** Threshold accessors */
NumericalScalar getThreshold() const;
void setThreshold(const NumericalScalar threshold);
/** Iso-probabilistic transformation accessor */
IsoProbabilisticTransformation getTransformation() const;
/** Comparison operator accessors */
ComparisonOperator getComparisonOperator() const;
void setComparisonOperator(const ComparisonOperator & comparisonOperator);
/** String converter */
virtual String __repr__() const;
/** Method save() stores the object through the StorageManager */
virtual void save(Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
virtual void load(Advocate & adv);
protected:
/* Input sample of the model */
NumericalSample inputSample_;
/* Associated output sample */
NumericalSample outputSample_;
/* Iso probabilistic transformation associated with the input sample distribution */
IsoProbabilisticTransformation transformation_;
/* Comparison operator defining the event we are interested in */
ComparisonOperator comparisonOperator_;
/* Main threshold of interest */
NumericalScalar threshold_;
}; // class SimulationSensitivityAnalysis
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_SIMULATIONSENSITIVITYANALYSIS_HXX */
|