diff options
author | Anthony Barbier <anthony.barbier@arm.com> | 2017-09-04 18:44:23 +0100 |
---|---|---|
committer | Anthony Barbier <anthony.barbier@arm.com> | 2018-09-17 13:03:09 +0100 |
commit | 6ff3b19ee6120edf015fad8caab2991faa3070af (patch) | |
tree | a7a6dcd16dfd56d79fa1b56a313caeebcc939b68 /arm_compute/core/IKernel.h | |
download | ComputeLibrary-6ff3b19ee6120edf015fad8caab2991faa3070af.tar.gz |
COMPMID-344 Updated doxygen
Change-Id: I32f7b84daa560e460b77216add529c8fa8b327ae
Diffstat (limited to 'arm_compute/core/IKernel.h')
-rw-r--r-- | arm_compute/core/IKernel.h | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/arm_compute/core/IKernel.h b/arm_compute/core/IKernel.h new file mode 100644 index 0000000000..4f3812b6da --- /dev/null +++ b/arm_compute/core/IKernel.h @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2016, 2017 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_IKERNEL_H__ +#define __ARM_COMPUTE_IKERNEL_H__ + +#include "arm_compute/core/Types.h" +#include "arm_compute/core/Window.h" + +namespace arm_compute +{ +/** Common information for all the kernels */ +class IKernel +{ +public: + /** Constructor */ + IKernel(); + /** Destructor */ + virtual ~IKernel() = default; + /** Indicates whether or not the kernel is parallelisable + * + * If the kernel is parallelisable then the window returned by window() can be split into sub-windows + * which can then be run in parallel. + * + * If the kernel is not parallelisable then only the window returned by window() can be passed to run() + * + * @return True if the kernel is parallelisable + */ + virtual bool is_parallelisable() const; + /** The size of the border for that kernel + * + * @return The width in number of elements of the border. + */ + virtual BorderSize border_size() const; + /** The maximum window the kernel can be executed on + * + * @return The maximum window the kernel can be executed on. + */ + const Window &window() const; + +protected: + /** Configure the kernel's window + * + * @param[in] window The maximum window which will be returned by window() + */ + void configure(const Window &window); + +private: + Window _window; +}; +} +#endif /*__ARM_COMPUTE_IKERNEL_H__ */ |