A SuperChunk is a collection of contiguous Chunk objects along with optimized methods for data retrieval and inflation. More...
#include <SuperChunk.h>
Public Member Functions | |
| virtual bool | add_chunk (std::shared_ptr< Chunk > candidate_chunk) |
| Attempts to add a new Chunk to this SuperChunk. More... | |
| virtual void | dump (std::ostream &strm) const |
| Writes the to_string() output to the stream strm. More... | |
| virtual bool | empty () |
| std::vector< std::shared_ptr< Chunk > > | get_chunks () |
| std::shared_ptr< http::url > | get_data_url () |
| virtual unsigned long long | get_offset () const |
| virtual unsigned long long | get_size () const |
| virtual std::string | id () const |
| virtual void | process_child_chunks () |
| Reads the SuperChunk, inflates/de-shuffles the subordinate chunks as required and copies the values into array. More... | |
| virtual void | process_child_chunks_unconstrained () |
| Reads the SuperChunk, inflates/deshuffles the subordinate chunks as required and copies the values into array. More... | |
| virtual void | read () |
| virtual void | read_unconstrained () |
| virtual void | retrieve_data () |
| Cause the SuperChunk and all of it's subordinate Chunks to be read. More... | |
| SuperChunk (const std::string sc_id, DmrppArray *parent=nullptr) | |
| std::string | to_string (bool verbose) const |
| Makes a string representation of the SuperChunk. More... | |
Detailed Description
A SuperChunk is a collection of contiguous Chunk objects along with optimized methods for data retrieval and inflation.
Definition at line 44 of file SuperChunk.h.
Member Function Documentation
◆ add_chunk()
Attempts to add a new Chunk to this SuperChunk.
The candidate_chunk is added to this SuperChunk if: it is contiguous with the end of the this SuperChunk and has the same data_url. Note that if the SuperChunk is empty, candidate_chunk meets those criteria by default.
- Note
- This method was modified to support fill value chunks as part of the work on HYRAX-635. As a stop-gap implementation, each fill value chunk will get its own SuperChunk, even though that is not the most efficient way forward. See HYRAX-713 for a bit more on this. To add FV chunk support, FV chunks can ony be added when d_chunks is empty. Thus, the is_contiguous(...) test must fail if the chunk uses fill values. To make this hack easier to unwind later on, I'm going to make that test right here - so it's obvious. jhrg 5/7/22
- Todo:
- Should candidate_chunk be passed by reference? Maybe calls to this method should use move()? jhrg 5/7/22
- Todo:
- Should this only be called when d_chunks is not empty? jhrg 5/7/22
- Parameters
-
candidate_chunk The Chunk to add.
- Returns
- True when the chunk is added, false otherwise.
Definition at line 425 of file SuperChunk.cc.
◆ dump()
|
virtual |
Writes the to_string() output to the stream strm.
- Parameters
-
strm
Definition at line 696 of file SuperChunk.cc.
◆ process_child_chunks()
|
virtual |
Reads the SuperChunk, inflates/de-shuffles the subordinate chunks as required and copies the values into array.
- Parameters
-
target_array The array into which to write the data.
Definition at line 596 of file SuperChunk.cc.
◆ process_child_chunks_unconstrained()
|
virtual |
Reads the SuperChunk, inflates/deshuffles the subordinate chunks as required and copies the values into array.
- Parameters
-
target_array The array into which to write the data.
Definition at line 634 of file SuperChunk.cc.
◆ retrieve_data()
|
virtual |
Cause the SuperChunk and all of it's subordinate Chunks to be read.
Definition at line 549 of file SuperChunk.cc.
◆ to_string()
| string dmrpp::SuperChunk::to_string | ( | bool | verbose = false | ) | const |
Makes a string representation of the SuperChunk.
- Parameters
-
verbose If set true then details of the subordinate Chunks will be included.
- Returns
- A string representation of the SuperChunk.
Definition at line 675 of file SuperChunk.cc.
The documentation for this class was generated from the following files:
