DAMIS/SDS.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
87
88
89
90
///////////////////////////////////////////////////////////
//  SDS.h
//  Implementation of the Class SDS
//  Created on:      07-Lie-2013 20:07:31
//  Original author: Povilas
///////////////////////////////////////////////////////////
/*! \file SDS class
    \brief A class of methods and attributes for SDS algorithm.
 */
#if !defined(SDS_H)
#define SDS_H

#include "ObjectMatrix.h"
#include "PCA.h"
#include "SMACOF.h"
#include "MDS.h"
#include "DistanceMetricsEnum.h"
#include "ProjectionEnum.h"


class SDS : public MDS
{

public:
    /*! \fn SDS()
    * \brief A default constructor.
    */
    SDS();
    /*! \fn virtual ~SDS();
    * \brief A destructor.
    */
    virtual ~SDS();
    /*! \fn SDS(double eps, int maxIter, int d, ProjectionEnum baseVectInitt, int nofBaseVect, DistanceMetricsEnum distMetrics);
     * \brief An overloaded constructor that accepts: epsilon, the maximum number of iterations,
     * base vectors initialization method, the number of base vectors and distance metrics.
     * \param double eps - diff between two iterations
     * \param int maxIter - no of maximum iterations to perform
     * \param int d - projection dimmension
     * \param ProjectionEnum baseVectInitt - enumerated value that indicates the initialization of base vectors
     * \param int nofBaseVect - number of base vectors
     * \param DistanceMetricsEnum distMetrics - enumeration that indicates which distance metrics should be used
     */
    SDS(double eps, int maxIter, int d, ProjectionEnum baseVectInitt, int nofBaseVect, DistanceMetricsEnum distMetrics);
    /*! \fn virtual ObjectMatrix getProjection();
     *  \brief Returns the projection matrix \a Y of matrix \a X.
     *  \return Y - the projection matrix.
     */
    virtual ObjectMatrix getProjection();
    /*! \fn virtual double getStress();
     *  \brief Returns the stress error value.
     *  \return error - Stress error value.
     */
private:
    /*!
     * Base vector initialization method
     */
    ProjectionEnum initMethod;
    /*! \var ObjectMatrix Y_new;
     *  \brief The matrix of remainder vectors.
     */
    ObjectMatrix Y_new;
    /*! \var DistanceMetricsEnum distMethod;
     *  \brief Distance measuring metric.
     */
    DistanceMetricsEnum distMethod;
    /*!
     * Number of base vectors
     */
    int nb;
    /*! \fn DataObject getQN();
     *  \brief Calculates one dataobject projection.
     *  \param Yqn - one dataObject for projection calculation.
     */
    DataObject getQN(DataObject Yqn);
    /*! \fn void Initialize();
     *  \brief Initialization of remainder vectors matrix \a Y_new.
     */
    void Initialize();
    /*! \fn static void E_SDS(const alglib::real_1d_array &x, double &func, alglib::real_1d_array &grad, void *ptr);
     *  \brief Function to minimize.
     *  \param x - the address of remainder vectors (initial values).
     *  \param func - The address of the minimized function.
     *  \param grad - The address of gradients.
     *  \param ptr - optional pointer which is passed to func/grad/hess/jac/rep can be NULL
     */
    static void E_SDS(const alglib::real_1d_array &x, double &func, alglib::real_1d_array &grad, void *ptr);

};
#endif // !defined(SDS_H)