1 //================================================================================================= 2 /*! 3 // \file blaze/math/typetraits/IsSymmetric.h 4 // \brief Header file for the IsSymmetric 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_ISSYMMETRIC_H_ 36 #define _BLAZE_MATH_TYPETRAITS_ISSYMMETRIC_H_ 37 38 39 //************************************************************************************************* 40 // Includes 41 //************************************************************************************************* 42 43 #include <blaze/math/typetraits/IsExpression.h> 44 #include <blaze/util/EnableIf.h> 45 #include <blaze/util/IntegralConstant.h> 46 #include <blaze/util/typetraits/IsSame.h> 47 48 49 namespace blaze { 50 51 //================================================================================================= 52 // 53 // CLASS DEFINITION 54 // 55 //================================================================================================= 56 57 //************************************************************************************************* 58 /*! \cond BLAZE_INTERNAL */ 59 template< typename T > struct IsSymmetric; 60 /*! \endcond */ 61 //************************************************************************************************* 62 63 64 //************************************************************************************************* 65 /*! \cond BLAZE_INTERNAL */ 66 /*!\brief Auxiliary helper struct for the IsSymmetric type trait. 67 // \ingroup math_traits 68 */ 69 template< typename T 70 , typename = void > 71 struct IsSymmetricHelper 72 : public FalseType 73 {}; 74 75 template< typename T > // Type of the operand 76 struct IsSymmetricHelper< T, EnableIf_t< IsExpression_v<T> && !IsSame_v<T,typename T::ResultType> > > 77 : public IsSymmetric< typename T::ResultType >::Type 78 {}; 79 /*! \endcond */ 80 //************************************************************************************************* 81 82 83 //************************************************************************************************* 84 /*!\brief Compile time check for symmetric matrices. 85 // \ingroup math_type_traits 86 // 87 // This type trait tests whether or not the given template parameter is a symmetric matrix type 88 // (i.e. a matrix type that is guaranteed to be symmetric at compile time). In case the type is 89 // a symmetric matrix type, the \a value member constant is set to \a true, the nested type 90 // definition \a Type is \a TrueType, and the class derives from \a TrueType. Otherwise \a value 91 // is set to \a false, \a Type is \a FalseType, and the class derives from \a FalseType. 92 93 \code 94 using blaze::rowMajor; 95 96 using StaticMatrixType = blaze::StaticMatrix<double,rowMajor>; 97 using DynamicMatrixType = blaze::DynamicMatrix<float,rowMajor>; 98 using CompressedMatrixType = blaze::CompressedMatrix<int,rowMajor>; 99 100 using SymmetricStaticType = blaze::SymmetricMatrix<StaticMatrixType>; 101 using SymmetricDynamicType = blaze::SymmetricMatrix<DynamicMatrixType>; 102 using SymmetricCompressedType = blaze::SymmetricMatrix<CompressedMatrixType>; 103 104 blaze::IsSymmetric< SymmetricStaticType >::value // Evaluates to 1 105 blaze::IsSymmetric< const SymmetricDynamicType >::Type // Results in TrueType 106 blaze::IsSymmetric< volatile SymmetricCompressedType > // Is derived from TrueType 107 blaze::IsSymmetric< StaticMatrixType >::value // Evaluates to 0 108 blaze::IsSymmetric< const DynamicMatrixType >::Type // Results in FalseType 109 blaze::IsSymmetric< volatile CompressedMatrixType > // Is derived from FalseType 110 \endcode 111 */ 112 template< typename T > 113 struct IsSymmetric 114 : public IsSymmetricHelper<T> 115 {}; 116 //************************************************************************************************* 117 118 119 //************************************************************************************************* 120 /*! \cond BLAZE_INTERNAL */ 121 /*!\brief Specialization of the IsSymmetric type trait for const types. 122 // \ingroup math_type_traits 123 */ 124 template< typename T > 125 struct IsSymmetric< const T > 126 : public IsSymmetric<T> 127 {}; 128 /*! \endcond */ 129 //************************************************************************************************* 130 131 132 //************************************************************************************************* 133 /*! \cond BLAZE_INTERNAL */ 134 /*!\brief Specialization of the IsSymmetric type trait for volatile types. 135 // \ingroup math_type_traits 136 */ 137 template< typename T > 138 struct IsSymmetric< volatile T > 139 : public IsSymmetric<T> 140 {}; 141 /*! \endcond */ 142 //************************************************************************************************* 143 144 145 //************************************************************************************************* 146 /*! \cond BLAZE_INTERNAL */ 147 /*!\brief Specialization of the IsSymmetric type trait for cv qualified types. 148 // \ingroup math_type_traits 149 */ 150 template< typename T > 151 struct IsSymmetric< const volatile T > 152 : public IsSymmetric<T> 153 {}; 154 /*! \endcond */ 155 //************************************************************************************************* 156 157 158 //************************************************************************************************* 159 /*!\brief Auxiliary variable template for the IsSymmetric type trait. 160 // \ingroup math_type_traits 161 // 162 // The IsSymmetric_v variable template provides a convenient shortcut to access the nested 163 // \a value of the IsSymmetric class template. For instance, given the type \a T the following 164 // two statements are identical: 165 166 \code 167 constexpr bool value1 = blaze::IsSymmetric<T>::value; 168 constexpr bool value2 = blaze::IsSymmetric_v<T>; 169 \endcode 170 */ 171 template< typename T > 172 constexpr bool IsSymmetric_v = IsSymmetric<T>::value; 173 //************************************************************************************************* 174 175 } // namespace blaze 176 177 #endif 178