metropolishistogrambuilder.h

Go to the documentation of this file.

/*

  This file is a part of MeanWalker, a library which provides utilities to
  sample from probability distributions using methods like the 
  Metropilis-Hastings algorithm and Goodman-Weare algorithm.

  Copyright (C) 2012 Jori Liesenborgs

  Contact: jori.liesenborgs@gmail.com
  
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
  
  This program 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 General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  
*/

#ifndef MEANWALKER_METROPOLISHISTOGRAMBUILDER_H

#define MEANWALKER_METROPOLISHISTOGRAMBUILDER_H

#include "meanwalkerconfig.h"
#include "histogrambuildertemplate.h"
#include "metropoliswalker.h"
#include "histogram.h"

namespace meanwalker
{

class MEANWALKER_IMPORTEXPORT MetropolisHistogramBuilder : private HistogramBuilderTemplate<MetropolisWalker>
{
public: 
        MetropolisHistogramBuilder(RandomNumberGenerator *pRndGen);
        ~MetropolisHistogramBuilder();

        bool init(Function *pProbFunction, const double *pMinCoords, const double *pMaxCoords, const double *pStartCoords,
                  size_t numBins, bool keepInside = true, bool delayed = false);

        using HistogramBuilderTemplate<MetropolisWalker>::run;
        using HistogramBuilderTemplate<MetropolisWalker>::clearHistograms;
        using HistogramBuilderTemplate<MetropolisWalker>::getHistogram;
        using HistogramBuilderTemplate<MetropolisWalker>::getHistograms;
        using HistogramBuilderTemplate<MetropolisWalker>::printHistograms;
        using MetropolisWalker::getDimension;
        using MetropolisWalker::getBestCoordinates;

        using ErrorBase::getErrorString;
protected:
        using HistogramBuilderTemplate<MetropolisWalker>::onNewSample;
        using HistogramBuilderTemplate<MetropolisWalker>::getHistogramMinMax;
        using HistogramBuilderTemplate<MetropolisWalker>::onRecordedValuesProcessed;
        using MetropolisWalker::stepToNewCoords;
};

} // end namespace   

#endif // MEANWALKER_METROPOLISHISTOGRAMBUILDER_H