Skip to content

GH-46396: [C++][Documentation][Statistics] Revise the documentation to clarify that arrow::ArrayStatistics is ignored during arrow::Array comparisons - #46470

Merged
kou merged 2 commits into
apache:mainfrom
andishgar:add-document-for-equality
May 21, 2025

Conversation

@andishgar

@andishgarandishgar commented May 16, 2025

Copy link
Copy Markdown
Contributor

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
Copy Markdown

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
@andishgarandishgar 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::ArrayStatisticsMay 16, 2025
@github-actions

Copy link
Copy Markdown

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

@andishgarandishgar 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::ArrayStatisticsGH-46396: [C++][Documentation][Statistics] Clarify that arrow::Array::Equals, ApproxEquals, and EqualsRange ignore arrow::ArrayStatisticsMay 16, 2025
@andishgar
andishgarforce-pushed the add-document-for-equality branch from 96d053d to 4f2bb0aCompareMay 16, 2025 11:58
@andishgarandishgar changed the title GH-46396: [C++][Documentation][Statistics] Clarify that arrow::Array::Equals, ApproxEquals, and EqualsRange ignore arrow::ArrayStatisticsGH-46396: [C++][Documentation][Statistics] Revise the documentation to clarify that arrow::ArrayStatistics is ignored during arrow::Array comparisonsMay 16, 2025
@andishgar
andishgar marked this pull request as ready for review May 16, 2025 13:48
@andishgar

Copy link
Copy Markdown
ContributorAuthor

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

kou
kou approved these changes May 21, 2025

@koukou left a comment

Copy link
Copy Markdown
Member

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:mainMay 21, 2025
@koukou removed the awaiting review Awaiting review label May 21, 2025
@github-actionsgithub-actionsBot 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
Copy Markdown

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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@andishgar@kou