Skip to content

Conversation

@andishgar
Copy link
Contributor

@andishgar andishgar commented May 16, 2025

Rationale for this change

as mentiond here, The document should be clarified that arrow::ArrayStatistics is not inlcuded in the arrow::Array comparasion

What changes are included in this PR?

Add documets for arrow::Array::Equals, arrow::Array::ApproxEquals, arrow::Array::EqualsRange, arrow::ArrayEquals, arrow::ArrayApproxEquals, arrow::ArrayRangeEquals, and arrow::ArrayRangeApproxEquals

Are these changes tested?

No

Are there any user-facing changes?

No

@github-actions
Copy link

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

See also:

@andishgar andishgar marked this pull request as draft May 16, 2025 10:35
@andishgar andishgar changed the title [ GH-46396: [C++][Documentation][Statistics] Clarify in the documentation of arrow::Array::Equals, arrow::Array::ApproxEquals, and arrow::Array::EqualsRange that they do not consider arrow::ArrayStatistics May 16, 2025
@github-actions
Copy link

⚠️ GitHub issue #46396 has been automatically assigned in GitHub to PR creator.

@andishgar andishgar changed the title GH-46396: [C++][Documentation][Statistics] Clarify in the documentation of arrow::Array::Equals, arrow::Array::ApproxEquals, and arrow::Array::EqualsRange that they do not consider arrow::ArrayStatistics GH-46396: [C++][Documentation][Statistics] Clarify that arrow::Array::Equals, ApproxEquals, and EqualsRange ignore arrow::ArrayStatistics May 16, 2025
@andishgar andishgar force-pushed the add-document-for-equality branch from 96d053d to 4f2bb0a Compare May 16, 2025 11:58
@andishgar andishgar changed the title GH-46396: [C++][Documentation][Statistics] Clarify that arrow::Array::Equals, ApproxEquals, and EqualsRange ignore arrow::ArrayStatistics GH-46396: [C++][Documentation][Statistics] Revise the documentation to clarify that arrow::ArrayStatistics is ignored during arrow::Array comparisons May 16, 2025
@andishgar andishgar marked this pull request as ready for review May 16, 2025 13:48
@andishgar
Copy link
Contributor Author

@kou Are the method comments okay, or do you have any suggestions for improvement?

Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou kou merged commit e20ccb6 into apache:main May 21, 2025
37 of 40 checks passed
@kou kou removed the awaiting review Awaiting review label May 21, 2025
@github-actions github-actions bot added the awaiting merge Awaiting merge label May 21, 2025
@andishgar andishgar deleted the add-document-for-equality branch May 21, 2025 08:21
@conbench-apache-arrow
Copy link

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit e20ccb6.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 8 possible false positives for unstable benchmarks that are known to sometimes produce them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants