tbb::internal::while_iteration_task< Body > Class Template Reference
For internal use only. More...
#include <parallel_while.h>
Inheritance diagram for tbb::internal::while_iteration_task< Body >:
Collaboration diagram for tbb::internal::while_iteration_task< Body >:
Private Member Functions | |
| task * | execute () __TBB_override |
| Should be overridden by derived classes. More... | |
| while_iteration_task (const typename Body::argument_type &value, const Body &body) | |
Private Attributes | |
| const Body & | my_body |
| Body::argument_type | my_value |
Friends | |
| template<typename Body_ > | |
| class | while_group_task |
| class | tbb::parallel_while< Body > |
Additional Inherited Members | |
 Public Types inherited from tbb::task | |
| enum | state_type { executing, reexecute, ready, allocated, freed, recycle } |
| Enumeration of task states that the scheduler considers. More... | |
| typedef internal::affinity_id | affinity_id |
| An id as used for specifying affinity. More... | |
| Public Member Functions inherited from tbb::task | |
| virtual | ~task () |
| Destructor. More... | |
| internal::allocate_continuation_proxy & | allocate_continuation () |
| Returns proxy for overloaded new that allocates a continuation task of *this. More... | |
| internal::allocate_child_proxy & | allocate_child () |
| Returns proxy for overloaded new that allocates a child task of *this. More... | |
| void | recycle_as_continuation () |
| Change this to be a continuation of its former self. More... | |
| void | recycle_as_safe_continuation () |
| Recommended to use, safe variant of recycle_as_continuation. More... | |
| void | recycle_as_child_of (task &new_parent) |
| Change this to be a child of new_parent. More... | |
| void | recycle_to_reexecute () |
| Schedule this for reexecution after current execute() returns. More... | |
| void | set_ref_count (int count) |
| Set reference count. More... | |
| void | increment_ref_count () |
| Atomically increment reference count. More... | |
| int | add_ref_count (int count) |
| Atomically adds to reference count and returns its new value. More... | |
| int | decrement_ref_count () |
| Atomically decrement reference count and returns its new value. More... | |
| void | spawn_and_wait_for_all (task &child) |
| Similar to spawn followed by wait_for_all, but more efficient. More... | |
| void __TBB_EXPORTED_METHOD | spawn_and_wait_for_all (task_list &list) |
| Similar to spawn followed by wait_for_all, but more efficient. More... | |
| void | wait_for_all () |
| Wait for reference count to become one, and set reference count to zero. More... | |
| task * | parent () const |
| task on whose behalf this task is working, or NULL if this is a root. More... | |
| void | set_parent (task *p) |
| sets parent task pointer to specified value More... | |
| task_group_context * | context () |
| This method is deprecated and will be removed in the future. More... | |
| task_group_context * | group () |
| Pointer to the task group descriptor. More... | |
| bool | is_stolen_task () const |
| True if task was stolen from the task pool of another thread. More... | |
| bool | is_enqueued_task () const |
| True if the task was enqueued. More... | |
| state_type | state () const |
| Current execution state. More... | |
| int | ref_count () const |
| The internal reference count. More... | |
| bool __TBB_EXPORTED_METHOD | is_owned_by_current_thread () const |
| Obsolete, and only retained for the sake of backward compatibility. Always returns true. More... | |
| void | set_affinity (affinity_id id) |
| Set affinity for this task. More... | |
| affinity_id | affinity () const |
| Current affinity of this task. More... | |
| virtual void __TBB_EXPORTED_METHOD | note_affinity (affinity_id id) |
| Invoked by scheduler to notify task that it ran on unexpected thread. More... | |
| void __TBB_EXPORTED_METHOD | change_group (task_group_context &ctx) |
| Moves this task from its current group into another one. More... | |
| bool | cancel_group_execution () |
| Initiates cancellation of all tasks in this cancellation group and its subordinate groups. More... | |
| bool | is_cancelled () const |
| Returns true if the context has received cancellation request. More... | |
| __TBB_DEPRECATED void | set_group_priority (priority_t p) |
| Changes priority of the task group this task belongs to. More... | |
| __TBB_DEPRECATED priority_t | group_priority () const |
| Retrieves current priority of the task group this task belongs to. More... | |
| Static Public Member Functions inherited from tbb::task | |
| static internal::allocate_root_proxy | allocate_root () |
| Returns proxy for overloaded new that allocates a root task. More... | |
| static internal::allocate_root_with_context_proxy | allocate_root (task_group_context &ctx) |
| Returns proxy for overloaded new that allocates a root task associated with user supplied context. More... | |
| static void | spawn_root_and_wait (task &root) |
| Spawn task allocated by allocate_root, wait for it to complete, and deallocate it. More... | |
| static void | spawn_root_and_wait (task_list &root_list) |
| Spawn root tasks on list and wait for all of them to finish. More... | |
| static void | enqueue (task &t) |
| Enqueue task for starvation-resistant execution. More... | |
| static void | enqueue (task &t, priority_t p) |
| Enqueue task for starvation-resistant execution on the specified priority level. More... | |
| static void | enqueue (task &t, task_arena &arena, priority_t p=priority_t(0)) |
| Enqueue task in task_arena. More... | |
| static task &__TBB_EXPORTED_FUNC | self () |
| The innermost task being executed or destroyed by the current thread at the moment. More... | |
| Protected Member Functions inherited from tbb::task | |
| task () | |
| Default constructor. More... | |
Detailed Description
template<typename Body>
class tbb::internal::while_iteration_task< Body >
For internal use only.
Executes one iteration of a while.
Definition at line 40 of file parallel_while.h.
Constructor & Destructor Documentation
◆ while_iteration_task()
template<typename Body >
|
inlineprivate |
Definition at line 47 of file parallel_while.h.
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void ITT_FORMAT p void ITT_FORMAT p void size_t ITT_FORMAT d void ITT_FORMAT p const wchar_t ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s no args void ITT_FORMAT p size_t ITT_FORMAT d no args const wchar_t const wchar_t ITT_FORMAT s __itt_heap_function void size_t int ITT_FORMAT d __itt_heap_function void ITT_FORMAT p __itt_heap_function void void size_t int ITT_FORMAT d no args no args unsigned int ITT_FORMAT u const __itt_domain __itt_id ITT_FORMAT lu const __itt_domain __itt_id __itt_id __itt_string_handle ITT_FORMAT p const __itt_domain __itt_id ITT_FORMAT p const __itt_domain __itt_id __itt_timestamp __itt_timestamp ITT_FORMAT lu const __itt_domain __itt_id __itt_id __itt_string_handle ITT_FORMAT p const __itt_domain ITT_FORMAT p const __itt_domain __itt_string_handle unsigned long long value
Definition: ittnotify_static.h:192
Body::argument_type my_value
Definition: parallel_while.h:42
Member Function Documentation
◆ execute()
template<typename Body >
|
inlineprivatevirtual |
Should be overridden by derived classes.
Implements tbb::task.
Definition at line 43 of file parallel_while.h.
Body::argument_type my_value
Definition: parallel_while.h:42
References tbb::internal::while_iteration_task< Body >::my_body, and tbb::internal::while_iteration_task< Body >::my_value.
Friends And Related Function Documentation
◆ tbb::parallel_while< Body >
template<typename Body >
|
friend |
Definition at line 51 of file parallel_while.h.
◆ while_group_task
Definition at line 50 of file parallel_while.h.
Member Data Documentation
◆ my_body
template<typename Body >
|
private |
Definition at line 41 of file parallel_while.h.
Referenced by tbb::internal::while_iteration_task< Body >::execute().
◆ my_value
template<typename Body >
|
private |
Definition at line 42 of file parallel_while.h.
Referenced by tbb::internal::while_iteration_task< Body >::execute().
The documentation for this class was generated from the following file: