Detailed Description

template<typename ValueType>
class thrill::api::DistributeNode< ValueType >

Definition at line 33 of file distribute.hpp.

Inheritance diagram for DistributeNode< ValueType >:

Collaboration diagram for DistributeNode< ValueType >:

#include <distribute.hpp>

Public Types
using	Super = SourceNode< ValueType >

Public Types inherited from SourceNode< ValueType >
using	Super = DIANode< ValueType >

Public Types inherited from DIANode< ValueType >
using	Callback = tlx::delegate< void(const ValueType &)>

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

Public Member Functions
	DistributeNode (Context &ctx, const std::vector< ValueType > &in_vector, size_t source_id)

	DistributeNode (Context &ctx, std::vector< ValueType > &&in_vector, size_t source_id)

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

void	Execute () final
	Executes the scatter operation: source sends out its data. More...

void	PushData (bool consume) final
	Virtual method for pushing data. Triggers actual pushing in sub-classes. More...

Public Member Functions inherited from SourceNode< ValueType >
	SourceNode (Context &ctx, const char *label)

void	Execute () override
	SourceNodes generally do not Execute, they only PushData. More...

Public Member Functions inherited from DIANode< ValueType >
	DIANode (Context &ctx, const char *label, const std::initializer_list< size_t > &parent_ids, const std::initializer_list< DIABasePtr > &parents)
	Constructor for a DIANode, which sets references to the parent nodes. More...

	DIANode (Context &ctx, const char *label, std::vector< size_t > &&parent_ids, std::vector< DIABasePtr > &&parents)
	Constructor for a DIANode, which sets references to the parent nodes. More...

virtual void	AddChild (DIABase *node, const Callback &callback=Callback(), size_t parent_index=0)
	Enables children to push their "folded" function chains to their parent. More...

std::vector< DIABase * >	children () const override
	Returns the children of this DIABase. More...

void	PushFile (data::File &file, bool consume) const

void	PushItem (const ValueType &item) const
	Method for derived classes to Push a single item to all children. More...

void	RemoveAllChildren () override

void	RemoveChild (DIABase *node) override

void	RunPushData () override

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

virtual void	DecConsumeCounter (size_t counter)

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

virtual bool	ForwardDataOnly () const

virtual void	IncConsumeCounter (size_t counter)

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)

virtual void	SetConsumeCounter (size_t counter)

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

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 Attributes
std::vector< ValueType >	in_vector_
	Vector pointer to read elements from. More...

size_t	source_id_
	source worker id, which sends vector More...

data::CatStreamPtr	stream_ { context_.GetNewCatStream(this) }

Additional Inherited Members
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 DIANode< ValueType >
std::vector< Child >	children_
	Callback functions from the child nodes. 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 = SourceNode<ValueType>

Definition at line 36 of file distribute.hpp.

Constructor & Destructor Documentation

◆ DistributeNode() [1/2]

DistributeNode	(	Context &	ctx,
		const std::vector< ValueType > &	in_vector,
		size_t	source_id
	)

inline

Definition at line 39 of file distribute.hpp.

◆ DistributeNode() [2/2]

DistributeNode	(	Context &	ctx,
		std::vector< ValueType > &&	in_vector,
		size_t	source_id
	)

inline

Definition at line 47 of file distribute.hpp.

Member Function Documentation

◆ Dispose()

void Dispose ( )

inlinefinalvirtual

Virtual clear method. Triggers actual disposing in sub-classes.

Reimplemented from DIABase.

Definition at line 84 of file distribute.hpp.

References DistributeNode< ValueType >::in_vector_, CountingPtr< Type, Deleter >::reset(), DistributeNode< ValueType >::stream_, and tlx::vector_free().

◆ Execute()

void Execute ( )

inlinefinalvirtual

Executes the scatter operation: source sends out its data.

Implements DIABase.

Definition at line 56 of file distribute.hpp.

References Range::begin, thrill::common::CalculateLocalRange(), DIABase::context_, Range::end, DistributeNode< ValueType >::in_vector_, Context::my_rank(), DistributeNode< ValueType >::source_id_, and DistributeNode< ValueType >::stream_.

◆ PushData()

void PushData ( bool consume )

inlinefinalvirtual

Virtual method for pushing data. Triggers actual pushing in sub-classes.

Implements DIABase.

Definition at line 76 of file distribute.hpp.

References BlockReader< BlockSource >::HasNext(), BlockReader< BlockSource >::Next(), DIANode< ValueType >::PushItem(), and DistributeNode< ValueType >::stream_.

Member Data Documentation

◆ in_vector_

std::vector<ValueType> in_vector_

private

Vector pointer to read elements from.

Definition at line 91 of file distribute.hpp.

Referenced by DistributeNode< ValueType >::Dispose(), and DistributeNode< ValueType >::Execute().

◆ source_id_

size_t source_id_

private

source worker id, which sends vector

Definition at line 93 of file distribute.hpp.

Referenced by DistributeNode< ValueType >::Execute().

◆ stream_

data::CatStreamPtr stream_ { context_.GetNewCatStream(this) }

private

Definition at line 95 of file distribute.hpp.

Referenced by DistributeNode< ValueType >::Dispose(), DistributeNode< ValueType >::Execute(), and DistributeNode< ValueType >::PushData().

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

thrill/api/distribute.hpp

Detailed Description

template<typename ValueType> class thrill::api::DistributeNode< ValueType >

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ Super

Constructor & Destructor Documentation

◆ DistributeNode() [1/2]

◆ DistributeNode() [2/2]

Member Function Documentation

◆ Dispose()

◆ Execute()

◆ PushData()

Member Data Documentation

◆ in_vector_

◆ source_id_

◆ stream_

template<typename ValueType>
class thrill::api::DistributeNode< ValueType >