KernelKMeansClustering.h

// KernelKMeansClustering.h:
// -------------------------
//

#ifndef __IPSDKMATH_KERNELKMEANSCLUSTERING_H__
#define __IPSDKMATH_KERNELKMEANSCLUSTERING_H__

// suppression warnings
// warning C4251: 'ipsdk::math::clustering::KernelKMeansClustering<KernelType>::_inputDataColl': class 'std::vector<ipsdk::math::Vector,std::allocator<_Ty>>' needs to have dll-interface to be used by clients of class 'ipsdk::math::clustering::KernelKMeansClustering<KernelType>'
// warning C4275: interface non dll class 'boost::noncopyable_::noncopyable' utilisée comme base d'une interface dll class 'ipsdk::math::clustering::KernelKMeansClustering<ipsdk::math::clustering::LinearKernel>'
#pragma warning (push)
#pragma warning (disable : 4275 4251)

#include <IPSDKMath/IPSDKMathExports.h>
#include <IPSDKMath/Clustering/ClusteringTypes.h>
#include <IPSDKMath/Clustering/KernelKMeansClusteringConfig.h>
#include <IPSDKMath/Clustering/KernelKMeansCentroid.h>
#include <boost/noncopyable.hpp>

namespace ipsdk {
namespace math {
namespace clustering {


template <typename KernelType>
class IPSDKMATH_API KernelKMeansClustering : public boost::noncopyable
{
// predefined public types
public:
    typedef KernelKMeansClusteringConfig AlgorithmConfig;

    typedef KernelKMeansCentroid<KernelType> CentroidType;

    typedef std::vector<CentroidType> CentroidsColl;

public:
    KernelKMeansClustering(const KernelType& kernel);
    ~KernelKMeansClustering();

// methods
public:
    const KernelType&       getKernel() const;

    const AlgorithmConfig&  getConfig() const;
    void                    setConfig(const AlgorithmConfig& config);
        
    // ----------------------------
    // ----------------------------

    bool                    isClusteringDone() const;

    bool                    compute(const ipUInt32 nbClusters,
                                    const VectorColl& inputDataColl);

    // ------------------------
    // ------------------------

    ipUInt32                getNbClusters() const;

    ipUInt32                getDataSize() const;

    ipUInt32                getNbInputData() const;

    const VectorColl&       getInputDataColl() const;

    ipUInt32                getNbFailedAttempts() const;

    ipReal64                getSeparation() const;

    ipUInt32                getNbIteration() const;
    
    ipUInt32                getClusterPopulation(const ipUInt32 clusterIdx) const;

    const CentroidsColl&    getClustersCentroids() const;

    const CentroidType&     getCentroid(const ipUInt32 clusterIdx) const;

    const UInt32Vector&     getAssignments() const;

    ipUInt32                computeAssignment(const Vector& data) const;

    void                    clear();

// attributes
protected:
    KernelType                      _kernel;

    AlgorithmConfig                 _config;

    VectorColl                      _inputDataColl;

    ipUInt32                        _nbFailedAttempts;

    ipUInt32                        _nbIteration;

    ipReal64                        _separation;

    CentroidsColl                   _clustersCentroids;

    UInt32Vector                    _assignments;
};


} // end of namespace clustering
} // end of namespace math
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKMATH_KERNELKMEANSCLUSTERING_H__