TUnuranSampler.h

Go to the documentation of this file.

// @(#)root/mathcore:$Id$
// Author: L. Moneta Fri Sep 22 15:06:47 2006
 
/**********************************************************************
 *                                                                    *
 * Copyright (c) 2006  LCG ROOT Math Team, CERN/PH-SFT                *
 *                                                                    *
 *                                                                    *
 **********************************************************************/
// Header file for class TUnuranSampler
 
#ifndef ROOT_TUnuranSampler
#define ROOT_TUnuranSampler
 
 
#include "Math/DistSampler.h"
 
// needed by the ClassDef
#include "Rtypes.h"
 
namespace ROOT {
 
   namespace Fit {
 
      class DataRange;
      class BinData;
      class UnBinData;
   }
 
   namespace Math {
   }
}
 
 
 
//_______________________________________________________________________________
/**
   \class TUnuranSampler
   \ingroup Unuran
 
   TUnuranSampler class
   class implementing  the ROOT::Math::DistSampler interface using the UNU.RAN
   package for sampling distributions.
 
*/
 
class TRandom;
class TF1;
class TUnuran;
 
class TUnuranSampler : public ROOT::Math::DistSampler {
 
public:
 
   /// default constructor
   TUnuranSampler();
 
 
   /// virtual destructor
   virtual ~TUnuranSampler();
 
 
   using DistSampler::SetFunction;
 
   /// Set the parent function distribution to use for random sampling (one dim case).
   void SetFunction(const ROOT::Math::IGenFunction & func)  {
      fFunc1D = &func;
      SetFunction<const ROOT::Math::IGenFunction>(func, 1);
   }
 
   /// Set the Function using a TF1 pointer.
   void SetFunction(TF1 * pdf);
 
   /// set the cumulative distribution function of the PDF used for random sampling (one dim case)
   void SetCdf(const ROOT::Math::IGenFunction &cdf);
 
   /// set the Derivative of the PDF used for random sampling (one dim continous case)
   void SetDPdf(const ROOT::Math::IGenFunction &dpdf);
 
   /**
      initialize the generators with the given algorithm
      If no algorithm is passed used the default one for the type of distribution
   */
   bool Init(const char * algo ="");
 
 
   /**
      initialize the generators with the given algorithm
      If no algorithm is passed used the default one for the type of distribution
   */
   bool Init(const ROOT::Math::DistSamplerOptions & opt );
 
   /**
       Set the random engine to be used
       Needs to be called before Init to have effect
   */
   void SetRandom(TRandom * r);
 
   /**
       Set the random seed for the TRandom instances used by the sampler
       classes
       Needs to be called before Init to have effect
   */
   void SetSeed(unsigned int seed);
 
   /**
      Set the print level
      (if level=-1 use default)
    */
   void SetPrintLevel(int level) {fLevel = level;}
 
   /*
      set the mode (1D distribution)
    */
   void SetMode(double mode) {
      fMode = mode;
      fHasMode = true;
   }
 
   /*
      set the mode (Multidim distribution)
   */
   void SetMode(const std::vector<double> &modes);
 
 
   /*
     set the area
    */
   void SetArea(double area) {
      fArea = area;
      fHasArea = true;
   }
 
   /// Set using of logarithm of PDF (only for 1D continous case)
   void SetUseLogPdf(bool on = true) { fUseLogPdf = on; }
 
   /**
      Get the random engine used by the sampler
    */
   TRandom * GetRandom();
 
   /**
      sample one event in one dimension
      better implementation could be provided by the derived classes
   */
   double Sample1D();//  {
//       return fUnuran->Sample();
//    }
 
   /**
      sample one event in multi-dimension by filling the given array
      return false if sampling failed
   */
   bool Sample(double * x);
//  {
//       if (!fOneDim) return fUnuran->SampleMulti(x);
//       x[0] = Sample1D();
//       return true;
//    }
 
   /**
      sample one bin given an estimated of the pdf in the bin
      (this can be function value at the center or its integral in the bin
      divided by the bin width)
      By default do not do random sample, just return the function values
    */
   bool SampleBin(double prob, double & value, double *error = 0);
 
 
 
protected:
 
   /// Initialization for 1D distributions.
   bool DoInit1D(const char * algo);
   /// Initialization for 1D discrete distributions.
   bool DoInitDiscrete1D(const char * algo);
   /// Initialization for multi-dim distributions.
   bool DoInitND(const char * algo);
 
 
private:
 
   // private member
   bool                              fOneDim = false;      /// flag to indicate if the function is 1 dimension
   bool                              fDiscrete = false;    /// flag to indicate if the function is discrete
   bool                              fHasMode = false;     /// flag to indicate if a mode is set
   bool                              fHasArea = false;     /// flag to indicate if a area is set
   bool                              fUseLogPdf = false;   /// flag to indicate if we use the log of the PDF 
   int fLevel;                                     /// debug level
   double                            fMode;        /// mode of dist (1D)
   double                            fArea;        /// area of dist
   std::vector<double>               fNDMode;      /// mode of the multi-dim distribution
   const ROOT::Math::IGenFunction *  fFunc1D = nullptr;      /// 1D function pointer (pdf)
   const ROOT::Math::IGenFunction *  fCDF    = nullptr;      /// CDF function pointer
   const ROOT::Math::IGenFunction *  fDPDF   = nullptr;        /// 1D Derivative function pointer
   TUnuran *                         fUnuran = nullptr;      /// unuran engine class
 
   ClassDef(TUnuranSampler, 2);                    /// Distribution sampler class based on UNU.RAN
};
 
 
 
#endif /* ROOT_TUnuranSampler */