DAMIS/Projection.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
/*
 * File:   Projection.h
 * Author: mindaugas
 *
 * Created on October 15, 2013, 9:48 AM
 */
/*! \file Projection class
    \brief A class of static methods for projecting the initial projection matrix.
 */
#ifndef PROJECTION_H
#define	PROJECTION_H

#include "ObjectMatrix.h"
#include "ProjectionEnum.h"

class Projection
{

public:
    /*! \fn  Projection();
    * \brief Default constructor
    */
    Projection();
    /*! \fn  Projection();
    * \brief Default destructor
    */
    virtual ~Projection();
    /*! \fn static ObjectMatrix projectMatrix(ProjectionEnum projEnum, ObjectMatrix objectMatrix);
     *  \brief Orders
     *  \param projEnum - the Enum type of projection.
     *  \param objectMatrix - the ObjectMatrix to project.
     *  \return ObjectMatrix - the projection by \a projEnum.
     */
    static ObjectMatrix projectMatrix(ProjectionEnum projEnum, ObjectMatrix objectMatrix);

private:
    /*! \fn static ObjectMatrix byDispersion(ObjectMatrix objectMatrix);
     *  \brief Projects matrix by dispersion.
     *  \param objectMatrix - The matrix that needs to be projected.
     *  \return projectionMatrix - The projected matrix.
     */
    static ObjectMatrix byDispersion(ObjectMatrix objectMatrix);
    /*! \fn static ObjectMatrix byPCA(ObjectMatrix objectMatrix);
     *  \brief Projects matrix by PCA.
     *  \param objectMatrix - The matrix that needs to be projected.
     *  \return projectionMatrix - The projected matrix.
     */
    static ObjectMatrix byPCA(ObjectMatrix objectMatrix);
    /*! \fn static ObjectMatrix byRAND(ObjectMatrix objectMatrix);
     *  \brief Projects matrix by RAND.
     *  \param objectMatrix - The matrix that needs to be projected.
     *  \return projectionMatrix - The projected matrix.
     */
    static ObjectMatrix byRand(ObjectMatrix objectMAtrix);

};

#endif	/* PROJECTION_H */