//
// File: IntegerTools.h
// Authors:
//   Francois Gindraud (2017)
// Created: 2017-03-28 00:00:00
// Last modified: 2017-06-26
//

/*
  Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
  
  This software is a computer program whose purpose is to provide utilitary
  classes. This file belongs to the Bio++ Project.
  
  This software is governed by the CeCILL 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
  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 license and that you accept its terms.
*/

#ifndef BPP_NUMERIC_INTEGERTOOLS_H
#define BPP_NUMERIC_INTEGERTOOLS_H

#include <type_traits>

namespace bpp
{
  /// Namespace for integer utils.
  namespace IntegerTools
  {

    /// Returns floor(n/divisor).
    template <typename T>
    T divideDown(T n, T divisor) noexcept
    {
      static_assert (std::is_integral<T>::value, "T must be an integral type");
      return n / divisor;
    }

    /// Returns ceil (n/divisor).
    template <typename T>
    T divideUp(T n, T divisor) noexcept
    {
      static_assert (std::is_integral<T>::value, "T must be an integral type");
      return divideDown(n + divisor - 1, divisor);
    }

    /// Round n to previous divisor multiple.
    template <typename T>
    T roundDown(T n, T divisor) noexcept
    {
      static_assert (std::is_integral<T>::value, "T must be an integral type");
      return divisor * divideDown(n, divisor);
    }

    /// Round n to next divisor multiple.
    template <typename T>
    T roundUp(T n, T divisor) noexcept
    {
      static_assert (std::is_integral<T>::value, "T must be an integral type");
      return divisor * divideUp(n, divisor);
    }
  }
} // namespace bpp
#endif // BPP_NUMERIC_INTEGERTOOLS_H
