goodmanwearehistogrambuilder.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_GOODMANWEAREHISTOGRAMBUILDER_H

#define MEANWALKER_GOODMANWEAREHISTOGRAMBUILDER_H

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

namespace meanwalker
{

class MEANWALKER_IMPORTEXPORT GoodmanWeareHistogramBuilder : private HistogramBuilderTemplate<GoodmanWeareWalkers>
{
public:
        GoodmanWeareHistogramBuilder(RandomNumberGenerator *pRng);
        ~GoodmanWeareHistogramBuilder();

        bool init(Function *pProbFunction, const double *pStartCoordCenter, double startCoordRadius,
                  size_t numBins, const double *pHistMinCoords = 0, const double *pHistMaxCoords = 0, 
                  double a = 2.0, int Nwalkers = 0);
        
        bool init(Function *pProbFunction, const double *pStartCoordCenter, const double *pStartCoordRadii,
                  size_t numBins, const double *pHistMinCoords = 0, const double *pHistMaxCoords = 0, 
                  double a = 2.0, int Nwalkers = 0);
        
        using HistogramBuilderTemplate<GoodmanWeareWalkers>::run;
        using HistogramBuilderTemplate<GoodmanWeareWalkers>::clearHistograms;
        using HistogramBuilderTemplate<GoodmanWeareWalkers>::getHistogram;
        using HistogramBuilderTemplate<GoodmanWeareWalkers>::getHistograms;
        using HistogramBuilderTemplate<GoodmanWeareWalkers>::printHistograms;
        using GoodmanWeareWalkers::getDimension;
        using GoodmanWeareWalkers::getBestCoordinates;
        using GoodmanWeareWalkers::getNumberOfWalkers;

        using errut::ErrorBase::getErrorString;
protected:
        using HistogramBuilderTemplate<GoodmanWeareWalkers>::onNewSample;
        using HistogramBuilderTemplate<GoodmanWeareWalkers>::getHistogramMinMax;
        using HistogramBuilderTemplate<GoodmanWeareWalkers>::onRecordedValuesProcessed;
};

#endif // MEANWALKER_GOODMANWEAREHISTOGRAMBUILDER_H

} // end namespace