Home | History | Annotate | Download | only in gtc
      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 gtc_ulp
     24 /// @file glm/gtc/ulp.hpp
     25 /// @date 2011-02-21 / 2011-12-12
     26 /// @author Christophe Riccio
     27 ///
     28 /// @see core (dependence)
     29 ///
     30 /// @defgroup gtc_ulp GLM_GTC_ulp
     31 /// @ingroup gtc
     32 ///
     33 /// @brief Allow the measurement of the accuracy of a function against a reference
     34 /// implementation. This extension works on floating-point data and provide results
     35 /// in ULP.
     36 /// <glm/gtc/ulp.hpp> need to be included to use these features.
     37 ///////////////////////////////////////////////////////////////////////////////////
     38 
     39 #ifndef GLM_GTC_ulp
     40 #define GLM_GTC_ulp
     41 
     42 // Dependencies
     43 #include "../detail/setup.hpp"
     44 #include "../detail/precision.hpp"
     45 #include "../detail/type_int.hpp"
     46 
     47 #if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
     48 #	pragma message("GLM: GLM_GTC_ulp extension included")
     49 #endif
     50 
     51 namespace glm
     52 {
     53 	/// @addtogroup gtc_ulp
     54 	/// @{
     55 
     56 	/// Return the next ULP value(s) after the input value(s).
     57 	/// @see gtc_ulp
     58 	template <typename genType>
     59 	GLM_FUNC_DECL genType next_float(genType const & x);
     60 
     61 	/// Return the previous ULP value(s) before the input value(s).
     62 	/// @see gtc_ulp
     63 	template <typename genType>
     64 	GLM_FUNC_DECL genType prev_float(genType const & x);
     65 
     66 	/// Return the value(s) ULP distance after the input value(s).
     67 	/// @see gtc_ulp
     68 	template <typename genType>
     69 	GLM_FUNC_DECL genType next_float(genType const & x, uint const & Distance);
     70 
     71 	/// Return the value(s) ULP distance before the input value(s).
     72 	/// @see gtc_ulp
     73 	template <typename genType>
     74 	GLM_FUNC_DECL genType prev_float(genType const & x, uint const & Distance);
     75 
     76 	/// Return the distance in the number of ULP between 2 scalars.
     77 	/// @see gtc_ulp
     78 	template <typename T>
     79 	GLM_FUNC_DECL uint float_distance(T const & x, T const & y);
     80 
     81 	/// Return the distance in the number of ULP between 2 vectors.
     82 	/// @see gtc_ulp
     83 	template<typename T, template<typename> class vecType>
     84 	GLM_FUNC_DECL vecType<uint> float_distance(vecType<T> const & x, vecType<T> const & y);
     85 
     86 	/// @}
     87 }// namespace glm
     88 
     89 #include "ulp.inl"
     90 
     91 #endif//GLM_GTC_ulp
     92 
     93