@phughesmcr/booleanarray@0.6.0
Built and signed on GitHub Actions
Built and signed on GitHub Actions

latest

phughesmcr/BooleanArray

A Hyper-Performant GC-Minimizing UInt32Array-Backed Boolean Array in Typescript

JSR Score

100%

Published

2 months ago (0.6.0)

@phughesmcr/booleanarray

BooleanArray

class BooleanArray

extends Uint32Array

A fast boolean array backed by a Uint32Array

Constructors

new



BooleanArray(size: number)

Creates a new BooleanArray

Properties

readonly



size: number

Methods



clear(): this

Clear the array



clone(): BooleanArray

Creates a copy of this BooleanArray



getBool(index: number): boolean

Get the boolean state of a bit



getBools(startIndex: number,
count: number,
): boolean[]

Add bulk operations for better performance



getFirstSetIndex(startIndex?: number): number

Get the index of the first set bit starting from a given index



getLastSetIndex(startIndex?: number): number

Get the index of the last set bit



getPopulationCount(): number

Get the number of set bits in the array



isEmpty(): boolean

Check if the array is empty



setAll(): this

Set all bits to true



setBool(index: number,
value: boolean,
): this

Set the boolean state of a bit



setRange(startIndex: number,
count: number,
value: boolean,
): this

Set a range of bits to a given value



toggleBool(index: number): boolean

Toggle the boolean state of a bit



truthyIndices(startIndex?: number,
endIndex?: number,
): IterableIterator<number>

Get the indices of the set bits in the array

Static Properties

readonly



ALL_BITS: 4294967295

The mask for all bits (~0 >>> 0)

readonly



BITS_PER_INT: 32

The number of bits per integer

readonly



CHUNK_MASK: 31

The mask for the chunk offset

readonly



CHUNK_SHIFT: 5

The shift for the chunk offset



DENSE_ARRAY_THRESHOLD: number

The threshold for what is considered a dense array



LARGE_RANGE_THRESHOLD: number

The threshold for what is considered a large array

readonly



MAX_SAFE_SIZE: 536870911

The maximum safe size for bit operations

Static Methods



and(a: BooleanArray,
b: BooleanArray,
): BooleanArray

Performs a bitwise AND operation with two BooleanArrays



difference(a: BooleanArray,
b: BooleanArray,
): BooleanArray

Performs a bitwise difference operation with two BooleanArrays



equals(a: BooleanArray,
b: BooleanArray,
): boolean

Checks if two BooleanArrays are equal



fromArray(arr: Array<number>,
size: number,
): BooleanArray

Create a BooleanArray from an array of numbers, each number representing a bit to set to true.



fromObjects<T>(size: number,
key: keyof T,
objs: T[],
): BooleanArray

Create a BooleanArray from an object, using the object's keys as the bit indices.



getChunk(index: number): number

Get the chunk index for a given bool index



getChunkCount(bools: number): number

Get the number of chunks required to accommodate a given number of bools



getChunkOffset(boolIndex: number): number

Get the offset of a bool within a chunk



nand(a: BooleanArray,
b: BooleanArray,
): BooleanArray

Performs a bitwise NAND operation with two BooleanArrays



nor(a: BooleanArray,
b: BooleanArray,
): BooleanArray

Performs a bitwise NOR operation with two BooleanArrays



not(a: BooleanArray): BooleanArray

Performs a bitwise NOT operation with a BooleanArray



operate(a: BooleanArray,
b: BooleanArray,
operation: (a: number,
b: number,
) => number,
): BooleanArray

Performs a bitwise operation with two BooleanArrays



or(a: BooleanArray,
b: BooleanArray,
): BooleanArray

Performs a bitwise OR operation with two BooleanArrays



validateValue(value: number,
maxSize?: number,
): number

Validate a value



xnor(a: BooleanArray,
b: BooleanArray,
): BooleanArray

Performs a bitwise XNOR operation with two BooleanArrays



xor(a: BooleanArray,
b: BooleanArray,
): BooleanArray

Performs a bitwise XOR operation with two BooleanArrays

Add Package

deno add jsr:@phughesmcr/booleanarray

Import symbol

import { BooleanArray } from "@phughesmcr/booleanarray";

---- OR ----

Import directly with a jsr specifier

import { BooleanArray } from "jsr:@phughesmcr/booleanarray";

Add Package

npx jsr add @phughesmcr/booleanarray

Import symbol

import { BooleanArray } from "@phughesmcr/booleanarray";

Add Package

yarn dlx jsr add @phughesmcr/booleanarray

Import symbol

import { BooleanArray } from "@phughesmcr/booleanarray";

Add Package

pnpm dlx jsr add @phughesmcr/booleanarray

Import symbol

import { BooleanArray } from "@phughesmcr/booleanarray";

Add Package

bunx jsr add @phughesmcr/booleanarray

Import symbol

import { BooleanArray } from "@phughesmcr/booleanarray";

@phughesmcr/booleanarray@0.6.0Built and signed on GitHub ActionsBuilt and signed on GitHub Actions

Constructors

Properties

Methods

Static Properties

Static Methods

@phughesmcr/booleanarray@0.6.0
Built and signed on GitHub Actions
Built and signed on GitHub Actions