glSpline/glm/gtx/norm.hpp

91 lines
2.4 KiB
C++
Raw Permalink Normal View History

2018-09-12 18:53:34 +02:00
/// @ref gtx_norm
/// @file glm/gtx/norm.hpp
///
/// @see core (dependence)
/// @see gtx_quaternion (dependence)
///
/// @defgroup gtx_norm GLM_GTX_norm
/// @ingroup gtx
///
/// @brief Various ways to compute vector norms.
///
/// <glm/gtx/norm.hpp> need to be included to use these functionalities.
#pragma once
// Dependency:
#include "../detail/func_geometric.hpp"
#include "../gtx/quaternion.hpp"
#ifndef GLM_ENABLE_EXPERIMENTAL
# error "GLM: GLM_GTX_norm 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."
#endif
#if GLM_MESSAGES == GLM_MESSAGES_ENABLED && !defined(GLM_EXT_INCLUDED)
# pragma message("GLM: GLM_GTX_norm extension included")
#endif
namespace glm
{
/// @addtogroup gtx_norm
/// @{
/// Returns the squared length of x.
/// From GLM_GTX_norm extension.
template<length_t L, typename T, precision P, template<length_t, typename, precision> class vecType>
GLM_FUNC_DECL T length2(
vecType<L, T, P> const& x);
/// Returns the squared distance between p0 and p1, i.e., length2(p0 - p1).
/// From GLM_GTX_norm extension.
template<length_t L, typename T, precision P, template<length_t, typename, precision> class vecType>
GLM_FUNC_DECL T distance2(
vecType<L, T, P> const& p0,
vecType<L, T, P> const& p1);
//! Returns the L1 norm between x and y.
//! From GLM_GTX_norm extension.
template<typename T, precision P>
GLM_FUNC_DECL T l1Norm(
vec<3, T, P> const & x,
vec<3, T, P> const & y);
//! Returns the L1 norm of v.
//! From GLM_GTX_norm extension.
template<typename T, precision P>
GLM_FUNC_DECL T l1Norm(
vec<3, T, P> const & v);
//! Returns the L2 norm between x and y.
//! From GLM_GTX_norm extension.
template<typename T, precision P>
GLM_FUNC_DECL T l2Norm(
vec<3, T, P> const & x,
vec<3, T, P> const & y);
//! Returns the L2 norm of v.
//! From GLM_GTX_norm extension.
template<typename T, precision P>
GLM_FUNC_DECL T l2Norm(
vec<3, T, P> const & x);
//! Returns the L norm between x and y.
//! From GLM_GTX_norm extension.
template<typename T, precision P>
GLM_FUNC_DECL T lxNorm(
vec<3, T, P> const & x,
vec<3, T, P> const & y,
unsigned int Depth);
//! Returns the L norm of v.
//! From GLM_GTX_norm extension.
template<typename T, precision P>
GLM_FUNC_DECL T lxNorm(
vec<3, T, P> const & x,
unsigned int Depth);
/// @}
}//namespace glm
#include "norm.inl"