tanh.hpp

//=======================================================================
// Copyright (c) 2014-2023 Baptiste Wicht
// Distributed under the terms of the MIT License.
// (See accompanying file LICENSE or copy at
//  http://opensource.org/licenses/MIT)
//=======================================================================

#pragma once

#include "etl/impl/egblas/tanh.hpp"

namespace etl {

template <typename T>
struct tanh_unary_op {
    static constexpr bool linear      = true; 
    static constexpr bool thread_safe = true; 

    template <vector_mode_t V>
    static constexpr bool vectorizable =
        (V == vector_mode_t::SSE3 && !is_complex_t<T>) || (V == vector_mode_t::AVX && !is_complex_t<T>) || (intel_compiler && !is_complex_t<T>);

    template <typename E>
    static constexpr bool gpu_computable = (is_single_precision_t<T> && impl::egblas::has_stanh) || (is_double_precision_t<T> && impl::egblas::has_dtanh)
                                           || (is_complex_single_t<T> && impl::egblas::has_ctanh) || (is_complex_double_t<T> && impl::egblas::has_ztanh);

    static constexpr int complexity() {
        return 16;
    }

    template <typename V = default_vec>
    using vec_type = typename V::template vec_type<T>;

    static constexpr T apply(const T& x) noexcept {
        return std::tanh(x);
    }

    template <typename V = default_vec>
    static vec_type<V> load(const vec_type<V>& x) noexcept {
        auto ex  = V::exp(x);
        auto emx = V::exp(V::minus(x));
        return V::div(V::sub(ex, emx), V::add(ex, emx));
    }

    template <typename X, typename Y>
    static auto gpu_compute_hint(const X& x, Y& y) noexcept {
        decltype(auto) t1 = smart_gpu_compute_hint(x, y);

        auto t2 = force_temporary_gpu_dim_only(t1);

        T alpha(1.0);
        impl::egblas::tanh(etl::size(y), alpha, t1.gpu_memory(), 1, t2.gpu_memory(), 1);

        return t2;
    }

    template <typename X, typename Y>
    static Y& gpu_compute(const X& x, Y& y) noexcept {
        decltype(auto) t1 = select_smart_gpu_compute(x, y);

        T alpha(1.0);
        impl::egblas::tanh(etl::size(y), alpha, t1.gpu_memory(), 1, y.gpu_memory(), 1);

        y.validate_gpu();
        y.invalidate_cpu();

        return y;
    }

    static std::string desc() noexcept {
        return "tanh";
    }
};

template <typename TT>
struct tanh_unary_op<etl::complex<TT>> {
    using T = etl::complex<TT>; 

    static constexpr bool linear      = true; 
    static constexpr bool thread_safe = true; 

    template <vector_mode_t V>
    static constexpr bool vectorizable = false;

    template <typename E>
    static constexpr bool gpu_computable = (is_single_precision_t<T> && impl::egblas::has_stanh) || (is_double_precision_t<T> && impl::egblas::has_dtanh)
                                           || (is_complex_single_t<T> && impl::egblas::has_ctanh) || (is_complex_double_t<T> && impl::egblas::has_ztanh);

    static constexpr int complexity() {
        return 16;
    }

    static constexpr T apply(const T& x) noexcept {
        return etl::tanh(x);
    }

    template <typename X, typename Y>
    static auto gpu_compute_hint(const X& x, Y& y) noexcept {
        decltype(auto) t1 = smart_gpu_compute_hint(x, y);

        auto t2 = force_temporary_gpu_dim_only(t1);

        T alpha(1.0);
        impl::egblas::tanh(etl::size(y), alpha, t1.gpu_memory(), 1, t2.gpu_memory(), 1);

        return t2;
    }

    template <typename X, typename Y>
    static Y& gpu_compute(const X& x, Y& y) noexcept {
        decltype(auto) t1 = select_smart_gpu_compute(x, y);

        T alpha(1.0);
        impl::egblas::tanh(etl::size(y), alpha, t1.gpu_memory(), 1, y.gpu_memory(), 1);

        y.validate_gpu();
        y.invalidate_cpu();

        return y;
    }

    static std::string desc() noexcept {
        return "tanh";
    }
};

} //end of namespace etl