aboutsummaryrefslogtreecommitdiffstats
path: root/src/include/glm/gtx/fast_square_root.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/glm/gtx/fast_square_root.hpp')
-rw-r--r--src/include/glm/gtx/fast_square_root.hpp92
1 files changed, 92 insertions, 0 deletions
diff --git a/src/include/glm/gtx/fast_square_root.hpp b/src/include/glm/gtx/fast_square_root.hpp
new file mode 100644
index 0000000..be38ee9
--- /dev/null
+++ b/src/include/glm/gtx/fast_square_root.hpp
@@ -0,0 +1,92 @@
+/// @ref gtx_fast_square_root
+/// @file glm/gtx/fast_square_root.hpp
+///
+/// @see core (dependence)
+///
+/// @defgroup gtx_fast_square_root GLM_GTX_fast_square_root
+/// @ingroup gtx
+///
+/// Include <glm/gtx/fast_square_root.hpp> to use the features of this extension.
+///
+/// Fast but less accurate implementations of square root based functions.
+/// - Sqrt optimisation based on Newton's method,
+/// www.gamedev.net/community/forums/topic.asp?topic id=139956
+
+#pragma once
+
+// Dependency:
+#include "../common.hpp"
+#include "../exponential.hpp"
+#include "../geometric.hpp"
+
+#if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
+# ifndef GLM_ENABLE_EXPERIMENTAL
+# pragma message("GLM: GLM_GTX_fast_square_root is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it.")
+# else
+# pragma message("GLM: GLM_GTX_fast_square_root extension included")
+# endif
+#endif
+
+namespace glm
+{
+ /// @addtogroup gtx_fast_square_root
+ /// @{
+
+ /// Faster than the common sqrt function but less accurate.
+ ///
+ /// @see gtx_fast_square_root extension.
+ template<typename genType>
+ GLM_FUNC_DECL genType fastSqrt(genType x);
+
+ /// Faster than the common sqrt function but less accurate.
+ ///
+ /// @see gtx_fast_square_root extension.
+ template<length_t L, typename T, qualifier Q>
+ GLM_FUNC_DECL vec<L, T, Q> fastSqrt(vec<L, T, Q> const& x);
+
+ /// Faster than the common inversesqrt function but less accurate.
+ ///
+ /// @see gtx_fast_square_root extension.
+ template<typename genType>
+ GLM_FUNC_DECL genType fastInverseSqrt(genType x);
+
+ /// Faster than the common inversesqrt function but less accurate.
+ ///
+ /// @see gtx_fast_square_root extension.
+ template<length_t L, typename T, qualifier Q>
+ GLM_FUNC_DECL vec<L, T, Q> fastInverseSqrt(vec<L, T, Q> const& x);
+
+ /// Faster than the common length function but less accurate.
+ ///
+ /// @see gtx_fast_square_root extension.
+ template<typename genType>
+ GLM_FUNC_DECL genType fastLength(genType x);
+
+ /// Faster than the common length function but less accurate.
+ ///
+ /// @see gtx_fast_square_root extension.
+ template<length_t L, typename T, qualifier Q>
+ GLM_FUNC_DECL T fastLength(vec<L, T, Q> const& x);
+
+ /// Faster than the common distance function but less accurate.
+ ///
+ /// @see gtx_fast_square_root extension.
+ template<typename genType>
+ GLM_FUNC_DECL genType fastDistance(genType x, genType y);
+
+ /// Faster than the common distance function but less accurate.
+ ///
+ /// @see gtx_fast_square_root extension.
+ template<length_t L, typename T, qualifier Q>
+ GLM_FUNC_DECL T fastDistance(vec<L, T, Q> const& x, vec<L, T, Q> const& y);
+
+ /// Faster than the common normalize function but less accurate.
+ ///
+ /// @see gtx_fast_square_root extension.
+ template<typename genType>
+ GLM_FUNC_DECL genType fastNormalize(genType const& x);
+
+ /// @}
+}// namespace glm
+
+#include "fast_square_root.inl"