/usr/include/openturns/MCMC.hxx is in libopenturns-dev 1.2-2.
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++ -*-
/**
* @file MCMC.hxx
* @brief MCMC updates the chain
*
* Copyright (C) 2005-2013 EDF-EADS-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/>.
*
* @author schueller
* @date 2012-02-17 19:35:43 +0100 (Fri, 17 Feb 2012)
*/
#ifndef OPENTURNS_MCMC_HXX
#define OPENTURNS_MCMC_HXX
#include "OTprivate.hxx"
#include "SamplerImplementation.hxx"
#include "ResourceMap.hxx"
#include "Distribution.hxx"
BEGIN_NAMESPACE_OPENTURNS
/**
* @class MCMC
*
* @brief The class implements the concept of comparison operator defined in Sampler.
*
* This class is abstract so it can not be instanciated. It must be derived.
* @see Sampler
*/
class MCMC
: public SamplerImplementation
{
CLASSNAME;
public:
typedef Collection<NumericalPoint> NumericalPointCollection;
typedef PersistentCollection<NumericalPoint> NumericalPointPersistentCollection;
typedef Collection<NumericalPointWithDescription> NumericalPointWithDescriptionCollection;
/** Default constructor */
MCMC();
/** Constructor with parameters*/
MCMC(const Distribution & prior,
const Distribution & conditional,
const NumericalSample & observations,
const NumericalPoint & initialState);
/** Constructor with parameters*/
MCMC(const Distribution & prior,
const Distribution & conditional,
const NumericalMathFunction & model,
const NumericalSample & observations,
const NumericalPoint & initialState);
/** String converter */
virtual String __repr__() const;
/** Compute the likelihood w.r.t. observartions */
NumericalScalar computeLogLikelihood(const NumericalPoint & currentState) const;
/** Prior accessor */
void setPrior(const Distribution & prior);
Distribution getPrior() const;
/** Conditional accessor */
Distribution getConditional() const;
/** Model accessor */
NumericalMathFunction getModel() const;
/** Obervations accessor */
void setObservations(const NumericalSample & observations);
NumericalSample getObservations() const;
/// Burning accessor
void setBurnIn(UnsignedLong burnIn);
UnsignedLong getBurnIn() const;
/// Thinning accessor
void setThinning(UnsignedLong thinning);
UnsignedLong getThinning() const;
/** Virtual constructor */
virtual MCMC * clone() const;
/** Dimension accessor */
virtual UnsignedLong getDimension() 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:
NumericalPoint initialState_;
mutable NumericalPoint currentState_;
private:
Distribution prior_;
Distribution conditional_;
NumericalMathFunction model_;
NumericalSample observations_;
UnsignedLong burnIn_; // number of first samples discarded to reach stationary regime
UnsignedLong thinning_; // number of samples skipped at each generation
}; /* class MCMC */
END_NAMESPACE_OPENTURNS
#endif /* OPENTURNS_MCMC_HXX */
|