STK_Law_Cauchy.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2008  Serge Iovleff

    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 : Serge.Iovleff@stkpp.org
*/

/*
 * Project:  Laws
 * Purpose:  Cauchy probability distribution.
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 **/

#ifndef STK_LAW_CAUCHY_H
#define STK_LAW_CAUCHY_H

#include "STK_Law_ITUnivariate.h"

namespace STK
{

namespace Law
{
class Cauchy : public ITUnivariate<Real>
{
  protected:
    Real location_;
    
    Real scale_;
    
  public:
    Cauchy( Real const& location=0, Real const& scale=1);

    virtual ~Cauchy();

    virtual Real rand() const;
    
    static Real rand( Real const& location, Real const& scale);
    
    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;
};

} // namespace Law

} // namespace STK

#endif /*STK_LAWCAUCHY_H*/