OpenMS  3.0.0
RealMassDecomposer.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: Timo Sachsenberg $
32 // $Authors: Anton Pervukhin <Anton.Pervukhin@CeBiTec.Uni-Bielefeld.DE> $
33 // --------------------------------------------------------------------------
34 //
35 
36 #pragma once
37 
38 #include <utility>
39 #include <map>
40 #include <memory>
41 
43 
44 namespace OpenMS
45 {
46  namespace ims
47  {
48 
67  class OPENMS_DLLAPI RealMassDecomposer
68  {
69 public:
70 
73 
76 
79 
81  typedef unsigned long long number_of_decompositions_type;
82 
83  typedef std::map<unsigned int, std::pair<unsigned int, unsigned int> > constraints_type;
84 
90  explicit RealMassDecomposer(const Weights & weights);
91 
99  decompositions_type getDecompositions(double mass, double error);
100 
101  decompositions_type getDecompositions(double mass, double error, const constraints_type & constraints);
102 
112  number_of_decompositions_type getNumberOfDecompositions(double mass, double error);
113 
114 private:
117 
119  std::pair<double, double> rounding_errors_;
120 
122  double precision_;
123 
128  std::shared_ptr<integer_decomposer_type> decomposer_;
129  };
130 
131  } // namespace ims
132 } // namespace OpenMS
133 
OpenMS::ims::IntegerMassDecomposer::value_type
MassDecomposer< ValueType, DecompositionValueType >::value_type value_type
Type of value to be decomposed.
Definition: IntegerMassDecomposer.h:75
OpenMS::ims::RealMassDecomposer::integer_value_type
integer_decomposer_type::value_type integer_value_type
Type of integer values that are decomposed.
Definition: RealMassDecomposer.h:75
OpenMS::ims::RealMassDecomposer::precision_
double precision_
Precision to scale double values to integer.
Definition: RealMassDecomposer.h:122
OpenMS::ims::RealMassDecomposer::weights_
Weights weights_
Weights over which values/masses to be decomposed.
Definition: RealMassDecomposer.h:116
OpenMS::ims::RealMassDecomposer::rounding_errors_
std::pair< double, double > rounding_errors_
Minimal and maximal rounding errors.
Definition: RealMassDecomposer.h:119
OpenMS::ims::IntegerMassDecomposer::decompositions_type
MassDecomposer< ValueType, DecompositionValueType >::decompositions_type decompositions_type
Type of container for many decompositions.
Definition: IntegerMassDecomposer.h:84
OpenMS::ims::Weights
Represents a set of weights (double values and scaled with a certain precision their integer counterp...
Definition: Weights.h:67
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::ims::RealMassDecomposer::integer_decomposer_type
IntegerMassDecomposer integer_decomposer_type
Type of integer decomposer.
Definition: RealMassDecomposer.h:72
OpenMS::ims::RealMassDecomposer::decompositions_type
integer_decomposer_type::decompositions_type decompositions_type
Type of result decompositions from integer decomposer.
Definition: RealMassDecomposer.h:78
OpenMS::ims::RealMassDecomposer::decomposer_
std::shared_ptr< integer_decomposer_type > decomposer_
Definition: RealMassDecomposer.h:128
IntegerMassDecomposer.h
OpenMS::ims::IntegerMassDecomposer
Implements MassDecomposer interface using algorithm and data structures described in paper "Efficient...
Definition: IntegerMassDecomposer.h:70
OpenMS::ims::RealMassDecomposer::number_of_decompositions_type
unsigned long long number_of_decompositions_type
Type of the number of decompositions.
Definition: RealMassDecomposer.h:81
OpenMS::ims::RealMassDecomposer
Handles decomposing of non-integer values/masses over a set of non-integer weights with an error allo...
Definition: RealMassDecomposer.h:67
OpenMS::ims::RealMassDecomposer::constraints_type
std::map< unsigned int, std::pair< unsigned int, unsigned int > > constraints_type
Definition: RealMassDecomposer.h:83