1 /* 2 * Copyright (c) 2016-2021 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_IKERNEL_H 25 #define ARM_COMPUTE_IKERNEL_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/core/Window.h" 29 30 namespace arm_compute 31 { 32 /** Common information for all the kernels */ 33 class IKernel 34 { 35 public: 36 /** Constructor */ 37 IKernel(); 38 /** Destructor */ 39 virtual ~IKernel() = default; 40 /** Indicates whether or not the kernel is parallelisable 41 * 42 * If the kernel is parallelisable then the window returned by window() can be split into sub-windows 43 * which can then be run in parallel. 44 * 45 * If the kernel is not parallelisable then only the window returned by window() can be passed to run() 46 * 47 * @return True if the kernel is parallelisable 48 */ 49 virtual bool is_parallelisable() const; 50 /** The size of the border for that kernel 51 * 52 * @return The width in number of elements of the border. 53 */ 54 virtual BorderSize border_size() const; 55 /** The maximum window the kernel can be executed on 56 * 57 * @return The maximum window the kernel can be executed on. 58 */ 59 const Window &window() const; 60 /** Function to check if the embedded window of this kernel has been configured 61 * 62 * @return True if the windows has been configured 63 */ 64 bool is_window_configured() const; 65 66 protected: 67 /** Configure the kernel's window 68 * 69 * @param[in] window The maximum window which will be returned by window() 70 */ 71 void configure(const Window &window); 72 73 private: 74 Window _window; 75 }; 76 } 77 #endif /*ARM_COMPUTE_IKERNEL_H */ 78