src/cpu/kernels/CpuAddMulAddKernel.h

/*
 * Copyright (c) 2023 Arm Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef SRC_CPU_KERNELS_CPUADDMULADDKERNEL
#define SRC_CPU_KERNELS_CPUADDMULADDKERNEL

#include "arm_compute/function_info/ActivationLayerInfo.h"

#include "src/core/common/Macros.h"
#include "src/cpu/ICpuKernel.h"

namespace arm_compute
{
namespace cpu
{
namespace kernels
{
/** Interface for the kernel to perform addition between two tensors */
class CpuAddMulAddKernel : public ICpuKernel<CpuAddMulAddKernel>
{
private:
    using AddMulAddKernelPtr = std::add_pointer<void(const ITensor *,
                                                     const ITensor *,
                                                     const ITensor *,
                                                     const ITensor *,
                                                     ITensor *,
                                                     ITensor *,
                                                     ConvertPolicy,
                                                     const ActivationLayerInfo &,
                                                     const Window &)>::type;

public:
    struct AddMulAddKernel
    {
        const char                  *name;
        const DataTypeISASelectorPtr is_selected;
        AddMulAddKernelPtr           ukernel;
    };

    CpuAddMulAddKernel() = default;
    ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuAddMulAddKernel);
    /** Initialize the kernel's inputs and outputs.
     *
     * Similar to @ref NEAddMulAdd::configure()
     *
     */
    void configure(const ITensorInfo         *input1,
                   const ITensorInfo         *input2,
                   const ITensorInfo         *bn_mul,
                   const ITensorInfo         *bn_add,
                   ITensorInfo               *add_output,
                   ITensorInfo               *final_output,
                   ConvertPolicy              policy,
                   const ActivationLayerInfo &act_info);
    /** Static function to check if given info will lead to a valid configuration
     *
     * Similar to CpuAddMulAddKernel::configure()
     *
     * @return a status
     */
    static Status validate(const ITensorInfo         *input1,
                           const ITensorInfo         *input2,
                           const ITensorInfo         *bn_mul,
                           const ITensorInfo         *bn_add,
                           const ITensorInfo         *add_output,
                           const ITensorInfo         *final_output,
                           ConvertPolicy              policy,
                           const ActivationLayerInfo &act_info);

    // Inherited methods overridden:
    void        run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
    const char *name() const override;

    static const std::vector<AddMulAddKernel> &get_available_kernels();

private:
    ConvertPolicy       _policy{};
    ActivationLayerInfo _act_info{};
    AddMulAddKernelPtr  _run_method{nullptr};
    std::string         _name{};
};
} // namespace kernels
} // namespace cpu
} // namespace arm_compute
#endif /* SRC_CPU_KERNELS_CPUADDMULADDKERNEL */