Types.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2012.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Oliver Kohlbacher $
// $Authors: Marc Sturm, Clemens Groepl $
// --------------------------------------------------------------------------

#ifndef OPENMS_CONCEPT_TYPES_H
#define OPENMS_CONCEPT_TYPES_H

#include <OpenMS/config.h>

#include <limits>
#include <cstddef> // for size_t
#include <ctime>
#include <cmath>
#include <string>
#include <iostream>
#include <iomanip>

// If possible use the ISO C99-compliant header stdint.h
// to define the portable integer types.
#ifdef OPENMS_HAS_STDINT_H
#include <stdint.h>
#endif

namespace OpenMS
{
  typedef OPENMS_INT32_TYPE Int32;

  typedef OPENMS_INT64_TYPE Int64;

  typedef OPENMS_UINT64_TYPE UInt64;

  typedef time_t  Time;

  //typedef size_t UInt;
  typedef unsigned int UInt;

  //typedef OPENMS_SIZE_T_SIGNED Int;
  typedef int Int;

  typedef float Real;

  typedef double DoubleReal;


  typedef OPENMS_BYTE_TYPE Byte;

  typedef OPENMS_UINT64_TYPE UID;

  typedef size_t Size;

  typedef ptrdiff_t SignedSize;

  enum ASCII
  {
    ASCII__BACKSPACE        = '\b',
    ASCII__BELL             = '\a',
    ASCII__CARRIAGE_RETURN  = '\r',
    ASCII__HORIZONTAL_TAB   = '\t',
    ASCII__NEWLINE          = '\n',
    ASCII__RETURN           = ASCII__NEWLINE,
    ASCII__SPACE            = ' ',
    ASCII__TAB              = ASCII__HORIZONTAL_TAB,
    ASCII__VERTICAL_TAB     = '\v',

    ASCII__COLON            = ':',
    ASCII__COMMA            = ',',
    ASCII__EXCLAMATION_MARK = '!',
    ASCII__POINT            = '.',
    ASCII__QUESTION_MARK    = '?',
    ASCII__SEMICOLON        = ';'
  };



  template <typename FloatingPointType>
  inline Int writtenDigits(const FloatingPointType & /* unused */ = FloatingPointType());

  template <>
  inline Int writtenDigits<float>(const float &)
  {
    return std::numeric_limits<float>::digits10;
  }

  template <>
  inline Int writtenDigits<double>(const double &)
  {
    return std::numeric_limits<double>::digits10;
  }

  template <>
  inline Int writtenDigits<int>(const int &)
  {
    return std::numeric_limits<int>::digits10;
  }

  template <>
  inline Int writtenDigits<unsigned int>(const unsigned int &)
  {
    return std::numeric_limits<unsigned int>::digits10;
  }

  template <>
  inline Int writtenDigits<long int>(const long int &)
  {
    return std::numeric_limits<int>::digits10;
  }

  template <>
  inline Int writtenDigits<unsigned long int>(const unsigned long int &)
  {
    return std::numeric_limits<unsigned int>::digits10;
  }

  class DataValue;
  template <>
  inline Int writtenDigits<DataValue>(const DataValue &)
  {
    return std::numeric_limits<double>::digits10;
  }

  /*
  META-COMMENT:  DO NOT INTRODUCE ANY LINEBREAKS BELOW IN
  "<code>std::numeric_limits<long double>::digits10 == 18</code>".
  The doxygen parser (version 1.5.5) will get confused!  (Clemens)
  */

  template <>
  inline Int writtenDigits<long double>(const long double &)
  {
#ifndef OPENMS_WINDOWSPLATFORM
    return std::numeric_limits<long double>::digits10;

#else
    return std::numeric_limits<double>::digits10;

#endif
  }

  template <typename FloatingPointType>
  inline Int writtenDigits(const FloatingPointType & /* unused */)
  {
    // Self-explanatory compile time error!
    return FloatingPointType::Sorry_but_writtenDigits_is_designed_to_work_for_floating_point_types_only;
  }

  // Note: I once tried to move PrecisionWrapper to namespace Internal, but oops! operator <<  won't be found (through ADL?) anymore.
  template <typename FloatingPointType>
  struct PrecisionWrapper
  {
    PrecisionWrapper(const FloatingPointType rhs) :
      ref_(rhs) {}
    PrecisionWrapper(const PrecisionWrapper & rhs) :
      ref_(rhs.ref_) {}
    FloatingPointType const ref_;
private:
    PrecisionWrapper();     // intentionally not implemented
  };

  template <typename FloatingPointType>
  inline const PrecisionWrapper<FloatingPointType> precisionWrapper(const FloatingPointType rhs)
  {
    return PrecisionWrapper<FloatingPointType>(rhs);
  }

  template <typename FloatingPointType>
  inline std::ostream & operator<<(std::ostream & os, const PrecisionWrapper<FloatingPointType> & rhs)
  {
    // Same test as used by isnan(), spelled out here to avoid issues during overload resolution.
    if (rhs.ref_ != rhs.ref_)
    {
      // That's what Linux GCC uses, and gnuplot understands.
      // Windows would print stuff like 1.#QNAN which makes testing hard.
      return os << "nan";
    }
    else
    {
      const std::streamsize prec_save = os.precision();
      return os << std::setprecision(writtenDigits(FloatingPointType()))
             << rhs.ref_ << std::setprecision(prec_save);
    }
  }


  template <typename Type>
  std::string typeAsString(const Type & /* unused */ = Type())
  {
#ifndef OPENMS_COMPILER_GXX
    return "[ Sorry, OpenMS::typeAsString() relies upon GNU extension __PRETTY_FUNCTION__ ]";

#else
    std::string pretty(__PRETTY_FUNCTION__);
    static char const context_left[] = "with Type =";
    static char const context_right[] = "]";
    size_t left = pretty.find(context_left);
    left += sizeof(context_left);
    size_t right = pretty.rfind(context_right);
    if (right <= left)
      return pretty;                      // oops!

    return pretty.substr(left, right - left);

#endif
  }

  namespace Internal
  {
    extern OPENMS_DLLAPI const char * OpenMS_locale;
  }

} // namespace OpenMS

#endif // OPENMS_CONCEPT_TYPES_H