Compute Library
 21.05
ICLSimpleKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2020 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_ICLSIMPLEKERNEL_H
25 #define ARM_COMPUTE_ICLSIMPLEKERNEL_H
26 
29 #include "src/core/CL/ICLKernel.h"
30 
31 namespace arm_compute
32 {
33 /** Interface for simple OpenCL kernels having 1 tensor input and 1 tensor output */
34 class ICLSimpleKernel : public ICLKernel
35 {
36 public:
37  /** Constructor. */
39  /** Prevent instances of this class from being copied (As this class contains pointers) */
40  ICLSimpleKernel(const ICLSimpleKernel &) = delete;
41  /** Prevent instances of this class from being copied (As this class contains pointers) */
42  ICLSimpleKernel &operator=(const ICLSimpleKernel &) = delete;
43  /** Allow instances of this class to be moved */
44  ICLSimpleKernel(ICLSimpleKernel &&) = default;
45  /** Allow instances of this class to be moved */
47  /** Default destructor */
48  ~ICLSimpleKernel() = default;
49 
50  /** Configure the kernel
51  *
52  * @param[in] input Source tensor.
53  * @param[out] output Destination tensor.
54  * @param[in] num_elems_processed_per_iteration Number of processed elements per iteration.
55  * @param[in] border_undefined (Optional) True if the border mode is undefined. False if it's replicate or constant.
56  * @param[in] border_size (Optional) Size of the border.
57  */
58  void configure(const ICLTensor *input, ICLTensor *output, unsigned int num_elems_processed_per_iteration, bool border_undefined = false, const BorderSize &border_size = BorderSize());
59 
60 protected:
61  const ICLTensor *_input;
62  ICLTensor *_output;
63 };
64 }
65 
66 #endif /*ARM_COMPUTE_ICLSIMPLEKERNEL_H */
ICLSimpleKernel & operator=(const ICLSimpleKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
Container for 2D border size.
Definition: Types.h:267
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:46
Copyright (c) 2017-2021 Arm Limited.
void configure(const ICLTensor *input, ICLTensor *output, unsigned int num_elems_processed_per_iteration, bool border_undefined=false, const BorderSize &border_size=BorderSize())
Configure the kernel.
Interface for simple OpenCL kernels having 1 tensor input and 1 tensor output.
virtual BorderSize border_size() const
The size of the border for that kernel.
Definition: IKernel.cpp:46
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
unsigned int num_elems_processed_per_iteration
~ICLSimpleKernel()=default
Default destructor.