| OpenMS 2.5.0

MassDecomposer.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: Timo Sachsenberg $
32 // $Authors: Anton Pervukhin <Anton.Pervukhin@CeBiTec.Uni-Bielefeld.DE> $
33 // --------------------------------------------------------------------------
34 //
35
36 #pragma once
37
38 #include <vector>
39
40 namespace OpenMS
41 {
42
43 namespace ims
44 {
65 template <typename ValueType,
66 typename DecompositionValueType>
67 class MassDecomposer
68 {
69 public:
73 typedef ValueType value_type;
74
78 typedef DecompositionValueType decomposition_value_type;
79
83 typedef std::vector<decomposition_value_type> decomposition_type;
84
88 typedef std::vector<decomposition_type> decompositions_type;
89
93 virtual ~MassDecomposer(){}
94
101 virtual bool exist(value_type mass) = 0;
102
109 virtual decomposition_type getDecomposition(value_type mass) = 0;
110
118 virtual decompositions_type getAllDecompositions(value_type mass) = 0;
119
126 virtual decomposition_value_type getNumberOfDecompositions(value_type mass) = 0;
127
128 };
129
130 } // namespace ims
131 } // namespace OpenMS
132
OpenMS::ims::MassDecomposer::getAllDecompositions
virtual decompositions_type getAllDecompositions(value_type mass)=0
OpenMS::ims::MassDecomposer::value_type
ValueType value_type
Definition: MassDecomposer.h:73
OpenMS::ims::MassDecomposer::decompositions_type
std::vector< decomposition_type > decompositions_type
Definition: MassDecomposer.h:88
OpenMS::ims::MassDecomposer::decomposition_type
std::vector< decomposition_value_type > decomposition_type
Definition: MassDecomposer.h:83
OpenMS::ims::MassDecomposer::getNumberOfDecompositions
virtual decomposition_value_type getNumberOfDecompositions(value_type mass)=0
OpenMS::ims::MassDecomposer
An interface to handle decomposing of integer values/masses over a set of integer weights (alphabet)...
Definition: MassDecomposer.h:67
OpenMS::ims::MassDecomposer::decomposition_value_type
DecompositionValueType decomposition_value_type
Definition: MassDecomposer.h:78
OpenMS::ims::MassDecomposer::~MassDecomposer
virtual ~MassDecomposer()
Definition: MassDecomposer.h:93
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::ims::MassDecomposer::getDecomposition
virtual decomposition_type getDecomposition(value_type mass)=0
OpenMS::ims::MassDecomposer::exist
virtual bool exist(value_type mass)=0