Compute Library
 21.08
ICPPKernel.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_ICPPKERNEL_H
25 #define ARM_COMPUTE_ICPPKERNEL_H
26 
29 #include "arm_compute/core/Types.h"
31 
32 namespace arm_compute
33 {
34 class Window;
35 class ITensor;
36 
37 /** Common interface for all kernels implemented in C++ */
38 class ICPPKernel : public IKernel
39 {
40 public:
41  /** Default destructor */
42  virtual ~ICPPKernel() = default;
43 
44  /** Execute the kernel on the passed window
45  *
46  * @warning If is_parallelisable() returns false then the passed window must be equal to window()
47  *
48  * @note The window has to be a region within the window returned by the window() method
49  *
50  * @note The width of the window has to be a multiple of num_elems_processed_per_iteration().
51  *
52  * @param[in] window Region on which to execute the kernel. (Must be a region of the window returned by window())
53  * @param[in] info Info about executing thread and CPU.
54  */
55  virtual void run(const Window &window, const ThreadInfo &info)
56  {
57  ARM_COMPUTE_UNUSED(window, info);
58  ARM_COMPUTE_ERROR("default implementation of legacy run() virtual member function invoked");
59  }
60 
61  /** legacy compatibility layer for implemantions which do not support thread_locator
62  * In these cases we simply narrow the interface down the legacy version
63  *
64  * @param[in] window Region on which to execute the kernel. (Must be a region of the window returned by window())
65  * @param[in] info Info about executing thread and CPU.
66  * @param[in] thread_locator Specifies "where" the current thread is in the multi-dimensional space
67  */
68  virtual void run_nd(const Window &window, const ThreadInfo &info, const Window &thread_locator)
69  {
70  ARM_COMPUTE_UNUSED(thread_locator);
71  run(window, info);
72  }
73 
74  /** Execute the kernel on the passed window
75  *
76  * @warning If is_parallelisable() returns false then the passed window must be equal to window()
77  *
78  * @note The window has to be a region within the window returned by the window() method
79  *
80  * @note The width of the window has to be a multiple of num_elems_processed_per_iteration().
81  *
82  * @param[in] tensors A vector containing the tensors to operate on.
83  * @param[in] window Region on which to execute the kernel. (Must be a region of the window returned by window())
84  * @param[in] info Info about executing thread and CPU.
85  */
86  virtual void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info)
87  {
88  ARM_COMPUTE_UNUSED(tensors, window, info);
89  }
90 
91  /** Name of the kernel
92  *
93  * @return Kernel name
94  */
95  virtual const char *name() const = 0;
96 };
97 } // namespace arm_compute
98 #endif /*ARM_COMPUTE_ICPPKERNEL_H */
Common information for all the kernels.
Definition: IKernel.h:33
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
#define ARM_COMPUTE_ERROR(msg)
Print the given message then throw an std::runtime_error.
Definition: Error.h:352
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
virtual ~ICPPKernel()=default
Default destructor.
virtual void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info)
Execute the kernel on the passed window.
Definition: ICPPKernel.h:86
Copyright (c) 2017-2021 Arm Limited.
virtual void run_nd(const Window &window, const ThreadInfo &info, const Window &thread_locator)
legacy compatibility layer for implemantions which do not support thread_locator In these cases we si...
Definition: ICPPKernel.h:68
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
virtual void run(const Window &window, const ThreadInfo &info)
Execute the kernel on the passed window.
Definition: ICPPKernel.h:55
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:158
Tensor packing service.
Definition: ITensorPack.h:39
Describe a multidimensional execution window.
Definition: Window.h:39
virtual const char * name() const =0
Name of the kernel.