source: trunk/c++_tools/statistics/Distance.h @ 675

Last change on this file since 675 was 675, checked in by Jari Häkkinen, 15 years ago

References #83. Changing project name to yat. Compilation will fail in this revision.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.6 KB
Line 
1#ifndef _theplu_statistics_distance_
2#define _theplu_statistics_distance_
3
4// $Id: Distance.h 675 2006-10-10 12:08:45Z jari $
5
6/*
7  Copyright (C) The authors contributing to this file.
8
9  This file is part of the yat library, http://lev.thep.lu.se/trac/yat
10
11  The yat library is free software; you can redistribute it and/or
12  modify it under the terms of the GNU General Public License as
13  published by the Free Software Foundation; either version 2 of the
14  License, or (at your option) any later version.
15
16  The yat library is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  General Public License for more details.
20
21  You should have received a copy of the GNU General Public License
22  along with this program; if not, write to the Free Software
23  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24  02111-1307, USA.
25*/
26
27namespace theplu{
28
29  namespace utility {
30    class vector;
31  }
32  namespace classifier {
33    class DataLookup1D;
34  }
35
36
37namespace statistics{
38  ///
39  /// Interface class for calculating distances between arrays.
40  ///
41  class Distance
42  {
43  public:
44
45    Distance()
46    {
47    }
48
49    virtual ~Distance() 
50    {
51    }
52
53    ///
54    /// @return distance
55    ///
56    virtual double operator()(const utility::vector& x, 
57                              const utility::vector& y) const = 0;
58
59
60    ///
61    /// This function is virtual, and implemented in this base class
62    /// copying the lookups to utilty::vectors followed by calling
63    /// appropriate function. If speed is crucial you can implement
64    /// this function in inherited class avoiding the copying.
65    ///
66    /// @return distance
67    ///
68    virtual double operator()(const classifier::DataLookup1D& x, 
69                              const classifier::DataLookup1D& y) const;
70       
71   
72    ///
73    /// @return weighted distance
74    ///
75    virtual double operator()(const utility::vector& x, 
76                              const utility::vector& y, 
77                              const utility::vector& wx, 
78                              const utility::vector& wy) const = 0;
79   
80    ///
81    /// This function is virtual, and implemented in this base class
82    /// copying the lookups to utilty::vectors followed by calling
83    /// appropiate function. If speed is crucial you can implement
84    /// this function in inherited class avoiding the copying.
85    ///
86    /// @return weighted distance
87    ///
88    virtual double operator()(const classifier::DataLookup1D& x, 
89                              const classifier::DataLookup1D& y,
90                              const classifier::DataLookup1D& wx,
91                              const classifier::DataLookup1D& wy) const;
92   
93  private:
94  };
95
96}} // of namespace statistics and namespace theplu
97
98#endif
Note: See TracBrowser for help on using the repository browser.