libcruft-util/maths.hpp

131 lines
2.6 KiB
C++

/*
* This file is part of libgim.
*
* libgim is free software: you can redistribute it and/or modify it under the
* terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later
* version.
*
* libgim 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 General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with libgim. If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2010 Danny Robson <danny@blubinc.net>
*/
#ifndef __MATHS_HPP
#define __MATHS_HPP
#include "annotations.hpp"
template <typename T>
T
pow2 (T value) pure;
template <typename T>
bool
is_pow2 (T value) pure;
template <typename T>
double
rootsquare (T a, T b) pure;
template <typename T>
T
round_up (T value, T align) pure;
template <typename T>
T
round_pow2 (T value) pure;
/**
* Check if two floating point numbers are approximately equal. Returns true
* if the difference is less than a percentage of each individual value.
*
* @e maximum percentage difference for equal values
*/
template <typename T>
bool
almost_equal (const T &a, const T &b)
{ return a == b; }
template <typename Ta, typename Tb>
bool
almost_equal (const Ta &a, const Tb &b) {
return almost_equal <decltype(a + b)> (static_cast<decltype(a + b)>(a),
static_cast<decltype(a + b)>(b));
}
const double PI = 3.141592653589793238462643;
inline double
to_degreees (double radians) {
return radians * 180 / PI;
}
inline double
to_radians (double degrees) {
return degrees / 180 * PI;
}
template <>
bool
almost_equal (const float &a, const float &b);
template <>
bool
almost_equal (const double &a, const double &b);
// Useful for explictly ignore equality warnings
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wfloat-equal"
template <typename T>
bool
exactly_equal (const T &a, const T &b)
{ return a == b; }
#pragma GCC diagnostic pop
/// Variadic minimum
template <typename T>
const T&
min (const T &a)
{ return a; }
template <typename T, typename ...Args>
const T&
min (const T &a , const T &b , const Args &...args )
{ return min ( b < a ? b : a, args...); }
/// Variadic maximum
template <typename T>
const T&
max (const T &a)
{ return a; }
template <typename T, typename ...Args>
const T&
max (const T &a , const T &b , const Args &...args )
{ return max ( b > a ? b : a, args...); }
#endif // __MATHS_HPP