1 //=================================================================================================
2 /*!
3 //  \file blaze/math/typetraits/IsBLASCompatible.h
4 //  \brief Header file for the IsBLASCompatible 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_ISBLASCOMPATIBLE_H_
36 #define _BLAZE_MATH_TYPETRAITS_ISBLASCOMPATIBLE_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <blaze/util/IntegralConstant.h>
44 #include <blaze/util/typetraits/IsComplexDouble.h>
45 #include <blaze/util/typetraits/IsComplexFloat.h>
46 #include <blaze/util/typetraits/IsDouble.h>
47 #include <blaze/util/typetraits/IsFloat.h>
48 
49 
50 namespace blaze {
51 
52 //=================================================================================================
53 //
54 //  CLASS DEFINITION
55 //
56 //=================================================================================================
57 
58 //*************************************************************************************************
59 /*!\brief Compile time check for data types.
60 // \ingroup math_type_traits
61 //
62 // This type trait tests whether or not the given template parameter is a data type compatible
63 // to the BLAS standard. The BLAS standard supports \c float, \c double, \c complex<float> and
64 // \c complex<double> values. If the type is BLAS compatible, the \a value member constant is
65 // set to \a true, the nested type definition \a Type is \a TrueType, and the class derives
66 // from \a TrueType. Otherwise \a value is set to \a false, \a Type is \a FalseType, and the
67 // class derives from \a FalseType.
68 
69    \code
70    blaze::IsBLASCompatible< float >::value         // Evaluates to 1
71    blaze::IsBLASCompatible< double >::Type         // Results in TrueType
72    blaze::IsBLASCompatible< complex<float> >       // Is derived from TrueType
73    blaze::IsBLASCompatible< int >::value           // Evaluates to 0
74    blaze::IsBLASCompatible< unsigned long >::Type  // Results in FalseType
75    blaze::IsBLASCompatible< long double >          // Is derived from FalseType
76    \endcode
77 */
78 template< typename T >
79 struct IsBLASCompatible
80    : public BoolConstant< IsFloat_v<T> || IsDouble_v<T> || IsComplexFloat_v<T> || IsComplexDouble_v<T> >
81 {};
82 //*************************************************************************************************
83 
84 
85 //*************************************************************************************************
86 /*!\brief Auxiliary variable template for the IsBLASCompatible type trait.
87 // \ingroup math_type_traits
88 //
89 // The IsBLASCompatible_v variable template provides a convenient shortcut to access the nested
90 // \a value of the IsBLASCompatible class template. For instance, given the type \a T the
91 // following two statements are identical:
92 
93    \code
94    constexpr bool value1 = blaze::IsBLASCompatible<T>::value;
95    constexpr bool value2 = blaze::IsBLASCompatible_v<T>;
96    \endcode
97 */
98 template< typename T >
99 constexpr bool IsBLASCompatible_v = IsBLASCompatible<T>::value;
100 //*************************************************************************************************
101 
102 } // namespace blaze
103 
104 #endif
105