STK_Law_Student.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:  Student probability distribution.
 * Author:   Serge Iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 **/
 
#ifndef STK_LAW_STUDENT_H
#define STK_LAW_STUDENT_H
 
#include "STK_Law_IUnivLaw.h"
 
namespace STK
{
 
namespace Law
{
class Student: public IUnivLaw<Real>
{
  public:
    typedef IUnivLaw<Real> Base;
    inline Student( int df = 1.): Base(_T("Student")), df_(df) {}
    inline virtual ~Student() {}
    inline int df() const { return df_;}
    inline void setDf( int df)
    {
      if (df<=0) STKDOMAIN_ERROR_1ARG(Student::setShape,df,shape must be > 0);
      df_ = df;
    }
    virtual Real rand() const;
    virtual Real pdf(Real const& x) const;
    virtual Real lpdf(Real const& x) const;
    virtual Real cdf(Real const& t) const;
    virtual Real icdf(Real const& p) const;
 
    static Real rand( int df);
    static Real pdf(Real const& x, int df);
    static Real lpdf(Real const& x, int df);
    static Real cdf(Real const& t, int df);
    static Real icdf(Real const& p, int df);
 
#ifdef IS_RTKPP_LIB
    virtual Real lcdf( Real const& t) const;
    virtual Real cdfc( Real const& t) const;
    virtual Real lcdfc( Real const& t) const;
#endif
 
  protected:
    int df_;
};
 
#ifdef IS_RTKPP_LIB
 
inline Real Student::rand() const
{
#ifdef _OPENMP
//#pragma omp critical
#endif
GetRNGstate(); Real s = Rf_rt(df_); PutRNGstate(); return s;
}
 
inline Real Student::pdf(Real const& x) const  { return Rf_dt(x, df_, false);}
inline Real Student::lpdf(Real const& x) const { return Rf_dt(x, df_, true);}
inline Real Student::cdf(Real const& t) const  { return Rf_pt(t, df_, true, false);}
inline Real Student::lcdf(Real const& t) const  { return Rf_pt(t, df_, true, true);}
inline Real Student::cdfc(Real const& t) const  { return Rf_pt(t, df_, false, false);}
inline Real Student::lcdfc(Real const& t) const  { return Rf_pt(t, df_, false, true);}
inline Real Student::icdf(Real const& p) const { return Rf_qt(p, df_, true, false);}
 
inline Real Student::rand( int df)
{
#ifdef _OPENMP
//#pragma omp critical
#endif
GetRNGstate(); Real s = Rf_rt(df); PutRNGstate(); return s;
}
 
inline Real Student::pdf(Real const& x, int df)  { return Rf_dt(x, df, false);}
inline Real Student::lpdf(Real const& x, int df) { return Rf_dt(x, df, true);}
inline Real Student::cdf(Real const& t, int df)  { return Rf_pt(t, df, true, false);}
inline Real Student::icdf(Real const& p, int df) { return Rf_qt(p, df, true, false);}
 
#endif
 
} // namespace Law
 
} // namespace STK
 
#endif /*STK_LAW_STUDENT_H*/