pool_derivative_expr.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/expr/base_temporary_expr.hpp"

//Get the implementations
#include "etl/impl/pooling.hpp"

namespace etl {

template <etl_expr A, etl_expr B, 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>
struct pool_derivative_expr : base_temporary_expr_bin<pool_derivative_expr<A, B, C1, C2, C3, S1, S2, S3, P1, P2, P3, Impl>, A, B> {
    using value_type  = value_t<A>;                                                           
    using this_type   = pool_derivative_expr<A, B, C1, C2, C3, S1, S2, S3, P1, P2, P3, Impl>; 
    using base_type   = base_temporary_expr_bin<this_type, A, B>;                             
    using left_traits = decay_traits<A>;                                                      

    static constexpr auto storage_order = left_traits::storage_order; 

    static constexpr bool gpu_computable = false;

    explicit pool_derivative_expr(A a, B b) : base_type(a, b) {
        //Nothing else to init
    }

    // Assignment functions

    template <etl_expr C>
    void assign_to(C&& c) const {
        inc_counter("temp:assign");

        auto& a = this->a();
        auto& b = this->b();

        Impl::template apply<C1, C2, C3, S1, S2, S3, P1, P2, P3>(smart_forward(a), smart_forward(b), c);
    }

    template <etl_expr L>
    void assign_add_to(L&& lhs) const {
        std_add_evaluate(*this, lhs);
    }

    template <etl_expr L>
    void assign_sub_to(L&& lhs) const {
        std_sub_evaluate(*this, lhs);
    }

    template <etl_expr L>
    void assign_mul_to(L&& lhs) const {
        std_mul_evaluate(*this, lhs);
    }

    template <etl_expr L>
    void assign_div_to(L&& lhs) const {
        std_div_evaluate(*this, lhs);
    }

    template <etl_expr L>
    void assign_mod_to(L&& lhs) const {
        std_mod_evaluate(*this, lhs);
    }

    friend std::ostream& operator<<(std::ostream& os, const pool_derivative_expr& expr) {
        return os << "pool_derivative(" << expr._a << ", " << expr._b << ")";
    }
};

template <etl_expr A, etl_expr B, 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>
struct etl_traits<etl::pool_derivative_expr<A, B, C1, C2, C3, S1, S2, S3, P1, P2, P3, Impl>> {
    using expr_t       = etl::pool_derivative_expr<A, B, C1, C2, C3, S1, S2, S3, P1, P2, P3, Impl>; 
    using left_expr_t  = std::decay_t<A>;                                                           
    using right_expr_t = std::decay_t<B>;                                                           
    using left_traits  = etl_traits<left_expr_t>;                                                   
    using right_traits = etl_traits<right_expr_t>;                                                  
    using value_type   = value_t<A>;                                                                

    static constexpr bool is_etl         = true;                                          
    static constexpr bool is_transformer = false;                                         
    static constexpr bool is_view        = false;                                         
    static constexpr bool is_magic_view  = false;                                         
    static constexpr bool is_fast        = left_traits::is_fast && right_traits::is_fast; 
    static constexpr bool is_linear      = false;                                         
    static constexpr bool is_thread_safe = true;                                          
    static constexpr bool is_value       = false;                                         
    static constexpr bool is_direct      = true;                                          
    static constexpr bool is_generator   = false;                                         
    static constexpr bool is_padded      = false;                                         
    static constexpr bool is_aligned     = true;                                          
    static constexpr bool is_temporary   = true;                                          
    static constexpr bool gpu_computable = is_gpu_t<value_type> && cuda_enabled;          
    static constexpr order storage_order = left_traits::storage_order;                    

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

    template <size_t DD>
    static constexpr size_t dim() {
        return left_traits::template dim<DD>();
    }

    static size_t dim(const expr_t& e, size_t d) {
        return left_traits::dim(e._a, d);
    }

    static size_t size(const expr_t& e) {
        return left_traits::size(e._a);
    }

    static constexpr size_t size() {
        return left_traits::size();
    }

    static constexpr size_t dimensions() {
        return left_traits::dimensions();
    }

    static constexpr int complexity() noexcept {
        return -1;
    }
};

template <size_t C1, size_t C2, size_t S1 = C1, size_t S2 = C2, size_t P1 = 0, size_t P2 = 0, etl_expr E, etl_expr F>
pool_derivative_expr<detail::build_type<E>, F, C1, C2, 0, S1, S2, 0, P1, P2, 0, impl::max_pool_derivative_2d> max_pool_derivative_2d(E&& input, F&& output) {
    return pool_derivative_expr<detail::build_type<E>, F, C1, C2, 0, S1, S2, 0, P1, P2, 0, impl::max_pool_derivative_2d>{input, output};
}

template <size_t C1, size_t C2, size_t C3, etl_expr E, etl_expr F>
pool_derivative_expr<detail::build_type<E>, F, C1, C2, C3, C1, C2, C3, 0, 0, 0, impl::max_pool_derivative_3d> max_pool_derivative_3d(E&& input, F&& output) {
    return pool_derivative_expr<detail::build_type<E>, F, C1, C2, C3, C1, C2, C3, 0, 0, 0, impl::max_pool_derivative_3d>{input, output};
}

template <size_t C1, size_t C2, size_t S1 = C1, size_t S2 = C2, size_t P1 = 0, size_t P2 = 0, etl_expr E, etl_expr F>
pool_derivative_expr<detail::build_type<E>, F, C1, C2, 0, S1, S2, 0, P1, P2, 0, impl::avg_pool_derivative_2d> avg_pool_derivative_2d(E&& input, F&& output) {
    return pool_derivative_expr<detail::build_type<E>, F, C1, C2, 0, S1, S2, 0, P1, P2, 0, impl::avg_pool_derivative_2d>{input, output};
}

template <size_t C1, size_t C2, size_t C3, etl_expr E, etl_expr F>
pool_derivative_expr<detail::build_type<E>, F, C1, C2, C3, C1, C2, C3, 0, 0, 0, impl::avg_pool_derivative_3d> avg_pool_derivative_3d(E&& input, F&& output) {
    return pool_derivative_expr<detail::build_type<E>, F, C1, C2, C3, C1, C2, C3, 0, 0, 0, impl::avg_pool_derivative_3d>{input, output};
}

} //end of namespace etl