1 //================================================================================================= 2 /*! 3 // \file blaze/math/typetraits/HasCosh.h 4 // \brief Header file for the HasCosh 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_HASCOSH_H_ 36 #define _BLAZE_MATH_TYPETRAITS_HASCOSH_H_ 37 38 39 //************************************************************************************************* 40 // Includes 41 //************************************************************************************************* 42 43 #include <utility> 44 #include <blaze/math/typetraits/IsMatrix.h> 45 #include <blaze/math/typetraits/IsVector.h> 46 #include <blaze/util/EnableIf.h> 47 #include <blaze/util/IntegralConstant.h> 48 #include <blaze/util/typetraits/Void.h> 49 50 51 namespace blaze { 52 53 //================================================================================================= 54 // 55 // CLASS DEFINITION 56 // 57 //================================================================================================= 58 59 //************************************************************************************************* 60 /*! \cond BLAZE_INTERNAL */ 61 /*!\brief Auxiliary helper struct for the HasCosh type trait. 62 // \ingroup math_type_traits 63 */ 64 template< typename T, typename = void > 65 struct HasCoshHelper 66 : public FalseType 67 {}; 68 /*! \endcond */ 69 //************************************************************************************************* 70 71 72 //************************************************************************************************* 73 /*! \cond BLAZE_INTERNAL */ 74 /*!\brief Specialization of the HasCoshHelper type trait for types providing the cosh() operation. 75 // \ingroup math_type_traits 76 */ 77 template< typename T > 78 struct HasCoshHelper< T, Void_t< decltype( cosh( std::declval<T>() ) ) > > 79 : public TrueType 80 {}; 81 /*! \endcond */ 82 //************************************************************************************************* 83 84 85 //************************************************************************************************* 86 /*!\brief Availability of the cosh() operation for the given data types. 87 // \ingroup math_type_traits 88 // 89 // This type trait provides the information whether the cosh() operation exists for the given 90 // data type \a T (taking the cv-qualifiers into account). In case the operation is available, 91 // the \a value member constant is set to \a true, the nested type definition \a Type is 92 // \a TrueType, and the class derives from \a TrueType. Otherwise \a value is set to \a false, 93 // \a Type is \a FalseType, and the class derives from \a FalseType. 94 95 \code 96 struct NoCosh {}; // Definition of a type without the cosh() operation 97 98 blaze::HasCosh< int >::value // Evaluates to 1 99 blaze::HasCosh< DynamicVector<float> >::Type // Results in TrueType 100 blaze::HasCosh< DynamicMatrix<double> > // Is derived from TrueType 101 blaze::HasCosh< NoCosh >::value // Evaluates to 0 102 blaze::HasCosh< NoCosh >::Type // Results in FalseType 103 blaze::HasCosh< NoCosh > // Is derived from FalseType 104 \endcode 105 */ 106 template< typename T, typename = void > 107 struct HasCosh 108 : public HasCoshHelper<T> 109 {}; 110 //************************************************************************************************* 111 112 113 //************************************************************************************************* 114 /*! \cond BLAZE_INTERNAL */ 115 /*!\brief Specialization of the HasCosh type trait for vectors. 116 // \ingroup math_type_traits 117 */ 118 template< typename T > 119 struct HasCosh< T, EnableIf_t< IsVector_v<T> > > 120 : public HasCosh< typename T::ElementType > 121 {}; 122 /*! \endcond */ 123 //************************************************************************************************* 124 125 126 //************************************************************************************************* 127 /*! \cond BLAZE_INTERNAL */ 128 /*!\brief Specialization of the HasCosh type trait for matrices. 129 // \ingroup math_type_traits 130 */ 131 template< typename T > 132 struct HasCosh< T, EnableIf_t< IsMatrix_v<T> > > 133 : public HasCosh< typename T::ElementType > 134 {}; 135 /*! \endcond */ 136 //************************************************************************************************* 137 138 139 //************************************************************************************************* 140 /*!\brief Auxiliary variable template for the HasCosh type trait. 141 // \ingroup math_type_traits 142 // 143 // The HasCosh_v variable template provides a convenient shortcut to access the nested \a value 144 // of the HasCosh class template. For instance, given the type \a T the following two statements 145 // are identical: 146 147 \code 148 constexpr bool value1 = blaze::HasCosh<T>::value; 149 constexpr bool value2 = blaze::HasCosh_v<T>; 150 \endcode 151 */ 152 template< typename T > 153 constexpr bool HasCosh_v = HasCosh<T>::value; 154 //************************************************************************************************* 155 156 } // namespace blaze 157 158 #endif 159