Expression Templates Library (ETL)
convmtx_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 //Get the implementations
13 #include "etl/impl/std/convmtx2.hpp"
14 
15 namespace etl {
16 
21 template <etl_expr A, size_t K1, size_t K2>
22 struct convmtx_2d_expr : base_temporary_expr_un<convmtx_2d_expr<A, K1, K2>, A> {
27 
28  static constexpr auto storage_order = sub_traits::storage_order;
29 
34  static constexpr bool gpu_computable = false;
35 
40  explicit convmtx_2d_expr(A a) : base_type(a) {
41  //Nothing else to init
42  }
43 
44  // Assignment functions
45 
50  template <same_dimensions<A> C>
51  void assign_to(C&& c) const {
52  inc_counter("temp:assign");
53 
54  auto& a = this->a();
55 
56  impl::standard::convmtx2_direct::template apply<K1, K2>(smart_forward(a), c);
57  }
58 
63  template <typename L>
64  void assign_add_to(L&& lhs) const {
65  std_add_evaluate(*this, lhs);
66  }
67 
72  template <typename L>
73  void assign_sub_to(L&& lhs) const {
74  std_sub_evaluate(*this, lhs);
75  }
76 
81  template <typename L>
82  void assign_mul_to(L&& lhs) const {
83  std_mul_evaluate(*this, lhs);
84  }
85 
90  template <typename L>
91  void assign_div_to(L&& lhs) const {
92  std_div_evaluate(*this, lhs);
93  }
94 
99  template <typename L>
100  void assign_mod_to(L&& lhs) const {
101  std_mod_evaluate(*this, lhs);
102  }
103 
110  friend std::ostream& operator<<(std::ostream& os, const convmtx_2d_expr& expr) {
111  return os << "convmtx2(" << expr._a << ")";
112  }
113 };
114 
119 template <typename A, size_t K1, size_t K2>
120 struct etl_traits<etl::convmtx_2d_expr<A, K1, K2>> {
123  using sub_expr_t = std::decay_t<A>;
126 
127  static constexpr bool is_etl = true;
128  static constexpr bool is_transformer = false;
129  static constexpr bool is_view = false;
130  static constexpr bool is_magic_view = false;
131  static constexpr bool is_fast = sub_traits::is_fast;
132  static constexpr bool is_linear = false;
133  static constexpr bool is_thread_safe = true;
134  static constexpr bool is_value = false;
135  static constexpr bool is_direct = true;
136  static constexpr bool is_generator = false;
137  static constexpr bool is_padded = false;
138  static constexpr bool is_aligned = true;
139  static constexpr bool is_temporary = true;
140  static constexpr bool gpu_computable = is_gpu_t<value_type> && cuda_enabled;
141  static constexpr order storage_order = sub_traits::storage_order;
142 
148  template <vector_mode_t V>
149  static constexpr bool vectorizable = true;
150 
155  template <size_t DD>
156  static constexpr size_t dim() {
157  return DD == 0 ? ((sub_traits::template dim<0>() + K1 - 1) * (sub_traits::template dim<1>() + K2 - 1)) : K1 * K2;
158  }
159 
166  static size_t dim(const expr_t& e, size_t d) {
167  if (d == 0) {
168  return (etl::dim<0>(e._a) + K1 - 1) * (etl::dim<1>(e._a) + K2 - 1);
169  } else {
170  return K1 * K2;
171  }
172  }
173 
179  static size_t size(const expr_t& e) {
180  return this_type::dim(e, 0) * this_type::dim(e, 1);
181  }
182 
187  static constexpr size_t size() {
188  return this_type::template dim<0>() * this_type::template dim<1>();
189  }
190 
195  static constexpr size_t dimensions() {
196  return 2;
197  }
198 
203  static constexpr int complexity() noexcept {
204  return -1;
205  }
206 };
207 
215 template <size_t K1, size_t K2, etl_2d A>
217  return convmtx_2d_expr<detail::build_type<A>, K1, K2>{a};
218 }
219 
220 } //end of namespace etl
std::add_lvalue_reference_t< A > a()
Returns the sub expression.
Definition: base_temporary_expr.hpp:489
static constexpr size_t size()
Returns the size of the expression.
Definition: convmtx_2d_expr.hpp:187
void assign_mul_to(L &&lhs) const
Multiply the given left-hand-side expression.
Definition: convmtx_2d_expr.hpp:82
A transposition expression.
Definition: convmtx_2d_expr.hpp:22
constexpr bool is_magic_view
Traits indicating if the given ETL type is a magic view expression.
Definition: traits.hpp:311
convmtx_2d_expr< detail::build_type< A >, K1, K2 > convmtx2_direct(A &&a)
Construct a matrix to compute a 2D convolution by matrix-matrix multiplication.
Definition: convmtx_2d_expr.hpp:216
void assign_add_to(L &&lhs) const
Add to the given left-hand-side expression.
Definition: convmtx_2d_expr.hpp:64
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: convmtx_2d_expr.hpp:51
A _a
The sub expression reference.
Definition: base_temporary_expr.hpp:447
static size_t dim(const expr_t &e, size_t d)
Returns the dth dimension of the expression.
Definition: convmtx_2d_expr.hpp:166
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
convmtx_2d_expr(A a)
Construct a new expression.
Definition: convmtx_2d_expr.hpp:40
value_t< A > value_type
The value type of the expression.
Definition: convmtx_2d_expr.hpp:125
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 assign_sub_to(L &&lhs) const
Sub from the given left-hand-side expression.
Definition: convmtx_2d_expr.hpp:73
void std_mod_evaluate(Expr &&expr, Result &&result)
Compound modulo evaluation of the expr into result.
Definition: evaluator.hpp:1271
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 constexpr bool gpu_computable
Indicates if the temporary expression can be directly evaluated using only GPU.
Definition: convmtx_2d_expr.hpp:34
void assign_div_to(L &&lhs) const
Divide the given left-hand-side expression.
Definition: convmtx_2d_expr.hpp:91
static constexpr size_t dimensions()
Returns the number of dimensions of the expression.
Definition: convmtx_2d_expr.hpp:195
constexpr bool is_view
Traits indicating if the given ETL type is a view expression.
Definition: traits.hpp:304
void assign_mod_to(L &&lhs) const
Modulo the given left-hand-side expression.
Definition: convmtx_2d_expr.hpp:100
static constexpr bool is_fast
Indicates if T is a fast structure.
Definition: traits_base.hpp:25
static constexpr size_t dim()
Returns the DDth dimension of the expression.
Definition: convmtx_2d_expr.hpp:156
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
Abstract base class for temporary unary expression.
Definition: base_temporary_expr.hpp:443
std::decay_t< A > sub_expr_t
The sub expression type.
Definition: convmtx_2d_expr.hpp:123
constexpr bool is_thread_safe
Traits to test if the given ETL expresion type is thread safe.
Definition: traits.hpp:687
static size_t size(const expr_t &e)
Returns the size of the expression.
Definition: convmtx_2d_expr.hpp:179
typename decay_traits< E >::value_type value_t
Traits to extract the value type out of an ETL type.
Definition: tmp.hpp:81
static constexpr auto storage_order
The sub storage order.
Definition: convmtx_2d_expr.hpp:28
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
value_t< A > value_type
The type of value of the expression.
Definition: convmtx_2d_expr.hpp:23
void std_add_evaluate(Expr &&expr, Result &&result)
Compound add evaluation of the expr into result.
Definition: evaluator.hpp:1195
friend std::ostream & operator<<(std::ostream &os, const convmtx_2d_expr &expr)
Print a representation of the expression on the given stream.
Definition: convmtx_2d_expr.hpp:110
static constexpr int complexity() noexcept
Estimate the complexity of computation.
Definition: convmtx_2d_expr.hpp:203