tbb::internal::parallel_invoke_helper Class Reference

#include <parallel_invoke.h>

Inheritance diagram for tbb::internal::parallel_invoke_helper:

Collaboration diagram for tbb::internal::parallel_invoke_helper:

Classes
class	parallel_invoke_noop

Public Member Functions
	parallel_invoke_helper (int number_of_children)
template<typename function >
void	add_children (const function &_func)
template<typename function1 , typename function2 >
void	add_children (const function1 &_func1, const function2 &_func2)
template<typename function1 , typename function2 , typename function3 >
void	add_children (const function1 &_func1, const function2 &_func2, const function3 &_func3)
template<typename F0 >
void	run_and_finish (const F0 &f0)
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...

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...
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

Definition at line 91 of file parallel_invoke.h.

Constructor & Destructor Documentation

parallel_invoke_helper()

tbb::internal::parallel_invoke_helper::parallel_invoke_helper ( int  number_of_children )

inline

Definition at line 99 of file parallel_invoke.h.

        {
            set_ref_count(number_of_children + 1);
        }

References tbb::task::set_ref_count().

Here is the call graph for this function:

Member Function Documentation

add_children() [1/3]

template<typename function >

void tbb::internal::parallel_invoke_helper::add_children ( const function &  _func )

inline

Definition at line 136 of file parallel_invoke.h.

        {
            internal::function_invoker<function>* invoker = new (allocate_child()) internal::function_invoker<function>(_func);
            __TBB_ASSERT(invoker, "Child task allocation failed");
            spawn(*invoker);
        }

References __TBB_ASSERT, and tbb::task::allocate_child().

Referenced by tbb::parallel_invoke().

Here is the call graph for this function:

Here is the caller graph for this function:

add_children() [2/3]

template<typename function1 , typename function2 >

void tbb::internal::parallel_invoke_helper::add_children ( const function1 &  _func1, const function2 &  _func2  )

inline

Definition at line 146 of file parallel_invoke.h.

        {
            // The third argument is dummy, it is ignored actually.
            parallel_invoke_noop noop;
            internal::spawner<2, function1, function2, parallel_invoke_noop>& sub_root = *new(allocate_child())internal::spawner<2, function1, function2, parallel_invoke_noop>(_func1, _func2, noop);
            spawn(sub_root);
        }

References tbb::task::allocate_child().

Here is the call graph for this function:

add_children() [3/3]

template<typename function1 , typename function2 , typename function3 >

void tbb::internal::parallel_invoke_helper::add_children ( const function1 &  _func1, const function2 &  _func2, const function3 &  _func3  )

inline

Definition at line 155 of file parallel_invoke.h.

        {
            internal::spawner<3, function1, function2, function3>& sub_root = *new(allocate_child())internal::spawner<3, function1, function2, function3>(_func1, _func2, _func3);
            spawn(sub_root);
        }

References tbb::task::allocate_child().

Here is the call graph for this function:

run_and_finish()

template<typename F0 >

void tbb::internal::parallel_invoke_helper::run_and_finish ( const F0 &  f0 )

inline

Definition at line 164 of file parallel_invoke.h.

        {
            internal::function_invoker<F0>* invoker = new (allocate_child()) internal::function_invoker<F0>(f0);
            __TBB_ASSERT(invoker, "Child task allocation failed");
            spawn_and_wait_for_all(*invoker);
        }

References __TBB_ASSERT, tbb::task::allocate_child(), and tbb::task::spawn_and_wait_for_all().

Referenced by tbb::parallel_invoke().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• parallel_invoke.h