Task Class Reference

Inheritance diagram for Task:

Collaboration diagram for Task:

Public Member Functions
	Task (int gen)
virtual void	run (madness::World &world)
	Runs a single-threaded task ... derived classes must implement this.
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 &world, const TaskThreadEnv &env)
	Runs a multi-threaded task.
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 ()

Static Public Member Functions
static bool	finished ()
Static Public Member Functions inherited from madness::TaskAttributes
static TaskAttributes	generator ()
static TaskAttributes	hipri ()
static TaskAttributes	multi_threaded (int nthread)

Private Attributes
bool	done
const int	gen

Additional Inherited Members
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)

Constructor & Destructor Documentation

Task()

Task::Task ( int  gen )

inline

Member Function Documentation

finished()

static bool Task::finished ( )

inlinestatic

References NGEN, NTASK, and total_count.

Referenced by main().

run()

virtual void Task::run ( madness::World &  )

inlinevirtual

Runs a single-threaded task ... derived classes must implement this.

This interface may disappear so new code should use the multi-threaded interface.

Reimplemented from madness::TaskInterface.

References madness::WorldTaskQueue::add(), done, gen, get_tls(), MADNESS_CHECK, madness::World::taskq, total_count, and madness::TaskInterface::world.

Member Data Documentation

done

bool Task::done

private

Referenced by run().

gen

const int Task::gen

private

Referenced by run().

---

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

• test_queue.cc