src/core/gpu/cl/kernels/ClScaleKernel.h

/*
 * Copyright (c) 2021 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 ARM_COMPUTE_CL_SCALE_KERNEL_H
#define ARM_COMPUTE_CL_SCALE_KERNEL_H

#include "arm_compute/core/KernelDescriptors.h"
#include "src/core/common/Macros.h"
#include "src/core/gpu/cl/ClCompileContext.h"
#include "src/core/gpu/cl/IClKernel.h"

namespace arm_compute
{
class ICLTensor;

namespace opencl
{
namespace kernels
{
/** Interface for the scale kernel */
class ClScaleKernel : public IClKernel
{
public:
    /** Default constructor */
    ClScaleKernel() = default;
    ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(ClScaleKernel);

    /** Initialise the kernel's inputs, output and interpolation policy
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  src             Source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32
     * @param[out] dst             Destination tensor info. Data types supported: Same as @p src
     *                             All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
     * @param[in]  info            @ref ScaleKernelInfo Kernel descriptor to be used to configure.
     */
    void configure(const CLCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const ScaleKernelInfo &info);

    /** Static function to check if given info will lead to a valid configuration of @ref ClScaleKernel
     *
     * @param[in] src  Source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32
     * @param[in] dst  Destination tensor info. Data types supported: Same as @p src
     *                 All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
     * @param[in] info @ref ScaleKernelInfo Kernel descriptor to be used to validate
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const ScaleKernelInfo &info);

    // Inherited methods overridden:
    BorderSize border_size() const override;
    void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;

    // Getter for interpolation policy
    InterpolationPolicy get_interpolation_policy() const
    {
        return _info.interpolation_policy;
    }

    // Getter for data type
    DataType get_data_type() const
    {
        return _data_type;
    }

    // Getter for output x dimension
    unsigned int get_output_x_dim() const
    {
        return _output_x_dim;
    }

private:
    ScaleKernelInfo _info         = ScaleKernelInfo(InterpolationPolicy::NEAREST_NEIGHBOR, BorderMode::UNDEFINED);
    DataType        _data_type    = DataType::UNKNOWN;
    DataLayout      _data_layout  = DataLayout::UNKNOWN;
    unsigned int    _output_x_dim = 0;
};
} // namespace kernels
} // namespace opencl
} // namespace arm_compute
#endif /*ARM_COMPUTE_CLSCALEKERNEL_H */