KernelKMeansClusteringConfig.h

// KernelKMeansClusteringConfig.h:
// -------------------------------
//

#ifndef __IPSDKMATH_KERNELKMEANSCLUSTERINGCONFIG_H__
#define __IPSDKMATH_KERNELKMEANSCLUSTERINGCONFIG_H__

#include <IPSDKMath/IPSDKMathExports.h>
#include <IPSDKMath/Clustering/ClusteringTypes.h>
#include <IPSDKUtil/Tools/NumericLimits.h>

namespace ipsdk {
namespace math {
namespace clustering {


class IPSDKMATH_API KernelKMeansClusteringConfig
{
public:
    KernelKMeansClusteringConfig();
    ~KernelKMeansClusteringConfig();

// methods
public:
    static inline ipUInt32  getDefaultNbAttempts()
    {
        return 10;
    }

    void                    setNbAttempts(const ipUInt32 nbAttempts);

    ipUInt32                getNbAttempts() const;

    static inline ipUInt32  getDefaultMaxIteration()
    {
        return 100;
    }

    void                    setNbMaxIteration(const ipUInt32 nbMaxIteration);

    ipUInt32                getNbMaxIteration() const;

    static ipReal64         getDefaultMinChangeRatio()
    {
        return 0.01;
    }

    void                    setMinChangeRatio(const ipReal64 minChangeRatio);

    ipReal64                getMinChangeRatio() const;

    static ipReal64         getDefaultAccuracyThreshold()
    {
        return 1e-3;
    }

    void                    setAccuracyThreshold(const ipReal64 accuracyThreshold);

    ipReal64                getAccuracyThreshold() const;

    static ipUInt32         getDefaultMaxDictionarySize()
    {
        return NumericLimits<ipUInt32>::max();
    }

    void                    setMaxDictionarySize(const ipUInt32 maxDictionarySize);

    ipUInt32                getMaxDictionarySize() const;

// attributes
protected:
    ipUInt32                        _nbAttempts;

    ipUInt32                        _nbMaxIteration;

    ipReal64                        _minChangeRatio;

    ipReal64                        _accuracyThreshold;

    ipUInt32                        _maxDictionarySize;
};


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

#endif // __IPSDKMATH_KERNELKMEANSCLUSTERINGCONFIG_H__