madness::PoolTaskNull Class Reference

A no-operation task used for various purposes. More...

#include <thread.h>

Inheritance diagram for madness::PoolTaskNull:

Collaboration diagram for madness::PoolTaskNull:

Public Member Functions
virtual	~PoolTaskNull ()
	Destructor.
void	run (const TaskThreadEnv &)
	Execution function that does nothing.
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.

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

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

A no-operation task used for various purposes.

Constructor & Destructor Documentation

~PoolTaskNull()

virtual madness::PoolTaskNull::~PoolTaskNull ( )

inlinevirtual

Destructor.

Member Function Documentation

get_id()

virtual void madness::PoolTaskNull::get_id ( std::pair< void *, unsigned short > &  id ) const

inlineprivatevirtual

Todo:

Brief description needed.

Todo:

Description needed.

Parameters

[in,out]

id

Description needed.

Reimplemented from madness::PoolTaskInterface.

References madness::PoolTaskInterface::make_id(), and run().

run()

void madness::PoolTaskNull::run ( const TaskThreadEnv &  )

inlinevirtual

Execution function that does nothing.

Implements madness::PoolTaskInterface.

Referenced by get_id().

---

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

• thread.h