Skip to content

Commit 4f2bb0a

Browse files
committed
Add document in compare.h
1 parent 4c33991 commit 4f2bb0a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

cpp/src/arrow/compare.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,29 @@ class EqualOptions {
9292
};
9393

9494
/// Returns true if the arrays are exactly equal
95+
///
96+
/// Note that arrow::ArrayStatistics is not included in the comparison.
9597
ARROW_EXPORT bool ArrayEquals(const Array& left, const Array& right,
9698
const EqualOptions& = EqualOptions::Defaults());
9799

98100
/// Returns true if the arrays are approximately equal. For non-floating point
99101
/// types, this is equivalent to ArrayEquals(left, right)
102+
///
103+
/// Note that arrow::ArrayStatistics is not included in the comparison.
100104
ARROW_EXPORT bool ArrayApproxEquals(const Array& left, const Array& right,
101105
const EqualOptions& = EqualOptions::Defaults());
102106

103107
/// Returns true if indicated equal-length segment of arrays are exactly equal
108+
///
109+
/// Note that arrow::ArrayStatistics is not included in the comparison.
104110
ARROW_EXPORT bool ArrayRangeEquals(const Array& left, const Array& right,
105111
int64_t start_idx, int64_t end_idx,
106112
int64_t other_start_idx,
107113
const EqualOptions& = EqualOptions::Defaults());
108114

109115
/// Returns true if indicated equal-length segment of arrays are approximately equal
116+
///
117+
/// Note that arrow::ArrayStatistics is not included in the comparison.
110118
ARROW_EXPORT bool ArrayRangeApproxEquals(const Array& left, const Array& right,
111119
int64_t start_idx, int64_t end_idx,
112120
int64_t other_start_idx,

0 commit comments

Comments
 (0)