Merge pull request #39 from louisabraham/perf/count-separation-and-inlining

Separate logical word count from buffer capacity

Author: lemire

.github/workflows/test.yml

@@ -1,5 +1,5 @@
 name: Test
-on: push
+on: [push, pull_request]
 jobs:
   test:
     timeout-minutes: 15

README.md

@@ -11,6 +11,7 @@ const tBitSet = require("bitset");
 const fBitSet = require("fast-bitset");
 const roaring = require("roaring");
 const os = require("os");
+const minimist = require("minimist");
 
 const smallgap = 3;
 const largegap = 210;
@@ -1360,23 +1361,67 @@ function XORBench() {
     .run({ async: false });
 }
 
+const benchmarks = {
+  "or": { fn: OrBench, desc: "union (new bitmap)" },
+  "xor": { fn: XORBench, desc: "change/XOR (new bitmap)" },
+  "and": { fn: AndBench, desc: "intersection (new bitmap)" },
+  "difference": { fn: DifferenceBench, desc: "difference (new bitmap)" },
+  "xor-inplace": { fn: XORInplaceBench, desc: "change/XOR (in-place)" },
+  "or-inplace": { fn: OrInplaceBench, desc: "union (in-place)" },
+  "and-inplace": { fn: AndInplaceBench, desc: "intersection (in-place)" },
+  "andnot-inplace": { fn: AndNotInplaceBench, desc: "difference (in-place)" },
+  "cardinality": { fn: CardBench, desc: "cardinality / size()" },
+  "or-card": { fn: OrCardBench, desc: "union cardinality" },
+  "and-card": { fn: AndCardBench, desc: "intersection cardinality" },
+  "difference-card": { fn: DifferenceCardBench, desc: "difference cardinality" },
+  "create": { fn: CreateBench, desc: "dynamic bitmap creation" },
+  "query": { fn: QueryBench, desc: "has() query" },
+  "array": { fn: ArrayBench, desc: "array extraction" },
+  "foreach": { fn: ForEachBench, desc: "forEach iteration" },
+  "clone": { fn: CloneBench, desc: "clone" },
+};
+
 const main = function () {
+  const args = minimist(process.argv.slice(2));
+
+  if (args.list) {
+    console.log("Available benchmarks:");
+    for (const [name, { desc }] of Object.entries(benchmarks)) {
+      console.log(`  ${name.padEnd(20)} ${desc}`);
+    }
+    return;
+  }
+
+  const selected = args.select
+    ? Object.entries(benchmarks).filter(([name, { desc }]) =>
+        name.includes(args.select) || desc.toLowerCase().includes(args.select.toLowerCase())
+      )
+    : Object.entries(benchmarks);
+
+  if (selected.length === 0) {
+    console.log(`No benchmarks matching "${args.select}". Use --list to see available benchmarks.`);
+    return;
+  }
+
+  function tryVersion(pkg) {
+    try { return require(pkg + "/package.json").version; } catch { return ""; }
+  }
   console.log("Benchmarking against:");
   console.log(
     "TypedFastBitSet.js: https://github.com/lemire/TypedFastBitSet.js"
   );
   console.log("roaring: https://www.npmjs.com/package/roaring");
   console.log(
     "infusion.BitSet.js from https://github.com/infusion/BitSet.js",
-    require("bitset.js/package.json").version
+    tryVersion("bitset.js")
   );
   console.log(
     "tdegrunt.BitSet from https://github.com/tdegrunt/bitset",
-    require("bitset/package.json").version
+    tryVersion("bitset")
   );
   console.log(
     "mattkrick.fast-bitset from https://github.com/mattkrick/fast-bitset",
-    require("fast-bitset/package.json").version
+    tryVersion("fast-bitset")
   );
   console.log("standard Set object from JavaScript");
   console.log("");
@@ -1395,50 +1440,11 @@ const main = function () {
       process.versions.v8
   );
   console.log();
-  console.log(
-    "We proceed with the logical operations generating new bitmaps: "
-  );
-  console.log("");
-  OrBench();
-  console.log("");
-  XORBench();
-  console.log("");
-  AndBench();
-  console.log("");
-  DifferenceBench();
-  console.log("");
-  console.log("We benchmark the in-place logical operations: ");
-  console.log("(Notice how much faster they are.)");
-  console.log("");
-  XORInplaceBench();
-  console.log("");
-  OrInplaceBench();
-  console.log("");
-  AndInplaceBench();
-  console.log("");
-  AndNotInplaceBench();
-  console.log("");
-  console.log("We benchmark the operations computing the set sizes: ");
-  console.log("");
-  CardBench();
-  console.log("");
-  OrCardBench();
-  console.log("");
-  AndCardBench();
-  console.log("");
-  DifferenceCardBench();
-  console.log("");
-  console.log("We conclude with other benchmarks: ");
-  console.log("");
-  CreateBench();
-  console.log("");
-  QueryBench();
-  console.log("");
-  ArrayBench();
-  console.log("");
-  ForEachBench();
-  console.log("");
-  CloneBench();
+
+  for (const [name, { fn, desc }] of selected) {
+    fn();
+    console.log("");
+  }
 };
 
 if (require.main === module) {

benchmark/test.js

@@ -18,7 +18,9 @@
     "build:package": "tsc -p tsconfig.build.json --outDir lib",
     "check:types": "tsc",
     "test": "node --expose-gc ./node_modules/jest/bin/jest",
-    "release": "npm run build:package && npm run test && release-it"
+    "release": "npm run build:package && npm run test && release-it",
+    "benchmark": "node benchmark/test.js",
+    "benchmark:ablation": "node benchmark/ablation.js"
   },
   "license": "Apache-2.0",
   "bugs": {
@@ -34,7 +36,7 @@
     "release-it": "^15.6.0",
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
-    "typescript": "^4.8.4"
+    "typescript": "^5.7.0"
   },
   "author": "Daniel Lemire <lemire@gmail.com> (http://lemire.me/en/)"
 }

package-lock.json

@@ -79,7 +79,7 @@ export class SparseTypedFastBitSet implements BitSet {
     }
   }
 
-  private toBitset(): Uint32Array {
+  private toBitset(): Uint32Array<ArrayBuffer> {
     const array = this.data;
     // currently converts its internal type to bitset
     const count = (array[0] + 32) >>> 5;