Apply an operation to a range of iterators. More...

#include <world_task_queue.h>

Inheritance diagram for madness::detail::ForEachRootTask< rangeT, opT >:

[legend]

Collaboration diagram for madness::detail::ForEachRootTask< rangeT, opT >:

[legend]

Public Member Functions
	ForEachRootTask (World &, const rangeT range, const opT &op)
	Constructor.

virtual	~ForEachRootTask ()=default
	Virtual destructor.

const Future< bool > &	result () const
	Result accessor.

virtual void	run (World &, const TaskThreadEnv &)
	Task run work.

Public Member Functions inherited from madness::TaskInterface
	TaskInterface (const TaskAttributes &attr)
	Create a new task with zero dependencies and given attributes.

	TaskInterface (int ndepend, const char *caller, const TaskAttributes attr=TaskAttributes())

	TaskInterface (int ndepend=0, const TaskAttributes attr=TaskAttributes())
	Create a new task with ndepend dependencies (default 0) and given attributes.

virtual	~TaskInterface ()

World *	get_world () const

virtual void	run (World &)
	Runs a single-threaded task ... derived classes must implement this.

Public Member Functions inherited from madness::PoolTaskInterface
	PoolTaskInterface ()
	Default constructor.

	PoolTaskInterface (const TaskAttributes &attr)

virtual	~PoolTaskInterface ()=default
	Destructor.

void	execute ()

void	set_nthread (int nthread)
	Call this to reset the number of threads before the task is submitted.

Public Member Functions inherited from madness::TaskAttributes
	TaskAttributes (const TaskAttributes &attr)
	Copy constructor.

	TaskAttributes (unsigned long flags=0)
	Sets the attributes to the desired values.

virtual	~TaskAttributes ()

int	get_nthread () const
	Get the number of threads.

bool	is_generator () const
	Test if the generator attribute is true.

bool	is_high_priority () const
	Test if the high priority attribute is true.

bool	is_stealable () const
	Test if the stealable attribute is true.

template<typename Archive >
void	serialize (Archive &ar)
	Serializes the attributes for I/O.

TaskAttributes &	set_generator (bool generator_hint)
	Sets the generator attribute.

TaskAttributes &	set_highpriority (bool hipri)
	Sets the high priority attribute.

void	set_nthread (int nthread)
	Set the number of threads.

TaskAttributes &	set_stealable (bool stealable)
	Sets the stealable attribute.

Public Member Functions inherited from madness::DependencyInterface
	DependencyInterface (int ndep, const char *caller)

	DependencyInterface (int ndep=0)

virtual	~DependencyInterface ()
	Destructor.

void	dec ()
	Decrement the number of dependencies and invoke the callback if `ndepend==0`.

void	dec_debug (const char *caller)

void	inc ()
	Increment the number of dependencies.

void	inc_debug (const char *caller)
	Same as inc(), but keeps track of `caller`; calling dec_debug() will signal error if no matching inc_debug() had been invoked

int	ndep () const
	Returns the number of unsatisfied dependencies.

void	notify ()
	Invoked by callbacks to notify of dependencies being satisfied.

void	notify_debug (const char *caller)
	Overload of CallbackInterface::notify_debug(), updates dec()

bool	probe () const
	Returns true if `ndepend == 0` (no unsatisfied dependencies).

void	register_callback (CallbackInterface *callback)
	Registers a callback that will be executed when `ndepend==0`; immediately invoked if `ndepend==0`.

void	register_final_callback (CallbackInterface *callback)
	Registers the final callback to be executed when `ndepend==0`; immediately invoked if `ndepend==0`.

Public Member Functions inherited from madness::CallbackInterface
virtual	~CallbackInterface ()

Private Member Functions
virtual void	get_id (std::pair< void *, unsigned short > &id) const
	Get the task ID.

Private Attributes
Future< bool >	completion_status_
	The result of this set of tasks.

opT	op_
	The foreach function.

rangeT	range_
	The range.

Additional Inherited Members
Static Public Member Functions inherited from madness::TaskAttributes
static TaskAttributes	generator ()

static TaskAttributes	hipri ()

static TaskAttributes	multi_threaded (int nthread)

Static Public Attributes inherited from madness::TaskInterface
static bool	debug = false

Static Public Attributes inherited from madness::TaskAttributes
static const unsigned long	GENERATOR = 1ul<<8
	Mask for generator bit.

static const unsigned long	HIGHPRIORITY = GENERATOR<<2
	Mask for priority bit.

static const unsigned long	NTHREAD = 0xff
	Mask for nthread byte.

static const unsigned long	STEALABLE = GENERATOR<<1
	Mask for stealable bit.

Protected Member Functions inherited from madness::TaskInterface
virtual void	run (const TaskThreadEnv &env)
	Override this method to implement a multi-threaded task.

Protected Member Functions inherited from madness::CallbackInterface
virtual void	notify_debug_impl (const char *caller)

Static Protected Member Functions inherited from madness::PoolTaskInterface
template<typename fnobjT >
static std::enable_if<!(detail::function_traits< fnobjT >::value\|\|detail::memfunc_traits< fnobjT >::value)>::type	make_id (std::pair< void *, unsigned short > &id, const fnobjT &)

template<typename fnT >
static std::enable_if< detail::function_traits< fnT >::value\|\|detail::memfunc_traits< fnT >::value >::type	make_id (std::pair< void *, unsigned short > &id, fnT fn)

Detailed Description

template<typename rangeT, typename opT>
class madness::detail::ForEachRootTask< rangeT, opT >

Apply an operation to a range of iterators.

Template Parameters

rangeT	The range of iterators type.
opT	The operation type. This task creates `for_each` tasks and collects information on the results of those tasks. Once all tasks have completed it will set the result future.