Expression Templates Library (ETL)
dyn_pool_derivative_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/pooling.hpp"
14 
15 namespace etl {
16 
21 template <etl_expr A, etl_expr B, typename Impl>
22 struct dyn_pool_derivative_expr : base_temporary_expr_bin<dyn_pool_derivative_expr<A, B, Impl>, A, B> {
27 
28  static constexpr auto storage_order = left_traits::storage_order;
29 
34  static constexpr bool gpu_computable = false;
35 
36  const size_t c1;
37  const size_t c2;
38  const size_t c3;
39 
40  const size_t s1;
41  const size_t s2;
42  const size_t s3;
43 
44  const size_t p1;
45  const size_t p2;
46  const size_t p3;
47 
52  explicit dyn_pool_derivative_expr(A a, B b, size_t c1, size_t c2, size_t c3, size_t s1, size_t s2, size_t s3, size_t p1, size_t p2, size_t p3) :
53  base_type(a, b), c1(c1), c2(c2), c3(c3), s1(s1), s2(s2), s3(s3), p1(p1), p2(p2), p3(p3) {
54  //Nothing else to init
55  }
56 
57  // Assignment functions
58 
63  template <etl_expr C>
64  void assign_to(C&& c) const {
65  inc_counter("temp:assign");
66 
67  auto& a = this->a();
68  auto& b = this->b();
69 
70  Impl::apply(smart_forward(a), smart_forward(b), c, c1, c2, c3, s1, s2, s3, p1, p2, p3);
71  }
72 
77  template <typename L>
78  void assign_add_to(L&& lhs) const {
79  std_add_evaluate(*this, lhs);
80  }
81 
86  template <typename L>
87  void assign_sub_to(L&& lhs) const {
88  std_sub_evaluate(*this, lhs);
89  }
90 
95  template <typename L>
96  void assign_mul_to(L&& lhs) const {
97  std_mul_evaluate(*this, lhs);
98  }
99 
104  template <typename L>
105  void assign_div_to(L&& lhs) const {
106  std_div_evaluate(*this, lhs);
107  }
108 
113  template <typename L>
114  void assign_mod_to(L&& lhs) const {
115  std_mod_evaluate(*this, lhs);
116  }
117 
124  friend std::ostream& operator<<(std::ostream& os, const dyn_pool_derivative_expr& expr) {
125  return os << "pool_derivative(" << expr._a << ", " << expr._b << ")";
126  }
127 };
128 
133 template <typename A, typename B, typename Impl>
136  using left_expr_t = std::decay_t<A>;
137  using right_expr_t = std::decay_t<B>;
141 
142  static constexpr bool is_etl = true;
143  static constexpr bool is_transformer = false;
144  static constexpr bool is_view = false;
145  static constexpr bool is_magic_view = false;
146  static constexpr bool is_fast = left_traits::is_fast && right_traits::is_fast;
147  static constexpr bool is_linear = false;
148  static constexpr bool is_thread_safe = true;
149  static constexpr bool is_value = false;
150  static constexpr bool is_direct = true;
151  static constexpr bool is_generator = false;
152  static constexpr bool is_padded = false;
153  static constexpr bool is_aligned = true;
154  static constexpr bool is_temporary = true;
155  static constexpr bool gpu_computable = is_gpu_t<value_type> && cuda_enabled;
156  static constexpr order storage_order = left_traits::storage_order;
157 
163  template <vector_mode_t V>
164  static constexpr bool vectorizable = true;
165 
170  template <size_t DD>
171  static constexpr size_t dim() {
172  return left_traits::template dim<DD>();
173  }
174 
181  static size_t dim(const expr_t& e, size_t d) {
182  return left_traits::dim(e._a, d);
183  }
184 
190  static size_t size(const expr_t& e) {
191  return left_traits::size(e._a);
192  }
193 
198  static constexpr size_t size() {
199  return left_traits::size();
200  }
201 
206  static constexpr size_t dimensions() {
207  return left_traits::dimensions();
208  }
209 
214  static constexpr int complexity() noexcept {
215  return -1;
216  }
217 };
218 
227 template <typename E, typename F>
229  return dyn_pool_derivative_expr<detail::build_type<E>, F, impl::max_pool_derivative_2d>{input, output, c1, c2, 0, c1, c2, 0, 0, 0, 0};
230 }
231 
240 template <typename E, typename F>
242  E&& input, F&& output, size_t c1, size_t c2, size_t s1, size_t s2, size_t p1 = 0, size_t p2 = 0) {
244 }
245 
255 template <typename E, typename F>
257  E&& input, F&& output, size_t c1, size_t c2, size_t c3) {
259 }
260 
269 template <typename E, typename F>
271  return dyn_pool_derivative_expr<detail::build_type<E>, F, impl::avg_pool_derivative_2d>{input, output, c1, c2, 0, c1, c2, 0, 0, 0, 0};
272 }
273 
282 template <typename E, typename F>
284  E&& input, F&& output, size_t c1, size_t c2, size_t s1, size_t s2, size_t p1 = 0, size_t p2 = 0) {
286 }
287 
297 template <typename E, typename F>
299  E&& input, F&& output, size_t c1, size_t c2, size_t c3) {
301 }
302 
303 } //end of namespace etl
const size_t p2
The padding for the second dimension.
Definition: dyn_pool_derivative_expr.hpp:45
static constexpr size_t dimensions()
Returns the number of dimensions of the expression.
Definition: dyn_pool_derivative_expr.hpp:206
dyn_pool_derivative_expr(A a, B b, size_t c1, size_t c2, size_t c3, size_t s1, size_t s2, size_t s3, size_t p1, size_t p2, size_t p3)
Construct a new expression.
Definition: dyn_pool_derivative_expr.hpp:52
const size_t s3
The stride for the third dimension.
Definition: dyn_pool_derivative_expr.hpp:42
dyn_pool_derivative_expr< detail::build_type< E >, F, impl::max_pool_derivative_3d > max_pool_derivative_3d(E &&input, F &&output, size_t c1, size_t c2, size_t c3)
Derivative of the 3D Max Pooling of the given matrix expression.
Definition: dyn_pool_derivative_expr.hpp:256
B _b
The sub expression reference.
Definition: base_temporary_expr.hpp:534
const size_t c2
The pooling ratio for the second dimension.
Definition: dyn_pool_derivative_expr.hpp:37
const size_t p3
The padding for the third dimension.
Definition: dyn_pool_derivative_expr.hpp:46
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
dyn_pool_derivative_expr< detail::build_type< E >, F, impl::avg_pool_derivative_2d > avg_pool_derivative_2d(E &&input, F &&output, size_t c1, size_t c2)
Derivative of the 2D Avg Pooling of the given matrix expression.
Definition: dyn_pool_derivative_expr.hpp:270
static constexpr size_t size()
Returns the size of the expression.
Definition: dyn_pool_derivative_expr.hpp:198
std::decay_t< B > right_expr_t
The right sub expression type.
Definition: dyn_pool_derivative_expr.hpp:137
order
Storage order of a matrix.
Definition: order.hpp:15
friend std::ostream & operator<<(std::ostream &os, const dyn_pool_derivative_expr &expr)
Print a representation of the expression on the given stream.
Definition: dyn_pool_derivative_expr.hpp:124
const size_t c3
The pooling ratio for the third dimension.
Definition: dyn_pool_derivative_expr.hpp:38
constexpr bool cuda_enabled
Indicates if CUDA is available.
Definition: config.hpp:94
void assign_div_to(L &&lhs) const
Divide the given left-hand-side expression.
Definition: dyn_pool_derivative_expr.hpp:105
Abstract base class for temporary binary expression.
Definition: base_temporary_expr.hpp:529
std::decay_t< A > left_expr_t
The left sub expression type.
Definition: dyn_pool_derivative_expr.hpp:136
Functor for the derivative of 3D Max Pooling.
Definition: max_pooling_derivative.hpp:279
void assign_mul_to(L &&lhs) const
Multiply the given left-hand-side expression.
Definition: dyn_pool_derivative_expr.hpp:96
std::add_lvalue_reference_t< B > b()
Returns the sub expression.
Definition: base_temporary_expr.hpp:593
void assign_mod_to(L &&lhs) const
Modulo the given left-hand-side expression.
Definition: dyn_pool_derivative_expr.hpp:114
static constexpr size_t dim()
Returns the DDth dimension of the expression.
Definition: dyn_pool_derivative_expr.hpp:171
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
Functor for the derivative of 2D Avg Pooling.
Definition: avg_pooling_derivative.hpp:15
static constexpr size_t dimensions()
Return the number of dimensions of the expression.
Definition: traits_base.hpp:31
static constexpr auto storage_order
The sub storage order.
Definition: dyn_pool_derivative_expr.hpp:28
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
value_t< A > value_type
The type of value of the expression.
Definition: dyn_pool_derivative_expr.hpp:23
void assign_sub_to(L &&lhs) const
Sub from the given left-hand-side expression.
Definition: dyn_pool_derivative_expr.hpp:87
const size_t s2
The stride for the second dimension.
Definition: dyn_pool_derivative_expr.hpp:41
void assign_to(C &&c) const
Assign to a matrix of the same storage order.
Definition: dyn_pool_derivative_expr.hpp:64
void std_mod_evaluate(Expr &&expr, Result &&result)
Compound modulo evaluation of the expr into result.
Definition: evaluator.hpp:1271
value_t< A > value_type
The value type of the expression.
Definition: dyn_pool_derivative_expr.hpp:140
static constexpr int complexity() noexcept
Estimate the complexity of computation.
Definition: dyn_pool_derivative_expr.hpp:214
static size_t dim(const expr_t &e, size_t d)
Returns the dth dimension of the expression.
Definition: dyn_pool_derivative_expr.hpp:181
void std_mul_evaluate(Expr &&expr, Result &&result)
Compound multiply evaluation of the expr into result.
Definition: evaluator.hpp:1233
constexpr bool is_transformer
Traits indicating if the given ETL type is a transformer expression.
Definition: traits.hpp:297
dyn_pool_derivative_expr< detail::build_type< E >, F, impl::avg_pool_derivative_3d > avg_pool_derivative_3d(E &&input, F &&output, size_t c1, size_t c2, size_t c3)
Derivative of the 3D Avg Pooling of the given matrix expression.
Definition: dyn_pool_derivative_expr.hpp:298
const size_t p1
The padding for the first dimension.
Definition: dyn_pool_derivative_expr.hpp:44
const size_t c1
The pooling ratio for the first dimension.
Definition: dyn_pool_derivative_expr.hpp:36
constexpr bool is_view
Traits indicating if the given ETL type is a view expression.
Definition: traits.hpp:304
const size_t s1
The stride for the first dimension.
Definition: dyn_pool_derivative_expr.hpp:40
static constexpr bool is_fast
Indicates if T is a fast structure.
Definition: traits_base.hpp:25
Functor for the derivative of 2D Max Pooling.
Definition: max_pooling_derivative.hpp:17
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
void assign_add_to(L &&lhs) const
Add to the given left-hand-side expression.
Definition: dyn_pool_derivative_expr.hpp:78
A transposition expression.
Definition: dyn_pool_derivative_expr.hpp:22
constexpr bool is_thread_safe
Traits to test if the given ETL expresion type is thread safe.
Definition: traits.hpp:687
typename decay_traits< E >::value_type value_t
Traits to extract the value type out of an ETL type.
Definition: tmp.hpp:81
Functor for the derivative of 3D Avg Pooling.
Definition: avg_pooling_derivative.hpp:205
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
static size_t size(const expr_t &e)
Returns the size of the expression.
Definition: dyn_pool_derivative_expr.hpp:190
static constexpr bool gpu_computable
Indicates if the temporary expression can be directly evaluated using only GPU.
Definition: dyn_pool_derivative_expr.hpp:34
std::add_lvalue_reference_t< A > a()
Returns the sub expression.
Definition: base_temporary_expr.hpp:577
dyn_pool_derivative_expr< detail::build_type< E >, F, impl::max_pool_derivative_2d > max_pool_derivative_2d(E &&input, F &&output, size_t c1, size_t c2)
Derivative of the 2D Max Pooling of the given matrix expression.
Definition: dyn_pool_derivative_expr.hpp:228
void std_add_evaluate(Expr &&expr, Result &&result)
Compound add evaluation of the expr into result.
Definition: evaluator.hpp:1195