roaring 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8760a84dea46c898206d34cfad17efe16e53d1c0c3b5398db7ce8aa641e9b07
-  data.tar.gz: df1a1d1b60b5e3bdff65bb6995279844c6cc23e0f5aedca1a924704e937774ec
+  metadata.gz: 54a748fcae71c5cf513774177c51f101a9eebf4e256cb7c255830e3ce9e0120d
+  data.tar.gz: f34710a57c8a91757f0560cc673b256c4b103ef73640cb8fc9ee916b2afbaea1
 SHA512:
-  metadata.gz: 384f8731d1143eddc4a1db541f51271d10916fbe4d39ec649598fee1619d3fb73deade6a77e6b7850af3f1dd94a06bd757763c180ee89d3fa36ae9ab93ecb749
-  data.tar.gz: 7ebe63d64b779ef73ba4586ac91ecfc302e7b1aa1488ae320e366e72d2a7b778f53c85ab71121e17098be03a7d1b309294d24cfca12bc1bf75826e6a425f5bd5
+  metadata.gz: 28477225f8b0415f7309a0e1a0490236313c89273cd57b459389b6e7d71481c54c4701d0b877685c948eb8e9e900b4b3156559b70f5aa99894e86dee9546dc44
+  data.tar.gz: 9aa1826a4bf7ee418c2a0c84a14c3031df75e6ea26cbca9e779d3fc64af944f735453c65dd8aed322d95b2032b018eb1007f97e8a85c3aafef08b565bab811aa

data/Gemfile

@@ -6,3 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
+
+gem "rake-compiler"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -1,18 +1,29 @@
 PATH
   remote: .
   specs:
-    roaring (0.0.0)
+    roaring (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    forwardable (1.3.2)
+    minitest (5.15.0)
+    prime (0.1.2)
+      forwardable
+      singleton
     rake (13.0.6)
+    rake-compiler (1.2.0)
+      rake
+    singleton (0.1.1)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  minitest (~> 5.0)
+  prime
   rake (~> 13.0)
+  rake-compiler
   roaring!
 
 BUNDLED WITH

data/LICENSE.txt

@@ -1,21 +1,201 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 John Hawthorn
-
-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.
+                                 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 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.

data/README.md

@@ -1,32 +1,53 @@
 # Roaring
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/roaring`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Ruby wrapper for CRoaring (a C/C++ implementation at https://github.com/RoaringBitmap/CRoaring)
 
-TODO: Delete this and the text above, and describe your gem
+Roaring Bitmaps are a compressed bitmap/bitset format/library.
+More information and papers can be found at https://roaringbitmap.org/
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem and add to the application's Gemfile by executing:
 
-```ruby
-gem 'roaring'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install roaring
+    $ bundle add roaring
 
 ## Usage
 
-TODO: Write usage instructions here
+``` ruby
+require "roaring"
+
+# Bitmaps can efficiently store a large range of 32-bit integers
+bitmap = Roaring::Bitmap[1, 2, 3, 999]
+bitmap << (2**32 - 1)
+
+# Element access
+bitmap.each { }
+bitmap.first # => 1
+bitmap.min   # => 1
+bitmap.max   # => 4294967295
+bitmap.last  # => 4294967295
+bitmap[3]    # => 999
+
+b1 = Roaring::Bitmap.new(200...500)
+b2 = Roaring::Bitmap.new(100...1000)
+
+# Support common set operations
+(b1 & b2).size # => 300
+(b1 ^ b2).size # => 600
+(b2 - b1).size # => 600
+(b1 - b2).empty? # => true
+b1 < b2 # => true
+(b2 - b1) == (b1 ^ b2) # => true
+
+# (De)Serialization (also available via Marshal#{dump,load})
+dump = bitmap.serialize
+loaded = Roaring::Bitmap.deserialize(dump)
+loaded == bitmap # => true
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
@@ -36,7 +57,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jhawth
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [Apache License, Version 2.0](https://opensource.org/licenses/Apache-2.0).
 
 ## Code of Conduct
 

data/Rakefile

@@ -1,4 +1,20 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rake/extensiontask"
+
+task build: :compile
+
+Rake::ExtensionTask.new("roaring") do |ext|
+  ext.lib_dir = "lib/roaring"
+end
+
+task default: %i[clobber compile test]

data/ext/roaring/cext.c

@@ -0,0 +1,274 @@
+#include "ruby.h"
+#include "roaring.h"
+
+#include <stdio.h>
+
+static VALUE cRoaringBitmap;
+VALUE rb_mRoaring;
+
+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 VALUE rb_roaring_initialize_copy(VALUE self, VALUE other) {
+    roaring_bitmap_t *self_data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, self_data);
+
+    roaring_bitmap_t *other_data;
+    TypedData_Get_Struct(other, roaring_bitmap_t, &roaring_type, other_data);
+
+    roaring_bitmap_overwrite(self_data, other_data);
+
+    return self;
+}
+
+static VALUE rb_roaring_cardinality(VALUE self)
+{
+
+    roaring_bitmap_t *data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+    uint64_t cardinality = roaring_bitmap_get_cardinality(data);
+    return ULONG2NUM(cardinality);
+}
+
+static VALUE rb_roaring_add(VALUE self, VALUE val)
+{
+    roaring_bitmap_t *data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    uint32_t num = NUM2UINT32(val);
+    roaring_bitmap_add(data, num);
+    return self;
+}
+
+static VALUE rb_roaring_include_p(VALUE self, VALUE val)
+{
+    roaring_bitmap_t *data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    uint32_t num = NUM2UINT32(val);
+    return roaring_bitmap_contains(data, num) ? Qtrue : Qfalse;
+}
+
+static VALUE rb_roaring_empty_p(VALUE self)
+{
+    roaring_bitmap_t *data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    return roaring_bitmap_is_empty(data) ? Qtrue : Qfalse;
+}
+
+static VALUE rb_roaring_clear(VALUE self)
+{
+    roaring_bitmap_t *data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    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;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    roaring_iterate(data, rb_roaring_each_i, NULL);
+    return self;
+}
+
+static VALUE rb_roaring_aref(VALUE self, VALUE rankv)
+{
+    roaring_bitmap_t *data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    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;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    uint32_t val = roaring_bitmap_minimum(data);
+    return UINT2NUM(val);
+}
+
+static VALUE rb_roaring_max(VALUE self)
+{
+    roaring_bitmap_t *data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    uint32_t val = roaring_bitmap_maximum(data);
+    return UINT2NUM(val);
+}
+
+static VALUE rb_roaring_run_optimize(VALUE self)
+{
+    roaring_bitmap_t *data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    return roaring_bitmap_run_optimize(data) ? Qtrue : Qfalse;
+}
+
+static VALUE rb_roaring_serialize(VALUE self)
+{
+    roaring_bitmap_t *data;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, data);
+
+    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;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, self_data);
+
+    roaring_bitmap_t *other_data;
+    TypedData_Get_Struct(other, roaring_bitmap_t, &roaring_type, other_data);
+
+    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;
+    TypedData_Get_Struct(self, roaring_bitmap_t, &roaring_type, self_data);
+
+    roaring_bitmap_t *other_data;
+    TypedData_Get_Struct(other, roaring_bitmap_t, &roaring_type, other_data);
+
+    bool result = func(self_data, other_data);
+    return result ? Qtrue : Qfalse;
+}
+
+
+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);
+}
+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, "<<", rb_roaring_add, 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, "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/lib/roaring/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Roaring
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/lib/roaring.rb

@@ -1,8 +1,70 @@
 # frozen_string_literal: true
 
 require_relative "roaring/version"
+require_relative "roaring/roaring"
+require "set"
 
 module Roaring
   class Error < StandardError; end
-  # Your code goes here...
+
+  class Bitmap
+    include Enumerable
+
+    alias size   cardinality
+    alias length cardinality
+    alias count  cardinality
+
+    alias + |
+
+    alias first min
+    alias last max
+
+    def initialize(enum = nil)
+      return unless enum
+
+      if enum.instance_of?(Roaring::Bitmap)
+        initialize_copy(enum)
+      else
+        enum.each { |x| self << x }
+      end
+    end
+
+    def self.[](*args)
+      if args.size == 0
+        new
+      elsif args.size == 1 && !(Integer === args[0])
+        new(args[0])
+      else
+        new(args)
+      end
+    end
+
+    def >(other)
+      other < self
+    end
+
+    def >=(other)
+      other <= self
+    end
+
+    def _dump level
+      serialize
+    end
+
+    def self._load args
+      deserialize(args)
+    end
+
+    def to_a
+      map(&:itself)
+    end
+
+    def to_set
+      ::Set.new(to_a)
+    end
+
+    def inspect
+      "#<#{self.class} cardinality=#{cardinality}>"
+    end
+  end
 end

data/roaring.gemspec

@@ -8,30 +8,25 @@ Gem::Specification.new do |spec|
   spec.authors = ["John Hawthorn"]
   spec.email = ["john@hawthorn.email"]
 
-  spec.summary = "placeholder"
-  spec.description = "placeholder"
+  spec.summary = "Roaring bitmaps for Ruby"
+  spec.description = spec.summary
   spec.homepage = "https://github.com/jhawthorn/roaring-ruby"
-  spec.license = "MIT"
+  spec.license = "Apache-2.0"
   spec.required_ruby_version = ">= 2.6.0"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.metadata["changelog_uri"] = spec.metadata["homepage_uri"] = spec.homepage
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.extensions = ["ext/roaring/extconf.rb"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency "prime"
 end

data/sig/roaring.rbs

@@ -0,0 +1,4 @@
+module Roaring
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,20 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: roaring
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - John Hawthorn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-14 00:00:00.000000000 Z
-dependencies: []
-description: placeholder
+date: 2022-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Roaring bitmaps for Ruby
 email:
 - john@hawthorn.email
 executables: []
-extensions: []
+extensions:
+- ext/roaring/extconf.rb
 extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
@@ -23,18 +38,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- ext/roaring/cext.c
+- ext/roaring/extconf.rb
 - lib/roaring.rb
 - lib/roaring/version.rb
 - roaring.gemspec
+- sig/roaring.rbs
 homepage: https://github.com/jhawthorn/roaring-ruby
 licenses:
-- MIT
+- Apache-2.0
 metadata:
   homepage_uri: https://github.com/jhawthorn/roaring-ruby
-  source_code_uri: https://github.com/jhawthorn/roaring-ruby
   changelog_uri: https://github.com/jhawthorn/roaring-ruby
+  source_code_uri: https://github.com/jhawthorn/roaring-ruby
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -53,5 +69,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: placeholder
+summary: Roaring bitmaps for Ruby
 test_files: []

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "roaring"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here