DAMIS/DistanceMetrics.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
/*
 * File:   DistanceMetrics.h
 * Author: mindaugas
 *
 * Created on September 1, 2013, 11:15 PM
 */
/*! \file DistanceMetrics class
    \brief A class of static methods for calculating distance between DataObjects.
 */
#ifndef DISTANCEMETRICS_H
#define	DISTANCEMETRICS_H

#include "DataObject.h"
#include "ObjectMatrix.h"
#include "DistanceMetricsEnum.h"

class DistanceMetrics
{
public:
    /*! \fn static double getDistance(DataObject object1, DataObject object2, DistanceMetricsEnum);
     *  \brief Calculates the distance between two DataObjects.
     * \param object1 - a DataObject.
     * \param object2 - a DataObject.
     * \param metricsEnum - enumeration type of the distance calculation metrics.
     * \return distance - the distance between two DataObjects.
     */
    static double getDistance(DataObject object1, DataObject object2, DistanceMetricsEnum metricsEnum);
private:
    /*! \fn static double getChebyshev(DataObject object1, DataObject object2);
     *  \brief Calculates the distance between two DataObjects using \a Chebyshev metrics.
     * \param object1 - a DataObject.
     * \param object2 - a DataObject.
     * \return distance - the distance between two DataObjects.
     */
    static double getChebyshev(DataObject object1, DataObject object2);
    /*! \fn static double getEuclidean(DataObject object1, DataObject object2);
     *  \brief Calculates the distance between two DataObjects using \a Euclidean metrics.
     * \param object1 - a DataObject.
     * \param object2 - a DataObject.
     * \return distance - the distance between two DataObjects.
     */
    static double getEuclidean(DataObject object1, DataObject object2);
    /*! \fn static double getManhattan(DataObject object1, DataObject object2);
     *  \brief Calculates the distance between two DataObjects using \a Manhattan metrics.
     * \param object1 - a DataObject.
     * \param object2 - a DataObject.
     * \return distance - the distance between two DataObjects.
     */
    static double getManhattan(DataObject object1, DataObject object2);

};

#endif	/* DISTANCEMETRICS_H */