arm_compute/runtime/IFunction.h

   1 /*
   2  * Copyright (c) 2016-2018 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     /** Destructor */
  34     virtual ~IFunction() = default;
  35     /** Run the kernels contained in the function
  36      *
  37      * For NEON kernels:
  38      * - Multi-threading is used for the kernels which are parallelisable.
  39      * - By default std::thread::hardware_concurrency() threads are used.
  40      *
  41      * @note @ref CPPScheduler::set_num_threads() can be used to manually set the number of threads
  42      *
  43      * For OpenCL kernels:
  44      * - All the kernels are enqueued on the queue associated with CLScheduler.
  45      * - The queue is then flushed.
  46      *
  47      * @note The function will not block until the kernels are executed. It is the user's responsibility to wait.
  48      * @note Will call prepare() on first run if hasn't been done
  49      */
  50     virtual void run() = 0;
  51     /** Prepare the function for executing
  52      *
  53      * Any one off pre-processing step required by the function is handled here
  54      *
  55      * @note Prepare stage might not need all the function's buffers' backing memory to be available in order to execute
  56      */
  57     virtual void prepare()
  58     {
  59     }
  60 };
  61 }
  62 #endif /*__ARM_COMPUTE_IFUNCTION_H__ */