STK_Law_IUnivLaw.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2016  Serge Iovleff, Université Lille 1, Inria
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place,
    Suite 330,
    Boston, MA 02111-1307
    USA
 
    Contact : S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
*/
 
/*
 * Project:  stkpp::STatistiK::Law
 * Purpose:  Interface base class for all univariate distributions laws.
 * Author:   Serge Iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 **/
 
#ifndef STK_LAW_IUNIVLAW_H
#define STK_LAW_IUNIVLAW_H
 
#include "STK_Law_ILawBase.h"
 
namespace STK
{
 
namespace Law
{
template <class Type>
class IUnivLaw: public ILawBase
{
  protected:
    IUnivLaw(String const& name): ILawBase(name) {}
    IUnivLaw(IUnivLaw const& law): ILawBase(law.name_) {}
 
  public:
    inline virtual ~IUnivLaw() {}
    // pure virtual metods
    virtual Type rand() const =0;
    virtual Real pdf(Type const& x) const =0;
    virtual Type icdf(Real const& p) const=0;
 
    // virtual methods with default implementation
    virtual Real lpdf(Type const& x) const { return(std::log(pdf(x)));}
    virtual Real cdf(Real const& t) const =0;
    virtual Real lcdf(Real const& t) const { return(std::log(cdf(t)));}
    virtual Real cdfc(Real const& t) const { return(1. - cdf(t));}
    virtual Real lcdfc(Real const& t) const { return(std::log(cdfc(t)));}
};
 
} // namespace Law
 
} //  namespace STK
 
#endif /*STK_LAW_IUNIVLAW_H*/