roaring_position_bitmap.h

Go to the documentation of this file.

/*
 * 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 <cstdint>
#include <functional>
#include <memory>
#include <span>
#include <string>
#include <string_view>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
 
namespace iceberg {
 
class PositionDeleteIndex;
 
 
class ICEBERG_EXPORT RoaringPositionBitmap {
 public:
  static constexpr int64_t kMaxPosition = 0x7FFFFFFE80000000LL;
 
  RoaringPositionBitmap();
  ~RoaringPositionBitmap();
 
  RoaringPositionBitmap(RoaringPositionBitmap&& other) noexcept;
  RoaringPositionBitmap& operator=(RoaringPositionBitmap&& other) noexcept;
 
  RoaringPositionBitmap(const RoaringPositionBitmap& other);
  RoaringPositionBitmap& operator=(const RoaringPositionBitmap& other);
 
  void Add(int64_t pos);
 
  void AddRange(int64_t pos_start, int64_t pos_end);
 
  bool Contains(int64_t pos) const;
 
  bool IsEmpty() const;
 
  size_t Cardinality() const;
 
  void Or(const RoaringPositionBitmap& other);
 
  bool Optimize();
 
  void ForEach(const std::function<void(int64_t)>& fn) const;
 
  size_t SerializedSizeInBytes() const;
 
  Result<std::string> Serialize() const;
 
  static Result<RoaringPositionBitmap> Deserialize(std::string_view bytes);
 
 private:
  struct Impl;
  std::unique_ptr<Impl> impl_;
 
  explicit RoaringPositionBitmap(std::unique_ptr<Impl> impl);
 
  // Bulk-add positions sharing high-32-bit `key`. Internal hook for
  // `PositionDeleteIndex::BulkAddForKey`; per-key grouping is the caller's
  // job, keeping this a thin wrapper around CRoaring's `addMany`.
  void AddManyForKey(int32_t key, std::span<const uint32_t> positions);
  // Appends the portable serialized bitmap and returns bytes appended.
  Result<size_t> SerializeTo(std::vector<uint8_t>& output) const;
  friend class PositionDeleteIndex;
};
 
}  // namespace iceberg