Detailed Description

template<typename ValueType, typename ReduceFunction>
class thrill::api::AllReduceNode< ValueType, ReduceFunction >

Definition at line 28 of file all_reduce.hpp.

Inheritance diagram for AllReduceNode< ValueType, ReduceFunction >:

Collaboration diagram for AllReduceNode< ValueType, ReduceFunction >:

#include <all_reduce.hpp>

Public Member Functions
template<typename ParentDIA >
	AllReduceNode (const ParentDIA &parent, const char *label, const ValueType &initial_value=ValueType(), bool with_initial_value=false, const ReduceFunction &reduce_function=ReduceFunction())

void	Execute () final
	Executes the sum operation. More...

void	PreOp (const ValueType &input)

const ValueType &	result () const final
	Returns result of global sum. More...

Public Member Functions inherited from ActionResultNode< ValueType >
	ActionResultNode (Context &ctx, const char *label, const std::initializer_list< size_t > &parent_ids, const std::initializer_list< DIABasePtr > &parents)

Public Member Functions inherited from ActionNode
	ActionNode (Context &ctx, const char *label, const std::initializer_list< size_t > &parent_ids, const std::initializer_list< DIABasePtr > &parents)

std::vector< DIABase * >	children () const final
	ActionNodes do not have children. More...

void	DecConsumeCounter (size_t) final

void	IncConsumeCounter (size_t) final

void	PushData (bool) final
	ActionNodes do not push data, they only Execute. More...

void	RemoveAllChildren () final
	ActionNodes do not have children. More...

void	RemoveChild (DIABase *) final
	ActionNodes do not have children. More...

void	RunPushData () final
	ActionNodes do not push data, they only Execute. More...

void	SetConsumeCounter (size_t) final

Public Member Functions inherited from DIABase
	DIABase (Context &ctx, const char *label, const std::initializer_list< size_t > &parent_ids, const std::initializer_list< DIABasePtr > &parents)
	The constructor for a DIABase. More...

	DIABase (Context &ctx, const char *label, std::vector< size_t > &&parent_ids, std::vector< DIABasePtr > &&parents)
	The constructor for a DIABase. More...

	DIABase (const DIABase &)=delete
	non-copyable: delete copy-constructor More...

	DIABase (DIABase &&)=default
	move-constructor: default More...

virtual	~DIABase ()
	Virtual destructor for a DIABase. More...

virtual size_t	consume_counter () const
	Returns consume_counter_. More...

Context &	context ()
	Returns the api::Context of this DIABase. More...

const size_t &	dia_id () const
	return unique id of DIANode subclass as stored by StatsNode More...

virtual bool	ForwardDataOnly () const

const char *	label () const
	return label() of DIANode subclass as stored by StatsNode More...

mem::Manager &	mem_manager ()
	Return the Context's memory manager. More...

DIABase &	operator= (const DIABase &)=delete
	non-copyable: delete assignment operator More...

DIABase &	operator= (DIABase &&)=default
	move-assignment operator: default More...

std::vector< size_t >	parent_ids () const
	Returns the parents of this DIABase. More...

const std::vector< DIABasePtr > &	parents () const
	Returns the parents of this DIABase. More...

void	RemoveParent (DIABase *p)
	Remove a parent. More...

virtual bool	RequireParentPushData (size_t) const

void	RunScope ()

void	set_mem_limit (const DIAMemUse &mem_limit)

void	set_state (const DIAState &state)

DIAState	state () const

virtual DIAMemUse	PreOpMemUse ()
	Amount of RAM used by PreOp after StartPreOp() More...

virtual void	StartPreOp (size_t)
	Virtual method for preparing start of PushData. More...

virtual bool	OnPreOpFile (const data::File &, size_t)

virtual void	StopPreOp (size_t)
	Virtual method for preparing end of PushData. More...

virtual DIAMemUse	ExecuteMemUse ()
	Amount of RAM used by Execute() More...

virtual DIAMemUse	PushDataMemUse ()
	Amount of RAM used by PushData() More...

virtual void	Dispose ()
	Virtual clear method. Triggers actual disposing in sub-classes. More...

Public Member Functions inherited from ReferenceCounter
	ReferenceCounter () noexcept
	new objects have zero reference count More...

	ReferenceCounter (const ReferenceCounter &) noexcept
	coping still creates a new object with zero reference count More...

	~ReferenceCounter ()

bool	dec_reference () const noexcept
	Call whenever resetting (i.e. More...

void	inc_reference () const noexcept
	Call whenever setting a pointer to the object. More...

ReferenceCounter &	operator= (const ReferenceCounter &) noexcept
	assignment operator, leaves pointers unchanged More...

size_t	reference_count () const noexcept
	Return the number of references to this object (for debugging) More...

bool	unique () const noexcept
	Test if the ReferenceCounter is referenced by only one CountingPtr. More...

Private Types
using	Super = ActionResultNode< ValueType >

Private Attributes
bool	first_

ReduceFunction	reduce_function_
	The sum function which is applied to two values. More...

ValueType	sum_
	Local/global sum to be used in all reduce operation. More...

Static Private Attributes
static constexpr bool	debug = false

Additional Inherited Members
Public Types inherited from DIABase
using	DIABasePtr = tlx::CountingPtr< DIABase >

Public Attributes inherited from DIABase
common::JsonLogger	logger_

Static Public Attributes inherited from DIABase
static constexpr size_t	kNeverConsume = static_cast<size_t>(-1)
	Never full consume. More...

Protected Attributes inherited from DIABase
Context &	context_
	associated Context More...

const size_t	dia_id_
	DIA serial id. More...

const char *const	label_
	DOp node static label. More...

DIAState	state_ = DIAState::NEW
	State of the DIANode. State is NEW on creation. More...

std::vector< DIABasePtr >	parents_
	Parents of this DIABase. More...

DIAMemUse	mem_limit_ = 0

size_t	consume_counter_ = 1

Member Typedef Documentation

◆ Super

using Super = ActionResultNode<ValueType>

private

Definition at line 32 of file all_reduce.hpp.

Constructor & Destructor Documentation

◆ AllReduceNode()

AllReduceNode	(	const ParentDIA &	parent,
		const char *	label,
		const ValueType &	initial_value = `ValueType()`,
		bool	with_initial_value = `false`,
		const ReduceFunction &	reduce_function = `ReduceFunction()`
	)

inline

Definition at line 37 of file all_reduce.hpp.

References AllReduceNode< ValueType, ReduceFunction >::first_, AllReduceNode< ValueType, ReduceFunction >::PreOp(), AllReduceNode< ValueType, ReduceFunction >::reduce_function_, and AllReduceNode< ValueType, ReduceFunction >::sum_.

Member Function Documentation

◆ Execute()

void Execute ( )

inlinefinalvirtual

Executes the sum operation.

Implements DIABase.

Definition at line 67 of file all_reduce.hpp.

References FlowControlChannel::AllReduce(), DIABase::context_, Context::net, AllReduceNode< ValueType, ReduceFunction >::reduce_function_, and AllReduceNode< ValueType, ReduceFunction >::sum_.

◆ PreOp()

void PreOp ( const ValueType & input )

inline

Definition at line 56 of file all_reduce.hpp.

References AllReduceNode< ValueType, ReduceFunction >::first_, AllReduceNode< ValueType, ReduceFunction >::reduce_function_, AllReduceNode< ValueType, ReduceFunction >::sum_, and TLX_UNLIKELY.

Referenced by AllReduceNode< ValueType, ReduceFunction >::AllReduceNode().

◆ result()

const ValueType& result ( ) const

inlinefinalvirtual

Returns result of global sum.

Implements ActionResultNode< ValueType >.

Definition at line 73 of file all_reduce.hpp.

References AllReduceNode< ValueType, ReduceFunction >::sum_.

Member Data Documentation

◆ debug

constexpr bool debug = false

staticprivate

Definition at line 30 of file all_reduce.hpp.

◆ first_

bool first_

private

indicate that sum_ is the default constructed first value. Worker 0's value is already set to initial_value.

Definition at line 84 of file all_reduce.hpp.

Referenced by AllReduceNode< ValueType, ReduceFunction >::AllReduceNode(), and AllReduceNode< ValueType, ReduceFunction >::PreOp().

◆ reduce_function_

ReduceFunction reduce_function_

private

The sum function which is applied to two values.

Definition at line 79 of file all_reduce.hpp.

Referenced by AllReduceNode< ValueType, ReduceFunction >::AllReduceNode(), AllReduceNode< ValueType, ReduceFunction >::Execute(), and AllReduceNode< ValueType, ReduceFunction >::PreOp().

◆ sum_

ValueType sum_

private

Local/global sum to be used in all reduce operation.

Definition at line 81 of file all_reduce.hpp.

Referenced by AllReduceNode< ValueType, ReduceFunction >::AllReduceNode(), AllReduceNode< ValueType, ReduceFunction >::Execute(), AllReduceNode< ValueType, ReduceFunction >::PreOp(), and AllReduceNode< ValueType, ReduceFunction >::result().

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

thrill/api/all_reduce.hpp

Detailed Description

template<typename ValueType, typename ReduceFunction> class thrill::api::AllReduceNode< ValueType, ReduceFunction >

Public Member Functions

Private Types

Private Attributes

Static Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ Super

Constructor & Destructor Documentation

◆ AllReduceNode()

Member Function Documentation

◆ Execute()

◆ PreOp()

◆ result()

Member Data Documentation

◆ debug

◆ first_

◆ reduce_function_

◆ sum_

template<typename ValueType, typename ReduceFunction>
class thrill::api::AllReduceNode< ValueType, ReduceFunction >