arm_compute/core/CPP/ICPPSimpleKernel.h

/*
 * Copyright (c) 2017-2019 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_ICPPSIMPLEKERNEL_H
#define ARM_COMPUTE_ICPPSIMPLEKERNEL_H

#include "arm_compute/core/CPP/ICPPKernel.h"

namespace arm_compute
{
class ITensor;

/** Interface for simple C++ kernels having 1 tensor input and 1 tensor output */
class ICPPSimpleKernel : public ICPPKernel
{
public:
    /** Constructor */
    ICPPSimpleKernel();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    ICPPSimpleKernel(const ICPPSimpleKernel &) = delete;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    ICPPSimpleKernel &operator=(const ICPPSimpleKernel &) = delete;
    /** Allow instances of this class to be moved */
    ICPPSimpleKernel(ICPPSimpleKernel &&) = default;
    /** Allow instances of this class to be moved */
    ICPPSimpleKernel &operator=(ICPPSimpleKernel &&) = default;
    /** Default destructor */
    ~ICPPSimpleKernel() = default;

protected:
    /** Configure the kernel
     *
     * @param[in]  input                             Source tensor.
     * @param[out] output                            Destination tensor.
     * @param[in]  num_elems_processed_per_iteration Number of processed elements per iteration.
     * @param[in]  border_undefined                  (Optional) True if the border mode is undefined. False if it's replicate or constant.
     * @param[in]  border_size                       (Optional) Size of the border.
     */
    void configure(const ITensor *input, ITensor *output, unsigned int num_elems_processed_per_iteration, bool border_undefined = false, const BorderSize &border_size = BorderSize());
    /** Static function to check if given info will lead to a valid configuration of @ref ICPPSimpleKernel.
     *
     * @param[in] input                             Source tensor info.
     * @param[in] output                            Destination tensor info.
     * @param[in] num_elems_processed_per_iteration Number of processed elements per iteration.
     * @param[in] border_undefined                  (Optional) True if the border mode is undefined. False if it's replicate or constant.
     * @param[in] border_size                       (Optional) Size of the border.
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int num_elems_processed_per_iteration,
                           bool border_undefined = false, const BorderSize &border_size = BorderSize());

protected:
    const ITensor *_input;
    ITensor       *_output;
};
} // namespace arm_compute
#endif /*ARM_COMPUTE_ICPPSIMPLEKERNEL_H */