From 03fda193a5d9f30eb4a508f2a2bd9a204ac399b9 Mon Sep 17 00:00:00 2001 From: Recep Aslantas Date: Fri, 30 Aug 2019 14:47:26 +0300 Subject: [PATCH] vec: update docs for norm --- docs/source/vec3.rst | 3 ++- docs/source/vec4.rst | 3 ++- include/cglm/vec3.h | 3 ++- include/cglm/vec4.h | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/source/vec3.rst b/docs/source/vec3.rst index b431528..100e849 100644 --- a/docs/source/vec3.rst +++ b/docs/source/vec3.rst @@ -158,7 +158,8 @@ Functions documentation .. c:function:: float glm_vec3_norm(vec3 vec) - norm (magnitude) of vec3 + | euclidean norm (magnitude), also called L2 norm + | this will give magnitude of vector in euclidean space Parameters: | *[in]* **vec** vector diff --git a/docs/source/vec4.rst b/docs/source/vec4.rst index f497868..58c861e 100644 --- a/docs/source/vec4.rst +++ b/docs/source/vec4.rst @@ -134,7 +134,8 @@ Functions documentation .. c:function:: float glm_vec4_norm(vec4 vec) - norm (magnitude) of vec4 + | euclidean norm (magnitude), also called L2 norm + | this will give magnitude of vector in euclidean space Parameters: | *[in]* **vec** vector diff --git a/include/cglm/vec3.h b/include/cglm/vec3.h index a09c272..cc6d552 100644 --- a/include/cglm/vec3.h +++ b/include/cglm/vec3.h @@ -200,7 +200,8 @@ glm_vec3_norm2(vec3 v) { } /*! - * @brief norm (magnitude) of vec3 + * @brief euclidean norm (magnitude), also called L2 norm + * this will give magnitude of vector in euclidean space * * @param[in] v vector * diff --git a/include/cglm/vec4.h b/include/cglm/vec4.h index 863f646..05835ff 100644 --- a/include/cglm/vec4.h +++ b/include/cglm/vec4.h @@ -240,7 +240,8 @@ glm_vec4_norm2(vec4 v) { } /*! - * @brief norm (magnitude) of vec4 + * @brief euclidean norm (magnitude), also called L2 norm + * this will give magnitude of vector in euclidean space * * @param[in] v vector *