Expression Templates Library (ETL)
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, 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, typename Impl>
19 struct pool_3d_expr : base_temporary_expr_un<pool_3d_expr<A, C1, C2, C3, S1, S2, S3, P1, P2, P3, 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 
37  explicit pool_3d_expr(A a) : base_type(a) {
38  //Nothing else to init
39  }
40 
41  // Assignment functions
42 
47  template <same_dimensions<A> C>
48  void assign_to(C&& c) const {
49  inc_counter("temp:assign");
50 
51  auto& a = this->a();
52 
53  Impl::template apply<C1, C2, C3, S1, S2, S3, P1, P2, P3>(a, c);
54  }
55 
60  template <same_dimensions<A> L>
61  void assign_add_to(L&& lhs) const {
62  std_add_evaluate(*this, lhs);
63  }
64 
69  template <same_dimensions<A> L>
70  void assign_sub_to(L&& lhs) const {
71  std_sub_evaluate(*this, lhs);
72  }
73 
78  template <same_dimensions<A> L>
79  void assign_mul_to(L&& lhs) const {
80  std_mul_evaluate(*this, lhs);
81  }
82 
87  template <same_dimensions<A> L>
88  void assign_div_to(L&& lhs) const {
89  std_div_evaluate(*this, lhs);
90  }
91 
96  template <same_dimensions<A> L>
97  void assign_mod_to(L&& lhs) const {
98  std_mod_evaluate(*this, lhs);
99  }
100 
107  friend std::ostream& operator<<(std::ostream& os, const pool_3d_expr& expr) {
108  return os << "pool3(" << expr._a << ")";
109  }
110 };
111 
116 template <etl_expr 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, typename Impl>
117 struct etl_traits<etl::pool_3d_expr<A, C1, C2, C3, S1, S2, S3, P1, P2, P3, Impl>> {
119  using sub_expr_t = std::decay_t<A>;
122 
123  static constexpr size_t D = sub_traits::dimensions();
124 
125  static constexpr bool is_etl = true;
126  static constexpr bool is_transformer = false;
127  static constexpr bool is_view = false;
128  static constexpr bool is_magic_view = false;
129  static constexpr bool is_fast = sub_traits::is_fast;
130  static constexpr bool is_linear = false;
131  static constexpr bool is_thread_safe = true;
132  static constexpr bool is_value = false;
133  static constexpr bool is_direct = true;
134  static constexpr bool is_generator = false;
135  static constexpr bool is_padded = false;
136  static constexpr bool is_aligned = true;
137  static constexpr bool is_temporary = true;
138  static constexpr bool gpu_computable = is_gpu_t<value_type> && cuda_enabled;
139  static constexpr order storage_order = sub_traits::storage_order;
140 
146  template <vector_mode_t V>
147  static constexpr bool vectorizable = true;
148 
153  template <size_t DD>
154  static constexpr size_t dim() {
155  return DD == D - 3 ? (decay_traits<A>::template dim<DD>() - C1 + 2 * P1) / S1 + 1
156  : DD == D - 2 ? (decay_traits<A>::template dim<DD>() - C2 + 2 * P2) / S2 + 1
157  : DD == D - 1 ? (decay_traits<A>::template dim<DD>() - C3 + 2 * P3) / S3 + 1 : decay_traits<A>::template dim<DD>();
158  }
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) - C1 + 2 * P1) / S1 + 1;
169  } else if (d == D - 2) {
170  return (etl::dim(e._a, d) - C2 + 2 * P2) / S2 + 1;
171  } else if (d == D - 1) {
172  return (etl::dim(e._a, d) - C3 + 2 * P3) / S3 + 1;
173  } else {
174  return etl::dim(e._a, d);
175  }
176  }
177 
183  static size_t size(const expr_t& e) {
184  size_t acc = 1;
185  for (size_t i = 0; i < D; ++i) {
186  acc *= dim(e, i);
187  }
188  return acc;
189  }
190 
195  template <size_t... I>
196  static constexpr size_t size_mul(const std::index_sequence<I...>& /*seq*/) {
197  return (dim<I>() * ...);
198  }
199 
204  static constexpr size_t size() {
205  return size_mul(std::make_index_sequence<D>());
206  }
207 
212  static constexpr size_t dimensions() {
213  return D;
214  }
215 
220  static constexpr int complexity() noexcept {
221  return -1;
222  }
223 };
224 
233 template <size_t C1, size_t C2, size_t C3, size_t S1 = C1, size_t S2 = C2, size_t S3 = C3, size_t P1 = 0, size_t P2 = 0, size_t P3 = 0, etl_expr E>
234 pool_3d_expr<detail::build_type<E>, C1, C2, C3, S1, S2, S3, P1, P2, P3, impl::max_pool_3d> max_pool_3d(E&& value) {
235  return pool_3d_expr<detail::build_type<E>, C1, C2, C3, S1, S2, S3, P1, P2, P3, impl::max_pool_3d>{value};
236 }
237 
246 template <size_t C1, size_t C2, size_t C3, size_t S1 = C1, size_t S2 = C2, size_t S3 = C3, size_t P1 = 0, size_t P2 = 0, size_t P3 = 0, etl_expr E>
247 pool_3d_expr<detail::build_type<E>, C1, C2, C3, S1, S2, S3, P1, P2, P3, impl::avg_pool_3d> avg_pool_3d(E&& value) {
248  return pool_3d_expr<detail::build_type<E>, C1, C2, C3, S1, S2, S3, P1, P2, P3, impl::avg_pool_3d>{value};
249 }
250 
251 } //end of namespace etl
void assign_to(C &&c) const
Assign to a matrix of the same storage order.
Definition: pool_3d_expr.hpp:48
std::add_lvalue_reference_t< A > a()
Returns the sub expression.
Definition: base_temporary_expr.hpp:489
void assign_sub_to(L &&lhs) const
Sub from the given left-hand-side expression.
Definition: pool_3d_expr.hpp:70
static size_t dim(const expr_t &e, size_t d)
Returns the dth dimension of the expression.
Definition: pool_3d_expr.hpp:166
static constexpr size_t dim()
Returns the DDth dimension of the expression.
Definition: pool_3d_expr.hpp:154
constexpr bool is_magic_view
Traits indicating if the given ETL type is a magic view expression.
Definition: traits.hpp:311
static size_t size(const expr_t &e)
Returns the size of the expression.
Definition: pool_3d_expr.hpp:183
D D
The number of dimensions.
Definition: dyn_matrix_view.hpp:24
pool_3d_expr(A a)
Construct a new expression.
Definition: pool_3d_expr.hpp:37
order
Storage order of a matrix.
Definition: order.hpp:15
constexpr bool cuda_enabled
Indicates if CUDA is available.
Definition: config.hpp:94
static constexpr size_t size()
Returns the size of the expression.
Definition: pool_3d_expr.hpp:204
static constexpr auto storage_order
The sub storage order.
Definition: pool_3d_expr.hpp:25
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
friend std::ostream & operator<<(std::ostream &os, const pool_3d_expr &expr)
Print a representation of the expression on the given stream.
Definition: pool_3d_expr.hpp:107
Traits to get information about ETL types.
Definition: tmp.hpp:68
Root namespace for the ETL library.
Definition: adapter.hpp:15
static constexpr size_t dimensions()
Return the number of dimensions of the expression.
Definition: traits_base.hpp:31
static constexpr int complexity() noexcept
Estimate the complexity of computation.
Definition: pool_3d_expr.hpp:220
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 constexpr bool gpu_computable
Indicates if the temporary expression can be directly evaluated using only GPU.
Definition: pool_3d_expr.hpp:31
void assign_div_to(L &&lhs) const
Divide the given left-hand-side expression.
Definition: pool_3d_expr.hpp:88
void std_mod_evaluate(Expr &&expr, Result &&result)
Compound modulo evaluation of the expr into result.
Definition: evaluator.hpp:1271
void assign_add_to(L &&lhs) const
Add to the given left-hand-side expression.
Definition: pool_3d_expr.hpp:61
value_t< A > value_type
The type of value of the expression.
Definition: pool_3d_expr.hpp:20
void std_mul_evaluate(Expr &&expr, Result &&result)
Compound multiply evaluation of the expr into result.
Definition: evaluator.hpp:1233
static constexpr size_t dimensions()
Returns the number of dimensions of the expression.
Definition: pool_3d_expr.hpp:212
constexpr bool is_transformer
Traits indicating if the given ETL type is a transformer expression.
Definition: traits.hpp:297
constexpr bool is_view
Traits indicating if the given ETL type is a view expression.
Definition: traits.hpp:304
std::decay_t< A > sub_expr_t
The sub expression type.
Definition: pool_3d_expr.hpp:119
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_mod_to(L &&lhs) const
Modulo the given left-hand-side expression.
Definition: pool_3d_expr.hpp:97
static constexpr bool is_fast
Indicates if T is a fast structure.
Definition: traits_base.hpp:25
Functor for 3D Average Pooling.
Definition: pooling.hpp:334
A transposition expression.
Definition: pool_3d_expr.hpp:19
void std_sub_evaluate(Expr &&expr, Result &&result)
Compound subtract evaluation of the expr into result.
Definition: evaluator.hpp:1214
void assign_mul_to(L &&lhs) const
Multiply the given left-hand-side expression.
Definition: pool_3d_expr.hpp:79
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
static constexpr size_t size_mul(const std::index_sequence< I... > &)
Returns the multiplicative sum of the dimensions at the given indices.
Definition: pool_3d_expr.hpp:196
value_t< A > value_type
The value type of the expression.
Definition: pool_3d_expr.hpp:121
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
Functor for 3D Max Pooling.
Definition: pooling.hpp:254
void std_add_evaluate(Expr &&expr, Result &&result)
Compound add evaluation of the expr into result.
Definition: evaluator.hpp:1195