roaring 0.0.0 → 0.2.0

data/ext/roaring/cext.c

@@ -0,0 +1,302 @@
+#include "ruby.h"
+#include "roaring.h"
+
+#include <stdio.h>
+
+static VALUE cRoaringBitmap;
+VALUE rb_mRoaring;
+
+#ifndef RBOOL
+#define RBOOL(x) ((x) ? Qtrue : Qfalse)
+#endif
+
+static inline uint32_t
+NUM2UINT32(VALUE num) {
+    if (!FIXNUM_P(num) && !RB_TYPE_P(num, T_BIGNUM)) {
+        rb_raise(rb_eTypeError, "wrong argument type %s (expected Integer)", rb_obj_classname(num));
+    } else if ((SIGNED_VALUE)num < (SIGNED_VALUE)INT2FIX(0)) {
+        rb_raise(rb_eRangeError, "Integer %"PRIdVALUE " must be >= 0 to use with Roaring::Bitmap", num);
+    } else {
+        return FIX2UINT(num);
+    }
+}
+
+static void rb_roaring_free(void *data)
+{
+    roaring_bitmap_free(data);
+}
+
+static size_t rb_roaring_memsize(const void *data)
+{
+    // This is probably an estimate, "frozen" refers to the "frozen"
+    // serialization format, which mimics the in-memory representation.
+    return sizeof(roaring_bitmap_t) + roaring_bitmap_frozen_size_in_bytes(data);
+}
+
+static const rb_data_type_t roaring_type = {
+    .wrap_struct_name = "roaring/bitmap",
+    .function = {
+        .dfree = rb_roaring_free,
+        .dsize = rb_roaring_memsize
+    },
+    .flags = RUBY_TYPED_FREE_IMMEDIATELY,
+};
+
+static VALUE rb_roaring_alloc(VALUE self)
+{
+    roaring_bitmap_t *data = roaring_bitmap_create();
+    return TypedData_Wrap_Struct(self, &roaring_type, data);
+}
+
+static roaring_bitmap_t *get_bitmap(VALUE obj) {
+    roaring_bitmap_t *bitmap;
+    TypedData_Get_Struct(obj, roaring_bitmap_t, &roaring_type, bitmap);
+    return bitmap;
+}
+
+static VALUE rb_roaring_initialize_copy(VALUE self, VALUE other) {
+    roaring_bitmap_t *self_data = get_bitmap(self);
+    roaring_bitmap_t *other_data = get_bitmap(other);
+
+    roaring_bitmap_overwrite(self_data, other_data);
+
+    return self;
+}
+
+static VALUE rb_roaring_cardinality(VALUE self)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+    uint64_t cardinality = roaring_bitmap_get_cardinality(data);
+    return ULONG2NUM(cardinality);
+}
+
+static VALUE rb_roaring_add(VALUE self, VALUE val)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+
+    uint32_t num = NUM2UINT32(val);
+    roaring_bitmap_add(data, num);
+    return self;
+}
+
+static VALUE rb_roaring_add_p(VALUE self, VALUE val)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+
+    uint32_t num = NUM2UINT32(val);
+    return roaring_bitmap_add_checked(data, num) ? self : Qnil;
+}
+
+static VALUE rb_roaring_remove(VALUE self, VALUE val)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+
+    uint32_t num = NUM2UINT32(val);
+    roaring_bitmap_remove(data, num);
+    return self;
+}
+
+static VALUE rb_roaring_remove_p(VALUE self, VALUE val)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+
+    uint32_t num = NUM2UINT32(val);
+    return roaring_bitmap_remove_checked(data, num) ? self : Qnil;
+}
+
+static VALUE rb_roaring_include_p(VALUE self, VALUE val)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+
+    uint32_t num = NUM2UINT32(val);
+    return RBOOL(roaring_bitmap_contains(data, num));
+}
+
+static VALUE rb_roaring_empty_p(VALUE self)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+    return RBOOL(roaring_bitmap_is_empty(data));
+}
+
+static VALUE rb_roaring_clear(VALUE self)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+    roaring_bitmap_clear(data);
+    return self;
+}
+
+bool rb_roaring_each_i(uint32_t value, void *param) {
+    rb_yield(UINT2NUM(value));
+    return true;  // iterate till the end
+}
+
+static VALUE rb_roaring_each(VALUE self)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+    roaring_iterate(data, rb_roaring_each_i, NULL);
+    return self;
+}
+
+static VALUE rb_roaring_aref(VALUE self, VALUE rankv)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+
+    uint32_t rank = NUM2UINT32(rankv);
+    uint32_t val;
+
+    if (roaring_bitmap_select(data, rank, &val)) {
+        return UINT2NUM(val);
+    } else {
+        return Qnil;
+    }
+    return self;
+}
+
+static VALUE rb_roaring_min(VALUE self)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+
+    if (roaring_bitmap_is_empty(data)) {
+        return Qnil;
+    } else {
+        uint32_t val = roaring_bitmap_minimum(data);
+        return UINT2NUM(val);
+    }
+}
+
+static VALUE rb_roaring_max(VALUE self)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+
+    if (roaring_bitmap_is_empty(data)) {
+        return Qnil;
+    } else {
+        uint32_t val = roaring_bitmap_maximum(data);
+        return UINT2NUM(val);
+    }
+}
+
+static VALUE rb_roaring_run_optimize(VALUE self)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+    return RBOOL(roaring_bitmap_run_optimize(data));
+}
+
+static VALUE rb_roaring_serialize(VALUE self)
+{
+    roaring_bitmap_t *data = get_bitmap(self);
+
+    size_t size = roaring_bitmap_portable_size_in_bytes(data);
+    VALUE str = rb_str_buf_new(size);
+
+    size_t written = roaring_bitmap_portable_serialize(data, RSTRING_PTR(str));
+    rb_str_set_len(str, written);
+
+    return str;
+}
+
+static VALUE rb_roaring_deserialize(VALUE self, VALUE str)
+{
+    roaring_bitmap_t *bitmap = roaring_bitmap_portable_deserialize_safe(RSTRING_PTR(str), RSTRING_LEN(str));
+
+    return TypedData_Wrap_Struct(cRoaringBitmap, &roaring_type, bitmap);
+}
+
+typedef roaring_bitmap_t *binary_func(const roaring_bitmap_t *, const roaring_bitmap_t *);
+static VALUE rb_roaring_binary_op(VALUE self, VALUE other, binary_func func) {
+    roaring_bitmap_t *self_data = get_bitmap(self);
+    roaring_bitmap_t *other_data = get_bitmap(other);
+
+    roaring_bitmap_t *result = func(self_data, other_data);
+
+    return TypedData_Wrap_Struct(cRoaringBitmap, &roaring_type, result);
+}
+
+typedef bool binary_func_bool(const roaring_bitmap_t *, const roaring_bitmap_t *);
+static VALUE rb_roaring_binary_op_bool(VALUE self, VALUE other, binary_func_bool func) {
+    roaring_bitmap_t *self_data = get_bitmap(self);
+    roaring_bitmap_t *other_data = get_bitmap(other);
+
+    bool result = func(self_data, other_data);
+    return RBOOL(result);
+}
+
+
+static VALUE rb_roaring_and(VALUE self, VALUE other)
+{
+    return rb_roaring_binary_op(self, other, roaring_bitmap_and);
+}
+
+static VALUE rb_roaring_or(VALUE self, VALUE other)
+{
+    return rb_roaring_binary_op(self, other, roaring_bitmap_or);
+}
+
+static VALUE rb_roaring_xor(VALUE self, VALUE other)
+{
+    return rb_roaring_binary_op(self, other, roaring_bitmap_xor);
+}
+
+static VALUE rb_roaring_andnot(VALUE self, VALUE other)
+{
+    return rb_roaring_binary_op(self, other, roaring_bitmap_andnot);
+}
+
+static VALUE rb_roaring_eq(VALUE self, VALUE other)
+{
+    return rb_roaring_binary_op_bool(self, other, roaring_bitmap_equals);
+}
+
+static VALUE rb_roaring_lt(VALUE self, VALUE other)
+{
+    return rb_roaring_binary_op_bool(self, other, roaring_bitmap_is_strict_subset);
+}
+
+static VALUE rb_roaring_lte(VALUE self, VALUE other)
+{
+    return rb_roaring_binary_op_bool(self, other, roaring_bitmap_is_subset);
+}
+
+static VALUE rb_roaring_intersect_p(VALUE self, VALUE other)
+{
+    return rb_roaring_binary_op_bool(self, other, roaring_bitmap_intersect);
+}
+
+void
+Init_roaring(void)
+{
+  rb_mRoaring = rb_define_module("Roaring");
+
+  cRoaringBitmap = rb_define_class_under(rb_mRoaring, "Bitmap", rb_cObject);
+  rb_define_alloc_func(cRoaringBitmap, rb_roaring_alloc);
+  rb_define_method(cRoaringBitmap, "initialize_copy", rb_roaring_initialize_copy, 1);
+  rb_define_method(cRoaringBitmap, "empty?", rb_roaring_empty_p, 0);
+  rb_define_method(cRoaringBitmap, "clear", rb_roaring_clear, 0);
+  rb_define_method(cRoaringBitmap, "cardinality", rb_roaring_cardinality, 0);
+  rb_define_method(cRoaringBitmap, "add", rb_roaring_add, 1);
+  rb_define_method(cRoaringBitmap, "add?", rb_roaring_add_p, 1);
+  rb_define_method(cRoaringBitmap, "<<", rb_roaring_add, 1);
+  rb_define_method(cRoaringBitmap, "remove", rb_roaring_remove, 1);
+  rb_define_method(cRoaringBitmap, "remove?", rb_roaring_remove_p, 1);
+  rb_define_method(cRoaringBitmap, "include?", rb_roaring_include_p, 1);
+  rb_define_method(cRoaringBitmap, "each", rb_roaring_each, 0);
+  rb_define_method(cRoaringBitmap, "[]", rb_roaring_aref, 1);
+
+  rb_define_method(cRoaringBitmap, "&", rb_roaring_and, 1);
+  rb_define_method(cRoaringBitmap, "|", rb_roaring_or, 1);
+  rb_define_method(cRoaringBitmap, "^", rb_roaring_xor, 1);
+  rb_define_method(cRoaringBitmap, "-", rb_roaring_andnot, 1);
+
+  rb_define_method(cRoaringBitmap, "==", rb_roaring_eq, 1);
+  rb_define_method(cRoaringBitmap, "<", rb_roaring_lt, 1);
+  rb_define_method(cRoaringBitmap, "<=", rb_roaring_lte, 1);
+  rb_define_method(cRoaringBitmap, "intersect?", rb_roaring_intersect_p, 1);
+
+  rb_define_method(cRoaringBitmap, "min", rb_roaring_min, 0);
+  rb_define_method(cRoaringBitmap, "max", rb_roaring_max, 0);
+
+  rb_define_method(cRoaringBitmap, "run_optimize", rb_roaring_run_optimize, 0);
+
+  rb_define_method(cRoaringBitmap, "serialize", rb_roaring_serialize, 0);
+  rb_define_singleton_method(cRoaringBitmap, "deserialize", rb_roaring_deserialize, 1);
+}

data/ext/roaring/extconf.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+submodule = "#{__dir__}/roaring/"
+
+$objs = ["cext.o", "#{submodule}/roaring.o"]
+$CPPFLAGS += " -I#{submodule} "
+
+create_makefile("roaring/roaring")

data/ext/roaring/roaring/LICENSE

@@ -0,0 +1,235 @@
+ The CRoaring project is under a dual license (Apache/MIT).
+Users of the library may choose one or the other license.
+
+------------------
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   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.
+
+-----------------------------------
+
+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

data/ext/roaring/roaring/README.md

@@ -0,0 +1,42 @@
+# CRoaringUnityBuild
+Dumps of CRoaring unity builds (for convenience)
+
+This code is automatically generated from https://github.com/RoaringBitmap/CRoaring
+
+## Building
+
+```bash
+ echo -e "#include <roaring.hh>\n int main(){Roaring x;}" > test.cpp && cc -c roaring.c -I. -std=c11 && c++ -o test test.cpp roaring.o -I. -std=c++11
+```
+
+You need to compile and link `roaring.c` with your project: this is not a header-only build.
+
+## Usage (C)
+
+```C
+#include <stdio.h>
+#include "roaring.c"
+int main() {
+  roaring_bitmap_t *r1 = roaring_bitmap_create();
+  for (uint32_t i = 100; i < 1000; i++) roaring_bitmap_add(r1, i);
+  printf("cardinality = %d\n", (int) roaring_bitmap_get_cardinality(r1));
+  roaring_bitmap_free(r1);
+  return 0;
+}
+```
+## Usage (C++)
+
+
+```C++
+#include <iostream>
+#include "roaring.hh"
+#include "roaring.c"
+int main() {
+  Roaring r1;
+  for (uint32_t i = 100; i < 1000; i++) {
+    r1.add(i);
+  }
+  std::cout << "cardinality = " << r1.cardinality() << std::endl;
+  return 0;
+}
+```