1 //================================================================================================= 2 /*! 3 // \file blaze/math/typetraits/YieldsStrictlyLower.h 4 // \brief Header file for the YieldsStrictlyLower 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_YIELDSSTRICTLYLOWER_H_ 36 #define _BLAZE_MATH_TYPETRAITS_YIELDSSTRICTLYLOWER_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 matrices. 56 // \ingroup math_type_traits 57 // 58 // This type trait tests whether or not the given operation \a OP yields a strictly lower 59 // matrix when applied to several matrices of types \a MT and \a MTs. In case the operation 60 // yields a strictly lower matrix, the \a value member constant is set to \a true, the nested 61 // type definition \a Type is \a TrueType, and the class derives from \a TrueType. Otherwise 62 // \a value is set to \a false, \a Type is \a FalseType, and the class derives from \a FalseType. 63 */ 64 template< typename OP, typename MT, typename... MTs > 65 struct YieldsStrictlyLower 66 : public FalseType 67 {}; 68 //************************************************************************************************* 69 70 71 //************************************************************************************************* 72 /*! \cond BLAZE_INTERNAL */ 73 /*!\brief Specialization of the YieldsStrictlyLower type trait for const types. 74 // \ingroup math_type_traits 75 */ 76 template< typename OP, typename MT, typename... MTs > 77 struct YieldsStrictlyLower< const OP, MT, MTs... > 78 : public YieldsStrictlyLower<OP,MT,MTs...> 79 {}; 80 /*! \endcond */ 81 //************************************************************************************************* 82 83 84 //************************************************************************************************* 85 /*! \cond BLAZE_INTERNAL */ 86 /*!\brief Specialization of the YieldsStrictlyLower type trait for volatile types. 87 // \ingroup math_type_traits 88 */ 89 template< typename OP, typename MT, typename... MTs > 90 struct YieldsStrictlyLower< volatile OP, MT, MTs... > 91 : public YieldsStrictlyLower<OP,MT,MTs...> 92 {}; 93 /*! \endcond */ 94 //************************************************************************************************* 95 96 97 //************************************************************************************************* 98 /*! \cond BLAZE_INTERNAL */ 99 /*!\brief Specialization of the YieldsStrictlyLower type trait for cv qualified types. 100 // \ingroup math_type_traits 101 */ 102 template< typename OP, typename MT, typename... MTs > 103 struct YieldsStrictlyLower< const volatile OP, MT, MTs... > 104 : public YieldsStrictlyLower<OP,MT,MTs...> 105 {}; 106 /*! \endcond */ 107 //************************************************************************************************* 108 109 110 //************************************************************************************************* 111 /*!\brief Auxiliary variable template for the YieldsStrictlyLower type trait. 112 // \ingroup math_type_traits 113 // 114 // The YieldsStrictlyLower_v variable template provides a convenient shortcut to access the nested 115 // \a value of the YieldsStrictlyLower class template. For instance, given the operation \a OP and 116 // the matrix type \a MT the following two statements are identical: 117 118 \code 119 constexpr bool value1 = blaze::YieldsStrictlyLower<OP,MT>::value; 120 constexpr bool value2 = blaze::YieldsStrictlyLower_v<OP,MT>; 121 \endcode 122 */ 123 template< typename OP, typename MT, typename... MTs > 124 constexpr bool YieldsStrictlyLower_v = YieldsStrictlyLower<OP,MT,MTs...>::value; 125 //************************************************************************************************* 126 127 } // namespace blaze 128 129 #endif 130