Skip to content

GH-50689: [C++][Parquet] Add IEEE-754 total order and nan count for floating types - #50807

Open
HuaHuaY wants to merge 2 commits into
apache:mainfrom
HuaHuaY:nan_count
Open

HuaHuaY wants to merge 2 commits into
apache:mainfrom
HuaHuaY:nan_count

Conversation

@HuaHuaY

@HuaHuaY HuaHuaY commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Rationale for this change

Implement IEEE 754 total order and NaN counts from apache/parquet-format#514.

What changes are included in this PR?

  • Use IEEE total order by default, with a writer-level TYPE order fallback.
  • Add nan_count to statistics and nan_counts to PageIndex.
  • Preserve NaN payloads and signed zero in statistics and dictionary encoding.
  • Make Dataset pruning NaN-aware (skip FLOAT16 numeric bounds until comparison kernels are available).

Are these changes tested?

Yes.

Are there any user-facing changes?

  • cpp/src/parquet/types.h: Adds ColumnOrder::IEEE_754_TOTAL_ORDER.
  • cpp/src/parquet/properties.h: Adds the floating-point column-order writer property.
  • cpp/src/parquet/schema.h: Allows column descriptors to use IEEE-ordered min/max statistics.
  • cpp/src/parquet/page_index.h: Exposes virtual std::optional<std::span<const int64_t>> nan_counts() const.
  • cpp/src/parquet/statistics.h: Adds NaN fields and presence APIs to EncodedStatistics and Statistics, and extends encoded-state Statistics::Make / MakeStatistics overloads with nan_count and has_nan_count.

Comment thread cpp/apidoc/Doxyfile
ARROW_SUPPRESS_DEPRECATION_WARNING= \
ARROW_UNSUPPRESS_DEPRECATION_WARNING= \
GANDIVA_EXPORT= \
PARQUET_DEPRECATED(x)= \

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Add this because I added a PARQUET_DEPRECATED at cpp/src/parquet/statistics.h and ci failed. https://github.com/apache/arrow/actions/runs/30975844655/job/92209544482

I believe this is a long-standing issue. If someone would like me to submit a separate PR to fix it, I can certainly do so.

@github-actions github-actions Bot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Aug 5, 2026
@HuaHuaY
HuaHuaY force-pushed the nan_count branch 2 times, most recently from bd13067 to f51ffc1 Compare August 5, 2026 08:03
Comment thread cpp/src/parquet/types.h Outdated
Comment thread cpp/src/parquet/schema.h Outdated
Comment thread cpp/src/parquet/schema.cc Outdated
Comment thread cpp/src/parquet/statistics.h Outdated
Comment thread docs/source/python/parquet.rst Outdated
Comment thread cpp/src/parquet/statistics.h Outdated
Comment thread cpp/src/parquet/statistics.h Outdated
Comment thread cpp/src/parquet/statistics.h Outdated
Comment thread cpp/src/parquet/schema_internal.h Outdated
Comment thread cpp/src/parquet/statistics.cc Outdated
Comment thread cpp/src/parquet/statistics.cc Outdated
Comment thread cpp/src/parquet/statistics.cc Outdated
Comment thread cpp/src/parquet/metadata.cc
Comment thread cpp/src/parquet/column_writer.cc
@HuaHuaY
HuaHuaY force-pushed the nan_count branch 3 times, most recently from a306ade to 2f24bb6 Compare August 19, 2026 09:19
Copilot AI lite review requested due to automatic review settings August 25, 2026 06:49

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates Arrow C++’s Parquet implementation to support IEEE-754 total ordering for floating-point statistics and to record NaN counts in statistics and page indexes, aligning with parquet-format changes (apache/parquet-format#514) and improving correctness for pruning, encoding, and metadata round-trips involving NaNs and signed zeros.

Changes:

  • Add ColumnOrder::IEEE_754_TOTAL_ORDER and a writer property to control floating-point column ordering (defaulting to IEEE total order).
  • Track and serialize nan_count in column/page statistics and expose per-page nan_counts via ColumnIndex.
  • Update statistics computation, dictionary encoding, metadata/schema handling, and dataset pruning to be NaN-aware (including special handling for FLOAT16 pruning limitations).

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/source/python/parquet.rst Update example metadata output values to match new behavior/encoding sizes.
cpp/src/parquet/types.h Add IEEE_754_TOTAL_ORDER to ColumnOrder enum and declare static instance.
cpp/src/parquet/types.cc Define ColumnOrder::ieee_754_total_order_.
cpp/src/parquet/thrift_internal.h Serialize/deserialize nan_count; treat IEEE order as min/max-value stats field source.
cpp/src/parquet/statistics.h Extend statistics APIs and encoded state to include optional nan_count; update comparator docs.
cpp/src/parquet/statistics.cc Implement IEEE total-order comparisons, NaN counting, and IEEE-aware min/max handling and merging.
cpp/src/parquet/statistics_test.cc Add/extend tests for NaN counts, IEEE total order, and float16 behaviors.
cpp/src/parquet/schema.h Allow can_use_min_max() for IEEE order (see review note re: non-float types).
cpp/src/parquet/schema.cc Add IsFloatingPointType helper for schema/metadata decisions.
cpp/src/parquet/schema_test.cc Test that IEEE column order allows min/max usage.
cpp/src/parquet/schema_internal.h Expose IsFloatingPointType as a non-public schema utility.
cpp/src/parquet/properties.h Add writer property floating_point_column_order with validation and plumbing.
cpp/src/parquet/page_index.h Add has_nan_counts() / nan_counts() to ColumnIndex API.
cpp/src/parquet/page_index.cc Persist per-page nan_counts when available for floating columns; validate vector lengths.
cpp/src/parquet/page_index_test.cc Add tests covering nan_counts propagation for IEEE total-order float columns.
cpp/src/parquet/metadata.cc Plumb encoded stats into Statistics::Make; enforce column-order compatibility; parse/write IEEE column order in file metadata.
cpp/src/parquet/file_writer.cc Build writer schema with per-float column orders from writer properties and stabilize type_length.
cpp/src/parquet/file_serialize_test.cc Add round-trip test validating floating-point column order behavior and schema stability.
cpp/src/parquet/encoding_test.cc Add tests ensuring dictionary encoding preserves float bit patterns and avoids NaN hash collisions.
cpp/src/parquet/encoder.cc Change float/double dictionary memoization keys to use bitwise representations for NaN payload stability.
cpp/src/parquet/column_writer.cc Gate legacy min/max field population based on effective ordering; enable stats collection via can_use_min_max().
cpp/src/parquet/arrow/reader_internal.cc Decode FLOAT16 min/max statistics into HalfFloat scalars for Arrow conversion.
cpp/src/parquet/arrow/index_test.cc Add nan_counts to column index round-trip expectations; add test parquet file coverage for mixed orders/nan counts.
cpp/src/parquet/arrow/arrow_reader_writer_test.cc Add end-to-end test ensuring float dictionary round-trips preserve NaN payloads and signed zeros with IEEE order and page index.
cpp/src/arrow/dataset/file_parquet.cc Make dataset pruning NaN-aware using nan_count; skip FLOAT16 numeric pruning until kernels exist.
cpp/src/arrow/dataset/file_parquet_test.cc Add tests validating pruning expressions with/without nan_count and for FLOAT16 behavior.
cpp/apidoc/Doxyfile Teach Doxygen about PARQUET_DEPRECATED macro for API docs.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread cpp/src/parquet/schema.h
Comment thread cpp/src/parquet/statistics.cc
Copilot AI review requested due to automatic review settings August 27, 2026 02:26
@HuaHuaY

HuaHuaY commented Aug 27, 2026

Copy link
Copy Markdown
Contributor Author

Run git rebase to resolve conflicts

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 28 out of 28 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings August 27, 2026 09:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 28 out of 28 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings September 1, 2026 09:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 28 out of 28 changed files in this pull request and generated 1 comment.

Comment thread cpp/src/parquet/statistics.cc
Copilot AI review requested due to automatic review settings September 1, 2026 10:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 28 out of 28 changed files in this pull request and generated no new comments.

Suppressed comments (1)

cpp/src/parquet/schema.cc:635

  • schema::IsFloatingPointType dereferences descr.logical_type() without a null check. ColumnDescriptor::logical_type() can be empty (e.g. FLBA columns created via PrimitiveNode::Make with only physical/converted type), which would crash when this helper is called (e.g. from page index / metadata code).
bool IsFloatingPointType(const ColumnDescriptor& descr) {
  return descr.physical_type() == Type::FLOAT || descr.physical_type() == Type::DOUBLE ||
         descr.logical_type()->type() == LogicalType::Type::FLOAT16;

@wgtmac wgtmac 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.

Thanks for addressing my comments! Looks good to me now. I still have two comments with open questions.

/// \param[in] is_min_value_exact whether the min value is exact
/// \param[in] is_max_value_exact whether the max value is exact
/// \param[in] pool a memory pool to use for any memory allocations, optional
static std::shared_ptr<Statistics> Make(

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.

I think that's a different concern. Here I mean we don't have to add yet another overload for adding an optional nan_count because we can add it to the end of an existing one with a default value. We don't need a breaking change this time. The issue you've mentioned is to replace has_xxx and xxx with a single std::optional<int64_t> which has to be a breaking change.

Comment thread cpp/src/parquet/statistics_test.cc Outdated
Repetition::type rep) {
return PrimitiveNode::Make(name, rep, LogicalType::Float16(),
Type::FIXED_LEN_BYTE_ARRAY, 2);
auto node = PrimitiveNode::Make(name, rep, LogicalType::Float16(),

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.

nit: should we expand PrimitiveNode::Make to accept column order as well? Currently we cannot create a primitive node of floating type with type-defined-order in a single shot.

@wgtmac

wgtmac commented Sep 1, 2026

Copy link
Copy Markdown
Member

@pitrou Do you want to take a look?

@pitrou

pitrou commented Sep 1, 2026

Copy link
Copy Markdown
Member

Yes, I'll take a look. Sorry!

Comment thread cpp/src/arrow/dataset/file_parquet.cc Outdated
Comment thread cpp/src/parquet/arrow/index_test.cc Outdated
Comment thread cpp/src/parquet/encoding_test.cc
*logical_type, min, max);
}
if (logical_type->type() == LogicalType::Type::FLOAT16) {
*min = std::make_shared<::arrow::HalfFloatScalar>(

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.

If this is a new feature, is it tested somewhere?

@HuaHuaY HuaHuaY Sep 14, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think it is more of a fix for incorrect behavior. Previously, float16 statistics were treated as fixed_size_binary[2].

It does not have a standalone unit test, but it is tested in TEST(ParquetPageIndex, FloatingPointOrdersInterop).

Comment thread cpp/src/parquet/page_index.h Outdated
Comment thread cpp/src/parquet/statistics_test.cc Outdated
Comment thread cpp/src/parquet/statistics_test.cc Outdated
Comment thread cpp/src/parquet/statistics_test.cc Outdated

TEST(TestFloatStatistics, TotalOrderFloat16) {
// -qNaN(payload=1), +qNaN(payload=1).
BufferedFloat16 negative_nan(Float16::FromBits(0xfe01));

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.

Unrelated, but I wonder if at some point TypedStatistics<FixedLenByteArray> could have a Update that doesn't involve an array of FLBAs, e.g.:

  template <int kByteLength>
  virtual void Update(std::span<const std::array<uint8_t, kByteLength> values, int64_t null_count) = 0 {
    UpdateFromLinearBuffer(reinterpret_cast<const uint8_t*>(values.data()), kByteLength, values.size(), null_count);
  }
  template <typename Value>
  virtual std::enable_if_t<std::is_arithmetic_v<Value>> Update(
      std::span<const Value> values, int64_t null_count) = 0 {
    UpdateFromLinearBuffer(
      reinterpret_cast<const uint8_t*>(values.data()), static_cast<int>(sizeof(Value)), values.size(), null_count);
  }

 protected:
  virtual void UpdateFromLinearBuffer(
      const uint8_t* valyes, int value_length, int64_t num_values, int64_t null_count) = 0;

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.

That could perhaps help us get rid of the BufferedFloat16 mess.

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.

And/or add a Float16Statistics class deriving from TypedStatistics<FixedLenByteArray>, with overloads that take/return Float16 values?

@HuaHuaY HuaHuaY Sep 19, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

In the refactoring mentioned earlier, I removed BufferedFloat16. However, the issue where FLBA only stores pointers remains. I feel that accepting Float16 might be a direction.

P.S. A member template function cannot be virtual in C++. So the API needs to be adjusted.

return lhs_bits <=> rhs_bits;
}

std::strong_ordering TotalOrderCompare(float lhs, float rhs) {

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.

Can we expose these functions as internal APIs somewhere (parquet/statistics_internal.h perhaps?) and unit-test them directly?


if (comparator_ == nullptr) return;

if constexpr (IsOneOf<DType, FloatType, DoubleType, FLBAType>::value) {

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.

It's... the amount of bespoke code that we have to add in this file for such a conceptually simple addition is scary. This is going to become difficult to maintain.

Perhaps the whole internal organization here has become impossible to work with and we should think of something else?

Copilot AI review requested due to automatic review settings September 19, 2026 16:40
@HuaHuaY

HuaHuaY commented Sep 19, 2026

Copy link
Copy Markdown
Contributor Author

I have addressed most of pitrou's review comments, except for the last two regarding statistics.cc. Let me take a little more time to resolve the remaining comments.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

NaN-count correctness, the missing presence API, and null logical-type handling remain unresolved.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 High severity · 1 Medium severity

Open (2)

Comment on lines +992 to +997
UpdateFloatingBounds(
[&](auto&& visit) {
visit_valid_indices(
[&](int64_t value_index) { visit(array.Value(value_index)); });
},
update_counts);
Comment thread cpp/src/parquet/page_index.h
Copilot AI review requested due to automatic review settings September 19, 2026 16:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Unresolved critical correctness, build, fixture, and API issues remain.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 5 High severity

Open (5)
Resolved since last review (1)

Comment on lines +697 to +699
TEST(ParquetPageIndex, FloatingPointOrdersInterop) {
auto reader = ParquetFileReader::OpenFile(
test::get_data_file("floating_orders_nan_count.parquet"));
Comment on lines +2087 to +2089
case ColumnOrder::IEEE_754_TOTAL_ORDER:
column_order.__set_IEEE_754_TOTAL_ORDER(format::IEEE754TotalOrder{});
break;
#include "parquet/page_index.h"

#include <gtest/gtest.h>
#include <algorithm>
Comment on lines +980 to +988
auto visit_valid_indices = [&](auto&& visit) {
::arrow::internal::VisitSetBitRunsVoid(
values.null_bitmap_data(), values.offset(), values.length(),
[&](int64_t position, int64_t run_length) {
for (int64_t value_index = 0; value_index < run_length; ++value_index) {
visit(position + value_index);
}
});
};
Copilot AI review requested due to automatic review settings September 19, 2026 16:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🔵 Needs a closer look

Restrict IEEE ordering to supported floating types and preserve row-weighted NaN counts for dictionary-encoded columns.

Review effort: Lite
Findings: 5 High severity

Open (5)

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.

4 participants