glm/glm/core/func_vector_relational.hpp

///////////////////////////////////////////////////////////////////////////////////
/// OpenGL Mathematics (glm.g-truc.net)
///
/// Copyright (c) 2005 - 2011 G-Truc Creation (www.g-truc.net)
/// Permission is hereby granted, free of charge, to any person obtaining a copy
/// of this software and associated documentation files (the "Software"), to deal
/// in the Software without restriction, including without limitation the rights
/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
/// copies of the Software, and to permit persons to whom the Software is
/// furnished to do so, subject to the following conditions:
/// 
/// The above copyright notice and this permission notice shall be included in
/// all copies or substantial portions of the Software.
/// 
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
/// THE SOFTWARE.
///
/// @ref core
/// @file glm/core/func_vector_relational.hpp
/// @date 2008-08-03 / 2011-06-15
/// @author Christophe Riccio
///////////////////////////////////////////////////////////////////////////////////

#ifndef glm_core_func_vector_relational
#define glm_core_func_vector_relational

#include "_detail.hpp"

namespace glm
{
	/// @addtogroup core_funcs
	/// @{

	//! Returns the component-wise comparison result of x < y.
    //!
    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThan.xml">GLSL lessThan man page</a>
    //! \li GLSL 1.30.08 specification, section 8.6
    template <typename T, template <typename> class vecType> 
	GLM_FUNC_QUALIFIER typename vecType<T>::bool_type lessThan
	(
		vecType<T> const & x, 
		vecType<T> const & y
	)
	{
		GLM_STATIC_ASSERT(detail::is_vector<vecType<T> >::_YES, 
			"Invalid template instantiation of 'lessThan', GLM vector types required");
		GLM_STATIC_ASSERT(detail::is_bool<T>::_NO,
			"Invalid template instantiation of 'lessThan', GLM vector types required floating-point or integer value types vectors");

		typename vecType<bool>::bool_type Result(vecType<bool>::null);
		for(typename vecType<bool>::size_type i = 0; i < vecType<bool>::value_size(); ++i)
			Result[i] = x[i] < y[i];

		return Result;
	}

	//! Returns the component-wise comparison of result x <= y.
    //!
    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/lessThanEqual.xml">GLSL lessThanEqual man page</a>
    //! \li GLSL 1.30.08 specification, section 8.6
	template <typename T, template <typename> class vecType> 
	GLM_FUNC_QUALIFIER typename vecType<T>::bool_type lessThanEqual
	(
		vecType<T> const & x, 
		vecType<T> const & y
	)
	{
		GLM_STATIC_ASSERT(detail::is_vector<vecType<T> >::_YES, 
			"Invalid template instantiation of 'lessThanEqual', GLM vector types required");
		GLM_STATIC_ASSERT(detail::is_bool<T>::_NO, 
			"Invalid template instantiation of 'lessThanEqual', GLM vector types required floating-point or integer value types vectors");

		typename vecType<bool>::bool_type Result(vecType<bool>::null);
		for(typename vecType<bool>::size_type i = 0; i < vecType<bool>::value_size(); ++i)
			Result[i] = x[i] <= y[i];
		return Result;
	}

	//! Returns the component-wise comparison of result x > y.
    //!
    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThan.xml">GLSL greaterThan man page</a>
    //! \li GLSL 1.30.08 specification, section 8.6
	template <typename T, template <typename> class vecType> 
	GLM_FUNC_QUALIFIER typename vecType<T>::bool_type greaterThan
	(
		vecType<T> const & x, 
		vecType<T> const & y
	)
	{
		GLM_STATIC_ASSERT(detail::is_vector<vecType<T> >::_YES, 
			"Invalid template instantiation of 'greaterThan', GLM vector types required");
		GLM_STATIC_ASSERT(detail::is_bool<T>::_NO, 
			"Invalid template instantiation of 'greaterThan', GLM vector types required floating-point or integer value types vectors");

		typename vecType<bool>::bool_type Result(vecType<bool>::null);
		for(typename vecType<bool>::size_type i = 0; i < vecType<bool>::value_size(); ++i)
			Result[i] = x[i] > y[i];
		return Result;
	}

	//! Returns the component-wise comparison of result x >= y.
    //!
    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/greaterThanEqual.xml">GLSL greaterThanEqual man page</a>
    //! \li GLSL 1.30.08 specification, section 8.6
	template <typename T, template <typename> class vecType> 
	GLM_FUNC_QUALIFIER typename vecType<T>::bool_type greaterThanEqual
	(
		vecType<T> const & x, 
		vecType<T> const & y
	)
	{
		GLM_STATIC_ASSERT(detail::is_vector<vecType<T> >::_YES, 
			"Invalid template instantiation of 'greaterThanEqual', GLM vector types required");
		GLM_STATIC_ASSERT(detail::is_bool<T>::_NO, 
			"Invalid template instantiation of 'greaterThanEqual', GLM vector types required floating-point or integer value types vectors");

		typename vecType<bool>::bool_type Result(vecType<bool>::null);
		for(typename vecType<bool>::size_type i = 0; i < vecType<bool>::value_size(); ++i)
			Result[i] = x[i] >= y[i];
		return Result;
	}

	//! Returns the component-wise comparison of result x == y.
    //!
    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/equal.xml">GLSL equal man page</a>
    //! \li GLSL 1.30.08 specification, section 8.6
	template <typename T, template <typename> class vecType> 
	GLM_FUNC_QUALIFIER typename vecType<T>::bool_type equal
	(
		vecType<T> const & x, 
		vecType<T> const & y
	)
	{
		GLM_STATIC_ASSERT(detail::is_vector<vecType<T> >::_YES, 
			"Invalid template instantiation of 'equal', GLM vector types required");

		typename vecType<bool>::bool_type Result(vecType<bool>::null);
		for(typename vecType<bool>::size_type i = 0; i < vecType<bool>::value_size(); ++i)
			Result[i] = x[i] == y[i];
		return Result;
	}

	//! Returns the component-wise comparison of result x != y.
    //!
    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/notEqual.xml">GLSL notEqual man page</a>
    //! \li GLSL 1.30.08 specification, section 8.6
	template <typename T, template <typename> class vecType> 
	GLM_FUNC_QUALIFIER typename vecType<T>::bool_type notEqual
	(
		vecType<T> const & x, 
		vecType<T> const & y
	)
	{
		GLM_STATIC_ASSERT(detail::is_vector<vecType<T> >::_YES, 
			"Invalid template instantiation of 'notEqual', GLM vector types required");

		typename vecType<bool>::bool_type Result(vecType<bool>::null);
		for(typename vecType<bool>::size_type i = 0; i < vecType<bool>::value_size(); ++i)
			Result[i] = x[i] != y[i];
		return Result;
	}

	//! Returns true if any component of x is true.
    //!
    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/any.xml">GLSL any man page</a>
    //! \li GLSL 1.30.08 specification, section 8.6
	template <template <typename> class vecType> 
	GLM_FUNC_QUALIFIER bool any(vecType<bool> const & v)
	{
		GLM_STATIC_ASSERT(detail::is_vector<vecType<bool> >::_YES, 
			"Invalid template instantiation of 'any', GLM boolean vector types required");

		bool Result = false;
		for(typename vecType<bool>::size_type i = 0; i < vecType<bool>::value_size(); ++i)
			Result = Result || v[i];
		return Result;
	}

	//! Returns true if all components of x are true.
    //!
    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/all.xml">GLSL all man page</a>
    //! \li GLSL 1.30.08 specification, section 8.6
	template <template <typename> class vecType> 
	GLM_FUNC_QUALIFIER bool all(vecType<bool> const & v)
	{
		GLM_STATIC_ASSERT(detail::is_vector<vecType<bool> >::_YES, 
			"Invalid template instantiation of 'all', GLM boolean vector types required");

		bool Result = true;
		for(typename vecType<bool>::size_type i = 0; i < vecType<bool>::value_size(); ++i)
			Result = Result && v[i];
		return Result;
	}

	//! Returns the component-wise logical complement of x.
    //! /!\ Because of language incompatibilities between C++ and GLSL, GLM defines the function not but not_ instead.
    //!
    //! \li <a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/not.xml">GLSL not man page</a>
    //! \li GLSL 1.30.08 specification, section 8.6
	template <template <typename> class vecType> 
	GLM_FUNC_QUALIFIER vecType<bool> not_(vecType<bool> const & v)
	{
		GLM_STATIC_ASSERT(detail::is_vector<vecType<bool> >::_YES, 
			"Invalid template instantiation of 'not_', GLM vector types required");

		typename vecType<bool>::bool_type Result(vecType<bool>::null);
		for(typename vecType<bool>::size_type i = 0; i < vecType<bool>::value_size(); ++i)
			Result[i] = !v[i];
		return Result;
	}

	/// @}
}//namespace glm

#include "func_vector_relational.inl"

#endif//glm_core_func_vector_relational