1 //=================================================================================================
2 /*!
3 //  \file blaze/math/typetraits/IsScalar.h
4 //  \brief Header file for the IsScalar 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_ISSCALAR_H_
36 #define _BLAZE_MATH_TYPETRAITS_ISSCALAR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <blaze/math/typetraits/HasCompositeType.h>
44 #include <blaze/math/typetraits/IsProxy.h>
45 #include <blaze/math/typetraits/IsSIMDPack.h>
46 #include <blaze/util/IntegralConstant.h>
47 #include <blaze/util/typetraits/IsPointer.h>
48 #include <blaze/util/typetraits/IsReference.h>
49 
50 
51 namespace blaze {
52 
53 //=================================================================================================
54 //
55 //  CLASS DEFINITION
56 //
57 //=================================================================================================
58 
59 //*************************************************************************************************
60 /*!\brief Compile time check for scalar types.
61 // \ingroup math_type_traits
62 //
63 // This type trait tests whether or not the given template parameter is scalar type (i.e. neither
64 // a vector, nor a matrix, proxy, SIMD pack, reference or pointer type). In case the type is a
65 // scalar type, the \a value member constant is set to \a true, the nested type definition \a Type
66 // is \a TrueType, and the class derives from \a TrueType. Otherwise \a value is set to \a false,
67 // \a Type is \a FalseType, and the class derives from \a FalseType.
68 
69    \code
70    blaze::IsScalar< int >::value                         // Evaluates to 1
71    blaze::IsScalar< const double >::Type                 // Results in TrueType
72    blaze::IsScalar< volatile complex<float> >            // Is derived from TrueType
73    blaze::IsScalar< StaticVector<double,3UL> >::value    // Evaluates to 0
74    blaze::IsScalar< const DynamicMatrix<double> >::Type  // Results in FalseType
75    blaze::IsScalar< volatile CompressedMatrix<int> >     // Is derived from FalseType
76    \endcode
77 */
78 
79 template< typename T >
80 struct IsScalar
81    : public BoolConstant< !HasCompositeType_v<T> &&
82                           !IsProxy_v<T> &&
83                           !IsSIMDPack_v<T> &&
84                           !IsReference_v<T> &&
85                           !IsPointer_v<T> >
86 {};
87 //*************************************************************************************************
88 
89 
90 //*************************************************************************************************
91 /*!\brief Auxiliary variable template for the IsScalar type trait.
92 // \ingroup math_type_traits
93 //
94 // The IsScalar_v variable template provides a convenient shortcut to access the nested \a value
95 // of the IsScalar class template. For instance, given the type \a T the following two statements
96 // are identical:
97 
98    \code
99    constexpr bool value1 = blaze::IsScalar<T>::value;
100    constexpr bool value2 = blaze::IsScalar_v<T>;
101    \endcode
102 */
103 template< typename T >
104 constexpr bool IsScalar_v = IsScalar<T>::value;
105 //*************************************************************************************************
106 
107 } // namespace blaze
108 
109 #endif
110