Expression Templates Library (ETL)
conv_1d_same_expr.hpp
1 //=======================================================================
2 // Copyright (c) 2014-2023 Baptiste Wicht
3 // Distributed under the terms of the MIT License.
4 // (See accompanying file LICENSE or copy at
5 // http://opensource.org/licenses/MIT)
6 //=======================================================================
7 
8 #pragma once
9 
10 #include "etl/expr/base_temporary_expr.hpp"
11 
12 //Get the implementations
13 #include "etl/impl/conv_select.hpp"
14 #include "etl/impl/conv.hpp"
15 
16 namespace etl {
17 
22 template <etl_expr A, etl_expr B>
23 struct conv_1d_same_expr : base_temporary_expr_bin<conv_1d_same_expr<A, B>, A, B> {
28 
29  static constexpr auto storage_order = left_traits::storage_order;
30 
35  static constexpr bool gpu_computable = false;
36 
41  explicit conv_1d_same_expr(A a, B b) : base_type(a, b) {
42  //Nothing else to init
43  }
44 
45  // Assignment functions
46 
50  template <etl_1d I, etl_1d K, etl_1d C>
51  static void check([[maybe_unused]] const I& input, [[maybe_unused]] const K& kernel, [[maybe_unused]] const C& conv) {
52  if constexpr (all_fast<A, B, C>) {
53  static_assert(etl::dim<0, C>() == etl::dim<0, I>(), "Invalid dimensions for conv1_same");
54  static_assert(etl::dim<0, I>() >= etl::dim<0, K>(), "Invalid dimensions for conv1_same");
55  } else {
56  cpp_assert(etl::dim(conv, 0) == etl::dim(input, 0), "Invalid dimensions for conv1_same");
57  cpp_assert(etl::dim(input, 0) >= etl::dim(kernel, 0), "Invalid dimensions for conv1_same");
58  }
59  }
60 
65  template <etl_expr C>
66  void assign_to(C&& conv) const {
67  inc_counter("temp:assign");
68 
69  auto& input_raw = this->a();
70  auto& kernel_raw = this->b();
71 
72  check(input_raw, kernel_raw, conv);
73 
74  // Execute the correct implementation
75 
76  constexpr_select const auto impl = detail::select_conv1_impl_new<conv_type::SAME, A, B, C>();
77 
78  if constexpr_select (impl == etl::conv_impl::VEC) {
79  inc_counter("impl:vec");
80 
81  if constexpr (parallel_support) {
82  bool parallel_dispatch = detail::select_parallel(input_raw, kernel_raw, conv);
83 
84  if (parallel_dispatch) {
85  decltype(auto) input = smart_forward(input_raw);
86  decltype(auto) kernel = smart_forward(kernel_raw);
87 
89  [&](size_t first, size_t last) { impl::vec::conv1_same(input, kernel, conv, first, last); }, 0, etl::size(conv), parallel_dispatch);
90  } else {
91  impl::vec::conv1_same(smart_forward(input_raw), smart_forward(kernel_raw), conv, 0, etl::size(conv));
92  }
93  } else {
94  impl::vec::conv1_same(smart_forward(input_raw), smart_forward(kernel_raw), conv, 0, etl::size(conv));
95  }
96  } else if constexpr_select (impl == etl::conv_impl::STD) {
97  inc_counter("impl:std");
98 
99  if constexpr (parallel_support) {
100  bool parallel_dispatch = detail::select_parallel(input_raw, kernel_raw, conv);
101 
102  if (parallel_dispatch) {
103  decltype(auto) input = smart_forward(input_raw);
104  decltype(auto) kernel = smart_forward(kernel_raw);
105 
106  engine_dispatch_1d([&](size_t first, size_t last) { impl::standard::conv1_same(input, kernel, conv, first, last); },
107  0,
108  etl::size(conv),
109  parallel_dispatch);
110  } else {
111  impl::standard::conv1_same(smart_forward(input_raw), smart_forward(kernel_raw), conv, 0, etl::size(conv));
112  }
113  } else {
114  impl::standard::conv1_same(smart_forward(input_raw), smart_forward(kernel_raw), conv, 0, etl::size(conv));
115  }
116  } else if constexpr_select (impl == etl::conv_impl::EGBLAS) {
117  inc_counter("impl:egblas");
118 
119  if constexpr (all_homogeneous<A, B, C>) {
120  decltype(auto) input = smart_forward_gpu(input_raw);
121  decltype(auto) kernel = smart_forward_gpu(kernel_raw);
122 
123  input.ensure_gpu_up_to_date();
124  kernel.ensure_gpu_up_to_date();
125 
126  conv.ensure_gpu_allocated();
127 
128  impl::egblas::conv1_same(
129  etl::size(input_raw), etl::size(kernel_raw), value_type(1), input.gpu_memory(), 1, kernel.gpu_memory(), 1, conv.gpu_memory(), 1);
130 
131  conv.validate_gpu();
132  conv.invalidate_cpu();
133  } else {
134  cpp_unreachable("Invalid conv implementation selection");
135  }
136  } else {
137  cpp_unreachable("Invalid conv implementation selection");
138  }
139  }
140 
145  template <etl_expr L>
146  void assign_add_to(L&& lhs) const {
147  std_add_evaluate(*this, lhs);
148  }
149 
154  template <etl_expr L>
155  void assign_sub_to(L&& lhs) const {
156  std_sub_evaluate(*this, lhs);
157  }
158 
163  template <etl_expr L>
164  void assign_mul_to(L&& lhs) const {
165  std_mul_evaluate(*this, lhs);
166  }
167 
172  template <etl_expr L>
173  void assign_div_to(L&& lhs) const {
174  std_div_evaluate(*this, lhs);
175  }
176 
181  template <etl_expr L>
182  void assign_mod_to(L&& lhs) const {
183  std_mod_evaluate(*this, lhs);
184  }
185 
192  friend std::ostream& operator<<(std::ostream& os, const conv_1d_same_expr& expr) {
193  return os << "conv1_same(" << expr._a << ", " << expr._b << ")";
194  }
195 };
196 
201 template <typename A, typename B>
204  using left_expr_t = std::decay_t<A>;
205  using right_expr_t = std::decay_t<B>;
209 
210  static constexpr bool is_etl = true;
211  static constexpr bool is_transformer = false;
212  static constexpr bool is_view = false;
213  static constexpr bool is_magic_view = false;
214  static constexpr bool is_fast = all_fast<A, B>;
215  static constexpr bool is_linear = false;
216  static constexpr bool is_thread_safe = true;
217  static constexpr bool is_value = false;
218  static constexpr bool is_direct = true;
219  static constexpr bool is_generator = false;
220  static constexpr bool is_padded = false;
221  static constexpr bool is_aligned = true;
222  static constexpr bool is_temporary = true;
223  static constexpr bool gpu_computable = is_gpu_t<value_type> && cuda_enabled;
224  static constexpr order storage_order = left_traits::storage_order;
225 
231  template <vector_mode_t V>
232  static constexpr bool vectorizable = true;
233 
238  template <size_t DD>
239  static constexpr size_t dim() {
240  return etl::dim<0, A>();
241  }
242 
249  static size_t dim(const expr_t& e, [[maybe_unused]] size_t d) {
250  return etl::dim(e._a, 0);
251  }
252 
258  static size_t size(const expr_t& e) {
259  return etl::dim(e._a, 0);
260  }
261 
266  static constexpr size_t size() {
267  return etl::dim<0, A>();
268  }
269 
274  static constexpr size_t dimensions() {
275  return 1;
276  }
277 
282  static constexpr int complexity() noexcept {
283  return -1;
284  }
285 };
286 
298 template <etl_expr A, etl_expr B>
301 }
302 
315 template <etl_expr A, etl_expr B, etl_expr C>
316 auto conv_1d_same(A&& a, B&& b, C&& c) {
317  c = conv_1d_same(a, b);
318 
319  return c;
320 }
321 
322 } //end of namespace etl
std::decay_t< A > left_expr_t
The left sub expression type.
Definition: conv_1d_same_expr.hpp:204
void engine_dispatch_1d(Functor &&functor, size_t first, size_t last, [[maybe_unused]] size_t threshold, [[maybe_unused]] size_t n_threads=etl::threads)
Dispatch the elements of a range to a functor in a parallel manner, using the global thread engine...
Definition: parallel_support.hpp:708
static void check([[maybe_unused]] const I &input, [[maybe_unused]] const K &kernel, [[maybe_unused]] const C &conv)
Assert that the convolution is done on correct dimensions.
Definition: conv_1d_same_expr.hpp:51
static constexpr size_t dimensions()
Returns the number of dimensions of the expression.
Definition: conv_1d_same_expr.hpp:274
B _b
The sub expression reference.
Definition: base_temporary_expr.hpp:534
Standard implementation.
static constexpr auto storage_order
The sub storage order.
Definition: conv_1d_same_expr.hpp:29
constexpr bool is_magic_view
Traits indicating if the given ETL type is a magic view expression.
Definition: traits.hpp:311
A _a
The sub expression reference.
Definition: base_temporary_expr.hpp:533
static size_t size(const expr_t &e)
Returns the size of the expression.
Definition: conv_1d_same_expr.hpp:258
order
Storage order of a matrix.
Definition: order.hpp:15
void assign_div_to(L &&lhs) const
Divide the given left-hand-side expression.
Definition: conv_1d_same_expr.hpp:173
constexpr bool cuda_enabled
Indicates if CUDA is available.
Definition: config.hpp:94
conv_1d_same_expr< detail::build_type< A >, detail::build_type< B > > conv_1d_same(A &&a, B &&b)
Creates an expression representing the &#39;same&#39; 1D convolution of a and b.
Definition: conv_1d_same_expr.hpp:299
void assign_add_to(L &&lhs) const
Add to the given left-hand-side expression.
Definition: conv_1d_same_expr.hpp:146
Abstract base class for temporary binary expression.
Definition: base_temporary_expr.hpp:529
VEC implementation.
void assign_mul_to(L &&lhs) const
Multiply the given left-hand-side expression.
Definition: conv_1d_same_expr.hpp:164
std::add_lvalue_reference_t< B > b()
Returns the sub expression.
Definition: base_temporary_expr.hpp:593
friend std::ostream & operator<<(std::ostream &os, const conv_1d_same_expr &expr)
Print a representation of the expression on the given stream.
Definition: conv_1d_same_expr.hpp:192
constexpr bool is_fast
Traits to test if the given ETL expresion type is fast (sizes known at compile-time) ...
Definition: traits.hpp:588
Traits to get information about ETL types.
Definition: tmp.hpp:68
Root namespace for the ETL library.
Definition: adapter.hpp:15
std::decay_t< B > right_expr_t
The right sub expression type.
Definition: conv_1d_same_expr.hpp:205
GPU implementation.
auto dim(E &&value, size_t i) -> detail::identity_helper< E, dim_view< detail::build_identity_type< E >, D >>
Return a view representing the ith Dth dimension.
Definition: view_expression_builder.hpp:25
static size_t dim(const expr_t &e, [[maybe_unused]] size_t d)
Returns the dth dimension of the expression.
Definition: conv_1d_same_expr.hpp:249
std::conditional_t< is_etl_value< T >, const std::decay_t< T > &, std::decay_t< T > > build_type
Helper to build the type for a sub expression.
Definition: expression_helpers.hpp:24
void std_mod_evaluate(Expr &&expr, Result &&result)
Compound modulo evaluation of the expr into result.
Definition: evaluator.hpp:1271
static constexpr bool gpu_computable
Indicates if the temporary expression can be directly evaluated using only GPU.
Definition: conv_1d_same_expr.hpp:35
A transposition expression.
Definition: conv_1d_same_expr.hpp:23
void std_mul_evaluate(Expr &&expr, Result &&result)
Compound multiply evaluation of the expr into result.
Definition: evaluator.hpp:1233
static constexpr size_t size()
Returns the size of the expression.
Definition: conv_1d_same_expr.hpp:266
constexpr bool is_transformer
Traits indicating if the given ETL type is a transformer expression.
Definition: traits.hpp:297
Selector for the convolution implementations.
decltype(auto) smart_forward_gpu(E &expr)
Smart forwarding for a temporary expression that will be computed in GPU.
Definition: helpers.hpp:343
value_t< A > value_type
The value type of the expression.
Definition: conv_1d_same_expr.hpp:208
constexpr size_t size(const E &expr) noexcept
Returns the size of the given ETL expression.
Definition: helpers.hpp:108
constexpr bool is_view
Traits indicating if the given ETL type is a view expression.
Definition: traits.hpp:304
static constexpr size_t dim()
Returns the DDth dimension of the expression.
Definition: conv_1d_same_expr.hpp:239
void std_sub_evaluate(Expr &&expr, Result &&result)
Compound subtract evaluation of the expr into result.
Definition: evaluator.hpp:1214
decltype(auto) smart_forward(E &expr)
Smart forwarding for a temporary expression.
Definition: helpers.hpp:323
constexpr bool parallel_support
Indicates if support for parallelization is integrated into the framework.
Definition: config.hpp:51
void assign_sub_to(L &&lhs) const
Sub from the given left-hand-side expression.
Definition: conv_1d_same_expr.hpp:155
value_t< A > value_type
The type of value of the expression.
Definition: conv_1d_same_expr.hpp:24
constexpr bool is_thread_safe
Traits to test if the given ETL expresion type is thread safe.
Definition: traits.hpp:687
void assign_to(C &&conv) const
Assign to a matrix of the same storage order.
Definition: conv_1d_same_expr.hpp:66
Contains selectors for convolution implementations.
void assign_mod_to(L &&lhs) const
Modulo the given left-hand-side expression.
Definition: conv_1d_same_expr.hpp:182
typename decay_traits< E >::value_type value_t
Traits to extract the value type out of an ETL type.
Definition: tmp.hpp:81
void std_div_evaluate(Expr &&expr, Result &&result)
Compound divide evaluation of the expr into result.
Definition: evaluator.hpp:1252
void inc_counter([[maybe_unused]] const char *name)
Increase the given counter.
Definition: counters.hpp:25
std::add_lvalue_reference_t< A > a()
Returns the sub expression.
Definition: base_temporary_expr.hpp:577
static constexpr int complexity() noexcept
Estimate the complexity of computation.
Definition: conv_1d_same_expr.hpp:282
conv_1d_same_expr(A a, B b)
Construct a new expression.
Definition: conv_1d_same_expr.hpp:41
void std_add_evaluate(Expr &&expr, Result &&result)
Compound add evaluation of the expr into result.
Definition: evaluator.hpp:1195