OpenMS  3.0.0
ObservationMatchGroup.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-2022.
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 
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  {
51  {
52  std::set<ObservationMatchRef> observation_match_refs;
53 
54  bool allSameMolecule() const
55  {
56  // @TODO: return true or false for the empty set?
57  if (observation_match_refs.size() <= 1) return true;
58  const IdentifiedMolecule var =
59  (*observation_match_refs.begin())->identified_molecule_var;
60  for (auto it = ++observation_match_refs.begin();
61  it != observation_match_refs.end(); ++it)
62  {
63  if (!((*it)->identified_molecule_var == var)) 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 (observation_match_refs.size() <= 1) return true;
72  ObservationRef ref = (*observation_match_refs.begin())->observation_ref;
73  for (auto it = ++observation_match_refs.begin();
74  it != observation_match_refs.end(); ++it)
75  {
76  if ((*it)->observation_ref != ref) return false;
77  }
78  return true;
79  }
80 
81  bool operator==(const ObservationMatchGroup rhs) const
82  {
85  }
86 
87  bool operator!=(const ObservationMatchGroup& rhs) const
88  {
89  return !operator==(rhs);
90  }
91  };
92 
93  typedef boost::multi_index_container<
94  ObservationMatchGroup,
95  boost::multi_index::indexed_by<
96  boost::multi_index::ordered_unique<
97  boost::multi_index::member<ObservationMatchGroup, std::set<ObservationMatchRef>,
101  }
102 }
OpenMS::IdentificationDataInternal::ObservationMatchGroup::allSameQuery
bool allSameQuery() const
Definition: ObservationMatchGroup.h:68
OpenMS::IdentificationDataInternal::ObservationMatchGroup::observation_match_refs
std::set< ObservationMatchRef > observation_match_refs
Definition: ObservationMatchGroup.h:52
OpenMS::IdentificationDataInternal::IdentifiedMolecule
Variant type holding Peptide/Compound/Oligo references and convenience functions.
Definition: IdentifiedMolecule.h:54
OpenMS::IdentificationDataInternal::ScoredProcessingResult::steps_and_scores
AppliedProcessingSteps steps_and_scores
Definition: ScoredProcessingResult.h:46
OpenMS::IdentificationDataInternal::ObservationMatchGroup
: Group of related (co-identified) input matches
Definition: ObservationMatchGroup.h:50
OpenMS::IdentificationDataInternal::ObservationMatchGroup::operator==
bool operator==(const ObservationMatchGroup rhs) const
Definition: ObservationMatchGroup.h:81
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::IdentificationDataInternal::IteratorWrapper< Observations::iterator >
OpenMS::IdentificationDataInternal::ObservationMatchGroup::allSameMolecule
bool allSameMolecule() const
Definition: ObservationMatchGroup.h:54
OpenMS::IdentificationDataInternal::ScoredProcessingResult
Base class for ID data with scores and processing steps (and meta info)
Definition: ScoredProcessingResult.h:44
OpenMS::IdentificationDataInternal::MatchGroupRef
IteratorWrapper< ObservationMatchGroups::iterator > MatchGroupRef
Definition: ObservationMatchGroup.h:100
OpenMS::IdentificationDataInternal::ObservationMatchGroup::operator!=
bool operator!=(const ObservationMatchGroup &rhs) const
Definition: ObservationMatchGroup.h:87
OpenMS::IdentificationDataInternal::ObservationMatchGroups
boost::multi_index_container< ObservationMatchGroup, boost::multi_index::indexed_by< boost::multi_index::ordered_unique< boost::multi_index::member< ObservationMatchGroup, std::set< ObservationMatchRef >, &ObservationMatchGroup::observation_match_refs > > > > ObservationMatchGroups
Definition: ObservationMatchGroup.h:99
ObservationMatch.h