DAMIS/KMEANS.h at master · InScience/DAMIS · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
#ifndef KMEANS_H
#define KMEANS_H

#include "ClusterizationMethods.h"

/*! \file KEMEANS class
 *   \brief Class implements kmeans clustering algorithm
 */

class KMEANS : public ClusterizationMethods
{
    public:
     /*! \fn KMEANS();
     *  \brief Default constructor
     */
        KMEANS();
     /*! \fn KMEANS(int noOfClusters, int maxIter);
     *  \brief Overloaded constructor.
     * \param int noOfClusters - quantity of clusters
     * \param maxIter - macimum number of iterations.
     */
        KMEANS( int noOfClusters, int maxIter);
     /*! \fn virtual ~KMEANS();
     *   \brief default destructor.
     */
        virtual ~KMEANS();

    /*! \fn virtual ObjectMatrix getProjection();
     *  \brief Returns the projection matrix \a Y of matrix \a X.
     *  \return ObjectMatrix Y - the projection matrix.
     */
    virtual ObjectMatrix getProjection();

    /*! \fn int getNoOfClusters();
     *  \brief Returns number of clusters.
     *  \return int  - Stress error value.
     */
     int getNoOfClusters();
    /*! \fn double getStress();
     *  \brief Returns the stress error value.
     *  \return error - Stress error value.
     */
    double getStress();

    protected:

    private:
    /*! \var  int maxIter;
     *  \brief Holds maximum iteration value.
     */
        int maxIter;
     /*! \var  int noOfClusters
     *  \brief Holds number of clusters.
     */
        int noOfClusters;
};

#endif // KMEANS_H