Compute Library
 22.05
SingleThreadScheduler.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_SINGLETHREADSCHEDULER_H
25 #define ARM_COMPUTE_SINGLETHREADSCHEDULER_H
26 
28 
29 namespace arm_compute
30 {
31 /** Pool of threads to automatically split a kernel's execution among several threads. */
32 class SingleThreadScheduler final : public IScheduler
33 {
34 public:
35  /** Constructor. */
36  SingleThreadScheduler() = default;
37  /** Sets the number of threads the scheduler will use to run the kernels.
38  *
39  * @param[in] num_threads This is ignored for this scheduler as the number of threads is always one.
40  */
41  void set_num_threads(unsigned int num_threads) override;
42  /** Returns the number of threads that the SingleThreadScheduler has, which is always 1.
43  *
44  * @return Number of threads available in SingleThreadScheduler.
45  */
46  unsigned int num_threads() const override;
47  /** Runs the kernel in the same thread as the caller synchronously.
48  *
49  * @param[in] kernel Kernel to execute.
50  * @param[in] hints Hints for the scheduler.
51  */
52  void schedule(ICPPKernel *kernel, const Hints &hints) override;
53  /** Runs the kernel in the same thread as the caller synchronously.
54  *
55  * @param[in] kernel Kernel to execute.
56  * @param[in] hints Hints for the scheduler.
57  * @param[in] window Window to use for kernel execution.
58  * @param[in] tensors Vector containing the tensors to operate on.
59  */
60  void schedule_op(ICPPKernel *kernel, const Hints &hints, const Window &window, ITensorPack &tensors) override;
61 
62 protected:
63  /** Will run the workloads sequentially and in order.
64  *
65  * @param[in] workloads Workloads to run
66  */
67  void run_workloads(std::vector<Workload> &workloads) override;
68 };
69 } // namespace arm_compute
70 #endif /* ARM_COMPUTE_SINGLETHREADSCHEDULER_H */
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
unsigned int num_threads() const override
Returns the number of threads that the SingleThreadScheduler has, which is always 1...
Scheduler interface to run kernels.
Definition: IScheduler.h:41
Copyright (c) 2017-2022 Arm Limited.
void schedule_op(ICPPKernel *kernel, const Hints &hints, const Window &window, ITensorPack &tensors) override
Runs the kernel in the same thread as the caller synchronously.
void schedule(ICPPKernel *kernel, const Hints &hints) override
Runs the kernel in the same thread as the caller synchronously.
SingleThreadScheduler()=default
Constructor.
void set_num_threads(unsigned int num_threads) override
Sets the number of threads the scheduler will use to run the kernels.
Pool of threads to automatically split a kernel&#39;s execution among several threads.
Tensor packing service.
Definition: ITensorPack.h:39
Describe a multidimensional execution window.
Definition: Window.h:39