venv/lib/python3.11/site-packages/pyarrow/include/arrow/chunk_resolver.h

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

#pragma once

#include <atomic>
#include <cassert>
#include <cstdint>
#include <limits>
#include <type_traits>
#include <vector>

#include "arrow/type_fwd.h"
#include "arrow/util/macros.h"
#include "arrow/util/span.h"

namespace arrow {

class ChunkResolver;

template <typename IndexType>
struct ARROW_EXPORT TypedChunkLocation {
  /// \brief Index of the chunk in the array of chunks
  ///
  /// The value is always in the range `[0, chunks.size()]`. `chunks.size()` is used
  /// to represent out-of-bounds locations.
  IndexType chunk_index = 0;

  /// \brief Index of the value in the chunk
  ///
  /// The value is UNDEFINED if `chunk_index >= chunks.size()`
  IndexType index_in_chunk = 0;

  TypedChunkLocation() = default;

  TypedChunkLocation(IndexType chunk_index, IndexType index_in_chunk)
      : chunk_index(chunk_index), index_in_chunk(index_in_chunk) {
    static_assert(sizeof(TypedChunkLocation<IndexType>) == 2 * sizeof(IndexType));
    static_assert(alignof(TypedChunkLocation<IndexType>) == alignof(IndexType));
  }

  bool operator==(TypedChunkLocation other) const {
    return chunk_index == other.chunk_index && index_in_chunk == other.index_in_chunk;
  }
};

using ChunkLocation = TypedChunkLocation<int64_t>;

/// \brief An utility that incrementally resolves logical indices into
/// physical indices in a chunked array.
class ARROW_EXPORT ChunkResolver {
 private:
  /// \brief Array containing `chunks.size() + 1` offsets.
  ///
  /// `offsets_[i]` is the starting logical index of chunk `i`. `offsets_[0]` is always 0
  /// and `offsets_[chunks.size()]` is the logical length of the chunked array.
  std::vector<int64_t> offsets_;

  /// \brief Cache of the index of the last resolved chunk.
  ///
  /// \invariant `cached_chunk_ in [0, chunks.size()]`
  mutable std::atomic<int32_t> cached_chunk_;

 public:
  explicit ChunkResolver(const ArrayVector& chunks) noexcept;
  explicit ChunkResolver(util::span<const Array* const> chunks) noexcept;
  explicit ChunkResolver(const RecordBatchVector& batches) noexcept;

  /// \brief Construct a ChunkResolver from a vector of chunks.size() + 1 offsets.
  ///
  /// The first offset must be 0 and the last offset must be the logical length of the
  /// chunked array. Each offset before the last represents the starting logical index of
  /// the corresponding chunk.
  explicit ChunkResolver(std::vector<int64_t> offsets) noexcept
      : offsets_(std::move(offsets)), cached_chunk_(0) {
#ifndef NDEBUG
    assert(offsets_.size() >= 1);
    assert(offsets_[0] == 0);
    for (size_t i = 1; i < offsets_.size(); i++) {
      assert(offsets_[i] >= offsets_[i - 1]);
    }
    assert(offsets_.size() - 1 <=
           static_cast<size_t>(std::numeric_limits<int32_t>::max()));
#endif
  }

  ChunkResolver(ChunkResolver&& other) noexcept;
  ChunkResolver& operator=(ChunkResolver&& other) noexcept;

  ChunkResolver(const ChunkResolver& other) noexcept;
  ChunkResolver& operator=(const ChunkResolver& other) noexcept;

  int64_t logical_array_length() const { return offsets_.back(); }
  int32_t num_chunks() const { return static_cast<int32_t>(offsets_.size() - 1); }

  int64_t chunk_length(int64_t chunk_index) const {
    return offsets_[chunk_index + 1] - offsets_[chunk_index];
  }

  /// \brief Resolve a logical index to a ChunkLocation.
  ///
  /// The returned ChunkLocation contains the chunk index and the within-chunk index
  /// equivalent to the logical index.
  ///
  /// \pre `index >= 0`
  /// \post `location.chunk_index` in `[0, chunks.size()]`
  /// \param index The logical index to resolve
  /// \return ChunkLocation with a valid chunk_index if index is within
  ///         bounds, or with `chunk_index == chunks.size()` if logical index is
  ///         `>= chunked_array.length()`.
  inline ChunkLocation Resolve(int64_t index) const {
    const auto cached_chunk = cached_chunk_.load(std::memory_order_relaxed);
    const auto chunk_index =
        ResolveChunkIndex</*StoreCachedChunk=*/true>(index, cached_chunk);
    return ChunkLocation{chunk_index, index - offsets_[chunk_index]};
  }

  /// \brief Resolve a logical index to a ChunkLocation.
  ///
  /// The returned ChunkLocation contains the chunk index and the within-chunk index
  /// equivalent to the logical index.
  ///
  /// \pre `index >= 0`
  /// \post `location.chunk_index` in `[0, chunks.size()]`
  /// \param index The logical index to resolve
  /// \param hint ChunkLocation{} or the last ChunkLocation returned by
  ///             this ChunkResolver.
  /// \return ChunkLocation with a valid chunk_index if index is within
  ///         bounds, or with `chunk_index == chunks.size()` if logical index is
  ///         `>= chunked_array.length()`.
  inline ChunkLocation ResolveWithHint(int64_t index, ChunkLocation hint) const {
    assert(hint.chunk_index < static_cast<uint32_t>(offsets_.size()));
    const auto chunk_index = ResolveChunkIndex</*StoreCachedChunk=*/false>(
        index, static_cast<int32_t>(hint.chunk_index));
    return ChunkLocation{chunk_index, index - offsets_[chunk_index]};
  }

  /// \brief Resolve `n_indices` logical indices to chunk indices.
  ///
  /// \pre 0 <= logical_index_vec[i] < logical_array_length()
  ///      (for well-defined and valid chunk index results)
  /// \pre out_chunk_location_vec has space for `n_indices` locations
  /// \pre chunk_hint in [0, chunks.size()]
  /// \post out_chunk_location_vec[i].chunk_index in [0, chunks.size()] for i in [0, n)
  /// \post if logical_index_vec[i] >= chunked_array.length(), then
  ///       out_chunk_location_vec[i].chunk_index == chunks.size()
  ///       and out_chunk_location_vec[i].index_in_chunk is UNDEFINED (can be
  ///       out-of-bounds)
  /// \post if logical_index_vec[i] < 0, then both values in out_chunk_index_vec[i]
  ///       are UNDEFINED
  ///
  /// \param n_indices The number of logical indices to resolve
  /// \param logical_index_vec The logical indices to resolve
  /// \param out_chunk_location_vec The output array where the locations will be written
  /// \param chunk_hint 0 or the last chunk_index produced by ResolveMany
  /// \return false iff chunks.size() > std::numeric_limits<IndexType>::max()
  template <typename IndexType>
  [[nodiscard]] bool ResolveMany(int64_t n_indices, const IndexType* logical_index_vec,
                                 TypedChunkLocation<IndexType>* out_chunk_location_vec,
                                 IndexType chunk_hint = 0) const {
    if constexpr (sizeof(IndexType) < sizeof(uint32_t)) {
      // The max value returned by Bisect is `offsets.size() - 1` (= chunks.size()).
      constexpr int64_t kMaxIndexTypeValue = std::numeric_limits<IndexType>::max();
      // A ChunkedArray with enough empty chunks can make the index of a chunk
      // exceed the logical index and thus the maximum value of IndexType.
      const bool chunk_index_fits_on_type = num_chunks() <= kMaxIndexTypeValue;
      if (ARROW_PREDICT_FALSE(!chunk_index_fits_on_type)) {
        return false;
      }
      // Since an index-in-chunk cannot possibly exceed the logical index being
      // queried, we don't have to worry about these values not fitting on IndexType.
    }
    if constexpr (std::is_signed_v<IndexType>) {
      // We interpret signed integers as unsigned and avoid having to generate double
      // the amount of binary code to handle each integer width.
      //
      // Negative logical indices can become large values when cast to unsigned, and
      // they are gracefully handled by ResolveManyImpl, but both the chunk index
      // and the index in chunk values will be undefined in these cases. This
      // happend because int8_t(-1) == uint8_t(255) and 255 could be a valid
      // logical index in the chunked array.
      using U = std::make_unsigned_t<IndexType>;
      ResolveManyImpl(n_indices, reinterpret_cast<const U*>(logical_index_vec),
                      reinterpret_cast<TypedChunkLocation<U>*>(out_chunk_location_vec),
                      static_cast<int32_t>(chunk_hint));
    } else {
      static_assert(std::is_unsigned_v<IndexType>);
      ResolveManyImpl(n_indices, logical_index_vec, out_chunk_location_vec,
                      static_cast<int32_t>(chunk_hint));
    }
    return true;
  }

 private:
  template <bool StoreCachedChunk>
  inline int64_t ResolveChunkIndex(int64_t index, int32_t cached_chunk) const {
    // It is common for algorithms sequentially processing arrays to make consecutive
    // accesses at a relatively small distance from each other, hence often falling in the
    // same chunk.
    //
    // This is guaranteed when merging (assuming each side of the merge uses its
    // own resolver), and is the most common case in recursive invocations of
    // partitioning.
    const auto num_offsets = static_cast<uint32_t>(offsets_.size());
    const int64_t* offsets = offsets_.data();
    if (ARROW_PREDICT_TRUE(index >= offsets[cached_chunk]) &&
        (static_cast<uint32_t>(cached_chunk + 1) == num_offsets ||
         index < offsets[cached_chunk + 1])) {
      return cached_chunk;
    }
    // lo < hi is guaranteed by `num_offsets = chunks.size() + 1`
    const auto chunk_index = Bisect(index, offsets, /*lo=*/0, /*hi=*/num_offsets);
    if constexpr (StoreCachedChunk) {
      assert(static_cast<uint32_t>(chunk_index) < static_cast<uint32_t>(offsets_.size()));
      cached_chunk_.store(chunk_index, std::memory_order_relaxed);
    }
    return chunk_index;
  }

  /// \pre all the pre-conditions of ChunkResolver::ResolveMany()
  /// \pre num_offsets - 1 <= std::numeric_limits<IndexType>::max()
  void ResolveManyImpl(int64_t, const uint8_t*, TypedChunkLocation<uint8_t>*,
                       int32_t) const;
  void ResolveManyImpl(int64_t, const uint16_t*, TypedChunkLocation<uint16_t>*,
                       int32_t) const;
  void ResolveManyImpl(int64_t, const uint32_t*, TypedChunkLocation<uint32_t>*,
                       int32_t) const;
  void ResolveManyImpl(int64_t, const uint64_t*, TypedChunkLocation<uint64_t>*,
                       int32_t) const;

 public:
  /// \brief Find the index of the chunk that contains the logical index.
  ///
  /// Any non-negative index is accepted. When `hi=num_offsets`, the largest
  /// possible return value is `num_offsets-1` which is equal to
  /// `chunks.size()`. Which is returned when the logical index is greater or
  /// equal the logical length of the chunked array.
  ///
  /// \pre index >= 0 (otherwise, when index is negative, hi-1 is returned)
  /// \pre lo < hi
  /// \pre lo >= 0 && hi <= offsets_.size()
  static inline int32_t Bisect(int64_t index, const int64_t* offsets, int32_t lo,
                               int32_t hi) {
    return Bisect(static_cast<uint64_t>(index),
                  reinterpret_cast<const uint64_t*>(offsets), static_cast<uint32_t>(lo),
                  static_cast<uint32_t>(hi));
  }

  static inline int32_t Bisect(uint64_t index, const uint64_t* offsets, uint32_t lo,
                               uint32_t hi) {
    // Similar to std::upper_bound(), but slightly different as our offsets
    // array always starts with 0.
    auto n = hi - lo;
    // First iteration does not need to check for n > 1
    // (lo < hi is guaranteed by the precondition).
    assert(n > 1 && "lo < hi is a precondition of Bisect");
    do {
      const uint32_t m = n >> 1;
      const uint32_t mid = lo + m;
      if (index >= offsets[mid]) {
        lo = mid;
        n -= m;
      } else {
        n = m;
      }
    } while (n > 1);
    return lo;
  }
};

// Explicitly instantiate template base struct, for DLL linking on Windows
template struct TypedChunkLocation<int32_t>;
template struct TypedChunkLocation<int16_t>;
template struct TypedChunkLocation<int8_t>;
template struct TypedChunkLocation<uint8_t>;
template struct TypedChunkLocation<uint16_t>;
template struct TypedChunkLocation<uint32_t>;
template struct TypedChunkLocation<int64_t>;
template struct TypedChunkLocation<uint64_t>;
}  // namespace arrow