macros.hpp

Go to the documentation of this file.

/*
 * Copyright(c):
 * Signal Image and Communications (SIC) Department 
 * http://www.sic.sp2mi.univ-poitiers.fr/ 
 *  - University of Poitiers, France http://www.univ-poitiers.fr 
 *  - XLIM  Institute UMR CNRS 7252  http://www.xlim.fr/ 
 * 
 * and 
 * 
 * D2 Fluid, Thermic and Combustion 
 *  - University of Poitiers, France http://www.univ-poitiers.fr 
 *  - PPRIME Institute -  UPR CNRS 3346  http://www.pprime.fr
 *  - ISAE-ENSMA http://www.ensma.fr
 *
 * Contributor(s):
 * The SLIP team,
 * Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>,
 * Laurent David <laurent.david_AT_lea.univ-poitiers.fr>, 
 * Ludovic Chatellier <ludovic.chatellier_AT_univ-poitiers.fr>, 
 * Lionel Thomas <lionel.thomas_AT_univ-poitiers.fr>, 
 * Denis Arrivault <arrivault_AT_sic.univ-poitiers.fr>, 
 * Julien Dombre <julien.dombre_AT_univ-poitiers.fr>.
 *
 * Description:
 * The Simple Library of Image Processing (SLIP) is a new image processing 
 * library. It is written in the C++ language following as much as possible 
 * the ISO/ANSI C++ standard. It is consequently compatible with any system  
 * satisfying the ANSI C++ complience. It works on different Unix , Linux ,  
 * Mircrosoft Windows and Mac OS X plateforms. SLIP is a research library that  
 * was created by the Signal, Image and Communications (SIC) departement of  
 * the XLIM, UMR 7252 CNRS Institute in collaboration with the Fluids, Thermic  
 * and Combustion departement of the P', UPR 3346 CNRS Institute of the  
 * University of Poitiers.
 * 
 * The SLIP Library source code has been registered to the APP (French Agency 
 * for the Protection of Programs) by the University of Poitiers and CNRS, 
 * under  registration number IDDN.FR.001.300034.000.S.P.2010.000.21000.

 * http://www.sic.sp2mi.univ-poitiers.fr/slip/
 *
 * This software is governed by the CeCILL-C license under French law and
 * abiding by the rules of distribution of free software.  You can  use, 
 * modify and/ or redistribute the software under the terms of the CeCILL-C 
 * license as circulated by CEA, CNRS and INRIA at the following URL 
 * http://www.cecill.info.
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 * 
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the 
 * same conditions as regards security. 
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C license and that you accept its terms.
 */



#ifndef SLIP_MACROS_HPP
#define SLIP_MACROS_HPP

#include <complex>
#include <cstring>
#include <limits>
#include <cmath>



namespace slip
{
  template<typename T1, typename T2> struct un_real : public std::unary_function<T1,T2>
{
  un_real(){}
  T2 operator() (const T1& x){return std::real(x);}
};
template<typename T1, typename T2> struct un_imag : public std::unary_function<T1,T2>
{
  un_imag(){}
  T2 operator() (const T1& x){return std::imag(x);}
};
template<typename T1, typename T2> 
struct un_abs : public std::unary_function<T1,T2>
{
  un_abs(){}
  T2 operator() (const T1& x){return (std::abs(x));}
};
  template <class _Tp>
  struct less_abs : public std::binary_function<_Tp, _Tp, bool>
  {
    inline
    bool
    operator()(const _Tp& __x, const _Tp& __y) const
    { 
      return std::abs(__x) < std::abs( __y);
    }
  };

  template <class _Tp>
  struct greater_abs : public std::binary_function<_Tp, _Tp, bool>
  {
    inline
    bool
    operator()(const _Tp& __x, const _Tp& __y) const
    { 
      return std::abs(__x) > std::abs( __y);
    }
  };

  template <class _Tp>
  struct mini : public std::binary_function<_Tp, _Tp, _Tp>
  {
    _Tp
    operator()(const _Tp& __x, const _Tp& __y) const
    { return std::min(__x,__y); }
  };

  template <class _Tp>
  struct maxi : public std::binary_function<_Tp, _Tp, _Tp>
  {
    _Tp
    operator()(const _Tp& __x, const _Tp& __y) const
    { return std::max(__x,__y); }
  };


  template<typename T>
  inline
  T sign(T a)
  {
    if (std::abs(a) > std::abs(std::numeric_limits<T>::epsilon()))
      return (a/std::abs(a));
    return T(1);
  }

template <typename T,typename R>
struct Sign : public std::unary_function<R,T>
{
  Sign()
  {}
  R operator() (const T& x)
  {
    R s = (x > T(0) ? R(1) : R(-1));
    if(x == T(0)) 
      {
                s = R(0);
      }
    return s;
  }
};


template <typename Complex>
struct complex_sign : public std::unary_function<Complex,Complex>
{
  complex_sign()
  {}
  Complex operator() (const Complex& x)
  {
    Complex r = Complex(1);
    if( x != Complex(0))
      {
                r = x/std::abs(x);
      }
    return r;
  }
};


  template <typename Real>
  inline 
  Real pythagore(const Real& x, const Real& y)
  {
    Real absx = std::abs(x), absy = std::abs(y);
    if (absx > absy)
      { 
                return(absx * std::sqrt(1.0+(absy/absx)*(absy/absx)));
      }
    else
      {
                return(absy == 0.0 ? 0.0 : absy * std::sqrt(1.0+(absx/absy)*(absx/absy)));
      }
  }


  template<typename Iterator>
  struct gt_it
  {
    bool operator()(Iterator s1, Iterator s2) const
    {
      return  *s1 > *s2;
    }
  };

  template<typename Iterator>
  struct lt_it
  {
    bool operator()(Iterator s1, Iterator s2) const
    {
      return  *s1 < *s2;
    }
  };

  template <int N, typename T>
  inline
  T nth_power(T x)
  {
    T result = x;
    for(int i = 1; i < N; ++i)
      {
                result *=  x;
      }
    return result;
  }
  template <typename T,typename Integer>
  inline
  T power(T x, Integer N)
  {
    assert( N >= 0);
    T result = T(1);
    if(N !=0)
      {
                result = x;
                for(Integer i = 1; i < N; ++i)
                  {
                    result = result * x;
                  }
      }
   
    return result;
  }


template<typename _Tp>
struct constants
{
  static _Tp pi() throw()
  { return static_cast<_Tp>(3.1415926535897932384626433832795029L); }
  static _Tp pi_2() throw()
  { return static_cast<_Tp>(1.5707963267948966192313216916397514L); }
  static _Tp pi_3() throw()
  { return static_cast<_Tp>(1.0471975511965977461542144610931676L); }
  static _Tp pi_4() throw()
  { return static_cast<_Tp>(0.7853981633974483096156608458198757L); }
  static _Tp _1_pi() throw()
  { return static_cast<_Tp>(0.3183098861837906715377675267450287L); }
  static _Tp _2_sqrtpi() throw()
  { return static_cast<_Tp>(1.1283791670955125738961589031215452L); }
  static _Tp one() throw()
  { return static_cast<_Tp>(1.0L); }
  static _Tp two() throw()
  { return static_cast<_Tp>(2.0L); }
  static _Tp half() throw()
  { return static_cast<_Tp>(0.5L); }
  static _Tp sqrt2() throw()
  { return static_cast<_Tp>(1.4142135623730950488016887242096981L); }
  static _Tp sqrt3() throw()
  { return static_cast<_Tp>(1.7320508075688772935274463415058723L); }
  static _Tp sqrtpi_2() throw()
  { return static_cast<_Tp>(1.2533141373155002512078826424055226L); }
  static _Tp sqrt1_2() throw()
  { return static_cast<_Tp>(0.7071067811865475244008443621048490L); }
  static _Tp lnpi() throw()
  { return static_cast<_Tp>(1.1447298858494001741434273513530587L); }
  static _Tp gamma_e() throw()
  { return static_cast<_Tp>(0.5772156649015328606065120900824024L); }
  static _Tp euler() throw()
  { return static_cast<_Tp>(2.7182818284590452353602874713526625L); }
};


} //::slip
#endif //SLIP_MACROS_HPP