arm_compute/runtime/SingleThreadScheduler.h

/*
 * Copyright (c) 2017-2018 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_SINGLETHREADSCHEDULER_H__
#define __ARM_COMPUTE_SINGLETHREADSCHEDULER_H__

#include "arm_compute/runtime/IScheduler.h"

namespace arm_compute
{
/** Pool of threads to automatically split a kernel's execution among several threads. */
class SingleThreadScheduler : public IScheduler
{
public:
    /** Sets the number of threads the scheduler will use to run the kernels.
     *
     * @param[in] num_threads This is ignored for this scheduler as the number of threads is always one.
     */
    void set_num_threads(unsigned int num_threads) override;
    /** Returns the number of threads that the SingleThreadScheduler has, which is always 1.
     *
     * @return Number of threads available in SingleThreadScheduler.
     */
    unsigned int num_threads() const override;
    /** Access the scheduler singleton
     *
     * @return The scheduler
     */
    static SingleThreadScheduler &get();
    /** Runs the kernel in the same thread as the caller synchronously.
     *
     * @param[in] kernel Kernel to execute.
     * @param[in] hints  Hints for the scheduler.
     */
    void schedule(ICPPKernel *kernel, const Hints &hints) override;

protected:
    /** Will run the workloads sequentially and in order.
     *
     * @param[in] workloads Workloads to run
     */
    void run_workloads(std::vector<Workload> &workloads) override;

private:
    /** Constructor. */
    SingleThreadScheduler() = default;
};
}
#endif /* __ARM_COMPUTE_SINGLETHREADSCHEDULER_H__ */