DAMIS/DimReductionMethod.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
///////////////////////////////////////////////////////////
//  DimReductionMethod.h
//  Implementation of the Class DimReductionMethod
//  Created on:      07-Lie-2013 20:07:29
//  Original author: Povilas
///////////////////////////////////////////////////////////
#if !defined(DIMREDUCTIONMETHOD_H)
#define DIMREDUCTIONMETHOD_H

#include "ObjectMatrix.h"
#include "HPCMethod.h"
/*! \file DimReductionMethod class
    \brief A class of methods and attributes for initialization of projection matrix.
 */
class DimReductionMethod : public HPCMethod
{

public:
    /*! \fn DimReductionMethod();
    * \brief A default constructor.
    */
    DimReductionMethod();
    /*! \fn virtual ~DimReductionMethod();
    * \brief A destructor.
    */
    virtual ~DimReductionMethod();
    /*! \fn virtual double getStress();
     *  \brief Returns the stress error value.
     *  \return error - The stress error value.
     */
    virtual double getStress();

protected:
    /*! \var int d;
     * \brief Projection Dimmension
     */
    int d;
    /*! \var ObjectMatrix Y;
     * \brief result matrix.
     */
    ObjectMatrix Y;
    /*! \fn ObjectMatrix getProjection();
     *  \brief A pure virtual function that returns the projection matrix.
     *  \return Y - an object of ObjectMatrix class.
     */
    virtual ObjectMatrix getProjection() =0;
    /*! \fn int getProjectionDimension();
     *  \brief Returns the dimension of the projection.
     *  \return d - a dimension projection.
     */
    int getProjectionDimension();
    /*! \fn void initializeProjectionMatrix();
     *  \brief Initializes the projection matrix.
     * \return void.
     */
    void initializeProjectionMatrix();
    /*! \fn void setProjectionDimension(int dimension);
     *  \brief Sets the projection dimension.
     *  \param dimension - a value assigned to \a d.
     *  \return void.
     */
    void setProjectionDimension(int dimension);
};
#endif // !defined(DIMREDUCTIONMETHOD_H)