DAMIS/SOMMDS.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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
///////////////////////////////////////////////////////////
//  SOMMDS.h
//  Implementation of the Class SOMMDS
//  Created on:      07-Lie-2013 20:07:32
//  Original author: Povilas
///////////////////////////////////////////////////////////
/*! \file SOMMDS class
    \brief A class of methods and attributes for SOMMDS algorithm.
 */
#if !defined(SOMMDS_H)
#define SOMMDS_H

#include "ObjectMatrix.h"
#include "SMACOF.h"
#include "SOM.h"

class SOMMDS : public SMACOF, public SOM
{

public:
    /*! \fn SOMMDS();
    * \brief A default constructor.
    */
    SOMMDS();
    /*! \fn virtual ~SOMMDS();
    * \brief A destructor.
    */
    virtual ~SOMMDS();
    /*! \fn SOMMDS(double eps, int max_iter, int d, int kx, int ky, int e_hat);
     * \brief An overloaded constructor that accepts: epsilon, maximum number of iterations,
     * projection dimension, number of SOM rows, number of SOM columns and hat value.
     * \param double eps - difference between two errors
     * \param int max_iter - number of maximum iterations
     * \param int d - projection dimmension
    * \param int kx - number of som rows
     * \param int ky - number of som columns
     * \param int e_Hat - learning epoch
     */
    SOMMDS(double eps, int max_iter, int d, int kx, int ky, int e_hat);
    /*! \fn double getSOMQuantizationError();
     *  \brief Returns the SOM quantization error.
     *  \return som_qe - SOM quantization error.
     */
    double getSOMQuantizationError();
    /*! \fn double getStress();
     *  \brief Returns the MDS stress error.
     *  \return mds_error - MDS stress error.
     */
    double getStress();
    /*! \fn ObjectMatrix getX();
     *  \brief Returns the matrix X.
     *  \return X - The initial data matrix.
     */
    ObjectMatrix getX();
    /*! \fn virtual ObjectMatrix getProjection();
     *  \brief Returns the projection matrix \a Y of matrix \a X.
     *  \return Y - the projection matrix.
     */
    virtual ObjectMatrix getProjection();
private:
    /*! \var double som_qe;
     *  \brief SOM quantization error.
     */
    double som_qe;
    /*! \var double eps;
     *  \brief Difference between SMACOF errors.
     */
    double eps;
    /*! \var double eps;
     *  \brief Difference between SMACOF errors.
     */
    int maxIter;
    /*! \var int maxIter
     *  \brief Number of SMACOF iterations.
     */
    double d;
    /*! \var double mds_error;
     *  \brief MDS error.
     */
    double mds_error;
    /*! \var SMACOF smcf;
     *  \brief Pointer to SMACOF object.
     */
    SMACOF *smcf;
};
#endif // !defined(SOMMDS_H)