The Fib multimedia system
Fib is a system for storing multimedia data (like images or films).
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
cDataPoint.h
Go to the documentation of this file.
1 /**
2  * @file cDataPoint
3  * file name: cDataPoint.h
4  * @author Betti Oesterholz
5  * @date 30.06.2010
6  * @mail webmaster@BioKom.info
7  *
8  * System: C++
9  *
10  * This header specifies a class for a two dimensional datapoint.
11  * Copyright (C) @c GPL3 2010 Betti Oesterholz
12  *
13  * This program is free software: you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License (GPL) as
15  * published by the Free Software Foundation, either version 3 of the
16  * License, or any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU Lesser General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
25  *
26  *
27  * This header specifies a class for a two dimensional datapoint.
28  * A datapoint (x,y,z) is contains a x, a y and an z value.
29  *
30  */
31 /*
32 History:
33 30.06.2010 Oesterholz created
34 */
35 
36 #ifndef ___N_D_2_C_DATA_POINT_H__
37 #define ___N_D_2_C_DATA_POINT_H__
38 
39 #include "version.h"
40 
41 
42 namespace fib{
43 
44 namespace algorithms{
45 
46 namespace nD2{
47 
48 
49 template <class tX, class tY, class tZ>
50 class cDataPoint{
51 public:
52 
53  /**
54  * The x value for the datapoint.
55  */
56  tX x;
57 
58  /**
59  * The y value for the datapoint.
60  */
61  tY y;
62 
63  /**
64  * The z value for the datapoint.
65  */
66  tZ z;
67 
68  /**
69  * standardconstructor for a datapoint
70  *
71  * @param inX the @see x value for the datapoint
72  * @param inY the @see y value for the datapoint
73  * @param inZ the @see z value for the datapoint
74  */
75  cDataPoint( tX inX = 0, tY inY = 0, tZ inZ = 0 );
76 
77  /**
78  * This method evalues the distance to an oter datapoint.
79  * The distance is the euclidean distance:
80  * ((x - dataPoint.x)^2 + (y - dataPoint.x)^2)^(1/2)
81  *
82  * @param dataPoint the datapoint to which the distance in the x
83  * and y value should be evalued
84  * @return the euclidean distance of this datapoint and the given datapoint
85  * @see x
86  * @see y
87  */
88  tX dist( const cDataPoint<tX, tY, tZ> & dataPoint ) const;
89 
90 };
91 
92 
93 };//end namespace nD2
94 };//end namespace algorithms
95 };//end namespace fib
96 
97 
98 //include template implementation
99 #include "../nD2/src/cDataPoint.cpp"
100 
101 
102 #endif //___N_D_2_C_DATA_POINT_H__