/usr/include/openturns/LHSExperiment.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 Abstract top-level view of an LHSExperiment plane
*
* 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_LHSEXPERIMENT_HXX
#define OPENTURNS_LHSEXPERIMENT_HXX
#include "openturns/WeightedExperimentImplementation.hxx"
#include "openturns/Matrix.hxx"
#include "openturns/Collection.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class LHSExperiment
*
* The class describes the probabilistic concept of LHSExperiment plan
*/
class OT_API LHSExperiment
: public WeightedExperimentImplementation
{
CLASSNAME;
public:
typedef Collection<Distribution> DistributionCollection;
/** Default constructor */
LHSExperiment();
/** Parameters constructor */
explicit LHSExperiment(const UnsignedInteger size,
const Bool alwaysShuffle = false,
const Bool randomShift = true);
/** Parameters constructor */
LHSExperiment(const Distribution & distribution,
const UnsignedInteger size,
const Bool alwaysShuffle = false,
const Bool randomShift = true);
/** Virtual constructor */
virtual LHSExperiment * clone() const;
/** String converter */
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/* Here is the interface that all derived class must implement */
/** Sample generation */
Sample generateWithWeights(Point & weights) const;
/** Shuffle the cells. */
static Matrix ComputeShuffle(const UnsignedInteger dimension,
const UnsignedInteger totalSize);
/** Shuffle accessor */
virtual Matrix getShuffle() const;
/** Distribution accessor */
void setDistribution(const Distribution & distribution);
/** AlwaysShuffle accessor */
Bool getAlwaysShuffle() const;
void setAlwaysShuffle(const Bool alwaysShuffle);
/** Random shift accessor */
Bool getRandomShift() const;
void setRandomShift(const Bool randomShift);
/** 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);
private:
// Marginal distributions
mutable DistributionCollection marginals_;
// Cells shuffle
mutable Matrix shuffle_;
// Flag to avoid redundant computation of the shuffle
mutable Bool isAlreadyComputedShuffle_;
// Initialization flag
Bool alwaysShuffle_;
// Random shift flag
Bool randomShift_;
}; /* class LHSExperiment */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_LHSEXPERIMENT_HXX */
|