OpenMS
EuclideanSimilarity.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-2023.
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: Mathias Walzer $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 //
35 #pragma once
36 
37 #include <cmath>
39 
40 namespace OpenMS
41 {
42 
51  class OPENMS_DLLAPI EuclideanSimilarity
52  {
53 private:
54 
55  float scale_;
56 
57 public:
58 
61 
64 
67 
70 
71 
80  float operator()(const std::pair<float, float> & a, const std::pair<float, float> & b) const;
81 
88  float operator()(const std::pair<float, float> & c) const;
89 
98  void setScale(float x);
99 
100  };
101 
102 }
CompareFunctor for 2Dpoints.
Definition: EuclideanSimilarity.h:52
float scale_
Definition: EuclideanSimilarity.h:55
float operator()(const std::pair< float, float > &a, const std::pair< float, float > &b) const
calculates similarity between two points in euclidean space
virtual ~EuclideanSimilarity()
destructor
EuclideanSimilarity & operator=(const EuclideanSimilarity &source)
assignment operator
EuclideanSimilarity(const EuclideanSimilarity &source)
copy constructor
EuclideanSimilarity()
default constructor
void setScale(float x)
clusters the indices according to their respective element distances
float operator()(const std::pair< float, float > &c) const
calculates self similarity, will yield 0
const double c
Definition: Constants.h:214
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48