STK_Law_ITUnivariate.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2007  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:  stkpp::STatistiK::Law
 * Purpose:  Interface base class for all univariate probabilities laws.
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 **/

#ifndef STK_LAW_ITUNIVARIATE_H
#define STK_LAW_ITUNIVARIATE_H

// RandBase header
#include "STK_Law_ILawBase.h"
#include "../../Sdk/include/STK_ITContainer2D.h"

namespace STK
{

namespace Law
{
template <class TYPE>
class ITUnivariate : public ILawBase
{
  protected:
    ITUnivariate(String const& name) : ILawBase(name)
    { ;}

  public:
    virtual ~ITUnivariate() { ;}

    template< class Container1D>
    void rand1D( ITContainer1D< TYPE, Container1D>& A) const
    {
      // get dimensions
      const Integer first = A.first(), last = A.last();
      // generate and set random variables
      for (Integer i=first; i<=last; i++) A[i] = rand();
    }

    template < class TContainer2D>
    void rand2D( ITContainer2D< TYPE, TContainer2D>& A) const
    {
      // get dimensions
      const Integer firstRow = A.firstRow(), lastRow = A.lastRow();
      const Integer firstCol = A.firstCol(), lastCol = A.lastCol();
      // generate and set random variables
      for (Integer j=firstCol; j<=lastCol; j++)
        for (Integer i=firstRow; i<=lastRow; i++)
          A(i, j) = rand();
    }

  private:
    virtual Real cdf(Real const& t) const =0;

    virtual Real pdf(TYPE const& x) const =0;
    
    virtual Real lpdf(TYPE const& x) const = 0;
    virtual TYPE rand() const =0;

    virtual Real icdf(Real const& p) const=0;
};

} // namespace Law

} //  namespace STK

#endif /*STK_LAW_ITUNIVARIATE_H*/