STK_IMixture.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: 14 nov. 2013
 * 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_IMIXTURE_H
#define STK_IMIXTURE_H
 
#include <Arrays/include/STK_CArrayPoint.h>
#include <Arrays/include/STK_CArrayVector.h>
#include <Arrays/include/STK_CArray.h>
#include <Arrays/include/STK_CArrayNumber.h>
 
namespace STK
{
 
class IMixtureStatModel;
 
class IMixture
{
  public:
    IMixture( String const& idData = String());
    IMixture( IMixture const& mixture);
    virtual ~IMixture();
 
    inline String const& idData() const { return idData_;}
    inline IMixtureStatModel const* const p_composer() const { return p_composer_;}
 
    void setMixtureModel( IMixtureStatModel const* p_composer);
 
    virtual IMixture* clone() const  = 0;
    virtual IMixture* create() const  = 0;
    virtual void initializeStep() = 0;
    virtual void randomInit()  = 0;
    virtual void paramUpdateStep() = 0;
    virtual Real lnComponentProbability(int sample_num, int Cluster_num) = 0;
    virtual int nbFreeParameter() const = 0;
    virtual int nbMissingValues() const = 0;
    virtual void imputationStep() {}
    virtual void samplingStep() {};
    virtual void storeIntermediateResults(int iteration) {}
    virtual void releaseIntermediateResults() {}
    virtual void setParametersStep() {}
    virtual void finalizeStep() {}
    inline virtual void writeParameters(std::ostream& out) const
    {
#ifdef STK_MIXTURE_DEBUG
    stk_cout<< _T("You need to override this method in your mixture!");
#endif
    }
 
  protected:
    int nbSample() const;
    int nbCluster() const;
    CPointX const* p_pk() const;
    CPointX const* p_tk() const;
    CArrayXX const* p_tik() const;
    CVectorXi const* p_zi() const;
 
  private:
    const IMixtureStatModel* p_composer_;
    String idData_;
};
 
} // namespace STK
 
#endif /* STK_IMIXTURE_H */