Thrill  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SortNode< ValueType, CompareFunction, SortAlgorithm > Class Template Referencefinal

Detailed Description

template<typename ValueType, typename CompareFunction, typename SortAlgorithm>
class thrill::api::SortNode< ValueType, CompareFunction, SortAlgorithm >

A DIANode which performs a Sort operation.

Sort sorts a DIA according to a given compare function

Template Parameters
ValueTypeType of DIA elements
StackFunction stack, which contains the chained lambdas between the last and this DIANode.
CompareFunctionType of the compare function

Definition at line 56 of file sort.hpp.

+ Inheritance diagram for SortNode< ValueType, CompareFunction, SortAlgorithm >:
+ Collaboration diagram for SortNode< ValueType, CompareFunction, SortAlgorithm >:

#include <sort.hpp>

Classes

class  TreeBuilder
 

Public Member Functions

template<typename ParentDIA >
 SortNode (const ParentDIA &parent, const CompareFunction &compare_function, const SortAlgorithm &sort_algorithm=SortAlgorithm())
 Constructor for a sort node. More...
 
bool EqualSampleGreaterIndex (const SampleIndexPair &a, const SampleIndexPair &b)
 
void FindAndSendSplitters (std::vector< SampleIndexPair > &splitters, size_t sample_size, data::MixStreamPtr &sample_stream, data::MixStream::Writers &sample_writers)
 
bool LessSampleIndex (const SampleIndexPair &a, const SampleIndexPair &b)
 
void MainOp ()
 
void ReceiveItems (data::MixStreamPtr &data_stream)
 
void SortAndWriteToFile (std::vector< ValueType > &vec)
 
void TransmitItems (const ValueType *const tree, size_t k, size_t log_k, size_t actual_k, const SampleIndexPair *const sorted_splitters, size_t prefix_items, data::MixStreamPtr &data_stream)
 
- 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...
 
Contextcontext ()
 Returns the api::Context of this DIABase. More...
 
virtual void DecConsumeCounter (size_t counter)
 
virtual bool ForwardDataOnly () const
 
const size_t & id () const
 return unique id() of DIANode subclass as stored by StatsNode More...
 
virtual void IncConsumeCounter (size_t counter)
 
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)
 
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 void Execute ()=0
 Virtual execution method. Triggers actual computation in sub-classes. More...
 
virtual DIAMemUse PushDataMemUse ()
 Amount of RAM used by PushData() More...
 
virtual void PushData (bool consume)=0
 Virtual method for pushing data. Triggers actual pushing in sub-classes. 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...
 

Static Public Member Functions

template<typename Integral >
static size_t RoundDown (Integral n, Integral k)
 round n down by k where k is a power of two. More...
 

Public Attributes

const bool parent_stack_empty_
 Whether the parent stack is empty. More...
 
SortAlgorithm sort_algorithm_
 Sort function class. More...
 
MainOp and PushData
std::deque< data::Filefiles_
 Local data files. More...
 
size_t local_out_size_ = 0
 Total number of local elements after communication. More...
 
Statistics
Timer timer_preop_
 time spent in PreOp (including preceding Node's computation) More...
 
Timer timer_execute_
 time spent in Execute More...
 
Timer timer_sort_
 time spent in sort() More...
 
- Public Attributes inherited from DIABase
common::JsonLogger logger_
 

Private Types

using RunTimer = common::RunTimer< Timer >
 RIAA class for running the timer. More...
 
using SampleIndexPair = std::pair< ValueType, size_t >
 
using Super = DOpNode< ValueType >
 
using Timer = common::StatsTimerBaseStopped< stats_enabled >
 Timer or FakeTimer. More...
 

Static Private Attributes

static constexpr bool debug = false
 
static constexpr bool stats_enabled = false
 Set this variable to true to enable generation and output of stats. More...
 
static const bool use_background_thread_ = false
 

PreOp Phase

data::File unsorted_file_ { context_.GetFile(this) }
 All local unsorted items before communication. More...
 
data::File::Writer unsorted_writer_
 Writer for unsorted_file_. More...
 
size_t local_items_ = 0
 Number of items on this worker. More...
 
std::vector< SampleIndexPairsamples_
 Sample vector: pairs of (sample,local index) More...
 
common::ReservoirSamplingGrow
< SampleIndexPair
res_sampler_
 Reservoir sampler. More...
 
static constexpr double desired_imbalance_ = 0.1
 epsilon More...
 
size_t wanted_sample_size () const
 calculate currently desired number of samples More...
 

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 >
 
- 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< Childchildren_
 Callback functions from the child nodes. More...
 
- Protected Attributes inherited from DIABase
Contextcontext_
 associated Context More...
 
const size_t 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

using RunTimer = common::RunTimer<Timer>
private

RIAA class for running the timer.

Definition at line 69 of file sort.hpp.

using SampleIndexPair = std::pair<ValueType, size_t>
private

Definition at line 71 of file sort.hpp.

using Super = DOpNode<ValueType>
private

Definition at line 63 of file sort.hpp.

Timer or FakeTimer.

Definition at line 67 of file sort.hpp.

Constructor & Destructor Documentation

SortNode ( const ParentDIA &  parent,
const CompareFunction &  compare_function,
const SortAlgorithm &  sort_algorithm = SortAlgorithm() 
)
inline

Constructor for a sort node.

Definition at line 80 of file sort.hpp.

Member Function Documentation

bool EqualSampleGreaterIndex ( const SampleIndexPair a,
const SampleIndexPair b 
)
inline
void FindAndSendSplitters ( std::vector< SampleIndexPair > &  splitters,
size_t  sample_size,
data::MixStreamPtr sample_stream,
data::MixStream::Writers sample_writers 
)
inline
bool LessSampleIndex ( const SampleIndexPair a,
const SampleIndexPair b 
)
inline
static size_t RoundDown ( Integral  n,
Integral  k 
)
inlinestatic

round n down by k where k is a power of two.

Definition at line 418 of file sort.hpp.

Referenced by SortNode< ValueType, CompareFunction, SortAlgorithm >::TransmitItems().

size_t wanted_sample_size ( ) const
inline

calculate currently desired number of samples

Definition at line 295 of file sort.hpp.

References ReservoirSamplingGrow< Type, RNG >::calc_sample_size(), and SortNode< ValueType, CompareFunction, SortAlgorithm >::res_sampler_.

Member Data Documentation

constexpr bool debug = false
staticprivate

Definition at line 58 of file sort.hpp.

constexpr double desired_imbalance_ = 0.1
static

epsilon

Definition at line 286 of file sort.hpp.

std::deque<data::File> files_

Local data files.

Definition at line 305 of file sort.hpp.

Referenced by SortNode< ValueType, CompareFunction, SortAlgorithm >::SortAndWriteToFile().

size_t local_items_ = 0
size_t local_out_size_ = 0

Total number of local elements after communication.

Definition at line 307 of file sort.hpp.

Referenced by SortNode< ValueType, CompareFunction, SortAlgorithm >::MainOp(), and SortNode< ValueType, CompareFunction, SortAlgorithm >::SortAndWriteToFile().

const bool parent_stack_empty_

Whether the parent stack is empty.

Definition at line 273 of file sort.hpp.

std::vector<SampleIndexPair> samples_

Sample vector: pairs of (sample,local index)

Definition at line 289 of file sort.hpp.

Referenced by SortNode< ValueType, CompareFunction, SortAlgorithm >::MainOp().

SortAlgorithm sort_algorithm_

Sort function class.

Definition at line 83 of file sort.hpp.

Referenced by SortNode< ValueType, CompareFunction, SortAlgorithm >::SortAndWriteToFile().

constexpr bool stats_enabled = false
staticprivate

Set this variable to true to enable generation and output of stats.

Definition at line 61 of file sort.hpp.

Referenced by SortNode< ValueType, CompareFunction, SortAlgorithm >::ReceiveItems().

Timer timer_execute_

time spent in Execute

Definition at line 318 of file sort.hpp.

Referenced by SortNode< ValueType, CompareFunction, SortAlgorithm >::MainOp().

Timer timer_preop_

time spent in PreOp (including preceding Node's computation)

Definition at line 315 of file sort.hpp.

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

All local unsorted items before communication.

Definition at line 279 of file sort.hpp.

Referenced by SortNode< ValueType, CompareFunction, SortAlgorithm >::TransmitItems().

data::File::Writer unsorted_writer_

Writer for unsorted_file_.

Definition at line 281 of file sort.hpp.

const bool use_background_thread_ = false
staticprivate

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