STK_IStatModelBase.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2011  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::StatModel
 * created on: 22 juil. 2011
 * Purpose: define the Interface base class IStatModelBase (Statistical Model).
 * Author:   iovleff, serge.iovleff@stkpp.org
 *
 **/

#ifndef STK_ISTATMODELBASE_H
#define STK_ISTATMODELBASE_H

#include <cmath>

#include "../../Sdk/include/STK_IRunnerBase.h"
#include "../../STKernel/include/STK_Real.h"
#include "../../STKernel/include/STK_Integer.h"

namespace STK
{

class IStatModelBase : virtual public IRunnerBase
{
  protected:
    IStatModelBase();

  public:
    virtual ~IStatModelBase();

    inline Integer const& nbSample() const { return nbSample_;}

    inline Integer const& nbVar() const { return nbVar_;}

    inline Real logNbSample() const
    { return (nbSample_ <= 0) ? Arithmetic<Real>::NA(): log((double)nbSample_) ;
    }

    inline Real logLikelihood() const { return logLikelihood_;}

    inline Real likelihood() const
    { return (Arithmetic<Real>::isFinite(logLikelihood_)) ? exp((double)logLikelihood_) : 0.;}

    inline Integer const& nbFreeParameter() const { return nbFreeParameter_;}
  
  protected:
    Integer nbSample_;
    Integer nbVar_;
    Real logLikelihood_;
    Integer nbFreeParameter_;
};

} // namespace STK

#endif