SpectralClustering.h

// SpectralClustering.h:
// ---------------------
//

#ifndef __IPSDKMATH_SPECTRALCLUSTERING_H__
#define __IPSDKMATH_SPECTRALCLUSTERING_H__

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

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

namespace ipsdk {
namespace math {
namespace clustering {


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

    typedef KernelKMeansClustering<KernelType> ClusteringAlgorithm;
    
    typedef boost::shared_ptr<ClusteringAlgorithm> ClusteringAlgorithmPtr;

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

// 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 UInt32Vector&         getAssignments() const;

    const Vector&               getEigenValues() const;

    const Matrix&               getEigenVectors() const;

    ipUInt32                    computeAssignment(const Vector& data) const;

    const ClusteringAlgorithm&  getClusteringAlgorithm() const;

    void                        clear();

// attributes
protected:
    ClusteringAlgorithmPtr  _pClusteringAlgorithm;

    VectorColl              _inputDataColl;

    UInt32Vector            _assignments;

    Vector                  _eigenValues;

    Matrix                  _eigenVectors;
};


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

#pragma warning (pop)

#endif // __IPSDKMATH_SPECTRALCLUSTERING_H__