kmeans.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef KMEANS_H
#define KMEANS_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "utils_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <string>
#include <QSharedPointer>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// DEFINE NAMESPACE MNELIB
//=============================================================================================================
 
namespace UTILSLIB
{
 
//=============================================================================================================
class UTILSSHARED_EXPORT KMeans
{
public:
    typedef QSharedPointer<KMeans> SPtr;            
    typedef QSharedPointer<const KMeans> ConstSPtr; 
 
    //distance {'sqeuclidean','cityblock','cosine','correlation','hamming'};
    //startNames = {'uniform','sample','cluster'};
    //emptyactNames = {'error','drop','singleton'};
 
    //=========================================================================================================
    explicit KMeans(QString distance = QString("sqeuclidean") ,
                    QString start = QString("sample"),
                    qint32 replicates = 1,
                    QString emptyact = QString("error"),
                    bool online = true,
                    qint32 maxit = 100);
 
//    //=========================================================================================================
//    /**
//     * Constructs a KMeans algorithm object.
//     *
//     * @param[in] distance   (optional) K-Means distance measure: "sqeuclidean" (default), "cityblock" , "cosine", "correlation", "hamming".
//     * @param[in] start      (optional) Cluster initialization: "sample" (default), "uniform", "cluster".
//     * @param[in] replicates (optional) Number of K-Means replicates, which are generated. Best is returned.
//     * @param[in] emptyact   (optional) What happens if a cluster wents empty: "error" (default), "drop", "singleton".
//     * @param[in] online     (optional) If centroids should be updated during iterations: true (default), false.
//     * @param[in] maxit      (optional) maximal number of iterations per replicate; 100 by default.
//     */
//    explicit KMeans(std::string distance = std::string{"sqeuclidean"} ,
//                    std::string start = std::string{"sample"},
//                    qint32 replicates = 1,
//                    std::string emptyact = std::string{"error"},
//                    bool online = true,
//                    qint32 maxit = 100);
 
    //=========================================================================================================
    bool calculate( Eigen::MatrixXd X,
                    qint32 kClusters,
                    Eigen::VectorXi& idx,
                    Eigen::MatrixXd& C,
                    Eigen::VectorXd& sumD,
                    Eigen::MatrixXd& D);
 
private:
    //=========================================================================================================
    Eigen::MatrixXd distfun(const Eigen::MatrixXd& X,
                            Eigen::MatrixXd& C);//, qint32 iter);
 
    //=========================================================================================================
    bool batchUpdate(const Eigen::MatrixXd& X,
                     Eigen::MatrixXd& C,
                     Eigen::VectorXi& idx);
 
    //=========================================================================================================
    void gcentroids(const Eigen::MatrixXd& X,
                    const Eigen::VectorXi& index,
                    const Eigen::VectorXi& clusts,
                    Eigen::MatrixXd& centroids,
                    Eigen::VectorXi& counts);
 
    //=========================================================================================================
    bool onlineUpdate(const Eigen::MatrixXd& X,
                      Eigen::MatrixXd& C,
                      Eigen::VectorXi& idx);
 
    //=========================================================================================================
    double unifrnd(double a, double b);
 
    std::string m_sDistance;    
    std::string m_sStart;       
    qint32 m_iReps;         
    std::string m_sEmptyact;    
    qint32 m_iMaxit;        
    bool m_bOnline;         
 
    qint32 emptyErrCnt;     
 
    qint32 iter;            
    qint32 k;               
    qint32 n;               
    qint32 p;               
 
    Eigen::MatrixXd Del;    
    Eigen::VectorXd d;      
    Eigen::VectorXi m;      
 
    double totsumD;         
 
    double prevtotsumD;     
 
    Eigen::VectorXi previdx;
};
} // NAMESPACE
 
#endif // KMEANS_H