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_SCHEDULETRAIT_HPP
46 #define KOKKOS_KOKKOS_SCHEDULETRAIT_HPP
47
48 #include <Kokkos_Macros.hpp>
49 #include <Kokkos_Concepts.hpp> // is_schedule_type, Schedule
50 #include <traits/Kokkos_PolicyTraitAdaptor.hpp>
51 #include <traits/Kokkos_Traits_fwd.hpp>
52
53 namespace Kokkos {
54
55 namespace Impl {
56
57 //==============================================================================
58 // <editor-fold desc="trait specification"> {{{1
59
60 struct ScheduleTrait : TraitSpecificationBase<ScheduleTrait> {
61 struct base_traits {
62 static constexpr auto schedule_type_is_defaulted = true;
63
64 using schedule_type = Schedule<Static>;
65 };
66 template <class T>
67 using trait_matches_specification = is_schedule_type<T>;
68 };
69
70 // </editor-fold> end trait specification }}}1
71 //==============================================================================
72
73 //==============================================================================
74 // <editor-fold desc="AnalyzeExecPolicy specializations"> {{{1
75
76 template <class ScheduleType, class... Traits>
77 struct AnalyzeExecPolicy<void, Kokkos::Schedule<ScheduleType>, Traits...>
78 : AnalyzeExecPolicy<void, Traits...> {
79 using base_t = AnalyzeExecPolicy<void, Traits...>;
80 using base_t::base_t;
81 static_assert(base_t::schedule_type_is_defaulted,
82 "Kokkos Error: More than one schedule type given");
83 static constexpr bool schedule_type_is_defaulted = false;
84 using schedule_type = Kokkos::Schedule<ScheduleType>;
85 };
86
87 // </editor-fold> end AnalyzeExecPolicy specializations }}}1
88 //==============================================================================
89
90 } // end namespace Impl
91
92 namespace Experimental {
93
94 //==============================================================================
95 // <editor-fold desc="User interface"> {{{1
96
97 template <class Policy, class ScheduleType>
require(Policy const & p,Kokkos::Schedule<ScheduleType>)98 constexpr auto require(Policy const& p, Kokkos::Schedule<ScheduleType>) {
99 static_assert(Kokkos::is_execution_policy<Policy>::value, "");
100 using new_policy_t = Kokkos::Impl::ScheduleTrait::policy_with_trait<
101 Policy, Kokkos::Schedule<ScheduleType>>;
102 return new_policy_t{p};
103 }
104
105 // </editor-fold> end User interface }}}1
106 //==============================================================================
107
108 } // end namespace Experimental
109
110 } // end namespace Kokkos
111
112 #endif // KOKKOS_KOKKOS_SCHEDULETRAIT_HPP
113