Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Tpetra_for_each.hpp
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Tpetra: Templated Linear Algebra Services Package
6 // Copyright (2008) Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ************************************************************************
41 // @HEADER
42 */
43 
44 #ifndef TPETRA_FOR_EACH_HPP
45 #define TPETRA_FOR_EACH_HPP
46 
47 #include "TpetraCore_config.h"
48 #include <type_traits>
49 
53 
54 namespace Tpetra {
55 
74  template<class ExecutionSpace,
75  class GlobalDataStructure,
76  class UserFunctionType>
77  void
78  for_each (const char kernelLabel[],
79  ExecutionSpace execSpace,
80  GlobalDataStructure& X,
81  UserFunctionType f);
82 
97  template<class GlobalDataStructure,
98  class UserFunctionType>
99  void
100  for_each (const char kernelLabel[],
101  GlobalDataStructure& X,
102  UserFunctionType f);
103 
104  namespace Details {
105 
108  template<class ExecutionSpace,
109  class GlobalDataStructure,
110  class UserFunctionType>
111  struct ForEach {
112  static void
113  for_each (const char kernelLabel[],
114  ExecutionSpace execSpace,
115  GlobalDataStructure& X,
116  UserFunctionType f);
117  };
118 
119  } // namespace Details
120 
121  template<class ExecutionSpace,
122  class GlobalDataStructure,
123  class UserFunctionType>
124  void
125  for_each (const char kernelLabel[],
126  ExecutionSpace execSpace,
127  GlobalDataStructure& X,
128  UserFunctionType f)
129  {
130  using impl_type = Details::ForEach<
131  ExecutionSpace,
132  typename std::remove_const<GlobalDataStructure>::type,
133  UserFunctionType>;
134 
135  impl_type::for_each (kernelLabel, execSpace, X, f);
136  }
137 
138  template<class GlobalDataStructure,
139  class UserFunctionType>
140  void
141  for_each (const char kernelLabel[],
142  GlobalDataStructure& X,
143  UserFunctionType f)
144  {
145  using execution_space =
146  typename GlobalDataStructure::device_type::execution_space;
147  using impl_type = Details::ForEach<
148  execution_space,
149  typename std::remove_const<GlobalDataStructure>::type,
150  UserFunctionType>;
151 
152  execution_space execSpace;
153  impl_type::for_each (kernelLabel, execSpace, X, f);
154  }
155 
156 } // namespace Tpetra
157 
158 #endif // TPETRA_FOR_EACH_HPP
159 
Specialize this class to implement Tpetra::for_each for specific GlobalDataStructure types...
void for_each(const char kernelLabel[], ExecutionSpace execSpace, GlobalDataStructure &X, UserFunctionType f)
Apply a function entrywise to each local entry of a Tpetra global data structure, analogously to std:...