Detailed Description
template<typename ValueType>
class thrill::api::CacheNode< ValueType >
A DOpNode which caches all items in an external file.
Inheritance diagram for CacheNode< ValueType >: Collaboration diagram for CacheNode< ValueType >:#include <cache.hpp>
Public Types | |
| 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 | |
| template<typename ParentDIA > | |
| CacheNode (const ParentDIA &parent) | |
| Constructor for a LOpNode. 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... | |
| size_t | NumItems () const |
| bool | OnPreOpFile (const data::File &file, size_t) final |
| 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 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 Attributes | |
| data::File | file_ { context_.GetFile(this) } |
| Local data file. More... | |
| const bool | parent_stack_empty_ |
| Whether the parent stack is empty. More... | |
| data::File::Writer | writer_ { file_.GetWriter() } |
| Data writer to local file (only active in PreOp). More... | |
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
Constructor & Destructor Documentation
◆ CacheNode()
|
inlineexplicit |
Constructor for a LOpNode.
Sets the Context, parents and stack.
Definition at line 42 of file cache.hpp.
References CacheNode< ValueType >::parent_stack_empty_, BlockWriter< BlockSink >::Put(), and CacheNode< ValueType >::writer_.
Member Function Documentation
◆ Dispose()
|
inlinefinalvirtual |
Virtual clear method. Triggers actual disposing in sub-classes.
Reimplemented from DIABase.
Definition at line 75 of file cache.hpp.
References File::Clear(), and CacheNode< ValueType >::file_.
◆ Execute()
|
inlinefinalvirtual |
◆ NumItems()
|
inline |
Definition at line 79 of file cache.hpp.
References CacheNode< ValueType >::file_, and File::num_items().
◆ OnPreOpFile()
|
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 52 of file cache.hpp.
References File::Copy(), CacheNode< ValueType >::file_, thrill::common::g_debug_push_file, LOGC, File::num_items(), and CacheNode< ValueType >::parent_stack_empty_.
◆ PushData()
|
inlinefinalvirtual |
Virtual method for pushing data. Triggers actual pushing in sub-classes.
Implements DIABase.
Definition at line 71 of file cache.hpp.
References CacheNode< ValueType >::file_, and DIANode< ValueType >::PushFile().
◆ StopPreOp()
|
inlinefinalvirtual |
Virtual method for preparing end of PushData.
Reimplemented from DIABase.
Definition at line 64 of file cache.hpp.
References BlockWriter< BlockSink >::Close(), and CacheNode< ValueType >::writer_.
Member Data Documentation
◆ file_
|
private |
Local data file.
Definition at line 85 of file cache.hpp.
Referenced by CacheNode< ValueType >::Dispose(), CacheNode< ValueType >::NumItems(), CacheNode< ValueType >::OnPreOpFile(), and CacheNode< ValueType >::PushData().
◆ parent_stack_empty_
|
private |
Whether the parent stack is empty.
Definition at line 89 of file cache.hpp.
Referenced by CacheNode< ValueType >::CacheNode(), and CacheNode< ValueType >::OnPreOpFile().
◆ writer_
|
private |
Data writer to local file (only active in PreOp).
Definition at line 87 of file cache.hpp.
Referenced by CacheNode< ValueType >::CacheNode(), and CacheNode< ValueType >::StopPreOp().
The documentation for this class was generated from the following file:
- thrill/api/cache.hpp
