Skip to main content

Compressed integer sets based on Roaring bitmaps.

Project description

Roaring bitmaps are fast, compressed, and portable bitmaps, used to store unique sorted integer sets. These bitmaps offer better real-world space complexity and performance than typical hash sets (such as Python’s built-in set), and can be serialized into a portable format for storage and interop with the C/C++, Java and Go libraries.

This library makes the CRoaring implementation available in Python 2.7 and 3.5+. It uses CFFI, so it works on both CPython and PyPy. The full Python set interface is implemented. Comprehensive tests are included.

Installation

pip install croaring

The CRoaring source is included with the Python library, so you don’t need to install it from elsewhere (though you may need a C compiler available if a binary package is unavailable for your architecture).

Usage

Instantiate a croaring.RoaringBitmap(), and use it just like a normal set:

>>> import croaring
>>> bitmap = croaring.RoaringBitmap()
>>> bitmap
RoaringBitmap([])
>>> bitmap.add(1)
>>> bitmap.add(4572)
>>> bitmap.add(326)
>>> bitmap
RoaringBitmap([1, 326, 4572])

You can use either binary operators (|, &, ^ and -) or their English names (union, intersection, symmetric_difference and difference):

>>> bitmap | RoaringBitmap([50, 95])
RoaringBitmap([1, 50, 95, 326, 4572])
>>> bitmap & RoaringBitmap([200, 326])
RoaringBitmap([326])
>>> bitmap ^ RoaringBitmap([200, 326])
RoaringBitmap([1, 200, 4572])

Since the bitmaps are ordered, indexing (including negative) is supported:

>>> bitmap[1]
326
>>> bitmap[-1]
4572

Finally, you can construct a bitmap from a range, similar to the arguments to Python’s built-in range:

>>> RoaringBitmap.range(10)
RoaringBitmap([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> RoaringBitmap.range(2, 10)
RoaringBitmap([2, 3, 4, 5, 6, 7, 8, 9])
>>> RoaringBitmap.range(2, 10, 3)
RoaringBitmap([2, 5, 8])

License

CRoaring is licensed under the Apache License v2.0:

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.

All other code is released under the Unlicense:

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

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 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.

For more information, please refer to http://unlicense.org/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

croaring-0.0.2.tar.gz (98.1 kB view details)

Uploaded Source

Built Distributions

croaring-0.0.2-cp36-cp36m-macosx_10_13_x86_64.whl (107.4 kB view details)

Uploaded CPython 3.6m macOS 10.13+ x86-64

croaring-0.0.2-cp27-cp27m-macosx_10_13_x86_64.whl (105.6 kB view details)

Uploaded CPython 2.7m macOS 10.13+ x86-64

File details

Details for the file croaring-0.0.2.tar.gz.

File metadata

  • Download URL: croaring-0.0.2.tar.gz
  • Upload date:
  • Size: 98.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for croaring-0.0.2.tar.gz
Algorithm Hash digest
SHA256 6fe9ecabaca21b83a2ed177f4561b6145d50bb453dae804b9a2f3f5e1ec2d24a
MD5 cda6d79cd11cffe53b4c0039bb22b302
BLAKE2b-256 b1ebcdfb47739048613ae778479063cbc4fb9f907ac00b11c9a006bb103d0786

See more details on using hashes here.

File details

Details for the file croaring-0.0.2-cp36-cp36m-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for croaring-0.0.2-cp36-cp36m-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 c0600e80cc75756d6565d01d5e24effa83ae9ccd5c5ec193c786aa354e26296e
MD5 6b80fe21c8235359472f1b4073fd7968
BLAKE2b-256 44e15661fabb684156785e56bbdf7c967f5795a93917eb1a0498b27621295c7b

See more details on using hashes here.

File details

Details for the file croaring-0.0.2-cp27-cp27m-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for croaring-0.0.2-cp27-cp27m-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 b4d4c93983b5399e6672f82560297c4f128bf472f657ba0d20c40abd97d270e3
MD5 b7d7663f3a2d5307be7ba119717bc02c
BLAKE2b-256 5a450ee887443ab9827c621edb30d04000258000a7d94df3488bb115748e8656

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page