| OpenMS 2.5.0

PrecisionWrapper.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: Marc Sturm, Clemens Groepl $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/config.h>
38 #include <OpenMS/CONCEPT/Types.h>
39 #include <OpenMS/DATASTRUCTURES/String.h>
40 #include <iostream>
41
42 namespace OpenMS
43 {
44
48 template <typename FloatingPointType>
49 struct PrecisionWrapper
50 {
52 explicit PrecisionWrapper(const FloatingPointType rhs) :
53 ref_(rhs) {}
54 PrecisionWrapper(const PrecisionWrapper & rhs) :
55 ref_(rhs.ref_) {}
56 FloatingPointType const ref_;
57 private:
58 PrecisionWrapper(); // intentionally not implemented
59 };
60
94 template <typename FloatingPointType>
95 inline const PrecisionWrapper<FloatingPointType> precisionWrapper(const FloatingPointType rhs)
96 {
97 return PrecisionWrapper<FloatingPointType>(rhs);
98 }
99
101 template <typename FloatingPointType>
102 inline std::ostream & operator<<(std::ostream & os, const PrecisionWrapper<FloatingPointType> & rhs)
103 {
104 // manual conversion to String is much faster than ostreams internal conversion
105 // (this calls the correct overload for extra precision)
106 String s(rhs.ref_, true);
107 os << s;
108 return os;
109 }
110 } // namespace OpenMS
111
OpenMS::PrecisionWrapper::PrecisionWrapper
PrecisionWrapper()
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::PrecisionWrapper
Wrapper class to implement output with appropriate precision. See precisionWrapper().
Definition: PrecisionWrapper.h:49
Types.h
OpenMS::precisionWrapper
const PrecisionWrapper< FloatingPointType > precisionWrapper(const FloatingPointType rhs)
Wrapper function that sets the appropriate precision for output temporarily. The original precision i...
Definition: PrecisionWrapper.h:95
String.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::PrecisionWrapper::PrecisionWrapper
PrecisionWrapper(const PrecisionWrapper &rhs)
Definition: PrecisionWrapper.h:54
OpenMS::PrecisionWrapper::ref_
FloatingPointType const ref_
Definition: PrecisionWrapper.h:56
OpenMS::PrecisionWrapper::PrecisionWrapper
PrecisionWrapper(const FloatingPointType rhs)
Constructor. Note: Normally you will prefer to use the "make"-function precisionWrapper(), which see.
Definition: PrecisionWrapper.h:52