| OpenMS 2.5.0

MetaInfoInterfaceUtils.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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/OpenMSConfig.h>
38 #include <OpenMS/DATASTRUCTURES/String.h>
39
40 #include <algorithm>
41 #include <map>
42 #include <vector>
43
44 namespace OpenMS
45 {
46
52 class /*OPENMS_DLLAPI -- disabled since it's template code only */ MetaInfoInterfaceUtils
53 {
54 public:
55
57
58
73 template<typename T_In, typename T_Out>
74 static T_Out findCommonMetaKeys(const typename T_In::const_iterator& it_start, const typename T_In::const_iterator& it_end, float min_frequency)
75 {
76 // make sure min_frequency is within [0,100]
77 min_frequency = std::min((float)100.0, std::max((float)0.0, min_frequency));
78
79 std::map<String, uint> counter;
80 typedef std::vector<String> KeysType;
81 KeysType keys;
82 for (typename T_In::const_iterator it = it_start; it != it_end; ++it)
83 {
84 it->getKeys(keys);
85 for (KeysType::const_iterator itk = keys.begin(); itk != keys.end(); ++itk)
86 {
87 ++counter[*itk];
88 }
89 }
90 // pick the keys which occur often enough
91 const uint required_counts = uint(min_frequency / 100.0 * std::distance(it_start, it_end));
92 T_Out common_keys;
93 for (std::map<String, uint>::const_iterator it = counter.begin(); it != counter.end(); ++it)
94 {
95 if (it->second >= required_counts)
96 {
97 common_keys.insert(common_keys.end(), it->first);
98 }
99 }
100 return common_keys;
101 }
102
103 private:
105 MetaInfoInterfaceUtils();
106 MetaInfoInterfaceUtils(const MetaInfoInterfaceUtils&);
107 MetaInfoInterfaceUtils& operator=(MetaInfoInterfaceUtils&);
108 // no Move semantics for utils class
109
110 }; // class
111
112 } // namespace OPENMS
113
OpenMS::MetaInfoInterfaceUtils
Utilities operating on containers inheriting from MetaInfoInterface.
Definition: MetaInfoInterfaceUtils.h:52
String.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::MetaInfoInterfaceUtils::operator=
MetaInfoInterfaceUtils & operator=(MetaInfoInterfaceUtils &)
OpenMS::MetaInfoInterfaceUtils::findCommonMetaKeys
static T_Out findCommonMetaKeys(const typename T_In::const_iterator &it_start, const typename T_In::const_iterator &it_end, float min_frequency)
Find keys in a collection of MetaInfoInterface objects which reach a certain frequency threshold...
Definition: MetaInfoInterfaceUtils.h:74
OpenMS::MetaInfoInterfaceUtils::MetaInfoInterfaceUtils
MetaInfoInterfaceUtils()
hide c&#39;tors to avoid instantiation of utils class