mirror of https://github.com/mosra/magnum.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
118 lines
3.8 KiB
118 lines
3.8 KiB
#ifndef Magnum_Math_Constants_h |
|
#define Magnum_Math_Constants_h |
|
/* |
|
This file is part of Magnum. |
|
|
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015 |
|
Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a |
|
copy of this software and associated documentation files (the "Software"), |
|
to deal in the Software without restriction, including without limitation |
|
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|
and/or sell copies of the Software, and to permit persons to whom the |
|
Software is furnished to do so, subject to the following conditions: |
|
|
|
The above copyright notice and this permission notice shall be included |
|
in all copies or substantial portions of the Software. |
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
|
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|
DEALINGS IN THE SOFTWARE. |
|
*/ |
|
|
|
/** @file |
|
* @brief Class @ref Magnum::Math::Constants |
|
*/ |
|
|
|
#include <cmath> |
|
|
|
#include "Magnum/configure.h" |
|
#ifndef MAGNUM_TARGET_GLES |
|
#include <limits> |
|
#endif |
|
|
|
#include "Magnum/Types.h" |
|
|
|
namespace Magnum { namespace Math { |
|
|
|
/** |
|
@brief Numeric constants |
|
|
|
@see @ref Magnum::Constants, @ref Magnum::Constantsd |
|
@todo Invent a way to generate double NaN/infinity without including whole limits header |
|
*/ |
|
template<class T> struct Constants { |
|
Constants() = delete; |
|
|
|
/* See TypeTraits for answer why these are functions and not constants. */ |
|
#ifdef DOXYGEN_GENERATING_OUTPUT |
|
/** |
|
* @brief Pi |
|
* |
|
* @see @ref piHalf(), @ref tau(), @ref Deg, @ref Rad |
|
*/ |
|
static constexpr T pi(); |
|
|
|
/** |
|
* @brief Half pi |
|
* |
|
* @see @ref pi(), @ref tau(), @ref Deg, @ref Rad |
|
*/ |
|
static constexpr T piHalf(); |
|
|
|
/** |
|
* @brief Tau |
|
* |
|
* Or two pi. |
|
* @see @ref pi(), @ref piHalf(), @ref Deg, @ref Rad |
|
*/ |
|
static constexpr T tau(); |
|
|
|
static constexpr T e(); /**< @brief Euler's number */ |
|
static constexpr T sqrt2(); /**< @brief Square root of 2 */ |
|
static constexpr T sqrt3(); /**< @brief Square root of 3 */ |
|
|
|
static constexpr T nan(); /**< @brief Quiet NaN */ |
|
static constexpr T inf(); /**< @brief Positive infinity */ |
|
#endif |
|
}; |
|
|
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
#ifndef MAGNUM_TARGET_GLES |
|
template<> struct Constants<Double> { |
|
Constants() = delete; |
|
|
|
static constexpr Double pi() { return 3.141592653589793; } |
|
static constexpr Double piHalf() { return 1.570796326794897; } |
|
static constexpr Double tau() { return 6.283185307179586; } |
|
static constexpr Double e() { return 2.718281828459045; } |
|
static constexpr Double sqrt2() { return 1.414213562373095; } |
|
static constexpr Double sqrt3() { return 1.732050807568877; } |
|
|
|
static constexpr Double nan() { return std::numeric_limits<Double>::quiet_NaN(); } |
|
static constexpr Double inf() { return std::numeric_limits<Double>::infinity(); } |
|
}; |
|
#endif |
|
template<> struct Constants<Float> { |
|
Constants() = delete; |
|
|
|
static constexpr Float pi() { return 3.141592654f; } |
|
static constexpr Float piHalf() { return 1.570796327f; } |
|
static constexpr Float tau() { return 6.283185307f; } |
|
static constexpr Float e() { return 2.718281828f; } |
|
static constexpr Float sqrt2() { return 1.414213562f; } |
|
static constexpr Float sqrt3() { return 1.732050808f; } |
|
|
|
static constexpr Float nan() { return NAN; } |
|
static constexpr Float inf() { return INFINITY; } |
|
}; |
|
#endif |
|
|
|
}} |
|
|
|
#endif
|
|
|