ICLSimpleFunction.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2020 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_ICLSIMPLEFUNCTION_H
#define ARM_COMPUTE_ICLSIMPLEFUNCTION_H

#include "arm_compute/runtime/IFunction.h"

#include <memory>

namespace arm_compute
{
// Forward declarations
class CLRuntimeContext;
class CLFillBorderKernel;
class ICLKernel;

/** Basic interface for functions which have a single OpenCL kernel */
class ICLSimpleFunction : public IFunction
{
public:
    /** Constructor
     *
     * @param[in] ctx Runtime context to be used by the function
     */
    ICLSimpleFunction(CLRuntimeContext *ctx = nullptr);

    /** Prevent instances of this class from being copied (As this class contains pointers) */
    ICLSimpleFunction(const ICLSimpleFunction &) = delete;
    /** Default move constructor */
    ICLSimpleFunction(ICLSimpleFunction &&) = default;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    ICLSimpleFunction &operator=(const ICLSimpleFunction &) = delete;
    /** Default move assignment operator */
    ICLSimpleFunction &operator=(ICLSimpleFunction &&) = default;
    /** Default destructor */
    ~ICLSimpleFunction();

    // Inherited methods overridden:
    void run() override final;

protected:
    std::unique_ptr<ICLKernel>          _kernel;         /**< Kernel to run */
    std::unique_ptr<CLFillBorderKernel> _border_handler; /**< Kernel to handle  borders */
    CLRuntimeContext                   *_ctx;            /**< Context to use */
};
} // namespace arm_compute
#endif /*ARM_COMPUTE_ICLSIMPLEFUNCTION_H */