pitrou commented on a change in pull request #11542:
URL: https://github.com/apache/arrow/pull/11542#discussion_r741903488
##########
File path: cpp/src/arrow/util/byte_size.h
##########
@@ -36,18 +36,55 @@ namespace util {
/// only be counted once.
int64_t ARROW_EXPORT TotalBufferSize(const ArrayData& array_data);
/// \brief The sum of bytes in each buffer referenced by the array
-/// Note: The caveats on the ArrayData overload apply here as well
+/// \see TotalBufferSize(const ArrayData& array_data) for details
int64_t ARROW_EXPORT TotalBufferSize(const Array& array);
/// \brief The sum of bytes in each buffer referenced by the array
-/// Note: The caveats on the ArrayData overload apply here as well
+/// \see TotalBufferSize(const ArrayData& array_data) for details
int64_t ARROW_EXPORT TotalBufferSize(const ChunkedArray& chunked_array);
/// \brief The sum of bytes in each buffer referenced by the batch
-/// Note: The caveats on the ArrayData overload apply here as well
+/// \see TotalBufferSize(const ArrayData& array_data) for details
int64_t ARROW_EXPORT TotalBufferSize(const RecordBatch& record_batch);
/// \brief The sum of bytes in each buffer referenced by the table
-/// Note: The caveats on the ArrayData overload apply here as well
+/// \see TotalBufferSize(const ArrayData& array_data) for details
int64_t ARROW_EXPORT TotalBufferSize(const Table& table);
+/// \brief Calculate the buffer ranges referenced by the array
+///
+/// These ranges will take into account array offsets
+///
+/// The ranges may contain duplicates
+///
+/// Dictionary arrays will ignore the offset of their containing array
+///
+/// The return value will be a struct array corresponding to the schema:
+/// schema({field("start", uint64()), field("offset", uint64()),
field("length",
+/// uint64()))
Review comment:
It would have been nice to explain what "start", "offset" and "length"
are.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
