Thrill  0.1
GatherNode< ValueType > Class Template Referencefinal

Detailed Description

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

Definition at line 28 of file gather.hpp.

+ Inheritance diagram for GatherNode< ValueType >:
+ Collaboration diagram for GatherNode< ValueType >:

#include <gather.hpp>

Public Types

using Super = ActionResultNode< std::vector< ValueType > >
 
- Public Types inherited from DIABase
using DIABasePtr = tlx::CountingPtr< DIABase >
 

Public Member Functions

template<typename ParentDIA >
 GatherNode (const ParentDIA &parent, const char *label, size_t target_id, std::vector< ValueType > *out_vector)
 
void Execute () final
 Virtual execution method. Triggers actual computation in sub-classes. More...
 
const std::vector< ValueType > & result () const final
 virtual method to return result via an ActionFuture More...
 
void StartPreOp (size_t) final
 Virtual method for preparing start of PushData. More...
 
void StopPreOp (size_t) final
 Virtual method for preparing end of PushData. More...
 
- Public Member Functions inherited from ActionResultNode< std::vector< 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...
 
Contextcontext ()
 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::Managermem_manager ()
 Return the Context's memory manager. More...
 
DIABaseoperator= (const DIABase &)=delete
 non-copyable: delete assignment operator More...
 
DIABaseoperator= (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 bool OnPreOpFile (const data::File &, size_t)
 
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...
 
ReferenceCounteroperator= (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

data::CatStream::Writers emitters_
 
std::vector< ValueType > * out_vector_
 Vector pointer to write elements to. More...
 
data::CatStreamPtr stream_ { context_.GetNewCatStream(this) }
 
size_t target_id_
 

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 DIABase
Contextcontext_
 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< DIABasePtrparents_
 Parents of this DIABase. More...
 
DIAMemUse mem_limit_ = 0
 
size_t consume_counter_ = 1
 

Member Typedef Documentation

◆ Super

using Super = ActionResultNode<std::vector<ValueType> >

Definition at line 31 of file gather.hpp.

Constructor & Destructor Documentation

◆ GatherNode()

GatherNode ( const ParentDIA &  parent,
const char *  label,
size_t  target_id,
std::vector< ValueType > *  out_vector 
)
inline

Member Function Documentation

◆ Execute()

void Execute ( )
inlinefinalvirtual

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

Implements DIABase.

Definition at line 68 of file gather.hpp.

References GatherNode< ValueType >::out_vector_, and GatherNode< ValueType >::stream_.

◆ result()

const std::vector<ValueType>& result ( ) const
inlinefinalvirtual

virtual method to return result via an ActionFuture

Implements ActionResultNode< std::vector< ValueType > >.

Definition at line 76 of file gather.hpp.

References GatherNode< ValueType >::out_vector_.

◆ StartPreOp()

void StartPreOp ( size_t  )
inlinefinalvirtual

Virtual method for preparing start of PushData.

Reimplemented from DIABase.

Definition at line 54 of file gather.hpp.

References GatherNode< ValueType >::emitters_, GatherNode< ValueType >::stream_, and GatherNode< ValueType >::target_id_.

◆ StopPreOp()

void StopPreOp ( size_t  )
inlinefinalvirtual

Virtual method for preparing end of PushData.

Reimplemented from DIABase.

Definition at line 64 of file gather.hpp.

References GatherNode< ValueType >::emitters_, and GatherNode< ValueType >::target_id_.

Member Data Documentation

◆ emitters_

◆ out_vector_

std::vector<ValueType>* out_vector_
private

Vector pointer to write elements to.

Definition at line 85 of file gather.hpp.

Referenced by GatherNode< ValueType >::Execute(), GatherNode< ValueType >::GatherNode(), and GatherNode< ValueType >::result().

◆ stream_

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

◆ target_id_

size_t target_id_
private

target worker id, which collects vector, all other workers do not get the data.

Definition at line 83 of file gather.hpp.

Referenced by GatherNode< ValueType >::GatherNode(), GatherNode< ValueType >::StartPreOp(), and GatherNode< ValueType >::StopPreOp().


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