Expression Templates Library (ETL)
dyn_pool_2d_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 namespace etl {
13 
18 template <etl_expr A, typename Impl>
19 struct dyn_pool_2d_expr : base_temporary_expr_un<dyn_pool_2d_expr<A, Impl>, A, false> {
24 
25  static constexpr auto storage_order = sub_traits::storage_order;
26 
31  static constexpr bool gpu_computable = Impl::template gpu_computable<A>;
32 
33  const size_t c1;
34  const size_t c2;
35  const size_t s1;
36  const size_t s2;
37  const size_t p1;
38  const size_t p2;
39 
44  explicit dyn_pool_2d_expr(A a, size_t c1, size_t c2, size_t s1, size_t s2, size_t p1, size_t p2)
45  : base_type(a), c1(c1), c2(c2), s1(s1), s2(s2), p1(p1), p2(p2) {
46  //Nothing else to init
47  }
48 
49  // Assignment functions
50 
55  template <same_dimensions<A> C>
56  void assign_to(C&& c) const {
57  inc_counter("temp:assign");
58 
59  auto& a = this->a();
60 
61  Impl::template apply<>(a, c, c1, c2, s1, s2, p1, p2);
62  }
63 
68  template <same_dimensions<A> L>
69  void assign_add_to(L&& lhs) const {
70  std_add_evaluate(*this, lhs);
71  }
72 
77  template <same_dimensions<A> L>
78  void assign_sub_to(L&& lhs) const {
79  std_sub_evaluate(*this, lhs);
80  }
81 
86  template <same_dimensions<A> L>
87  void assign_mul_to(L&& lhs) const {
88  std_mul_evaluate(*this, lhs);
89  }
90 
95  template <same_dimensions<A> L>
96  void assign_div_to(L&& lhs) const {
97  std_div_evaluate(*this, lhs);
98  }
99 
104  template <same_dimensions<A> L>
105  void assign_mod_to(L&& lhs) const {
106  std_mod_evaluate(*this, lhs);
107  }
108 
115  friend std::ostream& operator<<(std::ostream& os, const dyn_pool_2d_expr& expr) {
116  return os << "pool2(" << expr._a << ")";
117  }
118 };
119 
124 template <typename A, typename Impl>
125 struct etl_traits<etl::dyn_pool_2d_expr<A, Impl>> {
127  using sub_expr_t = std::decay_t<A>;
130 
131  static constexpr size_t D = sub_traits::dimensions();
132 
133  static constexpr bool is_etl = true;
134  static constexpr bool is_transformer = false;
135  static constexpr bool is_view = false;
136  static constexpr bool is_magic_view = false;
137  static constexpr bool is_fast = false;
138  static constexpr bool is_linear = false;
139  static constexpr bool is_thread_safe = true;
140  static constexpr bool is_value = false;
141  static constexpr bool is_direct = true;
142  static constexpr bool is_generator = false;
143  static constexpr bool is_padded = false;
144  static constexpr bool is_aligned = true;
145  static constexpr bool is_temporary = true;
146  static constexpr order storage_order = sub_traits::storage_order;
147  static constexpr bool gpu_computable = is_gpu_t<value_type> && cuda_enabled;
148 
154  template <vector_mode_t V>
155  static constexpr bool vectorizable = true;
156 
163  static size_t dim(const expr_t& e, size_t d) {
164  if (d == D - 2) {
165  return (etl::dim(e._a, d) - e.c1 + 2 * e.p1) / e.s1 + 1;
166  } else if (d == D - 1) {
167  return (etl::dim(e._a, d) - e.c2 + 2 * e.p2) / e.s2 + 1;
168  } else {
169  return etl::dim(e._a, d);
170  }
171  }
172 
178  static size_t size(const expr_t& e) {
179  size_t acc = 1;
180  for (size_t i = 0; i < D; ++i) {
181  acc *= dim(e, i);
182  }
183  return acc;
184  }
185 
190  static constexpr size_t dimensions() {
191  return D;
192  }
193 
198  static constexpr int complexity() noexcept {
199  return -1;
200  }
201 };
202 
210 template <etl_expr E>
213 }
214 
222 template <etl_expr E>
223 dyn_pool_2d_expr<detail::build_type<E>, impl::max_pool_2d> max_pool_2d(E&& value, size_t c1, size_t c2, size_t s1, size_t s2, size_t p1 = 0, size_t p2 = 0) {
225 }
226 
234 template <etl_expr E>
237 }
238 
246 template <etl_expr E>
247 dyn_pool_2d_expr<detail::build_type<E>, impl::avg_pool_2d> avg_pool_2d(E&& value, size_t c1, size_t c2, size_t s1, size_t s2, size_t p1 = 0, size_t p2 = 0) {
249 }
250 
258 template <etl_expr E>
260  validate_pmax_pooling(value, c1, c2);
262 }
263 
264 } //end of namespace etl
A transposition expression.
Definition: dyn_pool_2d_expr.hpp:19
void assign_add_to(L &&lhs) const
Add to the given left-hand-side expression.
Definition: dyn_pool_2d_expr.hpp:69
static constexpr int complexity() noexcept
Estimate the complexity of computation.
Definition: dyn_pool_2d_expr.hpp:198
std::add_lvalue_reference_t< A > a()
Returns the sub expression.
Definition: base_temporary_expr.hpp:489
const size_t s2
The stride for the second dimension.
Definition: dyn_pool_2d_expr.hpp:36
constexpr bool is_magic_view
Traits indicating if the given ETL type is a magic view expression.
Definition: traits.hpp:311
value_t< A > value_type
The type of value of the expression.
Definition: dyn_pool_2d_expr.hpp:20
Functor for 2D Average Pooling.
Definition: pooling.hpp:174
D D
The number of dimensions.
Definition: dyn_matrix_view.hpp:24
order
Storage order of a matrix.
Definition: order.hpp:15
constexpr bool cuda_enabled
Indicates if CUDA is available.
Definition: config.hpp:94
void assign_to(C &&c) const
Assign to a matrix of the same storage order.
Definition: dyn_pool_2d_expr.hpp:56
const size_t p2
The padding for the second dimension.
Definition: dyn_pool_2d_expr.hpp:38
value_t< A > value_type
The value type of the expression.
Definition: dyn_pool_2d_expr.hpp:129
A _a
The sub expression reference.
Definition: base_temporary_expr.hpp:447
const size_t s1
The stride for the first dimension.
Definition: dyn_pool_2d_expr.hpp:35
const size_t c1
The pooling ratio for the first dimension.
Definition: dyn_pool_2d_expr.hpp:33
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
dyn_pool_2d_expr< detail::build_type< E >, impl::max_pool_2d > max_pool_2d(E &&value, size_t c1, size_t c2)
2D Max Pooling of the given matrix expression
Definition: dyn_pool_2d_expr.hpp:211
static constexpr size_t dimensions()
Return the number of dimensions of the expression.
Definition: traits_base.hpp:31
static size_t size(const expr_t &e)
Returns the size of the expression.
Definition: dyn_pool_2d_expr.hpp:178
dyn_pool_2d_expr(A a, size_t c1, size_t c2, size_t s1, size_t s2, size_t p1, size_t p2)
Construct a new expression.
Definition: dyn_pool_2d_expr.hpp:44
Functor for 2D Max Pooling.
Definition: pooling.hpp:94
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
void validate_pmax_pooling(const E &expr)
Make sure that the pooling ratios are correct and that the expression can be pooled from...
Definition: checks.hpp:182
void assign_mod_to(L &&lhs) const
Modulo the given left-hand-side expression.
Definition: dyn_pool_2d_expr.hpp:105
void std_mod_evaluate(Expr &&expr, Result &&result)
Compound modulo evaluation of the expr into result.
Definition: evaluator.hpp:1271
void assign_div_to(L &&lhs) const
Divide the given left-hand-side expression.
Definition: dyn_pool_2d_expr.hpp:96
void assign_sub_to(L &&lhs) const
Sub from the given left-hand-side expression.
Definition: dyn_pool_2d_expr.hpp:78
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
std::decay_t< A > sub_expr_t
The sub expression type.
Definition: dyn_pool_2d_expr.hpp:127
static size_t dim(const expr_t &e, size_t d)
Returns the dth dimension of the expression.
Definition: dyn_pool_2d_expr.hpp:163
constexpr bool is_view
Traits indicating if the given ETL type is a view expression.
Definition: traits.hpp:304
static constexpr bool gpu_computable
Indicates if the temporary expression can be directly evaluated using only GPU.
Definition: dyn_pool_2d_expr.hpp:31
static constexpr size_t dimensions()
Returns the number of dimensions of the expression.
Definition: dyn_pool_2d_expr.hpp:190
void std_sub_evaluate(Expr &&expr, Result &&result)
Compound subtract evaluation of the expr into result.
Definition: evaluator.hpp:1214
Abstract base class for temporary unary expression.
Definition: base_temporary_expr.hpp:443
const size_t c2
The pooling ratio for the second dimension.
Definition: dyn_pool_2d_expr.hpp:34
void assign_mul_to(L &&lhs) const
Multiply the given left-hand-side expression.
Definition: dyn_pool_2d_expr.hpp:87
dyn_pool_2d_expr< detail::build_type< E >, impl::standard::dyn_pmp_p_impl > p_max_pool_p(E &&value, size_t c1, size_t c2)
Probabilistic Max Pooling for pooling units.
Definition: dyn_pool_2d_expr.hpp:259
static constexpr auto storage_order
The sub storage order.
Definition: dyn_pool_2d_expr.hpp:25
constexpr bool is_thread_safe
Traits to test if the given ETL expresion type is thread safe.
Definition: traits.hpp:687
friend std::ostream & operator<<(std::ostream &os, const dyn_pool_2d_expr &expr)
Print a representation of the expression on the given stream.
Definition: dyn_pool_2d_expr.hpp:115
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
const size_t p1
The padding for the first dimension.
Definition: dyn_pool_2d_expr.hpp:37
dyn_pool_2d_expr< detail::build_type< E >, impl::avg_pool_2d > avg_pool_2d(E &&value, size_t c1, size_t c2)
2D Average Pooling of the given matrix expression
Definition: dyn_pool_2d_expr.hpp:235
void std_add_evaluate(Expr &&expr, Result &&result)
Compound add evaluation of the expr into result.
Definition: evaluator.hpp:1195
Dynamic 4D Implemenetation of Probabilistic Max Pooling for pooling units.
Definition: prob_pooling.hpp:589