1 //================================================================================================= 2 /*! 3 // \file blaze/math/typetraits/YieldsZero.h 4 // \brief Header file for the YieldsZero type trait 5 // 6 // Copyright (C) 2012-2020 Klaus Iglberger - All Rights Reserved 7 // 8 // This file is part of the Blaze library. You can redistribute it and/or modify it under 9 // the terms of the New (Revised) BSD License. Redistribution and use in source and binary 10 // forms, with or without modification, are permitted provided that the following conditions 11 // are met: 12 // 13 // 1. Redistributions of source code must retain the above copyright notice, this list of 14 // conditions and the following disclaimer. 15 // 2. Redistributions in binary form must reproduce the above copyright notice, this list 16 // of conditions and the following disclaimer in the documentation and/or other materials 17 // provided with the distribution. 18 // 3. Neither the names of the Blaze development group nor the names of its contributors 19 // may be used to endorse or promote products derived from this software without specific 20 // prior written permission. 21 // 22 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 23 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 25 // SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 26 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 27 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 28 // BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 30 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 31 // DAMAGE. 32 */ 33 //================================================================================================= 34 35 #ifndef _BLAZE_MATH_TYPETRAITS_YIELDSZERO_H_ 36 #define _BLAZE_MATH_TYPETRAITS_YIELDSZERO_H_ 37 38 39 //************************************************************************************************* 40 // Includes 41 //************************************************************************************************* 42 43 #include <blaze/util/IntegralConstant.h> 44 45 46 namespace blaze { 47 48 //================================================================================================= 49 // 50 // CLASS DEFINITION 51 // 52 //================================================================================================= 53 54 //************************************************************************************************* 55 /*!\brief Compile time check for operations on vectors and matrices. 56 // \ingroup math_type_traits 57 // 58 // This type trait tests whether or not the given operation \a OP yields a zero vector or zero 59 // matrix when applied to several vectors or matrices of types \a T and \a Ts. In case the 60 // operation yields a zero vector or matrix, the \a value member constant is set to \a true, 61 // the nested type definition \a Type is \a TrueType, and the class derives from \a TrueType. 62 // Otherwise \a value is set to \a false, \a Type is \a FalseType, and the class derives from 63 // \a FalseType. 64 */ 65 template< typename OP, typename T, typename... Ts > 66 struct YieldsZero 67 : public FalseType 68 {}; 69 //************************************************************************************************* 70 71 72 //************************************************************************************************* 73 /*! \cond BLAZE_INTERNAL */ 74 /*!\brief Specialization of the YieldsZero type trait for const types. 75 // \ingroup math_type_traits 76 */ 77 template< typename OP, typename T, typename... Ts > 78 struct YieldsZero< const OP, T, Ts... > 79 : public YieldsZero<OP,T,Ts...> 80 {}; 81 /*! \endcond */ 82 //************************************************************************************************* 83 84 85 //************************************************************************************************* 86 /*! \cond BLAZE_INTERNAL */ 87 /*!\brief Specialization of the YieldsZero type trait for volatile types. 88 // \ingroup math_type_traits 89 */ 90 template< typename OP, typename T, typename... Ts > 91 struct YieldsZero< volatile OP, T, Ts... > 92 : public YieldsZero<OP,T,Ts...> 93 {}; 94 /*! \endcond */ 95 //************************************************************************************************* 96 97 98 //************************************************************************************************* 99 /*! \cond BLAZE_INTERNAL */ 100 /*!\brief Specialization of the YieldsZero type trait for cv qualified types. 101 // \ingroup math_type_traits 102 */ 103 template< typename OP, typename T, typename... Ts > 104 struct YieldsZero< const volatile OP, T, Ts... > 105 : public YieldsZero<OP,T,Ts...> 106 {}; 107 /*! \endcond */ 108 //************************************************************************************************* 109 110 111 //************************************************************************************************* 112 /*!\brief Auxiliary variable template for the YieldsZero type trait. 113 // \ingroup math_type_traits 114 // 115 // The YieldsZero_v variable template provides a convenient shortcut to access the nested 116 // \a value of the YieldsZero class template. For instance, given the operation \a OP and 117 // the vector or matrix type \a T the following two statements are identical: 118 119 \code 120 constexpr bool value1 = blaze::YieldsZero<OP,T>::value; 121 constexpr bool value2 = blaze::YieldsZero_v<OP,T>; 122 \endcode 123 */ 124 template< typename OP, typename T, typename... Ts > 125 constexpr bool YieldsZero_v = YieldsZero<OP,T,Ts...>::value; 126 //************************************************************************************************* 127 128 } // namespace blaze 129 130 #endif 131