| OpenMS 2.5.0

QueryMatchGroup.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: Hendrik Weisser $
32 // $Authors: Hendrik Weisser $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/METADATA/ID/MoleculeQueryMatch.h>
38
39 #include <boost/multi_index_container.hpp>
40 #include <boost/multi_index/ordered_index.hpp>
41
42 namespace OpenMS
43 {
44 namespace IdentificationDataInternal
45 {
50 struct QueryMatchGroup: public ScoredProcessingResult
51 {
52 std::set<QueryMatchRef> query_match_refs;
53
54 bool allSameMolecule() const
55 {
56 // @TODO: return true or false for the empty set?
57 if (query_match_refs.size() <= 1) return true;
58 const IdentifiedMoleculeRef ref =
59 (*query_match_refs.begin())->identified_molecule_ref;
60 for (auto it = ++query_match_refs.begin(); it != query_match_refs.end();
61 ++it)
62 {
63 if (!((*it)->identified_molecule_ref == ref)) return false;
64 }
65 return true;
66 }
67
68 bool allSameQuery() const
69 {
70 // @TODO: return true or false for the empty set?
71 if (query_match_refs.size() <= 1) return true;
72 DataQueryRef ref = (*query_match_refs.begin())->data_query_ref;
73 for (auto it = ++query_match_refs.begin(); it != query_match_refs.end();
74 ++it)
75 {
76 if ((*it)->data_query_ref != ref) return false;
77 }
78 return true;
79 }
80
81 bool operator==(const QueryMatchGroup rhs) const
82 {
83 return ((rhs.query_match_refs == query_match_refs) &&
84 (rhs.steps_and_scores == steps_and_scores));
85 }
86
87 bool operator!=(const QueryMatchGroup& rhs) const
88 {
89 return !operator==(rhs);
90 }
91 };
92
93 typedef boost::multi_index_container<
94 QueryMatchGroup,
95 boost::multi_index::indexed_by<
96 boost::multi_index::ordered_unique<
97 boost::multi_index::member<QueryMatchGroup, std::set<QueryMatchRef>,
98 &QueryMatchGroup::query_match_refs>>>
99 > QueryMatchGroups;
100 typedef IteratorWrapper<QueryMatchGroups::iterator> MatchGroupRef;
101
102 }
103 }
MoleculeQueryMatch.h
OpenMS::IdentificationDataInternal::QueryMatchGroup::query_match_refs
std::set< QueryMatchRef > query_match_refs
Definition: QueryMatchGroup.h:52
OpenMS::IdentificationDataInternal::MatchGroupRef
IteratorWrapper< QueryMatchGroups::iterator > MatchGroupRef
Definition: QueryMatchGroup.h:100
OpenMS::IdentificationDataInternal::QueryMatchGroup::allSameQuery
bool allSameQuery() const
Definition: QueryMatchGroup.h:68
OpenMS::IdentificationDataInternal::IteratorWrapper< DataQueries::iterator >
OpenMS::IdentificationDataInternal::IdentifiedMoleculeRef
boost::variant< IdentifiedPeptideRef, IdentifiedCompoundRef, IdentifiedOligoRef > IdentifiedMoleculeRef
Definition: MoleculeQueryMatch.h:57
OpenMS::IdentificationDataInternal::QueryMatchGroup::operator==
bool operator==(const QueryMatchGroup rhs) const
Definition: QueryMatchGroup.h:81
OpenMS::IdentificationDataInternal::ScoredProcessingResult
Base class for ID data with scores and processing steps (and meta info)
Definition: ScoredProcessingResult.h:44
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::IdentificationDataInternal::ScoredProcessingResult::steps_and_scores
AppliedProcessingSteps steps_and_scores
Definition: ScoredProcessingResult.h:46
OpenMS::IdentificationDataInternal::QueryMatchGroup
: Group of related (co-identified) molecule-query matches
Definition: QueryMatchGroup.h:50
OpenMS::IdentificationDataInternal::QueryMatchGroups
boost::multi_index_container< QueryMatchGroup, boost::multi_index::indexed_by< boost::multi_index::ordered_unique< boost::multi_index::member< QueryMatchGroup, std::set< QueryMatchRef >, &QueryMatchGroup::query_match_refs > > > > QueryMatchGroups
Definition: QueryMatchGroup.h:99
OpenMS::IdentificationDataInternal::QueryMatchGroup::operator!=
bool operator!=(const QueryMatchGroup &rhs) const
Definition: QueryMatchGroup.h:87
OpenMS::IdentificationDataInternal::QueryMatchGroup::allSameMolecule
bool allSameMolecule() const
Definition: QueryMatchGroup.h:54