pond-ts API Reference (core)
    Preparing search index...

    Class BooleanColumn

    Boolean value column with 1 bit per cell, packed into a Uint8Array. The bit layout matches ValidityBitmap: bits[i >> 3] & (1 << (i & 7)). Validity is tracked separately so read(i) distinguishes false from undefined.

    Implements

    • ColumnBase<boolean, "boolean">
    Index

    Constructors

    Properties

    kind: "boolean" = ...
    length: number

    Logical row count (number of cells), independent of buffer capacity.

    storage: "packed" = ...

    See ColumnStorage. Plain variants are 'packed'; chunked are 'chunked'.

    validity?: ValidityBitmap

    Optional validity bitmap. Absent ⇒ "every cell is defined." Build code only allocates a bitmap when at least one cell is undefined. Chunked columns surface an aggregate bitmap computed eagerly at construction from per-chunk validity — kept in sync with this convention so col.validity === undefined reliably means "all cells defined."

    values: Uint8Array

    Methods

    • Reads cell i. Out-of-range or invalid → undefined.

      Parameters

      • i: number

      Returns boolean | undefined

    • Linear scan with callback. skipInvalid defaults to true. The callback receives the cell value and the row index; row indices are always relative to this column, not the source it may have been sliced from.

      Parameters

      • fn: (value: boolean, i: number) => void
      • Optionaloptions: ScanOptions

      Returns void

    • Returns a column whose row i is this column's row indices[i]. Always materializes — gather cannot be expressed as a view over a single typed array. For zero-copy index projection at the store level use withRowSelection (lands in sub-step 1f).

      Parameters

      • indices: Int32Array

      Returns BooleanColumn

    • Returns a column covering the half-open range [start, end). For Float64Column the underlying buffer is a subarray view (zero-copy); other column kinds may repack.

      Parameters

      • start: number
      • end: number

      Returns BooleanColumn