STAT_DiracDistribution.h

Go to the documentation of this file.

#ifndef STAT_DiracDistribution_H
#define STAT_DiracDistribution_H

#include "STAT_Distribution.h"


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

  
    tReal mLocation;
    // ASSOCIATIONS
    
protected: 
    // METHODS
  
    // CONSTRUCTORS 
  
    STAT_DiracDistribution();
  
  
  
    // DESTRUCTORS 
  
  
    virtual ~STAT_DiracDistribution(void);   
  
  
  
public:
    //----------------
    // NEW constructors
    // ---------------

    inline static SP::STAT_DiracDistribution New(const tReal& location) {
        SP::STAT_DiracDistribution p(new STAT_DiracDistribution(),
                                     STAT_DiracDistribution::Delete());
        p->setProperties(location);
        p->setThis(p);
        return p;
    }
    inline static SP::STAT_DiracDistribution New() {
        return New(log(2));
    }
    virtual SP::STAT_Distribution NewInstance() const {
        return New();
    }


    virtual void copy(const STAT_Distribution& d) {
        setProperties(d.mean());
    }
    
    // --------------------
    // ATTRIBUTES setting
    // --------------------

    void setProperties(const tReal& location);

  
    
    // -----------------------
    // 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 quantile(const tReal& q) const;
    
    virtual tReal random() 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