IntDistribution.h

#ifndef UTIL_INT_DISTRIBUTION_H
#define UTIL_INT_DISTRIBUTION_H

/*
* Util Package - C++ Utilities for Scientific Computation
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/

#include <util/param/ParamComposite.h>
#include <util/containers/DArray.h>

namespace Util
{

   class IntDistribution : public ParamComposite 
   {
   
   public:
  
      IntDistribution();
   
      IntDistribution(const IntDistribution& other);
   
      IntDistribution& operator = (const IntDistribution& other);
   
      virtual ~IntDistribution();
   
      void readParameters(std::istream& in);
  
      void setParam(int min, int max);
   
      virtual void loadParameters(Serializable::IArchive& ar);

      virtual void save(Serializable::OArchive& ar);
  
      template <class Archive>
      void serialize(Archive& ar, const unsigned int version);

      void clear();
   
      void sample(int value);
   
      void output(std::ostream& out);
  
      int binIndex(int value);
  
      int min() const;
  
      int max() const;
    
      int nBin() const;
        
      const DArray<long>& data() const
      {  return histogram_; }
        
   protected:
   
      DArray<long> histogram_;  
      int   min_;               
      int   max_;               
      int   nBin_;              
      int   nSample_;           
      int   nReject_;           
   
   };

   // inline method definitions 
  
   /*
   * Return the index of the bin for a value.
   */
   inline int IntDistribution::binIndex(int value) 
   { return (value - min_); }
  
   /*
   * Get minimum value in range of histogram.
   */
   inline int IntDistribution::min() const
   {  return min_; }
  
   /*
   * Get maximum value in range of histogram.
   */
   inline int IntDistribution::max() const
   {  return max_; }
 
   /*
   * Get the number of bins
   */
   inline int IntDistribution::nBin() const
   {  return nBin_; }
        
   /*
   * Serialize this Distribution.
   */
   template <class Archive>
   void IntDistribution::serialize(Archive& ar, const unsigned int version)
   {
      ar & min_;        
      ar & max_;    
      ar & nBin_;     
      ar & nSample_;   
      ar & nReject_;    
      ar & histogram_; 
   }

}
#endif