struct thread_schedule_hint

Declaration

struct thread_schedule_hint { /* full declaration omitted */ };

Description

A hint given to a scheduler to guide where a task should be scheduled.

//////////////////////////////////////////////////////////////////////// A scheduler is free to ignore the hint, or modify the hint to suit the resources available to the scheduler.

Declared at: libs/pika/coroutines/include/pika/coroutines/thread_enums.hpp:222

Member Variables

public std::int16_t hint
The hint associated with the mode. The interepretation of this hint depends on the given mode.
public pika::threads::thread_schedule_hint_mode mode
The mode of the scheduling hint.

Method Overview

Methods

constexpr thread_schedule_hint() noexcept

Description

Construct a default hint with mode thread_schedule_hint_mode::none.

Declared at: libs/pika/coroutines/include/pika/coroutines/thread_enums.hpp:225

constexpr thread_schedule_hint(
    std::int16_t thread_hint) noexcept

Description

Construct a hint with mode thread_schedule_hint_mode::thread and the given hint as the local thread number.

Declared at: libs/pika/coroutines/include/pika/coroutines/thread_enums.hpp:233

Parameters

std::int16_t thread_hint

constexpr thread_schedule_hint(
    pika::threads::thread_schedule_hint_mode mode,
    std::int16_t hint) noexcept

Description

Construct a hint with the given mode and hint. The numerical hint is unused when the mode is thread_schedule_hint_mode::none.

Declared at: libs/pika/coroutines/include/pika/coroutines/thread_enums.hpp:242

Parameters

pika::threads::thread_schedule_hint_mode mode
std::int16_t hint