Detailed Description

template<typename ValueType, typename SumFunction, bool Inclusive>
class thrill::api::PrefixSumNode< ValueType, SumFunction, Inclusive >

Definition at line 28 of file prefix_sum.hpp.

Inheritance diagram for PrefixSumNode< ValueType, SumFunction, Inclusive >:

Collaboration diagram for PrefixSumNode< ValueType, SumFunction, Inclusive >:

#include <prefix_sum.hpp>

Public Member Functions
template<typename ParentDIA >
	PrefixSumNode (const ParentDIA &parent, const char *label, const SumFunction &sum_function, const ValueType &initial_element)

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

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

bool	OnPreOpFile (const data::File &file, size_t) final

void	PreOp (const ValueType &input)
	PreOp: compute local prefixsum and store items. More...

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

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

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

	DOpNode (Context &ctx, const char *label, std::vector< size_t > &&parent_ids, std::vector< DIABasePtr > &&parents)
	Constructor for a DOpNode, which sets references to the parent nodes. 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 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 Types
using	Super = DOpNode< ValueType >

Private Attributes
data::File	file_ { context_.GetFile(this) }
	Local data file. More...

const ValueType	initial_element_
	Initial element. More...

ValueType	local_sum_
	Local sum to be used in all reduce operation. More...

const bool	parent_stack_empty_
	Whether the parent stack is empty. More...

SumFunction	sum_function_
	The sum function which is applied to two elements. More...

data::File::Writer	writer_ { file_.GetWriter() }
	Data writer to local file (only active in PreOp). More...

Static Private Attributes
static constexpr bool	debug = false

Additional Inherited Members
Public Types inherited from DOpNode< 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 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 = DOpNode<ValueType>

private

Definition at line 32 of file prefix_sum.hpp.

Constructor & Destructor Documentation

◆ PrefixSumNode()

PrefixSumNode	(	const ParentDIA &	parent,
		const char *	label,
		const SumFunction &	sum_function,
		const ValueType &	initial_element
	)

inline

Definition at line 37 of file prefix_sum.hpp.

References PrefixSumNode< ValueType, SumFunction, Inclusive >::initial_element_, PrefixSumNode< ValueType, SumFunction, Inclusive >::local_sum_, PrefixSumNode< ValueType, SumFunction, Inclusive >::parent_stack_empty_, PrefixSumNode< ValueType, SumFunction, Inclusive >::PreOp(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::sum_function_.

Member Function Documentation

◆ Dispose()

void Dispose ( )

inlinefinalvirtual

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

Reimplemented from DIABase.

Definition at line 112 of file prefix_sum.hpp.

References File::Clear(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::file_.

◆ Execute()

void Execute ( )

inlinefinalvirtual

Executes the prefixsum operation.

Implements DIABase.

Definition at line 85 of file prefix_sum.hpp.

References DIABase::context_, FlowControlChannel::ExPrefixSum(), PrefixSumNode< ValueType, SumFunction, Inclusive >::initial_element_, PrefixSumNode< ValueType, SumFunction, Inclusive >::local_sum_, LOG, Context::net, and PrefixSumNode< ValueType, SumFunction, Inclusive >::sum_function_.

◆ OnPreOpFile()

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

inlinefinalvirtual

Virtual method for receiving a whole data::File of ValueType from parent. Returns true if the file was accepted (requires that the child's function stack is empty and that it can accept whole data::Files).

Reimplemented from DIABase.

Definition at line 62 of file prefix_sum.hpp.

References File::Copy(), PrefixSumNode< ValueType, SumFunction, Inclusive >::file_, thrill::common::g_debug_push_file, File::GetKeepReader(), PrefixSumNode< ValueType, SumFunction, Inclusive >::local_sum_, LOGC, PrefixSumNode< ValueType, SumFunction, Inclusive >::parent_stack_empty_, and PrefixSumNode< ValueType, SumFunction, Inclusive >::sum_function_.

◆ PreOp()

void PreOp ( const ValueType & input )

inline

PreOp: compute local prefixsum and store items.

Definition at line 56 of file prefix_sum.hpp.

References PrefixSumNode< ValueType, SumFunction, Inclusive >::local_sum_, LOG, BlockWriter< BlockSink >::Put(), PrefixSumNode< ValueType, SumFunction, Inclusive >::sum_function_, and PrefixSumNode< ValueType, SumFunction, Inclusive >::writer_.

Referenced by PrefixSumNode< ValueType, SumFunction, Inclusive >::PrefixSumNode().

◆ PushData()

void PushData ( bool consume )

inlinefinalvirtual

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

Implements DIABase.

Definition at line 92 of file prefix_sum.hpp.

References PrefixSumNode< ValueType, SumFunction, Inclusive >::file_, File::GetReader(), PrefixSumNode< ValueType, SumFunction, Inclusive >::local_sum_, BlockReader< BlockSource >::Next(), File::num_items(), DIANode< ValueType >::PushItem(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::sum_function_.

◆ StopPreOp()

void StopPreOp ( size_t )

inlinefinalvirtual

Virtual method for preparing end of PushData.

Reimplemented from DIABase.

Definition at line 80 of file prefix_sum.hpp.

References BlockWriter< BlockSink >::Close(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::writer_.

Member Data Documentation

◆ debug

constexpr bool debug = false

staticprivate

Definition at line 30 of file prefix_sum.hpp.

◆ file_

data::File file_ { context_.GetFile(this) }

private

Local data file.

Definition at line 127 of file prefix_sum.hpp.

Referenced by PrefixSumNode< ValueType, SumFunction, Inclusive >::Dispose(), PrefixSumNode< ValueType, SumFunction, Inclusive >::OnPreOpFile(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::PushData().

◆ initial_element_

const ValueType initial_element_

private

Initial element.

Definition at line 122 of file prefix_sum.hpp.

Referenced by PrefixSumNode< ValueType, SumFunction, Inclusive >::Execute(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::PrefixSumNode().

◆ local_sum_

ValueType local_sum_

private

Local sum to be used in all reduce operation.

Definition at line 120 of file prefix_sum.hpp.

Referenced by PrefixSumNode< ValueType, SumFunction, Inclusive >::Execute(), PrefixSumNode< ValueType, SumFunction, Inclusive >::OnPreOpFile(), PrefixSumNode< ValueType, SumFunction, Inclusive >::PrefixSumNode(), PrefixSumNode< ValueType, SumFunction, Inclusive >::PreOp(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::PushData().

◆ parent_stack_empty_

const bool parent_stack_empty_

private

Whether the parent stack is empty.

Definition at line 124 of file prefix_sum.hpp.

Referenced by PrefixSumNode< ValueType, SumFunction, Inclusive >::OnPreOpFile(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::PrefixSumNode().

◆ sum_function_

SumFunction sum_function_

private

The sum function which is applied to two elements.

Definition at line 118 of file prefix_sum.hpp.

Referenced by PrefixSumNode< ValueType, SumFunction, Inclusive >::Execute(), PrefixSumNode< ValueType, SumFunction, Inclusive >::OnPreOpFile(), PrefixSumNode< ValueType, SumFunction, Inclusive >::PrefixSumNode(), PrefixSumNode< ValueType, SumFunction, Inclusive >::PreOp(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::PushData().

◆ writer_

data::File::Writer writer_ { file_.GetWriter() }

private

Data writer to local file (only active in PreOp).

Definition at line 129 of file prefix_sum.hpp.

Referenced by PrefixSumNode< ValueType, SumFunction, Inclusive >::PreOp(), and PrefixSumNode< ValueType, SumFunction, Inclusive >::StopPreOp().

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

thrill/api/prefix_sum.hpp

Detailed Description

template<typename ValueType, typename SumFunction, bool Inclusive> class thrill::api::PrefixSumNode< ValueType, SumFunction, Inclusive >

Public Member Functions

Private Types

Private Attributes

Static Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ Super

Constructor & Destructor Documentation

◆ PrefixSumNode()

Member Function Documentation

◆ Dispose()

◆ Execute()

◆ OnPreOpFile()

◆ PreOp()

◆ PushData()

◆ StopPreOp()

Member Data Documentation

◆ debug

◆ file_

◆ initial_element_

◆ local_sum_

◆ parent_stack_empty_

◆ sum_function_

◆ writer_

template<typename ValueType, typename SumFunction, bool Inclusive>
class thrill::api::PrefixSumNode< ValueType, SumFunction, Inclusive >