Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2016, 2017 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_IFUNCTION_H__ |
| 25 | #define __ARM_COMPUTE_IFUNCTION_H__ |
| 26 | |
| 27 | namespace arm_compute |
| 28 | { |
| 29 | /** Base class for all functions */ |
| 30 | class IFunction |
| 31 | { |
| 32 | public: |
| 33 | /** Run the kernels contained in the function |
| 34 | * |
| 35 | * For NEON kernels: |
| 36 | * - Multi-threading is used for the kernels which are parallelisable. |
| 37 | * - By default std::thread::hardware_concurrency() threads are used. |
| 38 | * |
| 39 | * @note @ref CPPScheduler::set_num_threads() can be used to manually set the number of threads |
| 40 | * |
| 41 | * For OpenCL kernels: |
| 42 | * - All the kernels are enqueued on the queue associated with CLScheduler. |
| 43 | * - The queue is then flushed. |
| 44 | * |
| 45 | * @note The function will not block until the kernels are executed. It is the user's responsibility to wait. |
| 46 | */ |
| 47 | virtual void run() = 0; |
| 48 | /** Destructor |
| 49 | * |
| 50 | */ |
| 51 | virtual ~IFunction() = default; |
| 52 | }; |
| 53 | } |
| 54 | #endif /*__ARM_COMPUTE_IFUNCTION_H__ */ |