1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 //                        Kokkos v. 3.0
6 //       Copyright (2020) National Technology & Engineering
7 //               Solutions of Sandia, LLC (NTESS).
8 //
9 // Under the terms of Contract DE-NA0003525 with NTESS,
10 // the U.S. Government retains certain rights in this software.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Christian R. Trott (crtrott@sandia.gov)
40 //
41 // ************************************************************************
42 //@HEADER
43 */
44 
45 #ifndef KOKKOS_KOKKOS_INDEXTYPETRAIT_HPP
46 #define KOKKOS_KOKKOS_INDEXTYPETRAIT_HPP
47 
48 #include <Kokkos_Macros.hpp>
49 #include <Kokkos_Concepts.hpp>  // IndexType, is_index_type
50 #include <traits/Kokkos_PolicyTraitAdaptor.hpp>
51 #include <traits/Kokkos_Traits_fwd.hpp>
52 
53 namespace Kokkos {
54 namespace Impl {
55 
56 //==============================================================================
57 // <editor-fold desc="trait specification"> {{{1
58 
59 struct IndexTypeTrait : TraitSpecificationBase<IndexTypeTrait> {
60   struct base_traits {
61     static constexpr bool index_type_is_defaulted = true;
62     using index_type = dependent_policy_trait_default;
63   };
64   template <class T>
65   using trait_matches_specification =
66       std::integral_constant<bool, std::is_integral<T>::value ||
67                                        is_index_type<T>::value>;
68 };
69 
70 // </editor-fold> end trait specification }}}1
71 //==============================================================================
72 
73 //==============================================================================
74 // <editor-fold desc="AnalyzeExecPolicy specializations"> {{{1
75 
76 // Index type given as IndexType template
77 template <class IntegralIndexType, class... Traits>
78 struct AnalyzeExecPolicy<void, Kokkos::IndexType<IntegralIndexType>, Traits...>
79     : AnalyzeExecPolicy<void, Traits...> {
80   using base_t = AnalyzeExecPolicy<void, Traits...>;
81   using base_t::base_t;
82   static_assert(base_t::index_type_is_defaulted,
83                 "Kokkos Error: More than one index type given");
84   static constexpr bool index_type_is_defaulted = false;
85   using index_type = Kokkos::IndexType<IntegralIndexType>;
86 };
87 
88 // IndexType given as an integral type directly
89 template <class IntegralIndexType, class... Traits>
90 struct AnalyzeExecPolicy<
91     std::enable_if_t<std::is_integral<IntegralIndexType>::value>,
92     IntegralIndexType, Traits...> : AnalyzeExecPolicy<void, Traits...> {
93   using base_t = AnalyzeExecPolicy<void, Traits...>;
94   using base_t::base_t;
95   static_assert(base_t::index_type_is_defaulted,
96                 "Kokkos Error: More than one index type given");
97   static constexpr bool index_type_is_defaulted = false;
98   using index_type = Kokkos::IndexType<IntegralIndexType>;
99 };
100 
101 // </editor-fold> end AnalyzeExecPolicy specializations }}}1
102 //==============================================================================
103 
104 }  // end namespace Impl
105 }  // end namespace Kokkos
106 
107 #endif  // KOKKOS_KOKKOS_INDEXTYPETRAIT_HPP
108