fast-boolean-array 1.0.0

package/index.js

@@ -0,0 +1,125 @@
+import { performance } from 'node:perf_hooks';
+import BooleanArrayExisting from 'boolean-array';
+import { serialize } from 'v8';
+
+export class BooleanArray {
+	constructor(size) {
+		this.size = size;
+		this.buffer = new Uint8Array(Math.ceil(size / 8)); // Allocate memory
+	}
+
+	// Set a boolean value at a specific index, hex, or RGB
+	set(input, value) {
+		if (value) {
+			this.buffer[input >> 3] |= 1 << (input & 7); // Set bit
+		} else {
+			this.buffer[input >> 3] &= ~(1 << (input & 7)); // Clear bit
+		}
+	}
+
+	// Get a boolean value at a specific index, hex, or RGB
+	get(input) {
+		return (this.buffer[input >> 3] & (1 << input % 8)) !== 0; // Check bit
+	}
+
+	get length() {
+		return this.size;
+	}
+
+	set length(value) {
+		throw new Error("Setting the length on BooleanArray's is not supported");
+	}
+}
+
+function getMemoryUsageOfReference(ref) {
+	const serialized = serialize(ref); // Convert the reference to a Buffer
+	return serialized.length; // The size of the serialized Buffer in bytes
+}
+
+function testVanillaArraySet(amount, analyzeMemory = true) {
+	const vanillaArray = [];
+	const startTime = performance.now();
+	for (let i = 0; i < amount; i++) {
+		vanillaArray[i] = true;
+	}
+	const endTime = performance.now();
+	const usedMemory = analyzeMemory ? getMemoryUsageOfReference(vanillaArray) : 0;
+	return { vanillaArray, usedMemory, startTime, endTime };
+}
+testVanillaArraySet._name = 'Set Vanilla array     ';
+
+function testBooleanArraySet(amount, analyzeMemory = true) {
+	const theBooleanArray = new BooleanArray(amount);
+	const startTime = performance.now();
+	for (let i = 0; i < amount; i++) {
+		theBooleanArray.set(i, true);
+	}
+	const endTime = performance.now();
+	const usedMemory = analyzeMemory ? getMemoryUsageOfReference(theBooleanArray) : 0;
+	return { theBooleanArray, usedMemory, startTime, endTime };
+}
+testBooleanArraySet._name = 'Set Fast Boolean Array';
+
+function testVanillaArrayGet(amount) {
+	const { vanillaArray } = testVanillaArraySet(amount, false);
+	const startTime = performance.now();
+	for (let i = 0; i < amount; i++) {
+		vanillaArray[i];
+	}
+	const endTime = performance.now();
+	return {
+		usedMemory: 0,
+		startTime,
+		endTime
+	};
+}
+testVanillaArrayGet._name = 'Get Vanilla array     ';
+
+function testBooleanArrayGet(amount) {
+	const { theBooleanArray } = testBooleanArraySet(amount, false);
+	const startTime = performance.now();
+	for (let i = 0; i < amount; i++) {
+		theBooleanArray.get(i, true);
+	}
+	const endTime = performance.now();
+	return {
+		usedMemory: 0,
+		startTime,
+		endTime
+	};
+}
+testBooleanArrayGet._name = 'Get Fast Boolean Array';
+
+function performanceTest(test, amount) {
+	const runs = 1000; // Number of times to run the test
+	let totalTime = 0;
+	let totalMemory = 0;
+
+	for (let i = 0; i < runs; i++) {
+		const { startTime, endTime, usedMemory } = test(amount);
+
+		totalTime += endTime - startTime;
+		totalMemory += usedMemory;
+	}
+
+	const averageTime = (totalTime / runs).toFixed(8);
+	const averageMemory = totalMemory / runs;
+
+	console.log(
+		`${test._name}: ${averageTime} ms | ${test.name.includes('Set') ? averageMemory + ' Bytes' : 'N/A'} | ${amount} indexes`
+	);
+}
+
+// Run tests
+console.clear();
+[1, 100, 1_000, 10_000, 100_000, 1_000_000, 10_000_000].forEach(async (amount) => {
+	console.log('');
+	[testVanillaArraySet, testBooleanArraySet, testVanillaArrayGet, testBooleanArrayGet].forEach(
+		(test) => {
+			performanceTest(test, amount);
+		}
+	);
+	await new Promise((resolve) => {
+		setTimeout(resolve, 5_000); // Let garbadge collection do its thing for more accurate memory logging
+	});
+});

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "fast-boolean-array",
+  "version": "1.0.0",
+  "main": "test.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "boolean",
+    "array",
+    "fast",
+    "efficient",
+    "map"
+  ],
+  "author": "Jack van der Bilt",
+  "license": "MIT",
+  "description": ""
+}