1///////////////////////////////////////////////////////////////////////////////////
2/// OpenGL Mathematics (glm.g-truc.net)
3///
4/// Copyright (c) 2005 - 2014 G-Truc Creation (www.g-truc.net)
5/// Permission is hereby granted, free of charge, to any person obtaining a copy
6/// of this software and associated documentation files (the "Software"), to deal
7/// in the Software without restriction, including without limitation the rights
8/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9/// copies of the Software, and to permit persons to whom the Software is
10/// furnished to do so, subject to the following conditions:
11///
12/// The above copyright notice and this permission notice shall be included in
13/// all copies or substantial portions of the Software.
14///
15/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21/// THE SOFTWARE.
22///
23/// @ref gtx_integer
24/// @file glm/gtx/integer.hpp
25/// @date 2005-12-24 / 2011-10-13
26/// @author Christophe Riccio
27///
28/// @see core (dependence)
29///
30/// @defgroup gtx_integer GLM_GTX_integer
31/// @ingroup gtx
32///
33/// @brief Add support for integer for core functions
34///
35/// <glm/gtx/integer.hpp> need to be included to use these functionalities.
36///////////////////////////////////////////////////////////////////////////////////
37
38#ifndef GLM_GTX_integer
39#define GLM_GTX_integer
40
41// Dependency:
42#include "../glm.hpp"
43
44#if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
45#	pragma message("GLM: GLM_GTX_integer extension included")
46#endif
47
48namespace glm
49{
50	/// @addtogroup gtx_integer
51	/// @{
52
53	//! Returns x raised to the y power.
54	//! From GLM_GTX_integer extension.
55	GLM_FUNC_DECL int pow(int x, int y);
56
57	//! Returns the positive square root of x.
58	//! From GLM_GTX_integer extension.
59	GLM_FUNC_DECL int sqrt(int x);
60
61	//! Returns the log2 of x. Can be reliably using to compute mipmap count from the texture size.
62	//! From GLM_GTX_integer extension.
63	template <typename genIUType>
64	GLM_FUNC_DECL genIUType log2(genIUType x);
65
66	//! Returns the floor log2 of x.
67	//! From GLM_GTX_integer extension.
68	GLM_FUNC_DECL unsigned int floor_log2(unsigned int x);
69
70	//! Modulus. Returns x - y * floor(x / y) for each component in x using the floating point value y.
71	//! From GLM_GTX_integer extension.
72	GLM_FUNC_DECL int mod(int x, int y);
73
74	//! Return the factorial value of a number (!12 max, integer only)
75	//! From GLM_GTX_integer extension.
76	template <typename genType>
77	GLM_FUNC_DECL genType factorial(genType const & x);
78
79	//! 32bit signed integer.
80	//! From GLM_GTX_integer extension.
81	typedef signed int					sint;
82
83	//! Returns x raised to the y power.
84	//! From GLM_GTX_integer extension.
85	GLM_FUNC_DECL uint pow(uint x, uint y);
86
87	//! Returns the positive square root of x.
88	//! From GLM_GTX_integer extension.
89	GLM_FUNC_DECL uint sqrt(uint x);
90
91	//! Modulus. Returns x - y * floor(x / y) for each component in x using the floating point value y.
92	//! From GLM_GTX_integer extension.
93	GLM_FUNC_DECL uint mod(uint x, uint y);
94
95	//! Returns the number of leading zeros.
96	//! From GLM_GTX_integer extension.
97	GLM_FUNC_DECL uint nlz(uint x);
98
99	/// @}
100}//namespace glm
101
102#include "integer.inl"
103
104#endif//GLM_GTX_integer
105