STK_IMixtureModel.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::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_IMIXTUREMODEL_H
#define STK_IMIXTUREMODEL_H
 
#include "STK_IMixtureModelBase.h"
#include <StatModels/include/STK_Model_Util.h>
#include <STatistiK/include/STK_Law_Categorical.h>
 
#ifdef STK_MIXTURE_DEBUG
#include "Arrays/include/STK_Display.h"
#endif
 
namespace STK
{
namespace Clust
{
template <class Mixture> struct MixtureTraits;
 
} // namespace Clust
 
template <int Id> struct ModelParameters;
 
template<class Derived>
class IMixtureModel: public IRecursiveTemplate<Derived>, public IMixtureModelBase
{
  public:
    typedef typename Clust::MixtureTraits<Derived>::Array Array;
    typedef typename Clust::MixtureTraits<Derived>::Parameters Parameters;
    typedef typename Array::Type Type;
 
  protected:
    inline IMixtureModel( int nbCluster)
                        : IMixtureModelBase(nbCluster)
                        , param_(nbCluster)
                        , p_dataij_(0)
    {}
    IMixtureModel( IMixtureModel const& model)
                 : IMixtureModelBase(model)
                 , param_(model.param_)
                 , p_dataij_(model.p_dataij_)
    {}
 
  public:
    inline ~IMixtureModel() {}
    inline IMixtureModel* create() const { return new Derived(this->nbCluster());}
    inline Array const* p_data() const { return p_dataij_;}
 
    inline void setData(Array const& data)
    {
      p_dataij_ = &data;
      initializeModel();
    }
    inline bool initializeStep() { return this->asDerived().initializeStepImpl();}
    inline void setParametersStep()
    {
      param_.setParametersStep();
      this->asDerived().setParametersImpl();
    }
    inline void finalizeStep() { this->asDerived().finalizeStepImpl();}
 
    // default implementation of the pseudo-virtual methods
    inline void initializeModelImpl() {}
    inline bool initializeStepImpl() { return true;}
    inline void finalizeStepImpl() {}
 
    template<class Weights>
    Type sample(int i, int j, Weights const& tk) const
    { return this->asDerived().rand(i, j, Law::Categorical::rand(tk));}
 
  protected:
    void initializeModel()
    {
      // set dimensions
      this->setNbSample(p_dataij_->sizeRows());
      this->setNbVariable(p_dataij_->sizeCols());
      // call specific model initialization stuff
      this->asDerived().initializeModelImpl();
    }
    Parameters param_;
 
  private:
    Array const* p_dataij_;
};
 
} // namespace STK
 
#endif /* STK_IMIXTUREMODEL_H */