Detailed Description

template<typename ValueType, typename ZipFunction>
class thrill::api::ZipWithIndexNode< ValueType, ZipFunction >

A DIANode which calculates the array index for each items and performs a Zip-like operation without extra rebalancing of the DIA data.

This DIANode supports only one parent, if more than one inputs must be zipped, use the general Zip() with a Generate() DIA.

Definition at line 38 of file zip_with_index.hpp.

Inheritance diagram for ZipWithIndexNode< ValueType, ZipFunction >:

Collaboration diagram for ZipWithIndexNode< ValueType, ZipFunction >:

#include <zip_with_index.hpp>

Public Member Functions
template<typename ParentDIA >
	ZipWithIndexNode (const ZipFunction &zip_function, const ParentDIA &parent)
	Constructor for a ZipNode. More...

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

void	Execute () final
	Virtual execution method. Triggers actual computation in sub-classes. More...

bool	OnPreOpFile (const data::File &file, size_t) final
	Receive a whole data::File of ValueType, but only if our stack is empty. 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	InputType = typename common::FunctionTraits< ZipFunction >::template arg_plain< 0 >

using	Super = DOpNode< ValueType >

Private Attributes
data::File	file_ { context_.GetFile(this) }
	File for intermediate storage. More...

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

data::File::Writer	writer_ { file_.GetWriter() }
	Writer to intermediate file. More...

ZipFunction	zip_function_
	Zip function. More...

Variables for Calculating Global Index
size_t	dia_local_rank_
	exclusive prefix sum over the number of items in workers 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

◆ InputType

using InputType = typename common::FunctionTraits<ZipFunction>::template arg_plain<0>

private

Definition at line 46 of file zip_with_index.hpp.

◆ Super

using Super = DOpNode<ValueType>

private

Definition at line 42 of file zip_with_index.hpp.

Constructor & Destructor Documentation

◆ ZipWithIndexNode()

ZipWithIndexNode	(	const ZipFunction &	zip_function,
		const ParentDIA &	parent
	)

inline

Constructor for a ZipNode.

Definition at line 53 of file zip_with_index.hpp.

References ZipWithIndexNode< ValueType, ZipFunction >::parent_stack_empty_, BlockWriter< BlockSink >::Put(), ZipWithIndexNode< ValueType, ZipFunction >::writer_, and ZipWithIndexNode< ValueType, ZipFunction >::zip_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 zip_with_index.hpp.

References File::Clear(), and ZipWithIndexNode< ValueType, ZipFunction >::file_.

◆ Execute()

void Execute ( )

inlinefinalvirtual

Virtual execution method. Triggers actual computation in sub-classes.

number of elements of this worker

Implements DIABase.

Definition at line 86 of file zip_with_index.hpp.

References DIABase::context_, ZipWithIndexNode< ValueType, ZipFunction >::dia_local_rank_, FlowControlChannel::ExPrefixSum(), ZipWithIndexNode< ValueType, ZipFunction >::file_, Context::net, File::num_items(), and sLOG.

◆ OnPreOpFile()

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

inlinefinalvirtual

Receive a whole data::File of ValueType, but only if our stack is empty.

Reimplemented from DIABase.

Definition at line 69 of file zip_with_index.hpp.

References File::Copy(), ZipWithIndexNode< ValueType, ZipFunction >::file_, thrill::common::g_debug_push_file, LOGC, File::num_items(), and ZipWithIndexNode< ValueType, ZipFunction >::parent_stack_empty_.

◆ PushData()

void PushData ( bool consume )

inlinefinalvirtual

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

Implements DIABase.

Definition at line 95 of file zip_with_index.hpp.

References DIABase::context_, ZipWithIndexNode< ValueType, ZipFunction >::dia_local_rank_, ZipWithIndexNode< ValueType, ZipFunction >::file_, File::GetReader(), BlockReader< BlockSource >::HasNext(), File::num_items(), Context::PrintCollectiveMeanStdev(), DIANode< ValueType >::PushItem(), and ZipWithIndexNode< ValueType, ZipFunction >::zip_function_.

◆ StopPreOp()

void StopPreOp ( size_t )

inlinefinalvirtual

Virtual method for preparing end of PushData.

Reimplemented from DIABase.

Definition at line 82 of file zip_with_index.hpp.

References BlockWriter< BlockSink >::Close(), and ZipWithIndexNode< ValueType, ZipFunction >::writer_.

Member Data Documentation

◆ debug

constexpr bool debug = false

staticprivate

Definition at line 40 of file zip_with_index.hpp.

◆ dia_local_rank_

size_t dia_local_rank_

private

exclusive prefix sum over the number of items in workers

Definition at line 133 of file zip_with_index.hpp.

Referenced by ZipWithIndexNode< ValueType, ZipFunction >::Execute(), and ZipWithIndexNode< ValueType, ZipFunction >::PushData().

◆ file_

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

private

File for intermediate storage.

Definition at line 124 of file zip_with_index.hpp.

Referenced by ZipWithIndexNode< ValueType, ZipFunction >::Dispose(), ZipWithIndexNode< ValueType, ZipFunction >::Execute(), ZipWithIndexNode< ValueType, ZipFunction >::OnPreOpFile(), and ZipWithIndexNode< ValueType, ZipFunction >::PushData().

◆ parent_stack_empty_

const bool parent_stack_empty_

private

Whether the parent stack is empty.

Definition at line 121 of file zip_with_index.hpp.

Referenced by ZipWithIndexNode< ValueType, ZipFunction >::OnPreOpFile(), and ZipWithIndexNode< ValueType, ZipFunction >::ZipWithIndexNode().

◆ writer_

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

private

Writer to intermediate file.

Definition at line 127 of file zip_with_index.hpp.

Referenced by ZipWithIndexNode< ValueType, ZipFunction >::StopPreOp(), and ZipWithIndexNode< ValueType, ZipFunction >::ZipWithIndexNode().

◆ zip_function_

ZipFunction zip_function_

private

Zip function.

Definition at line 118 of file zip_with_index.hpp.

Referenced by ZipWithIndexNode< ValueType, ZipFunction >::PushData(), and ZipWithIndexNode< ValueType, ZipFunction >::ZipWithIndexNode().

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

thrill/api/zip_with_index.hpp

Detailed Description

template<typename ValueType, typename ZipFunction> class thrill::api::ZipWithIndexNode< ValueType, ZipFunction >

Public Member Functions

Private Types

Private Attributes

Static Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ InputType

◆ Super

Constructor & Destructor Documentation

◆ ZipWithIndexNode()

Member Function Documentation

◆ Dispose()

◆ Execute()

◆ OnPreOpFile()

◆ PushData()

◆ StopPreOp()

Member Data Documentation

◆ debug

◆ dia_local_rank_

◆ file_

◆ parent_stack_empty_

◆ writer_

◆ zip_function_

template<typename ValueType, typename ZipFunction>
class thrill::api::ZipWithIndexNode< ValueType, ZipFunction >