Expression Templates Library (ETL)
cosh.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/impl/egblas/cosh.hpp"
11 
12 namespace etl {
13 
18 template <typename T>
19 struct cosh_unary_op {
20  static constexpr bool linear = true;
21  static constexpr bool thread_safe = true;
22 
28  template <vector_mode_t V>
29  static constexpr bool vectorizable =
30  (V == vector_mode_t::SSE3 && !is_complex_t<T>) || (V == vector_mode_t::AVX && !is_complex_t<T>) || (intel_compiler && !is_complex_t<T>);
31 
35  template <typename E>
36  static constexpr bool gpu_computable = (is_single_precision_t<T> && impl::egblas::has_scosh) || (is_double_precision_t<T> && impl::egblas::has_dcosh)
37  || (is_complex_single_t<T> && impl::egblas::has_ccosh) || (is_complex_double_t<T> && impl::egblas::has_zcosh);
38 
43  static constexpr int complexity() {
44  return 16;
45  }
46 
50  template <typename V = default_vec>
51  using vec_type = typename V::template vec_type<T>;
52 
58  static constexpr T apply(const T& x) noexcept {
59  return std::cosh(x);
60  }
61 
68  template <typename V = default_vec>
69  static vec_type<V> load(const vec_type<V>& x) noexcept {
70  return V::div((V::add(V::exp(x), V::exp(V::minus(x)))), V::set(T(2)));
71  }
72 
80  template <typename X, typename Y>
81  static auto gpu_compute_hint(const X& x, Y& y) noexcept {
82  decltype(auto) t1 = smart_gpu_compute_hint(x, y);
83 
84  auto t2 = force_temporary_gpu_dim_only(y);
85 
86  T alpha(1.0);
87  impl::egblas::cosh(etl::size(y), alpha, t1.gpu_memory(), 1, t2.gpu_memory(), 1);
88 
89  return t2;
90  }
91 
98  template <typename X, typename Y>
99  static Y& gpu_compute(const X& x, Y& y) noexcept {
100  decltype(auto) t1 = select_smart_gpu_compute(x, y);
101 
102  T alpha(1.0);
103  impl::egblas::cosh(etl::size(y), alpha, t1.gpu_memory(), 1, y.gpu_memory(), 1);
104 
105  y.validate_gpu();
106  y.invalidate_cpu();
107 
108  return y;
109  }
110 
115  static std::string desc() noexcept {
116  return "cosh";
117  }
118 };
119 
124 template <typename TT>
125 struct cosh_unary_op<etl::complex<TT>> {
126  using T = etl::complex<TT>;
127 
128  static constexpr bool linear = true;
129  static constexpr bool thread_safe = true;
130 
136  template <vector_mode_t V>
137  static constexpr bool vectorizable = false;
138 
142  template <typename E>
143  static constexpr bool gpu_computable = (is_single_precision_t<T> && impl::egblas::has_scosh) || (is_double_precision_t<T> && impl::egblas::has_dcosh)
144  || (is_complex_single_t<T> && impl::egblas::has_ccosh) || (is_complex_double_t<T> && impl::egblas::has_zcosh);
145 
150  static constexpr int complexity() {
151  return 16;
152  }
153 
159  static constexpr T apply(const T& x) noexcept {
160  return etl::cosh(x);
161  }
162 
170  template <typename X, typename Y>
171  static auto gpu_compute_hint(const X& x, Y& y) noexcept {
172  decltype(auto) t1 = smart_gpu_compute_hint(x, y);
173 
174  auto t2 = force_temporary_gpu_dim_only(t1);
175 
176  T alpha(1.0);
177  impl::egblas::cosh(etl::size(y), alpha, t1.gpu_memory(), 1, t2.gpu_memory(), 1);
178 
179  return t2;
180  }
181 
188  template <typename X, typename Y>
189  static Y& gpu_compute(const X& x, Y& y) noexcept {
190  decltype(auto) t1 = select_smart_gpu_compute(x, y);
191 
192  T alpha(1.0);
193  impl::egblas::cosh(etl::size(y), alpha, t1.gpu_memory(), 1, y.gpu_memory(), 1);
194 
195  y.validate_gpu();
196  y.invalidate_cpu();
197 
198  return y;
199  }
200 
205  static std::string desc() noexcept {
206  return "cosh";
207  }
208 };
209 
210 } //end of namespace etl
static constexpr T apply(const T &x) noexcept
Apply the unary operator on x.
Definition: cosh.hpp:159
Complex number implementation.
Definition: complex.hpp:31
static auto gpu_compute_hint(const X &x, Y &y) noexcept
Compute the result of the operation using the GPU.
Definition: cosh.hpp:171
auto cosh(E &&value) -> detail::unary_helper< E, cosh_unary_op >
Apply hyperbolic cosinus on each value of the given expression.
Definition: function_expression_builder.hpp:134
decltype(auto) select_smart_gpu_compute(X &x, Y &y)
Compute the expression into a representation that is GPU up to date and possibly store this represent...
Definition: helpers.hpp:434
SSE3 is the max vectorization available.
static constexpr int complexity()
Estimate the complexity of operator.
Definition: cosh.hpp:43
static constexpr bool linear
Indicates if the operator is linear.
Definition: cosh.hpp:20
static constexpr T apply(const T &x) noexcept
Apply the unary operator on x.
Definition: cosh.hpp:58
static constexpr bool thread_safe
Indicates if the operator is thread safe or not.
Definition: cosh.hpp:21
constexpr bool intel_compiler
Indicates if the projectis compiled with intel compiler.
Definition: config.hpp:225
Root namespace for the ETL library.
Definition: adapter.hpp:15
static vec_type< V > load(const vec_type< V > &x) noexcept
Compute several applications of the operator at a time.
Definition: cosh.hpp:69
EGBLAS wrappers for the cosh operation.
static auto gpu_compute_hint(const X &x, Y &y) noexcept
Compute the result of the operation using the GPU.
Definition: cosh.hpp:81
Unary operation computing the hyperbolic cosinus.
Definition: cosh.hpp:19
static constexpr bool gpu_computable
Indicates if the operator can be computed on GPU.
Definition: cosh.hpp:36
static std::string desc() noexcept
Returns a textual representation of the operator.
Definition: cosh.hpp:205
decltype(auto) force_temporary_gpu_dim_only(E &&expr)
Force a temporary out of the expression, without copying its content.
Definition: temporary.hpp:223
static std::string desc() noexcept
Returns a textual representation of the operator.
Definition: cosh.hpp:115
constexpr size_t size(const E &expr) noexcept
Returns the size of the given ETL expression.
Definition: helpers.hpp:108
auto exp(E &&value) -> detail::unary_helper< E, exp_unary_op >
Apply exponential on each value of the given expression.
Definition: function_expression_builder.hpp:154
AVX is the max vectorization available.
static constexpr int complexity()
Estimate the complexity of operator.
Definition: cosh.hpp:150
decltype(auto) smart_gpu_compute_hint(E &expr, Y &y)
Compute the expression into a representation that is GPU up to date.
Definition: helpers.hpp:368
typename V::template vec_type< T > vec_type
Definition: cosh.hpp:51
static Y & gpu_compute(const X &x, Y &y) noexcept
Compute the result of the operation using the GPU.
Definition: cosh.hpp:189
static Y & gpu_compute(const X &x, Y &y) noexcept
Compute the result of the operation using the GPU.
Definition: cosh.hpp:99
static constexpr bool vectorizable
Indicates if the expression is vectorizable using the given vector mode.
Definition: cosh.hpp:29