/usr/include/openturns/SobolIndicesAlgorithm.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 | // -*- C++ -*-
/**
* @brief SobolIndicesAlgorithm provides capabilities for sensitivity algorithm
*
* 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_SOBOLINDICESALGORITHM_HXX
#define OPENTURNS_SOBOLINDICESALGORITHM_HXX
#include "openturns/OTprivate.hxx"
#include "openturns/TypedInterfaceObject.hxx"
#include "openturns/SobolIndicesAlgorithmImplementation.hxx"
#include "openturns/Interval.hxx"
#include "openturns/SymmetricMatrix.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class SobolIndicesAlgorithm
* This class provides capabilities for sensitivity algorithm
*/
class OT_API SobolIndicesAlgorithm
: public TypedInterfaceObject<SobolIndicesAlgorithmImplementation>
{
CLASSNAME;
public:
typedef Pointer<SobolIndicesAlgorithmImplementation> Implementation;
/** Default constructor */
SobolIndicesAlgorithm();
/** Constructor from an implementation */
SobolIndicesAlgorithm(const SobolIndicesAlgorithmImplementation & implementation);
/** Constructor from a Pointer to an implementation */
SobolIndicesAlgorithm(const Implementation & p_implementation);
/** Constructor with parameters */
SobolIndicesAlgorithm(const Sample & inputDesign,
const Sample & outputDesign,
const UnsignedInteger size);
/** Constructor with parameters */
SobolIndicesAlgorithm(const Distribution & distribution,
const UnsignedInteger size,
const Function & model,
const Bool computeSecondOrder = true);
/** Constructor with experiment / model parameters */
SobolIndicesAlgorithm(const WeightedExperiment & experiment,
const Function & model,
const Bool computeSecondOrder = true);
/** First order indices accessor */
Point getFirstOrderIndices(const UnsignedInteger marginalIndex = 0) const;
/** Interval for the first order indices accessor */
Interval getFirstOrderIndicesInterval() const;
/** Second order indices accessor */
SymmetricMatrix getSecondOrderIndices(const UnsignedInteger marginalIndex = 0) const;
/** Total order indices accessor */
Point getTotalOrderIndices(const UnsignedInteger marginalIndex = 0) const;
/** Interval for the total order indices accessor */
Interval getTotalOrderIndicesInterval() const;
/** Aggregated first order indices accessor for multivariate samples */
Point getAggregatedFirstOrderIndices() const;
/** Aggregated total order indices accessor for multivariate samples */
Point getAggregatedTotalOrderIndices() const;
// Setters for bootstrap size
UnsignedInteger getBootstrapSize() const;
void setBootstrapSize(const UnsignedInteger bootstrapSize);
// Setters for bootstrap confidence level
Scalar getBootstrapConfidenceLevel() const;
void setBootstrapConfidenceLevel(const Scalar confidenceLevel);
/** Method that draw (plot) the sensitivity graph */
virtual Graph draw() const;
/** Method that draw the sensitivity graph of a fixed marginal */
virtual Graph draw(UnsignedInteger marginalIndex) const;
/** String converter */
virtual String __repr__() const;
/** String converter */
virtual String __str__(const String & offset = "") const;
} ; /* class SobolIndicesAlgorithm */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_SOBOLINDICESALGORITHM_HXX */
|