STK_IMixtureModelBase.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2016  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 : S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
*/
 
/*
 * Project:  stkpp::Clustering
 * created on: 16 oct. 2012
 * Author:   iovleff, S..._Dot_I..._At_stkpp_Dot_org (see copyright for ...)
 * Originally created by Parmeet Bhatia <b..._DOT_p..._AT_gmail_Dot_com>
 **/
 
#ifndef STK_IMIXTUREMODELBASE_H
#define STK_IMIXTUREMODELBASE_H
 
#include <cmath>
#include "STK_Clust_Util.h"
 
namespace STK
{
class IMixtureModelBase
{
  public:
    IMixtureModelBase( int nbCluster);
    IMixtureModelBase( IMixtureModelBase const& model);
    ~IMixtureModelBase();
    inline int nbCluster() const { return nbCluster_;}
    inline int nbSample() const { return nbSample_;}
    inline Real lnNbSample() const
    { return (nbSample_ <= 0) ? -Arithmetic<Real>::infinity() : std::log((Real)nbSample_);}
 
  protected:
    inline void setNbSample( int nbSample) { nbSample_ = nbSample;}
 
  private:
    int nbCluster_;
    int nbSample_;
};
 
} // namespace STK
 
#endif /* STK_IMIXTUREMODELBASE_H */