3
<TITLE>MassDecomposer.h Source File</TITLE>
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
7
<BODY BGCOLOR="#FFFFFF">
8
<A href="index.html">Home</A> ·
9
<A href="classes.html">Classes</A> ·
10
<A href="annotated.html">Annotated Classes</A> ·
11
<A href="modules.html">Modules</A> ·
12
<A href="functions_func.html">Members</A> ·
13
<A href="namespaces.html">Namespaces</A> ·
14
<A href="pages.html">Related Pages</A>
15
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
16
<!-- Generated by Doxygen 1.8.5 -->
17
<div id="nav-path" class="navpath">
19
<li class="navelem"><a class="el" href="dir_e770f0cf77e550adde3f44739ef529fe.html">include</a></li><li class="navelem"><a class="el" href="dir_6a63c4937d4da007e55fff5dcf71e0f8.html">OpenMS</a></li><li class="navelem"><a class="el" href="dir_5f4b1c13d07405f47ee611fa1c92df17.html">CHEMISTRY</a></li><li class="navelem"><a class="el" href="dir_b0236496b069f9a5bb167765bff837cf.html">MASSDECOMPOSITION</a></li><li class="navelem"><a class="el" href="dir_e5ce06617876553ec904e1435a0fb40c.html">IMS</a></li> </ul>
23
<div class="headertitle">
24
<div class="title">MassDecomposer.h</div> </div>
26
<div class="contents">
27
<a href="MassDecomposer_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
28
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// OpenMS -- Open-Source Mass Spectrometry</span></div>
29
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
30
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,</span></div>
31
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// ETH Zurich, and Freie Universitaet Berlin 2002-2013.</span></div>
32
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div>
33
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// This software is released under a three-clause BSD license:</span></div>
34
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// * Redistributions of source code must retain the above copyright</span></div>
35
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// notice, this list of conditions and the following disclaimer.</span></div>
36
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// * Redistributions in binary form must reproduce the above copyright</span></div>
37
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// notice, this list of conditions and the following disclaimer in the</span></div>
38
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// documentation and/or other materials provided with the distribution.</span></div>
39
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// * Neither the name of any author or any participating institution</span></div>
40
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// may be used to endorse or promote products derived from this software</span></div>
41
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// without specific prior written permission.</span></div>
42
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// For a full list of authors, refer to the file AUTHORS.</span></div>
43
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
44
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div>
45
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
46
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
47
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING</span></div>
48
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div>
49
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div>
50
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;</span></div>
51
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span></div>
52
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR</span></div>
53
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF</span></div>
54
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
55
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">//</span></div>
56
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
57
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// $Maintainer: Stephan Aiche $</span></div>
58
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// $Authors: Anton Pervukhin <Anton.Pervukhin@CeBiTec.Uni-Bielefeld.DE> $</span></div>
59
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
60
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">//</span></div>
61
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
62
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#ifndef OPENMS_CHEMISTRY_MASSDECOMPOSITION_IMS_MASSDECOMPOSER_H</span></div>
63
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor">#define OPENMS_CHEMISTRY_MASSDECOMPOSITION_IMS_MASSDECOMPOSER_H</span></div>
64
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span></div>
65
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <vector></span></div>
66
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
67
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">namespace </span>OpenMS</div>
68
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div>
69
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
70
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">namespace </span>ims</div>
71
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  {</div>
72
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> ValueType,</div>
73
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">typename</span> DecompositionValueType></div>
74
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classOpenMS_1_1ims_1_1MassDecomposer.html"> 68</a></span>  <span class="keyword">class </span><a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html">MassDecomposer</a></div>
75
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div>
76
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">public</span>:</div>
77
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7e925095614a18db84f21a0de507edb5"> 74</a></span>  <span class="keyword">typedef</span> ValueType <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7e925095614a18db84f21a0de507edb5">value_type</a>;</div>
78
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
79
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7346a87f8ad822456061ff74cbaffa3b"> 79</a></span>  <span class="keyword">typedef</span> DecompositionValueType <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7346a87f8ad822456061ff74cbaffa3b">decomposition_value_type</a>;</div>
80
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
81
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classOpenMS_1_1ims_1_1MassDecomposer.html#ad16c2b9e2e514b3fa56f73f3fb95b2b5"> 84</a></span>  <span class="keyword">typedef</span> std::vector<decomposition_value_type> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#ad16c2b9e2e514b3fa56f73f3fb95b2b5">decomposition_type</a>;</div>
82
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
83
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classOpenMS_1_1ims_1_1MassDecomposer.html#aa2fe611aa3c8baa38be4ee3ddfa2d524"> 89</a></span>  <span class="keyword">typedef</span> std::vector<decomposition_type> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#aa2fe611aa3c8baa38be4ee3ddfa2d524">decompositions_type</a>;</div>
84
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
85
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a8c974cf8f3ade06e2840ee7728bac9a5"> 94</a></span>  <span class="keyword">virtual</span> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a8c974cf8f3ade06e2840ee7728bac9a5">~MassDecomposer</a>(){}</div>
86
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
87
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a028724be9d84a1f492dc5496fddc55c0">exist</a>(<a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7e925095614a18db84f21a0de507edb5">value_type</a> mass) = 0;</div>
88
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
89
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">virtual</span> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#ad16c2b9e2e514b3fa56f73f3fb95b2b5">decomposition_type</a> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a1680ab02b48557077a890c601099a0f5">getDecomposition</a>(<a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7e925095614a18db84f21a0de507edb5">value_type</a> mass) = 0;</div>
90
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div>
91
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">virtual</span> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#aa2fe611aa3c8baa38be4ee3ddfa2d524">decompositions_type</a> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a922ed56cc14234f7f6f12835df45724e">getAllDecompositions</a>(<a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7e925095614a18db84f21a0de507edb5">value_type</a> mass) = 0;</div>
92
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
93
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">virtual</span> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7346a87f8ad822456061ff74cbaffa3b">decomposition_value_type</a> <a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a6170b130bd0bcb1fc159deacbfb0963c">getNumberOfDecompositions</a>(<a class="code" href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7e925095614a18db84f21a0de507edb5">value_type</a> mass) = 0;</div>
94
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div>
95
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  };</div>
96
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
97
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  } <span class="comment">// namespace ims</span></div>
98
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> } <span class="comment">// namespace OpenMS</span></div>
99
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
100
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif //OPENMS_CHEMISTRY_MASSDECOMPOSITION_IMS_MASSDECOMPOSER_H</span></div>
101
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html_a1680ab02b48557077a890c601099a0f5"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html#a1680ab02b48557077a890c601099a0f5">OpenMS::ims::MassDecomposer::getDecomposition</a></div><div class="ttdeci">virtual decomposition_type getDecomposition(value_type mass)=0</div></div>
102
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html_a7e925095614a18db84f21a0de507edb5"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7e925095614a18db84f21a0de507edb5">OpenMS::ims::MassDecomposer::value_type</a></div><div class="ttdeci">ValueType value_type</div><div class="ttdef"><b>Definition:</b> MassDecomposer.h:74</div></div>
103
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html_a6170b130bd0bcb1fc159deacbfb0963c"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html#a6170b130bd0bcb1fc159deacbfb0963c">OpenMS::ims::MassDecomposer::getNumberOfDecompositions</a></div><div class="ttdeci">virtual decomposition_value_type getNumberOfDecompositions(value_type mass)=0</div></div>
104
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html_ad16c2b9e2e514b3fa56f73f3fb95b2b5"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html#ad16c2b9e2e514b3fa56f73f3fb95b2b5">OpenMS::ims::MassDecomposer::decomposition_type</a></div><div class="ttdeci">std::vector< decomposition_value_type > decomposition_type</div><div class="ttdef"><b>Definition:</b> MassDecomposer.h:84</div></div>
105
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html_a922ed56cc14234f7f6f12835df45724e"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html#a922ed56cc14234f7f6f12835df45724e">OpenMS::ims::MassDecomposer::getAllDecompositions</a></div><div class="ttdeci">virtual decompositions_type getAllDecompositions(value_type mass)=0</div></div>
106
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html_aa2fe611aa3c8baa38be4ee3ddfa2d524"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html#aa2fe611aa3c8baa38be4ee3ddfa2d524">OpenMS::ims::MassDecomposer::decompositions_type</a></div><div class="ttdeci">std::vector< decomposition_type > decompositions_type</div><div class="ttdef"><b>Definition:</b> MassDecomposer.h:89</div></div>
107
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html_a028724be9d84a1f492dc5496fddc55c0"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html#a028724be9d84a1f492dc5496fddc55c0">OpenMS::ims::MassDecomposer::exist</a></div><div class="ttdeci">virtual bool exist(value_type mass)=0</div></div>
108
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html">OpenMS::ims::MassDecomposer</a></div><div class="ttdoc">An inteface to handle decomposing of integer values/masses over a set of integer weights (alphabet)...</div><div class="ttdef"><b>Definition:</b> MassDecomposer.h:68</div></div>
109
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html_a8c974cf8f3ade06e2840ee7728bac9a5"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html#a8c974cf8f3ade06e2840ee7728bac9a5">OpenMS::ims::MassDecomposer::~MassDecomposer</a></div><div class="ttdeci">virtual ~MassDecomposer()</div><div class="ttdef"><b>Definition:</b> MassDecomposer.h:94</div></div>
110
<div class="ttc" id="classOpenMS_1_1ims_1_1MassDecomposer_html_a7346a87f8ad822456061ff74cbaffa3b"><div class="ttname"><a href="classOpenMS_1_1ims_1_1MassDecomposer.html#a7346a87f8ad822456061ff74cbaffa3b">OpenMS::ims::MassDecomposer::decomposition_value_type</a></div><div class="ttdeci">DecompositionValueType decomposition_value_type</div><div class="ttdef"><b>Definition:</b> MassDecomposer.h:79</div></div>
111
</div><!-- fragment --></div><!-- contents -->
112
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
113
<TABLE width="100%" border="0">
115
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
116
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:16 using doxygen 1.8.5</font></TD>