← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to include/OpenMS/KERNEL/DPeak.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/KERNEL/DPeak.h
1
 
// -*- mode: C++; tab-width: 2; -*-
2
 
// vi: set ts=2:
3
 
//
4
 
// --------------------------------------------------------------------------
5
 
//                   OpenMS Mass Spectrometry Framework
6
 
// --------------------------------------------------------------------------
7
 
//  Copyright (C) 2003-2011 -- Oliver Kohlbacher, Knut Reinert
8
 
//
9
 
//  This library is free software; you can redistribute it and/or
10
 
//  modify it under the terms of the GNU Lesser General Public
11
 
//  License as published by the Free Software Foundation; either
12
 
//  version 2.1 of the License, or (at your option) any later version.
13
 
//
14
 
//  This library is distributed in the hope that it will be useful,
15
 
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17
 
//  Lesser General Public License for more details.
18
 
//
19
 
//  You should have received a copy of the GNU Lesser General Public
20
 
//  License along with this library; if not, write to the Free Software
21
 
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
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-2013.
 
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.
22
29
//
23
30
// --------------------------------------------------------------------------
24
31
// $Maintainer: Clemens Groepl $
33
40
 
34
41
namespace OpenMS
35
42
{
36
 
        
37
 
        /**
38
 
                @brief Metafunction to choose among Peak1D respectively Peak2D through a template argument.
39
 
                
40
 
                The result is accessible via typedef Type:
41
 
                - @c DPeak<1>::Type is @c Peak1D
42
 
                - @c DPeak<2>::Type is @c Peak2D
43
 
        
44
 
                Example:
45
 
          @code
46
 
                template class BaseModel<UInt D>
47
 
                {
48
 
                        // BaseModel<D>::PeakType is either Peak1D or Peak2D, depending on D
49
 
                        typedef typename DPeak<D>::Type PeakType;
50
 
                };
51
 
                @endcode
52
 
        */
53
 
        template <UInt dimensions>
54
 
        struct DPeak
55
 
        {
56
 
        };
57
 
 
58
 
        // We do not want these classes to show up in the docu
59
 
        /// @cond HIDDENSTUFF
60
 
        
61
 
        template <>
62
 
        struct DPeak <1>
63
 
        {
64
 
                typedef Peak1D Type;
65
 
        };
66
 
 
67
 
        template <>
68
 
        struct DPeak <2>
69
 
        {
70
 
                typedef Peak2D Type;
71
 
        };
72
 
 
73
 
        /// @endcond
 
43
 
 
44
  /**
 
45
    @brief Metafunction to choose among Peak1D respectively Peak2D through a template argument.
 
46
 
 
47
    The result is accessible via typedef Type:
 
48
      - @c DPeak<1>::Type is @c Peak1D
 
49
      - @c DPeak<2>::Type is @c Peak2D
 
50
 
 
51
    Example:
 
52
    @code
 
53
      template class BaseModel<UInt D>
 
54
      {
 
55
          // BaseModel<D>::PeakType is either Peak1D or Peak2D, depending on D
 
56
          typedef typename DPeak<D>::Type PeakType;
 
57
      };
 
58
    @endcode
 
59
  */
 
60
  template <UInt dimensions>
 
61
  struct DPeak
 
62
  {};
 
63
 
 
64
  // We do not want these classes to show up in the docu
 
65
  /// @cond HIDDENSTUFF
 
66
 
 
67
  template <>
 
68
  struct DPeak<1>
 
69
  {
 
70
    typedef Peak1D Type;
 
71
  };
 
72
 
 
73
  template <>
 
74
  struct DPeak<2>
 
75
  {
 
76
    typedef Peak2D Type;
 
77
  };
 
78
 
 
79
  /// @endcond
74
80
 
75
81
} // namespace OpenMS
76
82