Expression Templates Library (ETL)
dyn_pool_3d_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_3d_expr : base_temporary_expr_un<dyn_pool_3d_expr<A, Impl>, A> {
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 c3;
36  const size_t s1;
37  const size_t s2;
38  const size_t s3;
39  const size_t p1;
40  const size_t p2;
41  const size_t p3;
42 
47  explicit dyn_pool_3d_expr(A a, 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)
48  : base_type(a), c1(c1), c2(c2), c3(c3), s1(s1), s2(s2), s3(s3), p1(p1), p2(p2), p3(p3) {
49  //Nothing else to init
50  }
51 
52  // Assignment functions
53 
58  template <same_dimensions<A> L>
59  void assign_to(L&& lhs) const {
60  inc_counter("temp:assign");
61 
62  auto& a = this->a();
63 
64  Impl::template apply<>(a, lhs, c1, c2, c3, s1, s2, s3, p1, p2, p3);
65  }
66 
71  template <etl_expr L>
72  void assign_add_to(L&& lhs) const {
73  std_add_evaluate(*this, lhs);
74  }
75 
80  template <etl_expr L>
81  void assign_sub_to(L&& lhs) const {
82  std_sub_evaluate(*this, lhs);
83  }
84 
89  template <etl_expr L>
90  void assign_mul_to(L&& lhs) const {
91  std_mul_evaluate(*this, lhs);
92  }
93 
98  template <etl_expr L>
99  void assign_div_to(L&& lhs) const {
100  std_div_evaluate(*this, lhs);
101  }
102 
107  template <etl_expr L>
108  void assign_mod_to(L&& lhs) const {
109  std_mod_evaluate(*this, lhs);
110  }
111 
118  friend std::ostream& operator<<(std::ostream& os, const dyn_pool_3d_expr& expr) {
119  return os << "pool3(" << expr._a << ")";
120  }
121 };
122 
127 template <etl_expr A, typename Impl>
128 struct etl_traits<etl::dyn_pool_3d_expr<A, Impl>> {
130  using sub_expr_t = std::decay_t<A>;
133 
134  static constexpr size_t D = sub_traits::dimensions();
135 
136  static constexpr bool is_etl = true;
137  static constexpr bool is_transformer = false;
138  static constexpr bool is_view = false;
139  static constexpr bool is_magic_view = false;
140  static constexpr bool is_fast = false;
141  static constexpr bool is_linear = false;
142  static constexpr bool is_thread_safe = true;
143  static constexpr bool is_value = false;
144  static constexpr bool is_direct = true;
145  static constexpr bool is_generator = false;
146  static constexpr bool is_padded = false;
147  static constexpr bool is_aligned = true;
148  static constexpr bool is_temporary = true;
149  static constexpr bool gpu_computable = is_gpu_t<value_type> && cuda_enabled;
150  static constexpr order storage_order = sub_traits::storage_order;
151 
157  template <vector_mode_t V>
158  static constexpr bool vectorizable = true;
159 
166  static size_t dim(const expr_t& e, size_t d) {
167  if (d == D - 3) {
168  return (etl::dim(e._a, d) - e.c1 + 2 * e.p1) / e.s1 + 1;
169  } else if (d == D - 2) {
170  return (etl::dim(e._a, d) - e.c2 + 2 * e.p2) / e.s2 + 1;
171  } else if (d == D - 1) {
172  return (etl::dim(e._a, d) - e.c3 + 2 * e.p3) / e.s3 + 1;
173  } else {
174  return etl::dim(e._a, d);
175  }
176  }
182  static size_t size(const expr_t& e) {
183  size_t acc = 1;
184  for (size_t i = 0; i < D; ++i) {
185  acc *= dim(e, i);
186  }
187  return acc;
188  }
189 
194  static constexpr size_t dimensions() {
195  return D;
196  }
197 
202  static constexpr int complexity() noexcept {
203  return -1;
204  }
205 };
206 
215 template <etl_expr E>
217  return dyn_pool_3d_expr<detail::build_type<E>, impl::max_pool_3d>{value, c1, c2, c3, c1, c2, c3, 0, 0, 0};
218 }
219 
228 template <etl_expr E>
230  E&& value, size_t c1, size_t c2, size_t c3, size_t s1, size_t s2, size_t s3, size_t p1 = 0, size_t p2 = 0, size_t p3 = 0) {
232 }
233 
234 /* Avg Pool 3D */
235 
244 template <etl_expr E>
246  return dyn_pool_3d_expr<detail::build_type<E>, impl::avg_pool_3d>{value, c1, c2, c3, c1, c2, c3, 0, 0, 0};
247 }
248 
257 template <etl_expr E>
259  E&& value, size_t c1, size_t c2, size_t c3, size_t s1, size_t s2, size_t s3, size_t p1 = 0, size_t p2 = 0, size_t p3 = 0) {
261 }
262 
263 } //end of namespace etl
const size_t p2
The padding for the second dimension.
Definition: dyn_pool_3d_expr.hpp:40
std::add_lvalue_reference_t< A > a()
Returns the sub expression.
Definition: base_temporary_expr.hpp:489
const size_t c1
The pooling ratio for the first dimension.
Definition: dyn_pool_3d_expr.hpp:33
void assign_mul_to(L &&lhs) const
Multiply the given left-hand-side expression.
Definition: dyn_pool_3d_expr.hpp:90
static constexpr int complexity() noexcept
Estimate the complexity of computation.
Definition: dyn_pool_3d_expr.hpp:202
static constexpr size_t dimensions()
Returns the number of dimensions of the expression.
Definition: dyn_pool_3d_expr.hpp:194
void assign_mod_to(L &&lhs) const
Modulo the given left-hand-side expression.
Definition: dyn_pool_3d_expr.hpp:108
value_t< A > value_type
The value type of the expression.
Definition: dyn_pool_3d_expr.hpp:132
constexpr bool is_magic_view
Traits indicating if the given ETL type is a magic view expression.
Definition: traits.hpp:311
D D
The number of dimensions.
Definition: dyn_matrix_view.hpp:24
friend std::ostream & operator<<(std::ostream &os, const dyn_pool_3d_expr &expr)
Print a representation of the expression on the given stream.
Definition: dyn_pool_3d_expr.hpp:118
const size_t c3
The pooling ratio for the third dimension.
Definition: dyn_pool_3d_expr.hpp:35
order
Storage order of a matrix.
Definition: order.hpp:15
constexpr bool cuda_enabled
Indicates if CUDA is available.
Definition: config.hpp:94
value_t< A > value_type
The type of value of the expression.
Definition: dyn_pool_3d_expr.hpp:20
const size_t c2
The pooling ratio for the second dimension.
Definition: dyn_pool_3d_expr.hpp:34
A _a
The sub expression reference.
Definition: base_temporary_expr.hpp:447
constexpr bool is_fast
Traits to test if the given ETL expresion type is fast (sizes known at compile-time) ...
Definition: traits.hpp:588
const size_t s1
The stride for the first dimension.
Definition: dyn_pool_3d_expr.hpp:36
Traits to get information about ETL types.
Definition: tmp.hpp:68
Root namespace for the ETL library.
Definition: adapter.hpp:15
A transposition expression.
Definition: dyn_pool_3d_expr.hpp:19
static constexpr size_t dimensions()
Return the number of dimensions of the expression.
Definition: traits_base.hpp:31
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
const size_t p3
The padding for the third dimension.
Definition: dyn_pool_3d_expr.hpp:41
const size_t s2
The stride for the second dimension.
Definition: dyn_pool_3d_expr.hpp:37
static constexpr bool gpu_computable
Indicates if the temporary expression can be directly evaluated using only GPU.
Definition: dyn_pool_3d_expr.hpp:31
void std_mod_evaluate(Expr &&expr, Result &&result)
Compound modulo evaluation of the expr into result.
Definition: evaluator.hpp:1271
const size_t s3
The stride for the third dimension.
Definition: dyn_pool_3d_expr.hpp:38
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
static size_t dim(const expr_t &e, size_t d)
Returns the dth dimension of the expression.
Definition: dyn_pool_3d_expr.hpp:166
constexpr bool is_view
Traits indicating if the given ETL type is a view expression.
Definition: traits.hpp:304
dyn_pool_3d_expr< detail::build_type< E >, impl::avg_pool_3d > avg_pool_3d(E &&value, size_t c1, size_t c2, size_t c3)
3D Average Pooling of the given matrix expression
Definition: dyn_pool_3d_expr.hpp:245
void assign_add_to(L &&lhs) const
Add to the given left-hand-side expression.
Definition: dyn_pool_3d_expr.hpp:72
static size_t size(const expr_t &e)
Returns the size of the expression.
Definition: dyn_pool_3d_expr.hpp:182
Functor for 3D Average Pooling.
Definition: pooling.hpp:334
void assign_div_to(L &&lhs) const
Divide the given left-hand-side expression.
Definition: dyn_pool_3d_expr.hpp:99
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
dyn_pool_3d_expr< detail::build_type< E >, impl::max_pool_3d > max_pool_3d(E &&value, size_t c1, size_t c2, size_t c3)
3D Max Pooling of the given matrix expression
Definition: dyn_pool_3d_expr.hpp:216
constexpr bool is_thread_safe
Traits to test if the given ETL expresion type is thread safe.
Definition: traits.hpp:687
dyn_pool_3d_expr(A a, 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_3d_expr.hpp:47
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
static constexpr auto storage_order
The sub storage order.
Definition: dyn_pool_3d_expr.hpp:25
void inc_counter([[maybe_unused]] const char *name)
Increase the given counter.
Definition: counters.hpp:25
Functor for 3D Max Pooling.
Definition: pooling.hpp:254
void assign_sub_to(L &&lhs) const
Sub from the given left-hand-side expression.
Definition: dyn_pool_3d_expr.hpp:81
std::decay_t< A > sub_expr_t
The sub expression type.
Definition: dyn_pool_3d_expr.hpp:130
void std_add_evaluate(Expr &&expr, Result &&result)
Compound add evaluation of the expr into result.
Definition: evaluator.hpp:1195
void assign_to(L &&lhs) const
Assign to a matrix of the same storage order.
Definition: dyn_pool_3d_expr.hpp:59
const size_t p1
The padding for the first dimension.
Definition: dyn_pool_3d_expr.hpp:39