STK_IMixtureDensity.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_IMIXTUREDENSITY_H
#define STK_IMIXTUREDENSITY_H
 
#include "STK_Clust_Util.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
{
template<class Derived>
class IMixtureDensity: public IRecursiveTemplate<Derived>
{
  public:
    typedef typename hidden::MixtureTraits<Derived>::Array Array;
    typedef typename hidden::MixtureTraits<Derived>::Parameters Parameters;
    typedef typename hidden::Traits<Array>::Type Type;
 
  protected:
    IMixtureDensity( int nbCluster);
    IMixtureDensity( IMixtureDensity const& model);
 
  public:
    ~IMixtureDensity() {}
 
    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_);}
    inline Array const* const& p_data() const { return p_dataij_;}
    inline Parameters const& param() const {return param_;}
 
    void setData(Array const& data);
    void setData(Array const& data, int nbRow, int nbCol, bool byRow = true);
    inline bool initializeStep() { return this->asDerived().initializeStepImpl();}
    inline void setParametersStep()
    {
      param_.setParametersStep();
      this->asDerived().setParametersImpl();
    }
    inline void finalizeStep() { this->asDerived().finalizeStepImpl();}
 
    template<class Weights>
    inline Type sample(int i, int j, Weights const& tk) const
    { return this->asDerived().rand(i, j, Law::Categorical::rand(tk));}
 
  protected:
    Parameters param_;
 
    void initializeModel();
    // default implementation of the pseudo-virtual methods
    inline bool initializeStepImpl() { return true;/* do nothing*/}
    inline void finalizeStepImpl() {/* do nothing*/}
 
    inline void setNbSample( int nbSample) { nbSample_ = nbSample;}
 
  private:
    int nbCluster_;
    int nbSample_;
    Array const* p_dataij_;
};
 
 
/* Default constructor.
 *  @param nbCluster the number of cluster
 **/
template<class Derived>
IMixtureDensity<Derived>::IMixtureDensity( int nbCluster)
                                         : param_(nbCluster)
                                         , nbCluster_(nbCluster)
                                         , nbSample_(0)
                                         , p_dataij_(0)
{}
/* copy constructor.
 *  - The Parameter class is copied using the copy constructor.
 *  - The pointer on the data set is copied as-is. Check if you should not
 *  change it on the copied object.
 *  @param model the model to copy
 **/
template<class Derived>
IMixtureDensity<Derived>::IMixtureDensity( IMixtureDensity const& model)
                                         : param_(model.param_)
                                         , nbCluster_(model.nbCluster_)
                                         , nbSample_(model.nbSample_)
                                         , p_dataij_(model.p_dataij_)
{}
 
/* @brief Set the data set.
 *  Setting a (new) data set will trigger the initializeModel() method.
 *  @param data the data set to set
 **/
template<class Derived>
void IMixtureDensity<Derived>::setData(Array const& data)
{
  p_dataij_ = &data;
  initializeModel();
}
/* @brief Set the data set.
 *  Setting a (new) data set will trigger the initializeModel() method.
 *  @param data the data set to set
 **/
template<class Derived>
void IMixtureDensity<Derived>::setData(Array const& data, int nbRow, int nbCol, bool byRow)
{
  p_dataij_ = &data;
  initializeModel();
}
 
 
/* @brief Initialize the model before its first use.
 * This function is triggered when data set is set.
 * In this interface, the @c initializeModel() method
 *  - set the number of samples of the mixture model
 *  - call the derived class implemented method
 * @code
 *   initializeModelImpl()
 * @endcode
 * for initialization of the specific model parameters if needed.
 **/
template<class Derived>
void IMixtureDensity<Derived>::initializeModel()
{
  // set dimensions
  this->setNbSample(p_dataij_->sizeRows());
  // call specific model initialization stuff
  this->asDerived().initializeModelImpl();
}
 
} // namespace STK
 
#endif /* STK_IMIXTUREDENSITY_H */