Tiny Vector Matrix library using Expression Templates

Sourceforge Project Page

---

include/tvmet/NumericTraits.h

Go to the documentation of this file.

/*
 * Tiny Vector Matrix Library
 * Dense Vector Matrix Libary of Tiny size using Expression Templates
 *
 * Copyright (C) 2001 - 2007 Olaf Petzold <opetzold@users.sourceforge.net>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * $Id: NumericTraits.h,v 1.16 2007-06-23 15:58:58 opetzold Exp $
 */

#ifndef TVMET_NUMERIC_TRAITS_H
#define TVMET_NUMERIC_TRAITS_H

#if defined(TVMET_HAVE_COMPLEX)
#  include <complex>
#endif
#include <cmath>
#include <limits>

#include <tvmet/CompileTimeError.h>


namespace tvmet {


template<class T>
struct NumericTraits {
  typedef T         base_type;
  typedef T         value_type;
  typedef value_type        sum_type;
  typedef value_type        diff_type;
  typedef value_type        float_type;
  typedef value_type        signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef const value_type&     argument_type;

  static inline
  base_type real(argument_type x);

  static inline
  base_type imag(argument_type x);

  static inline
  value_type conj(argument_type x);

  static inline
  base_type abs(argument_type x);

  static inline
  value_type sqrt(argument_type x);

  static inline
  base_type norm_1(argument_type x) {
    return NumericTraits<base_type>::abs(traits_type::real(x))
         + NumericTraits<base_type>::abs(traits_type::imag(x));
  }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) {
    return std::max(NumericTraits<base_type>::abs(traits_type::real(x)),
        NumericTraits<base_type>::abs(traits_type::imag(x)));
   }

  static inline
  bool equals(argument_type lhs, argument_type rhs) {
    static base_type sqrt_epsilon(
      NumericTraits<base_type>::sqrt(
        std::numeric_limits<base_type>::epsilon()));

    return traits_type::norm_inf(lhs - rhs) < sqrt_epsilon *
      std::max(std::max(traits_type::norm_inf(lhs),
      traits_type::norm_inf(rhs)),
         std::numeric_limits<base_type>::min());
  }
};


/*
 * numeric traits for standard types
 */


template<>
struct NumericTraits<char> {
  typedef char          value_type;
  typedef value_type        base_type;
  typedef long          sum_type;
  typedef int         diff_type;
  typedef float         float_type;
  typedef char          signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  value_type conj(argument_type x) { return x; }

  static inline
  base_type abs(argument_type x) { return std::abs(x); }

  static inline
  value_type sqrt(argument_type x) {
    return static_cast<value_type>(std::sqrt(static_cast<float_type>(x)));
  }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) { return lhs == rhs; }

  enum { is_complex = false };

  enum {
    ops_plus = 1, 
    ops_muls = 1  
  };
};


template<>
struct NumericTraits<unsigned char> {
  typedef unsigned char       value_type;
  typedef value_type        base_type;
  typedef unsigned long       sum_type;
  typedef int         diff_type;
  typedef float         float_type;
  typedef int         signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  base_type abs(argument_type x) { return std::abs(x); }

  static inline
  value_type sqrt(argument_type x) {
    return static_cast<value_type>(std::sqrt(static_cast<float_type>(x)));
  }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) { return lhs == rhs; }

  enum { is_complex = false };

  enum {
    ops_plus = 1, 
    ops_muls = 1  
  };
};


template<>
struct NumericTraits<short int> {
  typedef short int         value_type;
  typedef value_type        base_type;
#if defined(TVMET_HAVE_LONG_LONG)
  typedef long long       sum_type;
#else
  typedef long          sum_type;
#endif
  typedef int         diff_type;
  typedef float         float_type;
  typedef short int       signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  value_type conj(argument_type x) { return x; }

  static inline
  base_type abs(argument_type x) { return std::abs(x); }

  static inline
  value_type sqrt(argument_type x) {
    return static_cast<value_type>(std::sqrt(static_cast<float_type>(x)));
  }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) { return lhs == rhs; }

  enum { is_complex = false };

  enum {
    ops_plus = 1, 
    ops_muls = 1  
  };
};


template<>
struct NumericTraits<short unsigned int> {
  typedef short unsigned int      value_type;
  typedef value_type        base_type;
#if defined(TVMET_HAVE_LONG_LONG)
  typedef unsigned long long      sum_type;
#else
  typedef unsigned long       sum_type;
#endif
  typedef int           diff_type;
  typedef float         float_type;
  typedef int         signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  base_type abs(argument_type x) { return std::abs(x); }

  static inline
  value_type sqrt(argument_type x) {
    return static_cast<value_type>(std::sqrt(static_cast<float_type>(x)));
  }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) { return lhs == rhs; }

  enum { is_complex = false };

  enum {
    ops_plus = 1, 
    ops_muls = 1  
  };
};


template<>
struct NumericTraits<int> {
  typedef int           value_type;
  typedef value_type        base_type;
#if defined(TVMET_HAVE_LONG_LONG)
  typedef long long       sum_type;
#else
  typedef long          sum_type;
#endif
  typedef int         diff_type;
  typedef double        float_type;
  typedef int         signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  value_type conj(argument_type x) { return x; }

  static inline
  base_type abs(argument_type x) { return std::abs(x); }

  static inline
  value_type sqrt(argument_type x) {
    return static_cast<value_type>(std::sqrt(static_cast<float_type>(x)));
  }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) { return lhs == rhs; }

  enum { is_complex = false };

  enum {
    ops_plus = 1, 
    ops_muls = 1  
  };
};


template<>
struct NumericTraits<unsigned int> {
  typedef unsigned int        value_type;
  typedef value_type        base_type;
#if defined(TVMET_HAVE_LONG_LONG)
  typedef unsigned long long      sum_type;
#else
  typedef unsigned long       sum_type;
#endif
  typedef int           diff_type;
  typedef double        float_type;
  typedef long          signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  base_type abs(argument_type x) { return x; }

  static inline
  value_type sqrt(argument_type x) {
    return static_cast<value_type>(std::sqrt(static_cast<float_type>(x)));
  }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) { return lhs == rhs; }

  enum { is_complex = false };

  enum {
    ops_plus = 1, 
    ops_muls = 1  
  };
};


template<>
struct NumericTraits<long> {
  typedef long          value_type;
  typedef value_type        base_type;
#if defined(TVMET_HAVE_LONG_LONG)
  typedef long long       sum_type;
#else
  typedef long            sum_type;
#endif
  typedef long          diff_type;
  typedef double        float_type;
  typedef long          signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  value_type conj(argument_type x) { return x; }

  static inline
  base_type abs(argument_type x) { return std::abs(x); }

  static inline
  value_type sqrt(argument_type x) {
    return static_cast<value_type>(std::sqrt(static_cast<float_type>(x)));
  }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) { return lhs == rhs; }

  enum { is_complex = false };

  enum {
    ops_plus = 1, 
    ops_muls = 1  
  };
};


template<>
struct NumericTraits<unsigned long> {
  typedef unsigned long       value_type;
  typedef value_type        base_type;
#if defined(TVMET_HAVE_LONG_LONG)
  typedef unsigned long long      sum_type;
#else
  typedef unsigned long       sum_type;
#endif
  typedef unsigned long       diff_type;
  typedef double        float_type;
  typedef long          signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  base_type abs(argument_type x) { return x; }

  static inline
  value_type sqrt(argument_type x) {
    return static_cast<value_type>(std::sqrt(static_cast<float_type>(x)));
  }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) { return lhs == rhs; }

  enum { is_complex = false };

  enum {
    ops_plus = 1, 
    ops_muls = 1  
  };
};


template<>
struct NumericTraits<float> {
  typedef float         value_type;
  typedef value_type        base_type;
  typedef double        sum_type;
  typedef float         diff_type;
  typedef float         float_type;
  typedef float         signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  value_type conj(argument_type x) { return x; }

  static inline
  base_type abs(argument_type x) { return std::abs(x); }

  static inline
  value_type sqrt(argument_type x) { return std::sqrt(x); }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) {
    static base_type sqrt_epsilon(
      NumericTraits<base_type>::sqrt(
        std::numeric_limits<base_type>::epsilon()));

    return traits_type::norm_inf(lhs - rhs) < sqrt_epsilon *
      std::max(std::max(traits_type::norm_inf(lhs),
      traits_type::norm_inf(rhs)),
         std::numeric_limits<base_type>::min());
  }

  enum { is_complex = false };

  enum {
    ops_plus = 1, 
    ops_muls = 1  
  };
};


template<>
struct NumericTraits<double> {
  typedef double        value_type;
  typedef value_type        base_type;
#if defined(TVMET_HAVE_LONG_DOUBLE)
  typedef long double       sum_type;
#else
  typedef double        sum_type;
#endif
  typedef double        diff_type;
  typedef double        float_type;
  typedef double        signed_type;

  typedef NumericTraits<value_type>   traits_type;
  typedef value_type        argument_type;

  static inline
  base_type real(argument_type x) { return x; }

  static inline
  base_type imag(argument_type) { return 0; }

  static inline
  value_type conj(argument_type x) { return x; }

  static inline
  base_type abs(argument_type x) { return std::abs(x); }

  static inline
  value_type sqrt(argument_type x) { return std::sqrt(x); }

  static inline
  base_type norm_1(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_2(argument_type x) { return traits_type::abs(x); }

  static inline
  base_type norm_inf(argument_type x) { return traits_type::abs(x); }

  static inline
  bool equals(argument_type lhs, argument_type rhs) {
    static base_type sqrt_epsilon(
      NumericTraits<base_type>::sqrt(
        std::numeric_limits<base_type>::epsilon()));

    return traits_type::norm_inf(lhs - rhs) < sqrt_epsilon *
      std::max(std::max(traits_type::norm_inf(lhs),
      traits_type::norm_inf(rhs)),
         std::numeric_limits<base_type>::min());
  }