Wrap a callable object and its arguments into a task function. More...

#include <taskfn.h>

Inheritance diagram for madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >:

[legend]

Collaboration diagram for madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >:

[legend]

Public Types
typedef fnT	functionT
	The task function type.

typedef detail::task_result_type< fnT >::futureT	futureT

typedef detail::task_result_type< fnT >::resultT	resultT
	The result type of the function.

Public Member Functions
template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T , typename a6T , typename a7T , typename a8T , typename a9T >
	TaskFn (const futureT &result, functionT func, a1T &&a1, a2T &&a2, a3T &&a3, a4T &&a4, a5T &&a5, a6T &&a6, a7T &&a7, a8T &&a8, a9T &&a9, const TaskAttributes &attr)

template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T , typename a6T , typename a7T , typename a8T >
	TaskFn (const futureT &result, functionT func, a1T &&a1, a2T &&a2, a3T &&a3, a4T &&a4, a5T &&a5, a6T &&a6, a7T &&a7, a8T &&a8, const TaskAttributes &attr)

template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T , typename a6T , typename a7T >
	TaskFn (const futureT &result, functionT func, a1T &&a1, a2T &&a2, a3T &&a3, a4T &&a4, a5T &&a5, a6T &&a6, a7T &&a7, const TaskAttributes &attr)

template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T , typename a6T >
	TaskFn (const futureT &result, functionT func, a1T &&a1, a2T &&a2, a3T &&a3, a4T &&a4, a5T &&a5, a6T &&a6, const TaskAttributes &attr)

template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T >
	TaskFn (const futureT &result, functionT func, a1T &&a1, a2T &&a2, a3T &&a3, a4T &&a4, a5T &&a5, const TaskAttributes &attr)

template<typename a1T , typename a2T , typename a3T , typename a4T >
	TaskFn (const futureT &result, functionT func, a1T &&a1, a2T &&a2, a3T &&a3, a4T &&a4, const TaskAttributes &attr)

template<typename a1T , typename a2T , typename a3T >
	TaskFn (const futureT &result, functionT func, a1T &&a1, a2T &&a2, a3T &&a3, const TaskAttributes &attr)

template<typename a1T , typename a2T >
	TaskFn (const futureT &result, functionT func, a1T &&a1, a2T &&a2, const TaskAttributes &attr)

template<typename a1T >
	TaskFn (const futureT &result, functionT func, a1T &&a1, const TaskAttributes &attr)

	TaskFn (const futureT &result, functionT func, const TaskAttributes &attr)

	TaskFn (const futureT &result, functionT func, const TaskAttributes &attr, archive::BufferInputArchive &input_arch)

virtual	~TaskFn ()

const futureT &	result () const

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 ()

Static Public Attributes
static const unsigned int	arity

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
virtual void	run (World &, const TaskThreadEnv &)
	Runs a multi-threaded task.

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)

Private Types
typedef TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >	TaskFn_
	This class type.

Private Member Functions
	TaskFn (const TaskFn_ &)

void	check_dependencies ()
	Check dependencies and register callbacks where necessary.

template<typename T >
void	check_dependency (const detail::ArgHolder< T > &)
	None future arguments are always ready => no op.

void	check_dependency (const Future< void > &)
	Future<void> is always ready => no op.

void	check_dependency (const std::vector< Future< void > > &)
	Future<void> is always ready => no op.

template<typename T >
void	check_dependency (detail::ArgHolder< std::vector< Future< T > > > &arg)
	None future arguments are always ready => no op.

template<typename T >
void	check_dependency (Future< T > &fut)
	Register a non-ready future as a dependency.

template<typename T >
void	check_dependency (Future< T > *fut)
	Register (pointer to) a non-ready future as a dependency.

template<typename T >
void	check_dependency (std::vector< Future< T > > &vec)
	None future arguments are always ready => no op.

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

TaskFn_	operator= (TaskFn_ &)

Static Private Member Functions
template<typename ptrT , typename memfnT , typename resT >
static memfnT	get_func (const detail::MemFuncWrapper< ptrT, memfnT, resT > &wrapper)

template<typename fT >
static fT &	get_func (fT &f)

Private Attributes
detail::task_arg< arg1T >::holderT	arg1_
	Argument 1 that will be given to the function.

detail::task_arg< arg2T >::holderT	arg2_
	Argument 2 that will be given to the function.

detail::task_arg< arg3T >::holderT	arg3_
	Argument 3 that will be given to the function.

detail::task_arg< arg4T >::holderT	arg4_
	Argument 4 that will be given to the function.

detail::task_arg< arg5T >::holderT	arg5_
	Argument 5 that will be given to the function.

detail::task_arg< arg6T >::holderT	arg6_
	Argument 6 that will be given to the function.

detail::task_arg< arg7T >::holderT	arg7_
	Argument 7 that will be given to the function.

detail::task_arg< arg8T >::holderT	arg8_
	Argument 8 that will be given to the function.

detail::task_arg< arg9T >::holderT	arg9_
	Argument 9 that will be given to the function.

const functionT	func_
	The task function.

futureT	result_
	The task Future result.

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

static TaskAttributes	hipri ()

static TaskAttributes	multi_threaded (int nthread)

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 fnT, typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>
struct madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >

Wrap a callable object and its arguments into a task function.

The callable object may have up to 10 arguments

Note: arg*T cannot be a reference type

Member Typedef Documentation

◆ functionT

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

typedef fnT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::functionT

The task function type.

◆ futureT

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

typedef detail::task_result_type<fnT>::futureT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::futureT

◆ resultT

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

typedef detail::task_result_type<fnT>::resultT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::resultT

The result type of the function.

◆ TaskFn_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

typedef TaskFn<fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T> madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn_

private

This class type.

Constructor & Destructor Documentation

◆ TaskFn() [1/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn ( const TaskFn_ & )

private

◆ TaskFn() [2/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), MADNESS_ASSERT, and u().

◆ TaskFn() [3/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename a1T >

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		a1T &&	a1,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and MADNESS_ASSERT.

◆ TaskFn() [4/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename a1T , typename a2T >

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		a1T &&	a1,
		a2T &&	a2,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and MADNESS_ASSERT.

◆ TaskFn() [5/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename a1T , typename a2T , typename a3T >

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		a1T &&	a1,
		a2T &&	a2,
		a3T &&	a3,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and MADNESS_ASSERT.

◆ TaskFn() [6/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename a1T , typename a2T , typename a3T , typename a4T >

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		a1T &&	a1,
		a2T &&	a2,
		a3T &&	a3,
		a4T &&	a4,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and MADNESS_ASSERT.

◆ TaskFn() [7/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T >

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		a1T &&	a1,
		a2T &&	a2,
		a3T &&	a3,
		a4T &&	a4,
		a5T &&	a5,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and MADNESS_ASSERT.

◆ TaskFn() [8/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T , typename a6T >

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		a1T &&	a1,
		a2T &&	a2,
		a3T &&	a3,
		a4T &&	a4,
		a5T &&	a5,
		a6T &&	a6,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and MADNESS_ASSERT.

◆ TaskFn() [9/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T , typename a6T , typename a7T >

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		a1T &&	a1,
		a2T &&	a2,
		a3T &&	a3,
		a4T &&	a4,
		a5T &&	a5,
		a6T &&	a6,
		a7T &&	a7,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and MADNESS_ASSERT.

◆ TaskFn() [10/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T , typename a6T , typename a7T , typename a8T >

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		a1T &&	a1,
		a2T &&	a2,
		a3T &&	a3,
		a4T &&	a4,
		a5T &&	a5,
		a6T &&	a6,
		a7T &&	a7,
		a8T &&	a8,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and MADNESS_ASSERT.

◆ TaskFn() [11/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename a1T , typename a2T , typename a3T , typename a4T , typename a5T , typename a6T , typename a7T , typename a8T , typename a9T >

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		a1T &&	a1,
		a2T &&	a2,
		a3T &&	a3,
		a4T &&	a4,
		a5T &&	a5,
		a6T &&	a6,
		a7T &&	a7,
		a8T &&	a8,
		a9T &&	a9,
		const TaskAttributes &	attr
	)

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and MADNESS_ASSERT.

◆ TaskFn() [12/12]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::TaskFn	(	const futureT &	result,
		functionT	func,
		const TaskAttributes &	attr,
		archive::BufferInputArchive &	input_arch
	)

inline

◆ ~TaskFn()

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

virtual madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::~TaskFn ( )

inlinevirtual

Member Function Documentation

◆ check_dependencies()

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies ( )

inlineprivate

Check dependencies and register callbacks where necessary.

◆ check_dependency() [1/7]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename T >

void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency ( const detail::ArgHolder< T > & )

inlineprivate

None future arguments are always ready => no op.

◆ check_dependency() [2/7]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency ( const Future< void > & )

inlineprivate

Future<void> is always ready => no op.

◆ check_dependency() [3/7]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency ( const std::vector< Future< void > > & )

inlineprivate

Future<void> is always ready => no op.

◆ check_dependency() [4/7]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename T >

void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency ( detail::ArgHolder< std::vector< Future< T > > > & arg )

inlineprivate

None future arguments are always ready => no op.

References madness::arg(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency().

◆ check_dependency() [5/7]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename T >

void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency ( Future< T > & fut )

inlineprivate

Register a non-ready future as a dependency.

Template Parameters

T	The type of the future to check

Parameters

fut	The future to check

References madness::DependencyInterface::inc(), and madness::nonlinear_vector_solver().

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency().

◆ check_dependency() [6/7]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename T >

void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency ( Future< T > * fut )

inlineprivate

Register (pointer to) a non-ready future as a dependency.

Template Parameters

T	The type of the future to check

Parameters

fut	The future to check

References madness::DependencyInterface::inc(), and madness::nonlinear_vector_solver().

◆ check_dependency() [7/7]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename T >

void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency ( std::vector< Future< T > > & vec )

inlineprivate

None future arguments are always ready => no op.

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependency(), and madness::vec().

◆ get_func() [1/2]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename ptrT , typename memfnT , typename resT >

static memfnT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::get_func ( const detail::MemFuncWrapper< ptrT, memfnT, resT > & wrapper )

inlinestaticprivate

References madness::detail::get_mem_func_ptr(), and madness::nonlinear_vector_solver().

◆ get_func() [2/2]

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

template<typename fT >

static fT & madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::get_func ( fT & f )

inlinestaticprivate

References madness::f.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::get_id().

◆ get_id()

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

virtual void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::get_id ( std::pair< void *, unsigned short > & id ) const

inlineprivatevirtual

Todo:: Brief description needed.

Todo:: Descriptions needed.

Parameters

[in,out] id Description needed.

Reimplemented from madness::PoolTaskInterface.

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::func_, madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::get_func(), and madness::PoolTaskInterface::make_id().

◆ operator=()

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

TaskFn_ madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::operator= ( TaskFn_ & )

private

◆ result()

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

const futureT & madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::result ( ) const

inline

References madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::result_.

Referenced by madness::WorldTaskQueue::add().

◆ run()

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

virtual void madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run	(	World &	world,
		const TaskThreadEnv &	env
	)

inlineprotectedvirtual

Runs a multi-threaded task.

Reimplemented from madness::TaskInterface.

Member Data Documentation

◆ arg1_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

detail::task_arg<arg1T>::holderT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arg1_

private

Argument 1 that will be given to the function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ arg2_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

detail::task_arg<arg2T>::holderT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arg2_

private

Argument 2 that will be given to the function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ arg3_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

detail::task_arg<arg3T>::holderT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arg3_

private

Argument 3 that will be given to the function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ arg4_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

detail::task_arg<arg4T>::holderT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arg4_

private

Argument 4 that will be given to the function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ arg5_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

detail::task_arg<arg5T>::holderT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arg5_

private

Argument 5 that will be given to the function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ arg6_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

detail::task_arg<arg6T>::holderT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arg6_

private

Argument 6 that will be given to the function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ arg7_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

detail::task_arg<arg7T>::holderT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arg7_

private

Argument 7 that will be given to the function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ arg8_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

detail::task_arg<arg8T>::holderT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arg8_

private

Argument 8 that will be given to the function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ arg9_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

detail::task_arg<arg9T>::holderT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arg9_

private

Argument 9 that will be given to the function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::check_dependencies(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ arity

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

const unsigned int madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::arity

static

Initial value:

= detail::ArgCount<arg1T, arg2T, arg3T,

arg4T, arg5T, arg6T, arg7T, arg8T, arg9T>::value

madness::nonlinear_vector_solver

static XNonlinearSolver< std::vector< Function< T, NDIM > >, T, vector_function_allocator< T, NDIM > > nonlinear_vector_solver(World &world, const long nvec)

Definition nonlinsol.h:371

The number of arguments given for the function

Note: This may not match the arity of the function if it has default parameter values

◆ func_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

const functionT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::func_

private

The task function.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::get_id(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

◆ result_

template<typename fnT , typename arg1T = void, typename arg2T = void, typename arg3T = void, typename arg4T = void, typename arg5T = void, typename arg6T = void, typename arg7T = void, typename arg8T = void, typename arg9T = void>

futureT madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::result_

private

The task Future result.

Referenced by madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::result(), and madness::TaskFn< fnT, arg1T, arg2T, arg3T, arg4T, arg5T, arg6T, arg7T, arg8T, arg9T >::run().

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

taskfn.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ functionT

◆ futureT

◆ resultT

◆ TaskFn_

Constructor & Destructor Documentation

◆ TaskFn() [1/12]

◆ TaskFn() [2/12]

◆ TaskFn() [3/12]

◆ TaskFn() [4/12]

◆ TaskFn() [5/12]

◆ TaskFn() [6/12]

◆ TaskFn() [7/12]

◆ TaskFn() [8/12]

◆ TaskFn() [9/12]

◆ TaskFn() [10/12]

◆ TaskFn() [11/12]

◆ TaskFn() [12/12]

◆ ~TaskFn()

Member Function Documentation

◆ check_dependencies()

◆ check_dependency() [1/7]

◆ check_dependency() [2/7]

◆ check_dependency() [3/7]

◆ check_dependency() [4/7]

◆ check_dependency() [5/7]

◆ check_dependency() [6/7]

◆ check_dependency() [7/7]

◆ get_func() [1/2]

◆ get_func() [2/2]

◆ get_id()

◆ operator=()

◆ result()

◆ run()

Member Data Documentation

◆ arg1_

◆ arg2_

◆ arg3_

◆ arg4_

◆ arg5_

◆ arg6_

◆ arg7_

◆ arg8_

◆ arg9_

◆ arity

◆ func_

◆ result_