Numeric.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_Numeric_hxx
#define __ccxx_Numeric_hxx

#include <limits>

#ifdef min
#undef min
#endif

#ifdef max
#undef max
#endif

#include <commonc++/OutOfBoundsException.h++>

namespace ccxx {

class Numeric
{
 public:

  static uint32_t nextPowerOf2(uint32_t value);

  static uint32_t leastSignificantSetBit(uint32_t value);

  static uint64_t leastSignificantSetBit(uint64_t value);

  static uint32_t mostSignificantSetBit(uint32_t value);

  static uint64_t mostSignificantSetBit(uint64_t value);

  static uint_t countSetBits(uint32_t value);

  static uint_t countSetBits(uint64_t value);

  static uint_t countLeadingZeroes(uint32_t value);

  static uint_t countLeadingZeroes(uint64_t value);

  static uint_t countTrailingZeroes(uint32_t value);

  static uint_t countTrailingZeroes(uint64_t value);

 private:

  Numeric();
  CCXX_COPY_DECLS(Numeric);
};

template<typename S, typename T>
  inline T numeric_cast(S value)
{
  if((value < std::numeric_limits<T>::min())
     || (value > std::numeric_limits<T>::max()))
    throw OutOfBoundsException();
  else
    return(static_cast<T>(value));
}

template<typename S, typename T>
  inline T numeric_clipping_cast(S value)
{
  if(value < std::numeric_limits<T>::min())
    return(std::numeric_limits<T>::min());
  else if(value > std::numeric_limits<T>::max())
    return(std::numeric_limits<T>::max());
  else
    return(static_cast<T>(value));
}

template<typename T>
  inline T numeric_clip(T value, T min, T max)
{
  if(value < min)
    return(min);
  else if(value > max)
    return(max);
  else return(value);
}

} // namespace ccxx

#endif // __ccxx_Numeric_hxx