RoaringBitmap / RoaringBitmap/roaring

Roaring structs as value types

Open
#193 1 comment 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted performance
Dominant language
Go
Stars
2.9k
Forks
262
Avg merge
2h 34m
Merged PRs (30d)
8

Description

Currently, all functions take Roaring objects as pointer types... and all internal containers are effectively pointers on the heap.

There is an unmerged (API breaking) pull request that allows you to use Roaring structs as value types instead of pointer types...

https://github.com/RoaringBitmap/roaring/pull/149

We have opted not to merge this PR since it breaks the API and that's just bad for our users.

It looks like it massively speeds things up... (see the numbers at https://github.com/RoaringBitmap/roaring/pull/149) so we do not want to drop this idea.

My current proposal to get around this is to introduce a new struct and then basically do some copy and paste to recover @anacrolix's code. This would add to our API instead of changing it, so it would be safe. Since it introduces very few changes, it would not increase our maintenance burden significantly.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source files or tests are named; start by reviewing the current public API and the unmerged pull request #149. Define the proposed additional value-type struct without changing existing APIs, then verify that compatibility is preserved and the reported performance improvement is supported by tests or benchmarks.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.