roaring 0.2.0 → 0.3.0

data/ext/roaring/roaring/roaring.hh

@@ -1,2016 +0,0 @@
-// !!! DO NOT EDIT - THIS IS AN AUTO-GENERATED FILE !!!
-// Created by amalgamation.sh on Wed 20 Jul 2022 16:25:25 EDT
-
-/*
- * The CRoaring project is under a dual license (Apache/MIT).
- * Users of the library may choose one or the other license.
- */
-/*
- * Copyright 2016-2022 The CRoaring authors
- *
- * Licensed 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.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-/*
- * MIT License
- *
- * Copyright 2016-2022 The CRoaring authors
- *
- * Permission is hereby granted, free of charge, to any
- * person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the
- * Software without restriction, including without
- * limitation the rights to use, copy, modify, merge,
- * publish, distribute, sublicense, and/or sell copies of
- * the Software, and to permit persons to whom the Software
- * is furnished to do so, subject to the following
- * conditions:
- *
- * The above copyright notice and this permission notice
- * shall be included in all copies or substantial portions
- * of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
- * ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
- * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
- * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
- * SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
- * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
- * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
- * IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- * DEALINGS IN THE SOFTWARE
- *
- * SPDX-License-Identifier: MIT
- */
-
-#define ROARING_API_NOT_IN_GLOBAL_NAMESPACE  // see remarks in roaring.h
-#include "roaring.h"
-#undef ROARING_API_NOT_IN_GLOBAL_NAMESPACE
-/* begin file cpp/roaring.hh */
-/*
-A C++ header for Roaring Bitmaps.
-*/
-#ifndef INCLUDE_ROARING_HH_
-#define INCLUDE_ROARING_HH_
-
-#include <stdarg.h>
-
-#include <algorithm>
-#include <new>
-#include <stdexcept>
-#include <string>
-
-#if !defined(ROARING_EXCEPTIONS)
-// __cpp_exceptions is required by C++98 and we require C++11 or better.
-#ifndef __cpp_exceptions
-#error "__cpp_exceptions should be defined"
-#endif
-# if __cpp_exceptions
-#  define ROARING_EXCEPTIONS 1
-# else
-#  define ROARING_EXCEPTIONS 0
-# endif
-#endif
-
-#ifndef ROARING_TERMINATE
-# if ROARING_EXCEPTIONS
-#  define ROARING_TERMINATE(_s) throw std::runtime_error(_s)
-# else
-#  define ROARING_TERMINATE(_s) std::terminate()
-# endif
-#endif
-
-#define ROARING_API_NOT_IN_GLOBAL_NAMESPACE  // see remarks in roaring.h
-#undef ROARING_API_NOT_IN_GLOBAL_NAMESPACE
-
-
-namespace roaring {
-
-class RoaringSetBitForwardIterator;
-
-class Roaring {
-    typedef api::roaring_bitmap_t roaring_bitmap_t;  // class-local name alias
-
-public:
-    /**
-     * Create an empty bitmap in the existing memory for the class.
-     * The bitmap will be in the "clear" state with no auxiliary allocations.
-     */
-    Roaring() : roaring{} {
-        // The empty constructor roaring{} silences warnings from pedantic static analyzers.
-        api::roaring_bitmap_init_cleared(&roaring);
-    }
-
-    /**
-     * Construct a bitmap from a list of integer values.
-     */
-    Roaring(size_t n, const uint32_t *data) : Roaring() {
-        api::roaring_bitmap_add_many(&roaring, n, data);
-    }
-
-    /**
-     * Copy constructor
-     */
-    Roaring(const Roaring &r) : Roaring() {
-        if (!api::roaring_bitmap_overwrite(&roaring, &r.roaring)) {
-            ROARING_TERMINATE("failed roaring_bitmap_overwrite in constructor");
-        }
-        api::roaring_bitmap_set_copy_on_write(
-            &roaring,
-            api::roaring_bitmap_get_copy_on_write(&r.roaring));
-    }
-
-    /**
-     * Move constructor. The moved object remains valid, i.e.
-     * all methods can still be called on it.
-     */
-    explicit Roaring(Roaring &&r) noexcept : roaring(r.roaring) {
-        //
-        // !!! This clones the bits of the roaring structure to a new location
-        // and then overwrites the old bits...assuming that this will still
-        // work.  There are scenarios where this could break; e.g. if some of
-        // those bits were pointers into the structure memory itself.  If such
-        // things were possible, a roaring_bitmap_move() API would be needed.
-        //
-        api::roaring_bitmap_init_cleared(&r.roaring);
-    }
-
-    /**
-     * Construct a roaring object by taking control of a malloc()'d C struct.
-     *
-     * Passing a NULL pointer is unsafe.
-     * The pointer to the C struct will be invalid after the call.
-     */
-    explicit Roaring(roaring_bitmap_t *s) noexcept : roaring (*s) {
-        roaring_free(s);  // deallocate the passed-in pointer
-    }
-
-    /**
-     * Construct a bitmap from a list of integer values.
-     */
-    static Roaring bitmapOf(size_t n, ...) {
-        Roaring ans;
-        va_list vl;
-        va_start(vl, n);
-        for (size_t i = 0; i < n; i++) {
-            ans.add(va_arg(vl, uint32_t));
-        }
-        va_end(vl);
-        return ans;
-    }
-
-    /**
-     * Add value x
-     */
-    void add(uint32_t x) { api::roaring_bitmap_add(&roaring, x); }
-
-    /**
-     * Add value x
-     * Returns true if a new value was added, false if the value was already
-     * existing.
-     */
-    bool addChecked(uint32_t x) {
-        return api::roaring_bitmap_add_checked(&roaring, x);
-    }
-
-    /**
-     * Add all values from x (included) to y (excluded)
-     */
-    void addRange(const uint64_t x, const uint64_t y)  {
-        return api::roaring_bitmap_add_range(&roaring, x, y);
-    }
-
-    /**
-     * Add value n_args from pointer vals
-     */
-    void addMany(size_t n_args, const uint32_t *vals) {
-        api::roaring_bitmap_add_many(&roaring, n_args, vals);
-    }
-
-    /**
-     * Remove value x
-     */
-    void remove(uint32_t x) { api::roaring_bitmap_remove(&roaring, x); }
-
-    /**
-     * Remove value x
-     * Returns true if a new value was removed, false if the value was not
-     * existing.
-     */
-    bool removeChecked(uint32_t x) {
-        return api::roaring_bitmap_remove_checked(&roaring, x);
-    }
-
-    /**
-     * Return the largest value (if not empty)
-     */
-    uint32_t maximum() const { return api::roaring_bitmap_maximum(&roaring); }
-
-    /**
-     * Return the smallest value (if not empty)
-     */
-    uint32_t minimum() const { return api::roaring_bitmap_minimum(&roaring); }
-
-    /**
-     * Check if value x is present
-     */
-    bool contains(uint32_t x) const {
-        return api::roaring_bitmap_contains(&roaring, x);
-    }
-
-    /**
-     * Check if all values from x (included) to y (excluded) are present
-     */
-    bool containsRange(const uint64_t x, const uint64_t y) const {
-        return api::roaring_bitmap_contains_range(&roaring, x, y);
-    }
-
-    /**
-     * Destructor.  By contract, calling roaring_bitmap_clear() is enough to
-     * release all auxiliary memory used by the structure.
-     */
-    ~Roaring() {
-        if (!(roaring.high_low_container.flags & ROARING_FLAG_FROZEN)) {
-            api::roaring_bitmap_clear(&roaring);
-        } else {
-            // The roaring member variable copies the `roaring_bitmap_t` and
-            // nested `roaring_array_t` structures by value and is freed in the
-            // constructor, however the underlying memory arena used for the
-            // container data is not freed with it. Here we derive the arena
-            // pointer from the second arena allocation in
-            // `roaring_bitmap_frozen_view` and free it as well.
-            roaring_bitmap_free(
-                (roaring_bitmap_t *)((char *)
-                                     roaring.high_low_container.containers -
-                                     sizeof(roaring_bitmap_t)));
-        }
-    }
-
-    /**
-     * Copies the content of the provided bitmap, and
-     * discard the current content.
-     */
-    Roaring &operator=(const Roaring &r) {
-        if (!api::roaring_bitmap_overwrite(&roaring, &r.roaring)) {
-            ROARING_TERMINATE("failed memory alloc in assignment");
-        }
-        api::roaring_bitmap_set_copy_on_write(
-            &roaring,
-            api::roaring_bitmap_get_copy_on_write(&r.roaring));
-        return *this;
-    }
-
-    /**
-     * Moves the content of the provided bitmap, and
-     * discard the current content.
-     */
-    Roaring &operator=(Roaring &&r) noexcept {
-        api::roaring_bitmap_clear(&roaring);  // free this class's allocations
-
-        // !!! See notes in the Move Constructor regarding roaring_bitmap_move()
-        //
-        roaring = r.roaring;
-        api::roaring_bitmap_init_cleared(&r.roaring);
-
-        return *this;
-    }
-
-    /**
-     * Compute the intersection between the current bitmap and the provided
-     * bitmap, writing the result in the current bitmap. The provided bitmap
-     * is not modified.
-     */
-    Roaring &operator&=(const Roaring &r) {
-        api::roaring_bitmap_and_inplace(&roaring, &r.roaring);
-        return *this;
-    }
-
-    /**
-     * Compute the difference between the current bitmap and the provided
-     * bitmap, writing the result in the current bitmap. The provided bitmap
-     * is not modified.
-     */
-    Roaring &operator-=(const Roaring &r) {
-        api::roaring_bitmap_andnot_inplace(&roaring, &r.roaring);
-        return *this;
-    }
-
-    /**
-     * Compute the union between the current bitmap and the provided bitmap,
-     * writing the result in the current bitmap. The provided bitmap is not
-     * modified.
-     *
-     * See also the fastunion function to aggregate many bitmaps more quickly.
-     */
-    Roaring &operator|=(const Roaring &r) {
-        api::roaring_bitmap_or_inplace(&roaring, &r.roaring);
-        return *this;
-    }
-
-    /**
-     * Compute the symmetric union between the current bitmap and the provided
-     * bitmap, writing the result in the current bitmap. The provided bitmap
-     * is not modified.
-     */
-    Roaring &operator^=(const Roaring &r) {
-        api::roaring_bitmap_xor_inplace(&roaring, &r.roaring);
-        return *this;
-    }
-
-    /**
-     * Exchange the content of this bitmap with another.
-     */
-    void swap(Roaring &r) { std::swap(r.roaring, roaring); }
-
-    /**
-     * Get the cardinality of the bitmap (number of elements).
-     */
-    uint64_t cardinality() const {
-        return api::roaring_bitmap_get_cardinality(&roaring);
-    }
-
-    /**
-     * Returns true if the bitmap is empty (cardinality is zero).
-     */
-    bool isEmpty() const { return api::roaring_bitmap_is_empty(&roaring); }
-
-    /**
-     * Returns true if the bitmap is subset of the other.
-     */
-    bool isSubset(const Roaring &r) const {
-        return api::roaring_bitmap_is_subset(&roaring, &r.roaring);
-    }
-
-    /**
-     * Returns true if the bitmap is strict subset of the other.
-     */
-    bool isStrictSubset(const Roaring &r) const {
-        return api::roaring_bitmap_is_strict_subset(&roaring, &r.roaring);
-    }
-
-    /**
-     * Convert the bitmap to an array. Write the output to "ans", caller is
-     * responsible to ensure that there is enough memory allocated
-     * (e.g., ans = new uint32[mybitmap.cardinality()];)
-     */
-    void toUint32Array(uint32_t *ans) const {
-        api::roaring_bitmap_to_uint32_array(&roaring, ans);
-    }
-    /**
-     * To int array with pagination
-     */
-    void rangeUint32Array(uint32_t *ans, size_t offset, size_t limit) const {
-        api::roaring_bitmap_range_uint32_array(&roaring, offset, limit, ans);
-    }
-
-    /**
-     * Return true if the two bitmaps contain the same elements.
-     */
-    bool operator==(const Roaring &r) const {
-        return api::roaring_bitmap_equals(&roaring, &r.roaring);
-    }
-
-    /**
-     * Compute the negation of the roaring bitmap within a specified interval.
-     * Areas outside the range are passed through unchanged.
-     */
-    void flip(uint64_t range_start, uint64_t range_end) {
-        api::roaring_bitmap_flip_inplace(&roaring, range_start, range_end);
-    }
-
-    /**
-     * Remove run-length encoding even when it is more space efficient.
-     * Return whether a change was applied.
-     */
-    bool removeRunCompression() {
-        return api::roaring_bitmap_remove_run_compression(&roaring);
-    }
-
-    /**
-     * Convert array and bitmap containers to run containers when it is more
-     * efficient; also convert from run containers when more space efficient.
-     * Returns true if the result has at least one run container.  Additional
-     * savings might be possible by calling shrinkToFit().
-     */
-    bool runOptimize() { return api::roaring_bitmap_run_optimize(&roaring); }
-
-    /**
-     * If needed, reallocate memory to shrink the memory usage. Returns
-     * the number of bytes saved.
-     */
-    size_t shrinkToFit() { return api::roaring_bitmap_shrink_to_fit(&roaring); }
-
-    /**
-     * Iterate over the bitmap elements. The function iterator is called once
-     * for all the values with ptr (can be NULL) as the second parameter of
-     * each call.
-     *
-     * roaring_iterator is simply a pointer to a function that returns bool
-     * (true means that the iteration should continue while false means that it
-     * should stop), and takes (uint32_t,void*) as inputs.
-     */
-    void iterate(api::roaring_iterator iterator, void *ptr) const {
-        api::roaring_iterate(&roaring, iterator, ptr);
-    }
-
-    /**
-     * Selects the value at index rnk in the bitmap, where the smallest value
-     * is at index 0.
-     *
-     * If the size of the roaring bitmap is strictly greater than rank, then
-     * this function returns true and sets element to the element of given rank.
-     * Otherwise, it returns false.
-     */
-    bool select(uint32_t rnk, uint32_t *element) const {
-        return api::roaring_bitmap_select(&roaring, rnk, element);
-    }
-
-    /**
-     * Computes the size of the intersection between two bitmaps.
-     */
-    uint64_t and_cardinality(const Roaring &r) const {
-        return api::roaring_bitmap_and_cardinality(&roaring, &r.roaring);
-    }
-
-    /**
-     * Check whether the two bitmaps intersect.
-     */
-    bool intersect(const Roaring &r) const {
-        return api::roaring_bitmap_intersect(&roaring, &r.roaring);
-    }
-
-    /**
-     * Computes the Jaccard index between two bitmaps. (Also known as the
-     * Tanimoto distance,
-     * or the Jaccard similarity coefficient)
-     *
-     * The Jaccard index is undefined if both bitmaps are empty.
-     */
-    double jaccard_index(const Roaring &r) const {
-        return api::roaring_bitmap_jaccard_index(&roaring, &r.roaring);
-    }
-
-    /**
-     * Computes the size of the union between two bitmaps.
-     */
-    uint64_t or_cardinality(const Roaring &r) const {
-        return api::roaring_bitmap_or_cardinality(&roaring, &r.roaring);
-    }
-
-    /**
-     * Computes the size of the difference (andnot) between two bitmaps.
-     */
-    uint64_t andnot_cardinality(const Roaring &r) const {
-        return api::roaring_bitmap_andnot_cardinality(&roaring, &r.roaring);
-    }
-
-    /**
-     * Computes the size of the symmetric difference (andnot) between two
-     * bitmaps.
-     */
-    uint64_t xor_cardinality(const Roaring &r) const {
-        return api::roaring_bitmap_xor_cardinality(&roaring, &r.roaring);
-    }
-
-    /**
-     * Returns the number of integers that are smaller or equal to x.
-     * Thus the rank of the smallest element is one.  If
-     * x is smaller than the smallest element, this function will return 0.
-     * The rank and select functions differ in convention: this function returns
-     * 1 when ranking the smallest value, but the select function returns the
-     * smallest value when using index 0.
-     */
-    uint64_t rank(uint32_t x) const {
-        return api::roaring_bitmap_rank(&roaring, x);
-    }
-
-    /**
-     * Write a bitmap to a char buffer. This is meant to be compatible with
-     * the Java and Go versions. Returns how many bytes were written which
-     * should be getSizeInBytes().
-     *
-     * Setting the portable flag to false enable a custom format that
-     * can save space compared to the portable format (e.g., for very
-     * sparse bitmaps).
-     *
-     * Boost users can serialize bitmaps in this manner:
-     *
-     *       BOOST_SERIALIZATION_SPLIT_FREE(Roaring)
-     *       namespace boost {
-     *       namespace serialization {
-     *
-     *       template <class Archive>
-     *       void save(Archive& ar, const Roaring& bitmask,
-     *          const unsigned int version) {
-     *         std::size_t expected_size_in_bytes = bitmask.getSizeInBytes();
-     *         std::vector<char> buffer(expected_size_in_bytes);
-     *         std::size_t       size_in_bytes = bitmask.write(buffer.data());
-     *
-     *         ar& size_in_bytes;
-     *         ar& boost::serialization::make_binary_object(buffer.data(),
-     *             size_in_bytes);
-     *      }
-     *      template <class Archive>
-     *      void load(Archive& ar, Roaring& bitmask,
-     *          const unsigned int version) {
-     *         std::size_t size_in_bytes = 0;
-     *         ar& size_in_bytes;
-     *         std::vector<char> buffer(size_in_bytes);
-     *         ar&  boost::serialization::make_binary_object(buffer.data(),
-     *            size_in_bytes);
-     *         bitmask = Roaring::readSafe(buffer.data(), size_in_bytes);
-     *      }
-     *      }  // namespace serialization
-     *      }  // namespace boost
-     */
-    size_t write(char *buf, bool portable = true) const {
-        if (portable)
-            return api::roaring_bitmap_portable_serialize(&roaring, buf);
-        else
-            return api::roaring_bitmap_serialize(&roaring, buf);
-    }
-
-    /**
-     * Read a bitmap from a serialized version. This is meant to be compatible
-     * with the Java and Go versions.
-     *
-     * Setting the portable flag to false enable a custom format that
-     * can save space compared to the portable format (e.g., for very
-     * sparse bitmaps).
-     *
-     * This function is unsafe in the sense that if you provide bad data,
-     * many, many bytes could be read. See also readSafe.
-     */
-    static Roaring read(const char *buf, bool portable = true) {
-        roaring_bitmap_t * r = portable
-            ? api::roaring_bitmap_portable_deserialize(buf)
-            : api::roaring_bitmap_deserialize(buf);
-        if (r == NULL) {
-            ROARING_TERMINATE("failed alloc while reading");
-        }
-        return Roaring(r);
-    }
-
-    /**
-     * Read a bitmap from a serialized version, reading no more than maxbytes
-     * bytes.  This is meant to be compatible with the Java and Go versions.
-     *
-     */
-    static Roaring readSafe(const char *buf, size_t maxbytes) {
-        roaring_bitmap_t * r =
-            api::roaring_bitmap_portable_deserialize_safe(buf,maxbytes);
-        if (r == NULL) {
-            ROARING_TERMINATE("failed alloc while reading");
-        }
-        return Roaring(r);
-    }
-
-    /**
-     * How many bytes are required to serialize this bitmap (meant to be
-     * compatible with Java and Go versions)
-     *
-     * Setting the portable flag to false enable a custom format that
-     * can save space compared to the portable format (e.g., for very
-     * sparse bitmaps).
-     */
-    size_t getSizeInBytes(bool portable = true) const {
-        if (portable)
-            return api::roaring_bitmap_portable_size_in_bytes(&roaring);
-        else
-            return api::roaring_bitmap_size_in_bytes(&roaring);
-    }
-
-    static const Roaring frozenView(const char *buf, size_t length) {
-        const roaring_bitmap_t *s =
-            api::roaring_bitmap_frozen_view(buf, length);
-        if (s == NULL) {
-            ROARING_TERMINATE("failed to read frozen bitmap");
-        }
-        Roaring r;
-        r.roaring = *s;
-        return r;
-    }
-
-    void writeFrozen(char *buf) const {
-        roaring_bitmap_frozen_serialize(&roaring, buf);
-    }
-
-    size_t getFrozenSizeInBytes() const {
-        return roaring_bitmap_frozen_size_in_bytes(&roaring);
-    }
-
-    /**
-     * Computes the intersection between two bitmaps and returns new bitmap.
-     * The current bitmap and the provided bitmap are unchanged.
-     */
-    Roaring operator&(const Roaring &o) const {
-        roaring_bitmap_t *r = api::roaring_bitmap_and(&roaring, &o.roaring);
-        if (r == NULL) {
-            ROARING_TERMINATE("failed materalization in and");
-        }
-        return Roaring(r);
-    }
-
-    /**
-     * Computes the difference between two bitmaps and returns new bitmap.
-     * The current bitmap and the provided bitmap are unchanged.
-     */
-    Roaring operator-(const Roaring &o) const {
-        roaring_bitmap_t *r = api::roaring_bitmap_andnot(&roaring, &o.roaring);
-        if (r == NULL) {
-            ROARING_TERMINATE("failed materalization in andnot");
-        }
-        return Roaring(r);
-    }
-
-    /**
-     * Computes the union between two bitmaps and returns new bitmap.
-     * The current bitmap and the provided bitmap are unchanged.
-     */
-    Roaring operator|(const Roaring &o) const {
-        roaring_bitmap_t *r = api::roaring_bitmap_or(&roaring, &o.roaring);
-        if (r == NULL) {
-            ROARING_TERMINATE("failed materalization in or");
-        }
-        return Roaring(r);
-    }
-
-    /**
-     * Computes the symmetric union between two bitmaps and returns new bitmap.
-     * The current bitmap and the provided bitmap are unchanged.
-     */
-    Roaring operator^(const Roaring &o) const {
-        roaring_bitmap_t *r = api::roaring_bitmap_xor(&roaring, &o.roaring);
-        if (r == NULL) {
-            ROARING_TERMINATE("failed materalization in xor");
-        }
-        return Roaring(r);
-    }
-
-    /**
-     * Whether or not we apply copy and write.
-     */
-    void setCopyOnWrite(bool val) {
-        api::roaring_bitmap_set_copy_on_write(&roaring, val);
-    }
-
-    /**
-     * Print the content of the bitmap
-     */
-    void printf() const { api::roaring_bitmap_printf(&roaring); }
-
-    /**
-     * Print the content of the bitmap into a string
-     */
-    std::string toString() const {
-        struct iter_data {
-            std::string str{}; // The empty constructor silences warnings from pedantic static analyzers.
-            char first_char = '{';
-        } outer_iter_data;
-        if (!isEmpty()) {
-            iterate(
-                [](uint32_t value, void *inner_iter_data) -> bool {
-                    ((iter_data *)inner_iter_data)->str +=
-                        ((iter_data *)inner_iter_data)->first_char;
-                    ((iter_data *)inner_iter_data)->str +=
-                        std::to_string(value);
-                    ((iter_data *)inner_iter_data)->first_char = ',';
-                    return true;
-                },
-                (void *)&outer_iter_data);
-        } else
-            outer_iter_data.str = '{';
-        outer_iter_data.str += '}';
-        return outer_iter_data.str;
-    }
-
-    /**
-     * Whether or not copy and write is active.
-     */
-    bool getCopyOnWrite() const {
-        return api::roaring_bitmap_get_copy_on_write(&roaring);
-    }
-
-    /**
-     * Computes the logical or (union) between "n" bitmaps (referenced by a
-     * pointer).
-     */
-    static Roaring fastunion(size_t n, const Roaring **inputs) {
-        const roaring_bitmap_t **x =
-            (const roaring_bitmap_t **)roaring_malloc(n * sizeof(roaring_bitmap_t *));
-        if (x == NULL) {
-            ROARING_TERMINATE("failed memory alloc in fastunion");
-        }
-        for (size_t k = 0; k < n; ++k) x[k] = &inputs[k]->roaring;
-
-        roaring_bitmap_t *c_ans = api::roaring_bitmap_or_many(n, x);
-        if (c_ans == NULL) {
-            roaring_free(x);
-            ROARING_TERMINATE("failed memory alloc in fastunion");
-        }
-        Roaring ans(c_ans);
-        roaring_free(x);
-        return ans;
-    }
-
-    typedef RoaringSetBitForwardIterator const_iterator;
-
-    /**
-     * Returns an iterator that can be used to access the position of the set
-     * bits. The running time complexity of a full scan is proportional to the
-     * number of set bits: be aware that if you have long strings of 1s, this
-     * can be very inefficient.
-     *
-     * It can be much faster to use the toArray method if you want to retrieve
-     * the set bits.
-     */
-    const_iterator begin() const;
-
-    /**
-     * A bogus iterator that can be used together with begin()
-     * for constructions such as for (auto i = b.begin(); * i!=b.end(); ++i) {}
-     */
-    const_iterator &end() const;
-
-    roaring_bitmap_t roaring;
-};
-
-/**
- * Used to go through the set bits. Not optimally fast, but convenient.
- */
-class RoaringSetBitForwardIterator final {
-public:
-    typedef std::forward_iterator_tag iterator_category;
-    typedef uint32_t *pointer;
-    typedef uint32_t &reference_type;
-    typedef uint32_t value_type;
-    typedef int32_t difference_type;
-    typedef RoaringSetBitForwardIterator type_of_iterator;
-
-    /**
-     * Provides the location of the set bit.
-     */
-    value_type operator*() const { return i.current_value; }
-
-    bool operator<(const type_of_iterator &o) const {
-        if (!i.has_value) return false;
-        if (!o.i.has_value) return true;
-        return i.current_value < *o;
-    }
-
-    bool operator<=(const type_of_iterator &o) const {
-        if (!o.i.has_value) return true;
-        if (!i.has_value) return false;
-        return i.current_value <= *o;
-    }
-
-    bool operator>(const type_of_iterator &o)  const {
-        if (!o.i.has_value) return false;
-        if (!i.has_value) return true;
-        return i.current_value > *o;
-    }
-
-    bool operator>=(const type_of_iterator &o)  const {
-        if (!i.has_value) return true;
-        if (!o.i.has_value) return false;
-        return i.current_value >= *o;
-    }
-
-    /**
-     * Move the iterator to the first value >= val.
-     */
-    void equalorlarger(uint32_t val) {
-        api::roaring_move_uint32_iterator_equalorlarger(&i,val);
-    }
-
-    type_of_iterator &operator++() {  // ++i, must returned inc. value
-        api::roaring_advance_uint32_iterator(&i);
-        return *this;
-    }
-
-    type_of_iterator operator++(int) {  // i++, must return orig. value
-        RoaringSetBitForwardIterator orig(*this);
-        api::roaring_advance_uint32_iterator(&i);
-        return orig;
-    }
-
-    type_of_iterator& operator--() { // prefix --
-        api::roaring_previous_uint32_iterator(&i);
-        return *this;
-    }
-
-    type_of_iterator operator--(int) { // postfix --
-        RoaringSetBitForwardIterator orig(*this);
-        api::roaring_previous_uint32_iterator(&i);
-        return orig;
-    }
-
-    bool operator==(const RoaringSetBitForwardIterator &o) const {
-        return i.current_value == *o && i.has_value == o.i.has_value;
-    }
-
-    bool operator!=(const RoaringSetBitForwardIterator &o) const {
-        return i.current_value != *o || i.has_value != o.i.has_value;
-    }
-
-    RoaringSetBitForwardIterator(const Roaring &parent,
-                                 bool exhausted = false) {
-        if (exhausted) {
-            i.parent = &parent.roaring;
-            i.container_index = INT32_MAX;
-            i.has_value = false;
-            i.current_value = UINT32_MAX;
-        } else {
-            api::roaring_init_iterator(&parent.roaring, &i);
-        }
-    }
-
-    api::roaring_uint32_iterator_t i{}; // The empty constructor silences warnings from pedantic static analyzers.
-};
-
-inline RoaringSetBitForwardIterator Roaring::begin() const {
-    return RoaringSetBitForwardIterator(*this);
-}
-
-inline RoaringSetBitForwardIterator &Roaring::end() const {
-    static RoaringSetBitForwardIterator e(*this, true);
-    return e;
-}
-
-}  // namespace roaring
-
-#endif /* INCLUDE_ROARING_HH_ */
-/* end file cpp/roaring.hh */
-/* begin file cpp/roaring64map.hh */
-/*
-A C++ header for 64-bit Roaring Bitmaps, implemented by way of a map of many
-32-bit Roaring Bitmaps.
-*/
-#ifndef INCLUDE_ROARING_64_MAP_HH_
-#define INCLUDE_ROARING_64_MAP_HH_
-
-#include <algorithm>
-#include <cstdarg>  // for va_list handling in bitmapOf()
-#include <cstdio>  // for std::printf() in the printf() method
-#include <cstring>  // for std::memcpy()
-#include <limits>
-#include <map>
-#include <new>
-#include <numeric>
-#include <stdexcept>
-#include <string>
-#include <utility>
-
-using roaring::Roaring;
-
-namespace roaring {
-
-class Roaring64MapSetBitForwardIterator;
-class Roaring64MapSetBitBiDirectionalIterator;
-
-class Roaring64Map {
-    typedef api::roaring_bitmap_t roaring_bitmap_t;
-
-public:
-    /**
-     * Create an empty bitmap
-     */
-    Roaring64Map() = default;
-
-    /**
-     * Construct a bitmap from a list of 32-bit integer values.
-     */
-    Roaring64Map(size_t n, const uint32_t *data) { addMany(n, data); }
-
-    /**
-     * Construct a bitmap from a list of 64-bit integer values.
-     */
-    Roaring64Map(size_t n, const uint64_t *data) { addMany(n, data); }
-
-    /**
-     * Construct a 64-bit map from a 32-bit one
-     */
-    explicit Roaring64Map(const Roaring &r) { emplaceOrInsert(0, r); }
-
-    /**
-     * Construct a roaring object from the C struct.
-     *
-     * Passing a NULL point is unsafe.
-     */
-    explicit Roaring64Map(roaring_bitmap_t *s) {
-        Roaring r(s);
-        emplaceOrInsert(0, r);
-    }
-
-    Roaring64Map(const Roaring64Map& r)
-        : roarings(r.roarings),
-          copyOnWrite(r.copyOnWrite) { }
-
-    Roaring64Map(Roaring64Map&& r)
-        : roarings(r.roarings),
-          copyOnWrite(r.copyOnWrite) { }
-
-    /**
-     * Assignment operator.
-     */
-    Roaring64Map &operator=(const Roaring64Map &r) {
-        roarings = r.roarings;
-        return *this;
-    }
-
-    /**
-     * Construct a bitmap from a list of integer values.
-     */
-    static Roaring64Map bitmapOf(size_t n...) {
-        Roaring64Map ans;
-        va_list vl;
-        va_start(vl, n);
-        for (size_t i = 0; i < n; i++) {
-            ans.add(va_arg(vl, uint64_t));
-        }
-        va_end(vl);
-        return ans;
-    }
-
-    /**
-     * Add value x
-     */
-    void add(uint32_t x) {
-        roarings[0].add(x);
-        roarings[0].setCopyOnWrite(copyOnWrite);
-    }
-    void add(uint64_t x) {
-        roarings[highBytes(x)].add(lowBytes(x));
-        roarings[highBytes(x)].setCopyOnWrite(copyOnWrite);
-    }
-
-    /**
-     * Add value x
-     * Returns true if a new value was added, false if the value was already existing.
-     */
-    bool addChecked(uint32_t x) {
-        bool result = roarings[0].addChecked(x);
-        roarings[0].setCopyOnWrite(copyOnWrite);
-        return result;
-    }
-    bool addChecked(uint64_t x) {
-        bool result = roarings[highBytes(x)].addChecked(lowBytes(x));
-        roarings[highBytes(x)].setCopyOnWrite(copyOnWrite);
-        return result;
-    }
-
-    /**
-     * Add value n_args from pointer vals
-     */
-    void addMany(size_t n_args, const uint32_t *vals) {
-        for (size_t lcv = 0; lcv < n_args; lcv++) {
-            roarings[0].add(vals[lcv]);
-            roarings[0].setCopyOnWrite(copyOnWrite);
-        }
-    }
-    void addMany(size_t n_args, const uint64_t *vals) {
-        for (size_t lcv = 0; lcv < n_args; lcv++) {
-            roarings[highBytes(vals[lcv])].add(lowBytes(vals[lcv]));
-            roarings[highBytes(vals[lcv])].setCopyOnWrite(copyOnWrite);
-        }
-    }
-
-    /**
-     * Remove value x
-     */
-    void remove(uint32_t x) { roarings[0].remove(x); }
-    void remove(uint64_t x) {
-        auto roaring_iter = roarings.find(highBytes(x));
-        if (roaring_iter != roarings.cend())
-            roaring_iter->second.remove(lowBytes(x));
-    }
-
-    /**
-     * Remove value x
-     * Returns true if a new value was removed, false if the value was not existing.
-     */
-    bool removeChecked(uint32_t x) {
-        return roarings[0].removeChecked(x);
-    }
-    bool removeChecked(uint64_t x) {
-        auto roaring_iter = roarings.find(highBytes(x));
-        if (roaring_iter != roarings.cend())
-            return roaring_iter->second.removeChecked(lowBytes(x));
-        return false;
-    }
-
-    /**
-     * Clear the bitmap
-     */
-    void clear() {
-        roarings.clear();
-    }
-
-    /**
-     * Return the largest value (if not empty)
-     */
-    uint64_t maximum() const {
-        for (auto roaring_iter = roarings.crbegin();
-             roaring_iter != roarings.crend(); ++roaring_iter) {
-            if (!roaring_iter->second.isEmpty()) {
-                return uniteBytes(roaring_iter->first,
-                                  roaring_iter->second.maximum());
-            }
-        }
-        // we put std::numeric_limits<>::max/min in parenthesis
-        // to avoid a clash with the Windows.h header under Windows
-        return (std::numeric_limits<uint64_t>::min)();
-    }
-
-    /**
-     * Return the smallest value (if not empty)
-     */
-    uint64_t minimum() const {
-        for (auto roaring_iter = roarings.cbegin();
-             roaring_iter != roarings.cend(); ++roaring_iter) {
-            if (!roaring_iter->second.isEmpty()) {
-                return uniteBytes(roaring_iter->first,
-                                  roaring_iter->second.minimum());
-            }
-        }
-        // we put std::numeric_limits<>::max/min in parenthesis
-        // to avoid a clash with the Windows.h header under Windows
-        return (std::numeric_limits<uint64_t>::max)();
-    }
-
-    /**
-     * Check if value x is present
-     */
-    bool contains(uint32_t x) const {
-        return roarings.count(0) == 0 ? false : roarings.at(0).contains(x);
-    }
-    bool contains(uint64_t x) const {
-        return roarings.count(highBytes(x)) == 0
-            ? false
-            : roarings.at(highBytes(x)).contains(lowBytes(x));
-    }
-
-    /**
-     * Compute the intersection between the current bitmap and the provided
-     * bitmap, writing the result in the current bitmap. The provided bitmap
-     * is not modified.
-     */
-    Roaring64Map &operator&=(const Roaring64Map &r) {
-        for (auto &map_entry : roarings) {
-            if (r.roarings.count(map_entry.first) == 1)
-                map_entry.second &= r.roarings.at(map_entry.first);
-            else
-                map_entry.second = Roaring();
-        }
-        return *this;
-    }
-
-    /**
-     * Compute the difference between the current bitmap and the provided
-     * bitmap, writing the result in the current bitmap. The provided bitmap
-     * is not modified.
-     */
-    Roaring64Map &operator-=(const Roaring64Map &r) {
-        for (auto &map_entry : roarings) {
-            if (r.roarings.count(map_entry.first) == 1)
-                map_entry.second -= r.roarings.at(map_entry.first);
-        }
-        return *this;
-    }
-
-    /**
-     * Compute the union between the current bitmap and the provided bitmap,
-     * writing the result in the current bitmap. The provided bitmap is not
-     * modified.
-     *
-     * See also the fastunion function to aggregate many bitmaps more quickly.
-     */
-    Roaring64Map &operator|=(const Roaring64Map &r) {
-        for (const auto &map_entry : r.roarings) {
-            if (roarings.count(map_entry.first) == 0) {
-                roarings[map_entry.first] = map_entry.second;
-                roarings[map_entry.first].setCopyOnWrite(copyOnWrite);
-            } else
-                roarings[map_entry.first] |= map_entry.second;
-        }
-        return *this;
-    }
-
-    /**
-     * Compute the symmetric union between the current bitmap and the provided
-     * bitmap, writing the result in the current bitmap. The provided bitmap
-     * is not modified.
-     */
-    Roaring64Map &operator^=(const Roaring64Map &r) {
-        for (const auto &map_entry : r.roarings) {
-            if (roarings.count(map_entry.first) == 0) {
-                roarings[map_entry.first] = map_entry.second;
-                roarings[map_entry.first].setCopyOnWrite(copyOnWrite);
-            } else
-                roarings[map_entry.first] ^= map_entry.second;
-        }
-        return *this;
-    }
-
-    /**
-     * Exchange the content of this bitmap with another.
-     */
-    void swap(Roaring64Map &r) { roarings.swap(r.roarings); }
-
-    /**
-     * Get the cardinality of the bitmap (number of elements).
-     * Throws std::length_error in the special case where the bitmap is full
-     * (cardinality() == 2^64). Check isFull() before calling to avoid
-     * exception.
-     */
-    uint64_t cardinality() const {
-        if (isFull()) {
-#if ROARING_EXCEPTIONS
-            throw std::length_error("bitmap is full, cardinality is 2^64, "
-                                    "unable to represent in a 64-bit integer");
-#else
-            ROARING_TERMINATE("bitmap is full, cardinality is 2^64, "
-                              "unable to represent in a 64-bit integer");
-#endif
-        }
-        return std::accumulate(
-            roarings.cbegin(), roarings.cend(), (uint64_t)0,
-            [](uint64_t previous,
-               const std::pair<const uint32_t, Roaring> &map_entry) {
-                return previous + map_entry.second.cardinality();
-            });
-    }
-
-    /**
-     * Returns true if the bitmap is empty (cardinality is zero).
-     */
-    bool isEmpty() const {
-        return std::all_of(roarings.cbegin(), roarings.cend(),
-                           [](const std::pair<const uint32_t, Roaring> &map_entry) {
-                               return map_entry.second.isEmpty();
-                           });
-    }
-
-    /**
-     * Returns true if the bitmap is full (cardinality is max uint64_t + 1).
-     */
-    bool isFull() const {
-        // only bother to check if map is fully saturated
-        //
-        // we put std::numeric_limits<>::max/min in parenthesis
-        // to avoid a clash with the Windows.h header under Windows
-        return roarings.size() ==
-            ((uint64_t)(std::numeric_limits<uint32_t>::max)()) + 1
-            ? std::all_of(
-                roarings.cbegin(), roarings.cend(),
-                [](const std::pair<const uint32_t, Roaring> &roaring_map_entry) {
-                    // roarings within map are saturated if cardinality
-                    // is uint32_t max + 1
-                    return roaring_map_entry.second.cardinality() ==
-                        ((uint64_t)
-                         (std::numeric_limits<uint32_t>::max)()) +
-                        1;
-                })
-            : false;
-    }
-
-    /**
-     * Returns true if the bitmap is subset of the other.
-     */
-    bool isSubset(const Roaring64Map &r) const {
-        for (const auto &map_entry : roarings) {
-            auto roaring_iter = r.roarings.find(map_entry.first);
-            if (roaring_iter == r.roarings.cend())
-                return false;
-            else if (!map_entry.second.isSubset(roaring_iter->second))
-                return false;
-        }
-        return true;
-    }
-
-    /**
-     * Returns true if the bitmap is strict subset of the other.
-     * Throws std::length_error in the special case where the bitmap is full
-     * (cardinality() == 2^64). Check isFull() before calling to avoid exception.
-     */
-    bool isStrictSubset(const Roaring64Map &r) const {
-        return isSubset(r) && cardinality() != r.cardinality();
-    }
-
-    /**
-     * Convert the bitmap to an array. Write the output to "ans",
-     * caller is responsible to ensure that there is enough memory
-     * allocated
-     * (e.g., ans = new uint32[mybitmap.cardinality()];)
-     */
-    void toUint64Array(uint64_t *ans) const {
-        // Annoyingly, VS 2017 marks std::accumulate() as [[nodiscard]]
-        (void)std::accumulate(roarings.cbegin(), roarings.cend(), ans,
-                              [](uint64_t *previous,
-                                 const std::pair<const uint32_t, Roaring> &map_entry) {
-                                  for (uint32_t low_bits : map_entry.second)
-                                      *previous++ =
-                                          uniteBytes(map_entry.first, low_bits);
-                                  return previous;
-                              });
-    }
-
-    /**
-     * Return true if the two bitmaps contain the same elements.
-     */
-    bool operator==(const Roaring64Map &r) const {
-        // we cannot use operator == on the map because either side may contain
-        // empty Roaring Bitmaps
-        auto lhs_iter = roarings.cbegin();
-        auto lhs_cend = roarings.cend();
-        auto rhs_iter = r.roarings.cbegin();
-        auto rhs_cend = r.roarings.cend();
-        while (lhs_iter != lhs_cend && rhs_iter != rhs_cend) {
-            auto lhs_key = lhs_iter->first, rhs_key = rhs_iter->first;
-            const auto &lhs_map = lhs_iter->second, &rhs_map = rhs_iter->second;
-            if (lhs_map.isEmpty()) {
-                ++lhs_iter;
-                continue;
-            }
-            if (rhs_map.isEmpty()) {
-                ++rhs_iter;
-                continue;
-            }
-            if (!(lhs_key == rhs_key)) {
-                return false;
-            }
-            if (!(lhs_map == rhs_map)) {
-                return false;
-            }
-            ++lhs_iter;
-            ++rhs_iter;
-        }
-        while (lhs_iter != lhs_cend) {
-            if (!lhs_iter->second.isEmpty()) {
-                return false;
-            }
-            ++lhs_iter;
-        }
-        while (rhs_iter != rhs_cend) {
-            if (!rhs_iter->second.isEmpty()) {
-                return false;
-            }
-            ++rhs_iter;
-        }
-        return true;
-    }
-
-    /**
-     * Compute the negation of the roaring bitmap within a specified interval.
-     * areas outside the range are passed through unchanged.
-     */
-    void flip(uint64_t range_start, uint64_t range_end) {
-        uint32_t start_high = highBytes(range_start);
-        uint32_t start_low = lowBytes(range_start);
-        uint32_t end_high = highBytes(range_end);
-        uint32_t end_low = lowBytes(range_end);
-
-        if (start_high == end_high) {
-            roarings[start_high].flip(start_low, end_low);
-            return;
-        }
-        // we put std::numeric_limits<>::max/min in parenthesis
-        // to avoid a clash with the Windows.h header under Windows
-        roarings[start_high].flip(start_low,
-                                  (std::numeric_limits<uint32_t>::max)());
-        roarings[start_high++].setCopyOnWrite(copyOnWrite);
-
-        for (; start_high <= highBytes(range_end) - 1; ++start_high) {
-            roarings[start_high].flip((std::numeric_limits<uint32_t>::min)(),
-                                      (std::numeric_limits<uint32_t>::max)());
-            roarings[start_high].setCopyOnWrite(copyOnWrite);
-        }
-
-        roarings[start_high].flip((std::numeric_limits<uint32_t>::min)(),
-                                  end_low);
-        roarings[start_high].setCopyOnWrite(copyOnWrite);
-    }
-
-    /**
-     * Remove run-length encoding even when it is more space efficient
-     * return whether a change was applied
-     */
-    bool removeRunCompression() {
-        return std::accumulate(
-            roarings.begin(), roarings.end(), true,
-            [](bool previous, std::pair<const uint32_t, Roaring> &map_entry) {
-                return map_entry.second.removeRunCompression() && previous;
-            });
-    }
-
-    /**
-     * Convert array and bitmap containers to run containers when it is more
-     * efficient; also convert from run containers when more space efficient.
-     * Returns true if the result has at least one run container.
-     * Additional savings might be possible by calling shrinkToFit().
-     */
-    bool runOptimize() {
-        return std::accumulate(
-            roarings.begin(), roarings.end(), true,
-            [](bool previous, std::pair<const uint32_t, Roaring> &map_entry) {
-                return map_entry.second.runOptimize() && previous;
-            });
-    }
-
-    /**
-     * If needed, reallocate memory to shrink the memory usage.
-     * Returns the number of bytes saved.
-     */
-    size_t shrinkToFit() {
-        size_t savedBytes = 0;
-        auto iter = roarings.begin();
-        while (iter != roarings.cend()) {
-            if (iter->second.isEmpty()) {
-                // empty Roarings are 84 bytes
-                savedBytes += 88;
-                roarings.erase(iter++);
-            } else {
-                savedBytes += iter->second.shrinkToFit();
-                iter++;
-            }
-        }
-        return savedBytes;
-    }
-
-    /**
-     * Iterate over the bitmap elements in order(start from the smallest one)
-     * and call iterator once for every element until the iterator function
-     * returns false. To iterate over all values, the iterator function should
-     * always return true.
-     *
-     * The roaring_iterator64 parameter is a pointer to a function that
-     * returns bool (true means that the iteration should continue while false
-     * means that it should stop), and takes (uint64_t element, void* ptr) as
-     * inputs.
-     */
-    void iterate(api::roaring_iterator64 iterator, void *ptr) const {
-        for (const auto &map_entry : roarings) {
-            bool should_continue =
-                roaring_iterate64(&map_entry.second.roaring, iterator,
-                                  uint64_t(map_entry.first) << 32, ptr);
-            if (!should_continue) {
-                break;
-            }
-        }
-    }
-
-    /**
-     * If the size of the roaring bitmap is strictly greater than rank, then
-     * this function returns true and set element to the element of given
-     * rank.  Otherwise, it returns false.
-     */
-    bool select(uint64_t rnk, uint64_t *element) const {
-        for (const auto &map_entry : roarings) {
-            uint64_t sub_cardinality = (uint64_t)map_entry.second.cardinality();
-            if (rnk < sub_cardinality) {
-                *element = ((uint64_t)map_entry.first) << 32;
-                // assuming little endian
-                return map_entry.second.select((uint32_t)rnk,
-                                               ((uint32_t *)element));
-            }
-            rnk -= sub_cardinality;
-        }
-        return false;
-    }
-
-    /**
-     * Returns the number of integers that are smaller or equal to x.
-     */
-    uint64_t rank(uint64_t x) const {
-        uint64_t result = 0;
-        auto roaring_destination = roarings.find(highBytes(x));
-        if (roaring_destination != roarings.cend()) {
-            for (auto roaring_iter = roarings.cbegin();
-                 roaring_iter != roaring_destination; ++roaring_iter) {
-                result += roaring_iter->second.cardinality();
-            }
-            result += roaring_destination->second.rank(lowBytes(x));
-            return result;
-        }
-        roaring_destination = roarings.lower_bound(highBytes(x));
-        for (auto roaring_iter = roarings.cbegin();
-             roaring_iter != roaring_destination; ++roaring_iter) {
-            result += roaring_iter->second.cardinality();
-        }
-        return result;
-    }
-
-    /**
-     * Write a bitmap to a char buffer. This is meant to be compatible with
-     * the Java and Go versions. Returns how many bytes were written which
-     * should be getSizeInBytes().
-     *
-     * Setting the portable flag to false enables a custom format that
-     * can save space compared to the portable format (e.g., for very
-     * sparse bitmaps).
-     */
-    size_t write(char *buf, bool portable = true) const {
-        const char *orig = buf;
-        // push map size
-        uint64_t map_size = roarings.size();
-        std::memcpy(buf, &map_size, sizeof(uint64_t));
-        buf += sizeof(uint64_t);
-        std::for_each(
-            roarings.cbegin(), roarings.cend(),
-            [&buf, portable](const std::pair<const uint32_t, Roaring> &map_entry) {
-                // push map key
-                std::memcpy(buf, &map_entry.first, sizeof(uint32_t));
-                // ^-- Note: `*((uint32_t*)buf) = map_entry.first;` is undefined
-
-                buf += sizeof(uint32_t);
-                // push map value Roaring
-                buf += map_entry.second.write(buf, portable);
-            });
-        return buf - orig;
-    }
-
-    /**
-     * Read a bitmap from a serialized version. This is meant to be compatible
-     * with the Java and Go versions.
-     *
-     * Setting the portable flag to false enable a custom format that
-     * can save space compared to the portable format (e.g., for very
-     * sparse bitmaps).
-     *
-     * This function is unsafe in the sense that if you provide bad data, many
-     * bytes could be read, possibly causing a buffer overflow. See also
-     * readSafe.
-     */
-    static Roaring64Map read(const char *buf, bool portable = true) {
-        Roaring64Map result;
-        // get map size
-        uint64_t map_size;
-        std::memcpy(&map_size, buf, sizeof(uint64_t));
-        buf += sizeof(uint64_t);
-        for (uint64_t lcv = 0; lcv < map_size; lcv++) {
-            // get map key
-            uint32_t key;
-            std::memcpy(&key, buf, sizeof(uint32_t));
-            // ^-- Note: `uint32_t key = *((uint32_t*)buf);` is undefined
-
-            buf += sizeof(uint32_t);
-            // read map value Roaring
-            Roaring read_var = Roaring::read(buf, portable);
-            // forward buffer past the last Roaring Bitmap
-            buf += read_var.getSizeInBytes(portable);
-            result.emplaceOrInsert(key, std::move(read_var));
-        }
-        return result;
-    }
-
-    /**
-     * Read a bitmap from a serialized version, reading no more than maxbytes
-     * bytes.  This is meant to be compatible with the Java and Go versions.
-     *
-     * Setting the portable flag to false enable a custom format that can save
-     * space compared to the portable format (e.g., for very sparse bitmaps).
-     */
-    static Roaring64Map readSafe(const char *buf, size_t maxbytes) {
-        Roaring64Map result;
-        // get map size
-        uint64_t map_size;
-        std::memcpy(&map_size, buf, sizeof(uint64_t));
-        buf += sizeof(uint64_t);
-        for (uint64_t lcv = 0; lcv < map_size; lcv++) {
-            // get map key
-            if(maxbytes < sizeof(uint32_t)) {
-#if ROARING_EXCEPTIONS
-                throw std::runtime_error("ran out of bytes");
-#else
-                ROARING_TERMINATE("ran out of bytes");
-#endif
-            }
-            uint32_t key;
-            std::memcpy(&key, buf, sizeof(uint32_t));
-            // ^-- Note: `uint32_t key = *((uint32_t*)buf);` is undefined
-
-            buf += sizeof(uint32_t);
-            maxbytes -= sizeof(uint32_t);
-            // read map value Roaring
-            Roaring read_var = Roaring::readSafe(buf, maxbytes);
-            // forward buffer past the last Roaring Bitmap
-            size_t tz = read_var.getSizeInBytes(true);
-            buf += tz;
-            maxbytes -= tz;
-            result.emplaceOrInsert(key, std::move(read_var));
-        }
-        return result;
-    }
-
-    /**
-     * Return the number of bytes required to serialize this bitmap (meant to
-     * be compatible with Java and Go versions)
-     *
-     * Setting the portable flag to false enable a custom format that can save
-     * space compared to the portable format (e.g., for very sparse bitmaps).
-     */
-    size_t getSizeInBytes(bool portable = true) const {
-        // start with, respectively, map size and size of keys for each map
-        // entry
-        return std::accumulate(
-            roarings.cbegin(), roarings.cend(),
-            sizeof(uint64_t) + roarings.size() * sizeof(uint32_t),
-            [=](size_t previous,
-                const std::pair<const uint32_t, Roaring> &map_entry) {
-                // add in bytes used by each Roaring
-                return previous + map_entry.second.getSizeInBytes(portable);
-            });
-    }
-
-    static const Roaring64Map frozenView(const char *buf) {
-        // size of bitmap buffer and key
-        const size_t metadata_size = sizeof(size_t) + sizeof(uint32_t);
-
-        Roaring64Map result;
-
-        // get map size
-        uint64_t map_size;
-        memcpy(&map_size, buf, sizeof(uint64_t));
-        buf += sizeof(uint64_t);
-
-        for (uint64_t lcv = 0; lcv < map_size; lcv++) {
-            // pad to 32 bytes minus the metadata size
-            while (((uintptr_t)buf + metadata_size) % 32 != 0) buf++;
-
-            // get bitmap size
-            size_t len;
-            memcpy(&len, buf, sizeof(size_t));
-            buf += sizeof(size_t);
-
-            // get map key
-            uint32_t key;
-            memcpy(&key, buf, sizeof(uint32_t));
-            buf += sizeof(uint32_t);
-
-            // read map value Roaring
-            const Roaring read = Roaring::frozenView(buf, len);
-            result.emplaceOrInsert(key, read);
-
-            // forward buffer past the last Roaring Bitmap
-            buf += len;
-        }
-        return result;
-    }
-
-    // As with serialized 64-bit bitmaps, 64-bit frozen bitmaps are serialized
-    // by concatenating one or more Roaring::write output buffers with the
-    // preceeding map key. Unlike standard bitmap serialization, frozen bitmaps
-    // must be 32-byte aligned and requires a buffer length to parse. As a
-    // result, each concatenated output of Roaring::writeFrozen is preceeded by
-    // padding, the buffer size (size_t), and the map key (uint32_t). The
-    // padding is used to ensure 32-byte alignment, but since it is followed by
-    // the buffer size and map key, it actually pads to `(x - sizeof(size_t) +
-    // sizeof(uint32_t)) mod 32` to leave room for the metadata.
-    void writeFrozen(char *buf) const {
-        // size of bitmap buffer and key
-        const size_t metadata_size = sizeof(size_t) + sizeof(uint32_t);
-
-        // push map size
-        uint64_t map_size = roarings.size();
-        memcpy(buf, &map_size, sizeof(uint64_t));
-        buf += sizeof(uint64_t);
-
-        for (auto &map_entry : roarings) {
-            size_t frozenSizeInBytes = map_entry.second.getFrozenSizeInBytes();
-
-            // pad to 32 bytes minus the metadata size
-            while (((uintptr_t)buf + metadata_size) % 32 != 0) buf++;
-
-            // push bitmap size
-            memcpy(buf, &frozenSizeInBytes, sizeof(size_t));
-            buf += sizeof(size_t);
-
-            // push map key
-            memcpy(buf, &map_entry.first, sizeof(uint32_t));
-            buf += sizeof(uint32_t);
-
-            // push map value Roaring
-            map_entry.second.writeFrozen(buf);
-            buf += map_entry.second.getFrozenSizeInBytes();
-        }
-    }
-
-    size_t getFrozenSizeInBytes() const {
-        // size of bitmap size and map key
-        const size_t metadata_size = sizeof(size_t) + sizeof(uint32_t);
-        size_t ret = 0;
-
-        // map size
-        ret += sizeof(uint64_t);
-
-        for (auto &map_entry : roarings) {
-            // pad to 32 bytes minus the metadata size
-            while ((ret + metadata_size) % 32 != 0) ret++;
-            ret += metadata_size;
-
-            // frozen bitmaps must be 32-byte aligned
-            ret += map_entry.second.getFrozenSizeInBytes();
-        }
-        return ret;
-    }
-
-    /**
-     * Computes the intersection between two bitmaps and returns new bitmap.
-     * The current bitmap and the provided bitmap are unchanged.
-     */
-    Roaring64Map operator&(const Roaring64Map &o) const {
-        return Roaring64Map(*this) &= o;
-    }
-
-    /**
-     * Computes the difference between two bitmaps and returns new bitmap.
-     * The current bitmap and the provided bitmap are unchanged.
-     */
-    Roaring64Map operator-(const Roaring64Map &o) const {
-        return Roaring64Map(*this) -= o;
-    }
-
-    /**
-     * Computes the union between two bitmaps and returns new bitmap.
-     * The current bitmap and the provided bitmap are unchanged.
-     */
-    Roaring64Map operator|(const Roaring64Map &o) const {
-        return Roaring64Map(*this) |= o;
-    }
-
-    /**
-     * Computes the symmetric union between two bitmaps and returns new bitmap.
-     * The current bitmap and the provided bitmap are unchanged.
-     */
-    Roaring64Map operator^(const Roaring64Map &o) const {
-        return Roaring64Map(*this) ^= o;
-    }
-
-    /**
-     * Whether or not we apply copy and write.
-     */
-    void setCopyOnWrite(bool val) {
-        if (copyOnWrite == val) return;
-        copyOnWrite = val;
-        std::for_each(roarings.begin(), roarings.end(),
-                      [=](std::pair<const uint32_t, Roaring> &map_entry) {
-                          map_entry.second.setCopyOnWrite(val);
-                      });
-    }
-
-    /**
-     * Print the content of the bitmap
-     */
-    void printf() const {
-        if (!isEmpty()) {
-            auto map_iter = roarings.cbegin();
-            while (map_iter->second.isEmpty()) ++map_iter;
-            struct iter_data {
-                uint32_t high_bits{};
-                char first_char{'{'};
-            } outer_iter_data;
-            outer_iter_data.high_bits = roarings.begin()->first;
-            map_iter->second.iterate(
-                [](uint32_t low_bits, void *inner_iter_data) -> bool {
-                    std::printf("%c%llu",
-                                ((iter_data *)inner_iter_data)->first_char,
-                                (long long unsigned)uniteBytes(
-                                    ((iter_data *)inner_iter_data)->high_bits,
-                                    low_bits));
-                    ((iter_data *)inner_iter_data)->first_char = ',';
-                    return true;
-                },
-                (void *)&outer_iter_data);
-            std::for_each(
-                ++map_iter, roarings.cend(),
-                [](const std::pair<const uint32_t, Roaring> &map_entry) {
-                    map_entry.second.iterate(
-                        [](uint32_t low_bits, void *high_bits) -> bool {
-                            std::printf(",%llu",
-                                        (long long unsigned)uniteBytes(
-                                            *(uint32_t *)high_bits, low_bits));
-                            return true;
-                        },
-                        (void *)&map_entry.first);
-                });
-        } else
-            std::printf("{");
-        std::printf("}\n");
-    }
-
-    /**
-     * Print the content of the bitmap into a string
-     */
-    std::string toString() const {
-        struct iter_data {
-            std::string str{}; // The empty constructor silences warnings from pedantic static analyzers.
-            uint32_t high_bits{0};
-            char first_char{'{'};
-        } outer_iter_data;
-        if (!isEmpty()) {
-            auto map_iter = roarings.cbegin();
-            while (map_iter->second.isEmpty()) ++map_iter;
-            outer_iter_data.high_bits = roarings.begin()->first;
-            map_iter->second.iterate(
-                [](uint32_t low_bits, void *inner_iter_data) -> bool {
-                    ((iter_data *)inner_iter_data)->str +=
-                        ((iter_data *)inner_iter_data)->first_char;
-                    ((iter_data *)inner_iter_data)->str += std::to_string(
-                        uniteBytes(((iter_data *)inner_iter_data)->high_bits,
-                                   low_bits));
-                    ((iter_data *)inner_iter_data)->first_char = ',';
-                    return true;
-                },
-                (void *)&outer_iter_data);
-            std::for_each(
-                ++map_iter, roarings.cend(),
-                [&outer_iter_data](
-                    const std::pair<const uint32_t, Roaring> &map_entry) {
-                    outer_iter_data.high_bits = map_entry.first;
-                    map_entry.second.iterate(
-                        [](uint32_t low_bits, void *inner_iter_data) -> bool {
-                            ((iter_data *)inner_iter_data)->str +=
-                                ((iter_data *)inner_iter_data)->first_char;
-                            ((iter_data *)inner_iter_data)->str +=
-                                std::to_string(uniteBytes(
-                                    ((iter_data *)inner_iter_data)->high_bits,
-                                    low_bits));
-                            return true;
-                        },
-                        (void *)&outer_iter_data);
-                });
-        } else
-            outer_iter_data.str = '{';
-        outer_iter_data.str += '}';
-        return outer_iter_data.str;
-    }
-
-    /**
-     * Whether or not copy and write is active.
-     */
-    bool getCopyOnWrite() const { return copyOnWrite; }
-
-    /**
-     * Computes the logical or (union) between "n" bitmaps (referenced by a
-     * pointer).
-     */
-    static Roaring64Map fastunion(size_t n, const Roaring64Map **inputs) {
-        Roaring64Map ans;
-        // not particularly fast
-        for (size_t lcv = 0; lcv < n; ++lcv) {
-            ans |= *(inputs[lcv]);
-        }
-        return ans;
-    }
-
-    friend class Roaring64MapSetBitForwardIterator;
-    friend class Roaring64MapSetBitBiDirectionalIterator;
-    typedef Roaring64MapSetBitForwardIterator const_iterator;
-    typedef Roaring64MapSetBitBiDirectionalIterator const_bidirectional_iterator;
-
-    /**
-     * Returns an iterator that can be used to access the position of the set
-     * bits. The running time complexity of a full scan is proportional to the
-     * number of set bits: be aware that if you have long strings of 1s, this
-     * can be very inefficient.
-     *
-     * It can be much faster to use the toArray method if you want to
-     * retrieve the set bits.
-     */
-    const_iterator begin() const;
-
-    /**
-     * A bogus iterator that can be used together with begin()
-     * for constructions such as: for (auto i = b.begin(); * i!=b.end(); ++i) {}
-     */
-    const_iterator end() const;
-
-private:
-    std::map<uint32_t, Roaring> roarings{}; // The empty constructor silences warnings from pedantic static analyzers.
-    bool copyOnWrite{false};
-    static uint32_t highBytes(const uint64_t in) { return uint32_t(in >> 32); }
-    static uint32_t lowBytes(const uint64_t in) { return uint32_t(in); }
-    static uint64_t uniteBytes(const uint32_t highBytes,
-                               const uint32_t lowBytes) {
-        return (uint64_t(highBytes) << 32) | uint64_t(lowBytes);
-    }
-    // this is needed to tolerate gcc's C++11 libstdc++ lacking emplace
-    // prior to version 4.8
-    void emplaceOrInsert(const uint32_t key, const Roaring &value) {
-#if defined(__GLIBCXX__) && __GLIBCXX__ < 20130322
-        roarings.insert(std::make_pair(key, value));
-#else
-        roarings.emplace(std::make_pair(key, value));
-#endif
-    }
-
-    void emplaceOrInsert(const uint32_t key, Roaring &&value) {
-#if defined(__GLIBCXX__) && __GLIBCXX__ < 20130322
-        roarings.insert(std::make_pair(key, std::move(value)));
-#else
-        roarings.emplace(key, value);
-#endif
-    }
-};
-
-/**
- * Used to go through the set bits. Not optimally fast, but convenient.
- */
-class Roaring64MapSetBitForwardIterator {
-public:
-    typedef std::forward_iterator_tag iterator_category;
-    typedef uint64_t *pointer;
-    typedef uint64_t &reference_type;
-    typedef uint64_t value_type;
-    typedef int64_t difference_type;
-    typedef Roaring64MapSetBitForwardIterator type_of_iterator;
-
-    /**
-     * Provides the location of the set bit.
-     */
-    value_type operator*() const {
-        return Roaring64Map::uniteBytes(map_iter->first, i.current_value);
-    }
-
-    bool operator<(const type_of_iterator &o) const {
-        if (map_iter == map_end) return false;
-        if (o.map_iter == o.map_end) return true;
-        return **this < *o;
-    }
-
-    bool operator<=(const type_of_iterator &o) const {
-        if (o.map_iter == o.map_end) return true;
-        if (map_iter == map_end) return false;
-        return **this <= *o;
-    }
-
-    bool operator>(const type_of_iterator &o) const {
-        if (o.map_iter == o.map_end) return false;
-        if (map_iter == map_end) return true;
-        return **this > *o;
-    }
-
-    bool operator>=(const type_of_iterator &o) const {
-        if (map_iter == map_end) return true;
-        if (o.map_iter == o.map_end) return false;
-        return **this >= *o;
-    }
-
-    type_of_iterator &operator++() {  // ++i, must returned inc. value
-        if (i.has_value == true) roaring_advance_uint32_iterator(&i);
-        while (!i.has_value) {
-            map_iter++;
-            if (map_iter == map_end) return *this;
-            roaring_init_iterator(&map_iter->second.roaring, &i);
-        }
-        return *this;
-    }
-
-    type_of_iterator operator++(int) {  // i++, must return orig. value
-        Roaring64MapSetBitForwardIterator orig(*this);
-        roaring_advance_uint32_iterator(&i);
-        while (!i.has_value) {
-            map_iter++;
-            if (map_iter == map_end) return orig;
-            roaring_init_iterator(&map_iter->second.roaring, &i);
-        }
-        return orig;
-    }
-
-    bool move(const value_type& x) {
-        map_iter = p.lower_bound(Roaring64Map::highBytes(x));
-        if (map_iter != p.cend()) {
-            roaring_init_iterator(&map_iter->second.roaring, &i);
-            if (map_iter->first == Roaring64Map::highBytes(x)) {
-                if (roaring_move_uint32_iterator_equalorlarger(&i, Roaring64Map::lowBytes(x)))
-                    return true;
-                map_iter++;
-                if (map_iter == map_end) return false;
-                roaring_init_iterator(&map_iter->second.roaring, &i);
-            }
-            return true;
-        }
-        return false;
-    }
-
-    bool operator==(const Roaring64MapSetBitForwardIterator &o) const {
-        if (map_iter == map_end && o.map_iter == o.map_end) return true;
-        if (o.map_iter == o.map_end) return false;
-        return **this == *o;
-    }
-
-    bool operator!=(const Roaring64MapSetBitForwardIterator &o) const {
-        if (map_iter == map_end && o.map_iter == o.map_end) return false;
-        if (o.map_iter == o.map_end) return true;
-        return **this != *o;
-    }
-
-    Roaring64MapSetBitForwardIterator &operator=(const Roaring64MapSetBitForwardIterator& r) {
-        map_iter = r.map_iter;
-        map_end = r.map_end;
-        i = r.i;
-        return *this;
-    }
-
-    Roaring64MapSetBitForwardIterator(const Roaring64MapSetBitForwardIterator& r)
-        : p(r.p),
-          map_iter(r.map_iter),
-          map_end(r.map_end),
-          i(r.i)
-    {}
-
-    Roaring64MapSetBitForwardIterator(const Roaring64Map &parent,
-                                      bool exhausted = false)
-        : p(parent.roarings), map_end(parent.roarings.cend()) {
-        if (exhausted || parent.roarings.empty()) {
-            map_iter = parent.roarings.cend();
-        } else {
-            map_iter = parent.roarings.cbegin();
-            roaring_init_iterator(&map_iter->second.roaring, &i);
-            while (!i.has_value) {
-                map_iter++;
-                if (map_iter == map_end) return;
-                roaring_init_iterator(&map_iter->second.roaring, &i);
-            }
-        }
-    }
-
-protected:
-    const std::map<uint32_t, Roaring>& p;
-    std::map<uint32_t, Roaring>::const_iterator map_iter{}; // The empty constructor silences warnings from pedantic static analyzers.
-    std::map<uint32_t, Roaring>::const_iterator map_end{}; // The empty constructor silences warnings from pedantic static analyzers.
-    api::roaring_uint32_iterator_t i{}; // The empty constructor silences warnings from pedantic static analyzers.
-};
-
-class Roaring64MapSetBitBiDirectionalIterator final :public Roaring64MapSetBitForwardIterator {
-public:
-    explicit Roaring64MapSetBitBiDirectionalIterator(const Roaring64Map &parent,
-                                                     bool exhausted = false)
-        : Roaring64MapSetBitForwardIterator(parent, exhausted), map_begin(parent.roarings.cbegin())
-    {}
-
-    Roaring64MapSetBitBiDirectionalIterator &operator=(const Roaring64MapSetBitForwardIterator& r) {
-        *(Roaring64MapSetBitForwardIterator*)this = r;
-        return *this;
-    }
-
-    Roaring64MapSetBitBiDirectionalIterator& operator--() { //  --i, must return dec.value
-        if (map_iter == map_end) {
-            --map_iter;
-            roaring_init_iterator_last(&map_iter->second.roaring, &i);
-            if (i.has_value) return *this;
-        }
-
-        roaring_previous_uint32_iterator(&i);
-        while (!i.has_value) {
-            if (map_iter == map_begin) return *this;
-            map_iter--;
-            roaring_init_iterator_last(&map_iter->second.roaring, &i);
-        }
-        return *this;
-    }
-
-    Roaring64MapSetBitBiDirectionalIterator operator--(int) {  // i--, must return orig. value
-        Roaring64MapSetBitBiDirectionalIterator orig(*this);
-        if (map_iter == map_end) {
-            --map_iter;
-            roaring_init_iterator_last(&map_iter->second.roaring, &i);
-            return orig;
-        }
-
-        roaring_previous_uint32_iterator(&i);
-        while (!i.has_value) {
-            if (map_iter == map_begin) return orig;
-            map_iter--;
-            roaring_init_iterator_last(&map_iter->second.roaring, &i);
-        }
-        return orig;
-    }
-
-protected:
-    std::map<uint32_t, Roaring>::const_iterator map_begin;
-};
-
-inline Roaring64MapSetBitForwardIterator Roaring64Map::begin() const {
-    return Roaring64MapSetBitForwardIterator(*this);
-}
-
-inline Roaring64MapSetBitForwardIterator Roaring64Map::end() const {
-    return Roaring64MapSetBitForwardIterator(*this, true);
-}
-
-}  // namespace roaring
-
-#endif /* INCLUDE_ROARING_64_MAP_HH_ */
-/* end file cpp/roaring64map.hh */