STAT_GeometricDistribution.h

Go to the documentation of this file.

#ifndef STAT_GeometricDistribution_H
#define STAT_GeometricDistribution_H

#include "STAT_Distribution.h"

DEFINE_SPTR(STAT_UniformDistribution);

#include "STAT_Distribution.h"
#include <boost/math/distributions/geometric.hpp>
#include <boost/random/geometric_distribution.hpp>
#include <boost/random/variate_generator.hpp>

DEFINE_SPTR(STAT_GeometricDistribution);
class STAT_GeometricDistribution : public STAT_Distribution {
    SP_OBJECT(STAT_GeometricDistribution);
    // ATTRIBUTES
  
private:

  
  
    // ASSOCIATIONS
    SP::STAT_UniformDistribution mUniform;
    
    boost::math::geometric_distribution<tReal> *mDistribution;
    boost::random::geometric_distribution<int,tReal> *mRandomDistribution;
    boost::random::variate_generator<RNGType&,
                                     boost::random::geometric_distribution<int,tReal> > *mGenerator;
protected: 
    // METHODS
  
    // CONSTRUCTORS 
  
    STAT_GeometricDistribution();
  
  
  
    // DESTRUCTORS 
  
  
    virtual ~STAT_GeometricDistribution(void);   
  
  
  
public:
    //----------------
    // NEW constructors
    // ---------------

    inline static SP::STAT_GeometricDistribution New(const tReal& prob) {
        SP::STAT_GeometricDistribution p(new STAT_GeometricDistribution(),
                                         STAT_GeometricDistribution::Delete());
        p->setProperties(prob);
        p->setThis(p);
        return p;
    }
    inline static SP::STAT_GeometricDistribution New() {
        return New(0.5);
    }
    virtual SP::STAT_Distribution NewInstance() const {
        return New();
    }
    
    
    virtual void copy(const STAT_Distribution& d) {
        if (d.mean()!=0) setProperties(1./(1.+d.mean()));
    }
    // --------------------
    // ATTRIBUTES setting
    // --------------------

    void setProperties(const tReal & p);
    
    // -----------------------
    // USUAL Functions
    // ------------------------

    
    virtual tReal pdf(const tReal& x) const;
    
    virtual tReal cdf(const tReal& x) const;

    virtual tReal cdfc(const tReal& x) const;

    virtual void range(tReal& xmin,tReal& xmax) const;
    
    virtual tReal mean() const;

    virtual tReal variance() const;
    virtual tReal standardDeviation() const;
    
    virtual tReal random() const;
    virtual tReal random(const tReal& p) const;
    
    
    virtual void computeSample(const int& n,CORE_RealArray& sample) const;
    
    protected:
    /* \brief return the growth rate of the distribution
     * @param adjust: is true rescale the parameters of the distribution suach as its growth rate is rho
     * 
     */
    virtual tReal computeGrowthRate(const tReal& v,
                                    const tBoolean& adjust,
                                    const tReal& rho);
   
    
  
   
};

#endif