NumericType.h

Go to the documentation of this file.

/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000-2009 Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

    See STIR/LICENSE.txt for details
*/

#ifndef __stir_NumericType_H__
#define __stir_NumericType_H__

/*
  Modification History:

  - first version by Kris Thielemans

  - KT 28/07/98
  added two methods to NumericType:
  inline bool signed_type() const;
  inline bool integer_type() const;

  - KT 15/12/99
  removed inlining. Gave troubles with gcc on NT.
  added method that returns Interfile info

  - KT 15/07/04
  added TypeForNumericType
*/

#include "stir/common.h"
#include <string>

START_NAMESPACE_STIR

class NumericType
{
public:
  // BIT has to be the first type, and UNKNOWN_TYPE has to be
  // the last name for the implementation of the 2nd NumericType constructor
  // to work
  enum Type
  {
    BIT,
    SCHAR,
    UCHAR,
    SHORT,
    USHORT,
    INT,
    UINT,
    LONG,
    ULONG,
    FLOAT,
    DOUBLE,
    UNKNOWN_TYPE
  };

  Type id;

  inline NumericType(Type t = UNKNOWN_TYPE);


  NumericType(const std::string& number_format, const std::size_t size_in_bytes);

  inline bool operator==(NumericType type) const;
  inline bool operator!=(NumericType type) const;

  std::size_t size_in_bytes() const;

  std::size_t size_in_bits() const;

  bool signed_type() const;

  bool integer_type() const;

  void get_Interfile_info(std::string& number_format, std::size_t& size_in_bytes) const;
};

template <int numeric_type_enum>
struct TypeForNumericType
{
};

#ifndef DOXYGEN_SKIP // disable definitions when running doxygen to avoid having all of this in the doc
template <>
struct TypeForNumericType<NumericType::SCHAR>
{
  typedef signed char type;
};
template <>
struct TypeForNumericType<NumericType::UCHAR>
{
  typedef unsigned char type;
};
template <>
struct TypeForNumericType<NumericType::SHORT>
{
  typedef signed short type;
};
template <>
struct TypeForNumericType<NumericType::USHORT>
{
  typedef unsigned short type;
};
template <>
struct TypeForNumericType<NumericType::INT>
{
  typedef signed int type;
};
template <>
struct TypeForNumericType<NumericType::UINT>
{
  typedef unsigned int type;
};
template <>
struct TypeForNumericType<NumericType::LONG>
{
  typedef signed long type;
};
template <>
struct TypeForNumericType<NumericType::ULONG>
{
  typedef unsigned long type;
};
template <>
struct TypeForNumericType<NumericType::FLOAT>
{
  typedef float type;
};
template <>
struct TypeForNumericType<NumericType::DOUBLE>
{
  typedef double type;
};
#endif

END_NAMESPACE_STIR

#include "stir/NumericType.inl"

#endif