Add documentation for parallel_phase feature #1646
Conversation
Signed-off-by: Isaev, Ilya <[email protected]>
Signed-off-by: Isaev, Ilya <[email protected]>
Signed-off-by: Isaev, Ilya <[email protected]>
| with the following API: | ||
| * Add enumeration class ``leave_policy`` to ``task_arena``. | ||
| * Add ``leave_policy`` as the last parameter to ``task_arena`` constructors and ``task_arena::initialize`` methods. | ||
| This allows to choose retention policy for worker threads in case when no more parallel work in the arena. |
There was a problem hiding this comment.
| This allows to choose retention policy for worker threads in case when no more parallel work in the arena. | |
| This allows you to define a retention policy for worker threads when no parallel work is in the arena. |
There was a problem hiding this comment.
I am not sure how to better state this but at the same time to not overwhelm documentation with lots of details. The idea is that the feature allows users to tell the scheduler, what policy to use when TBB's worker threads are going to leave task_arena because they failed to find any work.
There was a problem hiding this comment.
maybe smth like: This feature allows you to inform the scheduler about the preferred policy for worker threads when they are about to leave task_arena due to a lack of available work.
Co-authored-by: Alexandra <[email protected]>
Co-authored-by: Alexandra <[email protected]>
| with the following API: | ||
| * Add enumeration class ``leave_policy`` to ``task_arena``. | ||
| * Add ``leave_policy`` as the last parameter to ``task_arena`` constructors and ``task_arena::initialize`` methods. | ||
| This allows to choose retention policy for worker threads in case when no more parallel work in the arena. |
There was a problem hiding this comment.
maybe smth like: This feature allows you to inform the scheduler about the preferred policy for worker threads when they are about to leave task_arena due to a lack of available work.
Co-authored-by: Alexandra <[email protected]>
Signed-off-by: Isaev, Ilya <[email protected]>
isaevil
requested review from
aleksei-fedotov,
vossmjp,
akukanov,
dnmokhov and
kboyarinov
Description
Document parallel_phase and leave_policy extensions to
task_arenain Developer Reference.Fixes # - issue number(s) if exists
Type of change
Choose one or multiple, leave empty if none of the other choices apply
Add a respective label(s) to PR if you have permissions
Tests
Documentation
Breaks backward compatibility
Notify the following users
List users with
@to send notificationsOther information