Skip to content

MINOR: [C++] Add missing docstrings for ChunkedArray methods #11902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Jedi18 wants to merge 1 commit into from
Closed

MINOR: [C++] Add missing docstrings for ChunkedArray methods #11902

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cpp/src/arrow/chunked_array.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,13 @@ class ARROW_EXPORT ChunkedArray {
/// \return the total number of nulls among all chunks
int64_t null_count() const { return null_count_; }

/// \return the total number of chunks in the chunked array
int num_chunks() const { return static_cast<int>(chunks_.size()); }

/// \return chunk a particular chunk from the chunked array
std::shared_ptr<Array> chunk(int i) const { return chunks_[i]; }

/// \return an ArrayVector of chunks
const ArrayVector& chunks() const { return chunks_; }

/// \brief Construct a zero-copy slice of the chunked array with the
Expand Down Expand Up @@ -139,6 +141,7 @@ class ARROW_EXPORT ChunkedArray {
/// there are zero chunks
Result<std::shared_ptr<ChunkedArray>> View(const std::shared_ptr<DataType>& type) const;

/// \brief Return the type of the chunked array
const std::shared_ptr<DataType>& type() const { return type_; }

/// \brief Return a Scalar containing the value of this array at index
Expand Down