Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
SingleLinkage.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-2013.
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 #ifndef OPENMS_COMPARISON_CLUSTERING_SINGLELINKAGE_H
36 #define OPENMS_COMPARISON_CLUSTERING_SINGLELINKAGE_H
37 
38 #include <vector>
39 #include <set>
40 #include <limits>
41 #include <algorithm>
42 
46 
47 namespace OpenMS
48 {
58  class OPENMS_DLLAPI SingleLinkage :
59  public ClusterFunctor, public ProgressLogger
60  {
61 public:
62 
64  SingleLinkage();
65 
67  SingleLinkage(const SingleLinkage & source);
68 
70  virtual ~SingleLinkage();
71 
73  SingleLinkage & operator=(const SingleLinkage & source);
74 
85  void operator()(DistanceMatrix<Real> & original_distance, std::vector<BinaryTreeNode> & cluster_tree, const Real threshold = 1) const;
86 
89  {
90  return new SingleLinkage();
91  }
92 
94  static const String getProductName()
95  {
96  return "SingleLinkage";
97  }
98 
99  };
100 
101 
102 
103 }
104 #endif //OPENMS_COMPARISON_CLUSTERING_SINGLELINKAGE_H
float Real
Real type.
Definition: Types.h:109
A more convenient string class.
Definition: String.h:56
A two-dimensional distance matrix, similar to OpenMS::Matrix.
Definition: DistanceMatrix.h:57
SingleLinkage ClusterMethod.
Definition: SingleLinkage.h:58
Base class for all classes that want to report their progess.
Definition: ProgressLogger.h:56
static ClusterFunctor * create()
creates a new instance of a SingleLinkage object
Definition: SingleLinkage.h:88
static const String getProductName()
get the identifier for this object
Definition: SingleLinkage.h:94
Base class for cluster functors.
Definition: ClusterFunctor.h:54

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:20 using doxygen 1.8.5