| OpenMS 2.5.0

KDTreeFeatureNode.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Johannes Veit $
32 // $Authors: Johannes Veit $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/config.h>
38
39 #include <OpenMS/CONCEPT/Types.h>
40 #include <OpenMS/CONCEPT/Exception.h>
41 #include <OpenMS/CONCEPT/Macros.h>
42
43 namespace OpenMS
44 {
45
46 class KDTreeFeatureMaps;
47
49 class OPENMS_DLLAPI KDTreeFeatureNode
50 {
51
52 public:
53
55 KDTreeFeatureNode(KDTreeFeatureMaps* data, Size idx);
56
58 KDTreeFeatureNode(const KDTreeFeatureNode& rhs);
59
61 KDTreeFeatureNode& operator=(KDTreeFeatureNode const& rhs);
62
64 virtual ~KDTreeFeatureNode();
65
67 typedef double value_type;
68
70 value_type operator[](Size i) const;
71
73 Size getIndex() const;
74
75 protected:
76
78 KDTreeFeatureMaps* data_;
79
81 Size idx_;
82
83 private:
84
86 KDTreeFeatureNode();
87
88 };
89
90 }
91
Exception.h
OpenMS::KDTreeFeatureMaps
Stores a set of features, together with a 2D tree for fast search.
Definition: KDTreeFeatureMaps.h:49
Types.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::KDTreeFeatureNode
A node of the kD-tree with pointer to corresponding data and index.
Definition: KDTreeFeatureNode.h:49
OpenMS::KDTreeFeatureNode::value_type
double value_type
libkdtree++ needs this typedef
Definition: KDTreeFeatureNode.h:67
OpenMS::KDTreeFeatureNode::data_
KDTreeFeatureMaps * data_
Pointer to the actual data.
Definition: KDTreeFeatureNode.h:78
OpenMS::KDTreeFeatureNode::idx_
Size idx_
Index of this feature.
Definition: KDTreeFeatureNode.h:81
double
Macros.h
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127