bitz 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b36def536acce5c5af37285db45e3b0444b2b3890c2aa9d7545125c26845eef
+  data.tar.gz: df6bbbf2e16954e338829eb063e1d3a580d98bed6099dda029313d5e0b393ad2
+SHA512:
+  metadata.gz: e065f3bedf8d3ca9c942e4aa71d36e4c4c538faad62b1b85c05b118f22cf72c1581fda586f144e0f7df6f41c3854262a70f2b9018cc72230edbec70ae55cf90e
+  data.tar.gz: 3852e5dde0f66a80aabd687210ad0522089f00239930d2e42ce95a9f58ae7bde4b8b6ae6030a6944516b85d0921e50eec40aab8306737e14ae8e6eb77feef23c

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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 Aaron Patterson
+
+   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

@@ -0,0 +1,214 @@
+# Bitz
+
+A pure Ruby, JIT-friendly dynamic bitset implementation
+
+## Features
+
+- **Dynamic resizing**: Automatically grows buffer as needed when setting bits
+- **Memory efficient**: Uses packed byte arrays for optimal memory usage
+- **Ruby-idiomatic**: Standard operators (`&`, `|`, `!`) and method chaining support
+- **0-indexed**: Bit positions start from 0, following standard conventions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitz'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bitz
+
+## Usage
+
+### Basic Operations
+
+```ruby
+require 'bitz'
+
+# Create a new bitset with default capacity (64 bits)
+bitset = Bitz::Set.new
+
+# Set individual bits
+bitset.set(5)
+bitset.set(10)
+bitset.set(15)
+
+# Check if bits are set
+bitset.set?(5)   # => true
+bitset.set?(3)   # => false
+bitset.set?(100) # => nil (position doesn't exist yet)
+
+# Unset bits
+bitset.unset(10)
+bitset.set?(10)  # => false
+
+# Count set bits
+bitset.count     # => 2 (bits 5 and 15 are set)
+
+# Get total capacity
+bitset.capacity  # => 64
+```
+
+### Bulk Operations
+
+```ruby
+# Set all bits to 1
+bitset.set_all
+bitset.count     # => 64
+
+# Set all bits to 0
+bitset.unset_all
+bitset.count     # => 0
+```
+
+### Custom Initialization
+
+```ruby
+# Create bitset with specific capacity
+large_bitset = Bitz::Set.new(256)
+
+# Create bitset with all bits initially set
+filled_bitset = Bitz::Set.new(64, fill: true)
+filled_bitset.count  # => 64
+```
+
+### Set Operations
+
+#### Mutating Operations
+
+```ruby
+set1 = Bitz::Set.new
+set1.set(1)
+set1.set(2)
+
+set2 = Bitz::Set.new
+set2.set(2)
+set2.set(3)
+
+# Union (modifies set1)
+set1.set_union(set2)
+# set1 now contains bits 1, 2, 3
+
+set1 = Bitz::Set.new
+set1.set(1)
+set1.set(2)
+
+# Intersection (modifies set1)
+set1.set_intersection(set2)
+# set1 now contains only bit 2
+```
+
+#### Non-mutating Operations
+
+```ruby
+set1 = Bitz::Set.new
+set1.set(1)
+set1.set(2)
+
+set2 = Bitz::Set.new  
+set2.set(2)
+set2.set(3)
+
+# Union (creates new bitset)
+union_result = set1 | set2
+# union_result contains bits 1, 2, 3
+# set1 and set2 are unchanged
+
+# Intersection (creates new bitset)
+intersection_result = set1 & set2
+# intersection_result contains only bit 2
+# set1 and set2 are unchanged
+
+# Complement/NOT (creates new bitset with all bits flipped)
+complement_result = !set1
+# complement_result has all bits flipped - bits 0, 3, 4, 5, ..., 63 are set
+# set1 is unchanged
+```
+
+### Copying
+
+```ruby
+original = Bitz::Set.new
+original.set(5)
+
+# Create independent copy
+copy = original.dup
+copy.set(10)
+
+original.set?(10)  # => false (original unchanged)
+copy.set?(5)       # => true (copy has original's bits)
+```
+
+## API Reference
+
+### Constructor
+
+- `Bitz::Set.new(bits = 64, fill: false)` - Create bitset with initial capacity
+
+### Bit Manipulation
+
+- `set(bit)` - Set bit at position to 1
+- `unset(bit)` - Set bit at position to 0  
+- `set?(bit)` - Check if bit is set (returns true/false/nil)
+
+### Bulk Operations
+
+- `set_all` - Set all bits to 1
+- `unset_all` - Set all bits to 0
+- `count` - Count number of set bits
+- `capacity` - Get total bit capacity
+
+### Set Operations (Mutating)
+
+- `set_union(other)` - Union with another bitset (modifies self)
+- `set_intersection(other)` - Intersection with another bitset (modifies self)
+
+### Set Operations (Non-mutating)
+
+- `|(other)` - Union operator (returns new bitset)
+- `&(other)` - Intersection operator (returns new bitset)
+- `!` - Complement/NOT operator (returns new bitset with all bits flipped)
+
+### Copying
+
+- `dup` - Create independent copy of bitset
+
+## Error Handling
+
+Operations between bitsets with different capacities will raise `ArgumentError`:
+
+```ruby
+set1 = Bitz::Set.new(64)
+set2 = Bitz::Set.new(128)
+
+set1 | set2  # => ArgumentError: Cannot union bitsets with different capacities: 64 != 128
+```
+
+## Development
+
+After checking out the repo, run tests with:
+
+```bash
+rake test
+```
+
+This will run the full test suite including:
+- Basic bit manipulation tests
+- Set operation tests  
+- Error condition tests
+- Performance validation tests
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the [Apache 2.0](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = true
+end
+
+task :default => :test

data/bitz.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+$: << File.expand_path("lib")
+
+require_relative "lib/bitz"
+
+Gem::Specification.new do |spec|
+  spec.name = "bitz"
+  spec.version = Bitz::VERSION
+  spec.authors = ["Aaron Patterson"]
+  spec.email = "tenderlove@ruby-lang.org"
+
+  spec.summary = "A pure Ruby, JIT-friendly dynamic bitset implementation"
+  spec.description = "Bitz provides a dynamic bitset implementation for Ruby with efficient bit manipulation operations, automatic buffer resizing, and idiomatic operators."
+  spec.homepage = "https://github.com/tenderlove/bitz"
+  spec.license = "Apache-2.0"
+
+  spec.files       = `git ls-files -z`.split("\x0")
+  spec.test_files  = spec.files.grep(%r{^test/})
+
+  spec.required_ruby_version = ">= 3.0.0"
+  # Development dependencies
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+end