KMeansClustering.h

// KMeansClustering.h:
// -------------------
//

#ifndef __IPSDKMATH_KMEANSCLUSTERING_H__
#define __IPSDKMATH_KMEANSCLUSTERING_H__

// suppression warnings
// warning C4251: 'ipsdk::math::clustering::KMeansClustering::_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::KMeansClustering'
// warning C4275: interface non dll class 'boost::noncopyable_::noncopyable' utilisée comme base d'une interface dll class 'ipsdk::math::clustering::KMeansClustering'
#pragma warning (push)
#pragma warning (disable : 4275 4251)

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

namespace ipsdk {
namespace math {
namespace clustering {


class IPSDKMATH_API KMeansClustering : public boost::noncopyable
{
// predefined public types
public:
    typedef KMeansClusteringConfig AlgorithmConfig;

public:
    KMeansClustering();
    ~KMeansClustering();

// methods
public:
    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                getCompactness() const;

    ipUInt32                getNbIteration() const;

    ipReal64                computeValidityIndex(const eValidityIndexType& validityIndexType) const;

    const VectorColl&       getClustersCenters() const;

    ipUInt32                getClusterPopulation(const ipUInt32 clusterIdx) const;

    const Vector&           getClusterCenter(const ipUInt32 clusterIdx) const;

    ipReal64                getClusterStdDev(const ipUInt32 clusterIdx) const;

    const UInt32Vector&     getAssignments() const;

    ipUInt32                computeAssignment(const Vector& data) const;

    void                    clear();

// attributes
protected:
    AlgorithmConfig         _config;

    VectorColl              _inputDataColl;

    ipUInt32                _nbFailedAttempts;

    ipUInt32                _nbIteration;

    ipReal64                _compactness;

    VectorColl              _clustersCenters;

    UInt32Vector            _assignments;
};


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

#pragma warning (pop)

#endif // __IPSDKMATH_KMEANSCLUSTERING_H__