// Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. import { Vector } from './vector.mjs'; import { BufferType, Type } from './enum.mjs'; import { DataType, strideForType } from './type.mjs'; import { popcnt_bit_range, truncateBitmap } from './util/bit.mjs'; /** @ignore */ export const kUnknownNullCount = -1; /** * Data structure underlying {@link Vector}s. Use the convenience method {@link makeData}. */ export class Data { constructor(type, offset, length, nullCount, buffers, children = [], dictionary) { this.type = type; this.children = children; this.dictionary = dictionary; this.offset = Math.floor(Math.max(offset || 0, 0)); this.length = Math.floor(Math.max(length || 0, 0)); this._nullCount = Math.floor(Math.max(nullCount || 0, -1)); let buffer; if (buffers instanceof Data) { this.stride = buffers.stride; this.values = buffers.values; this.typeIds = buffers.typeIds; this.nullBitmap = buffers.nullBitmap; this.valueOffsets = buffers.valueOffsets; } else { this.stride = strideForType(type); if (buffers) { (buffer = buffers[0]) && (this.valueOffsets = buffer); (buffer = buffers[1]) && (this.values = buffer); (buffer = buffers[2]) && (this.nullBitmap = buffer); (buffer = buffers[3]) && (this.typeIds = buffer); } } this.nullable = this._nullCount !== 0 && this.nullBitmap && this.nullBitmap.byteLength > 0; } get typeId() { return this.type.typeId; } get ArrayType() { return this.type.ArrayType; } get buffers() { return [this.valueOffsets, this.values, this.nullBitmap, this.typeIds]; } get byteLength() { let byteLength = 0; const { valueOffsets, values, nullBitmap, typeIds } = this; valueOffsets && (byteLength += valueOffsets.byteLength); values && (byteLength += values.byteLength); nullBitmap && (byteLength += nullBitmap.byteLength); typeIds && (byteLength += typeIds.byteLength); return this.children.reduce((byteLength, child) => byteLength + child.byteLength, byteLength); } get nullCount() { let nullCount = this._nullCount; let nullBitmap; if (nullCount <= kUnknownNullCount && (nullBitmap = this.nullBitmap)) { this._nullCount = nullCount = this.length - popcnt_bit_range(nullBitmap, this.offset, this.offset + this.length); } return nullCount; } getValid(index) { if (this.nullable && this.nullCount > 0) { const pos = this.offset + index; const val = this.nullBitmap[pos >> 3]; return (val & (1 << (pos % 8))) !== 0; } return true; } setValid(index, value) { // Don't interact w/ nullBitmap if not nullable if (!this.nullable) { return value; } // If no null bitmap, initialize one on the fly if (!this.nullBitmap || this.nullBitmap.byteLength <= (index >> 3)) { const { nullBitmap } = this._changeLengthAndBackfillNullBitmap(this.length); Object.assign(this, { nullBitmap, _nullCount: 0 }); } const { nullBitmap, offset } = this; const pos = (offset + index) >> 3; const bit = (offset + index) % 8; const val = (nullBitmap[pos] >> bit) & 1; // If `val` is truthy and the current bit is 0, flip it to 1 and increment `_nullCount`. // If `val` is falsey and the current bit is 1, flip it to 0 and decrement `_nullCount`. value ? val === 0 && ((nullBitmap[pos] |= (1 << bit)), (this._nullCount = this.nullCount + 1)) : val === 1 && ((nullBitmap[pos] &= ~(1 << bit)), (this._nullCount = this.nullCount - 1)); return value; } clone(type = this.type, offset = this.offset, length = this.length, nullCount = this._nullCount, buffers = this, children = this.children) { return new Data(type, offset, length, nullCount, buffers, children, this.dictionary); } slice(offset, length) { const { stride, typeId, children } = this; // +true === 1, +false === 0, so this means // we keep nullCount at 0 if it's already 0, // otherwise set to the invalidated flag -1 const nullCount = +(this._nullCount === 0) - 1; const childStride = typeId === 16 /* FixedSizeList */ ? stride : 1; const buffers = this._sliceBuffers(offset, length, stride, typeId); return this.clone(this.type, this.offset + offset, length, nullCount, buffers, // Don't slice children if we have value offsets (the variable-width types) (children.length === 0 || this.valueOffsets) ? children : this._sliceChildren(children, childStride * offset, childStride * length)); } _changeLengthAndBackfillNullBitmap(newLength) { if (this.typeId === Type.Null) { return this.clone(this.type, 0, newLength, 0); } const { length, nullCount } = this; // start initialized with 0s (nulls), then fill from 0 to length with 1s (not null) const bitmap = new Uint8Array(((newLength + 63) & ~63) >> 3).fill(255, 0, length >> 3); // set all the bits in the last byte (up to bit `length - length % 8`) to 1 (not null) bitmap[length >> 3] = (1 << (length - (length & ~7))) - 1; // if we have a nullBitmap, truncate + slice and set it over the pre-filled 1s if (nullCount > 0) { bitmap.set(truncateBitmap(this.offset, length, this.nullBitmap), 0); } const buffers = this.buffers; buffers[BufferType.VALIDITY] = bitmap; return this.clone(this.type, 0, newLength, nullCount + (newLength - length), buffers); } _sliceBuffers(offset, length, stride, typeId) { let arr; const { buffers } = this; // If typeIds exist, slice the typeIds buffer (arr = buffers[BufferType.TYPE]) && (buffers[BufferType.TYPE] = arr.subarray(offset, offset + length)); // If offsets exist, only slice the offsets buffer (arr = buffers[BufferType.OFFSET]) && (buffers[BufferType.OFFSET] = arr.subarray(offset, offset + length + 1)) || // Otherwise if no offsets, slice the data buffer. Don't slice the data vector for Booleans, since the offset goes by bits not bytes (arr = buffers[BufferType.DATA]) && (buffers[BufferType.DATA] = typeId === 6 ? arr : arr.subarray(stride * offset, stride * (offset + length))); return buffers; } _sliceChildren(children, offset, length) { return children.map((child) => child.slice(offset, length)); } } Data.prototype.children = Object.freeze([]); import { Visitor } from './visitor.mjs'; import { toArrayBufferView, toInt32Array, toUint8Array } from './util/buffer.mjs'; class MakeDataVisitor extends Visitor { visit(props) { return this.getVisitFn(props['type']).call(this, props); } visitNull(props) { const { ['type']: type, ['offset']: offset = 0, ['length']: length = 0, } = props; return new Data(type, offset, length, 0); } visitBool(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.ArrayType, props['data']); const { ['length']: length = data.length >> 3, ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap]); } visitInt(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.ArrayType, props['data']); const { ['length']: length = data.length, ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap]); } visitFloat(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.ArrayType, props['data']); const { ['length']: length = data.length, ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap]); } visitUtf8(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const data = toUint8Array(props['data']); const nullBitmap = toUint8Array(props['nullBitmap']); const valueOffsets = toInt32Array(props['valueOffsets']); const { ['length']: length = valueOffsets.length - 1, ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0 } = props; return new Data(type, offset, length, nullCount, [valueOffsets, data, nullBitmap]); } visitBinary(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const data = toUint8Array(props['data']); const nullBitmap = toUint8Array(props['nullBitmap']); const valueOffsets = toInt32Array(props['valueOffsets']); const { ['length']: length = valueOffsets.length - 1, ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0 } = props; return new Data(type, offset, length, nullCount, [valueOffsets, data, nullBitmap]); } visitFixedSizeBinary(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.ArrayType, props['data']); const { ['length']: length = data.length / strideForType(type), ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap]); } visitDate(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.ArrayType, props['data']); const { ['length']: length = data.length / strideForType(type), ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap]); } visitTimestamp(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.ArrayType, props['data']); const { ['length']: length = data.length / strideForType(type), ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap]); } visitTime(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.ArrayType, props['data']); const { ['length']: length = data.length / strideForType(type), ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap]); } visitDecimal(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.ArrayType, props['data']); const { ['length']: length = data.length / strideForType(type), ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap]); } visitList(props) { const { ['type']: type, ['offset']: offset = 0, ['child']: child } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const valueOffsets = toInt32Array(props['valueOffsets']); const { ['length']: length = valueOffsets.length - 1, ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0 } = props; return new Data(type, offset, length, nullCount, [valueOffsets, undefined, nullBitmap], [child]); } visitStruct(props) { const { ['type']: type, ['offset']: offset = 0, ['children']: children = [] } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const { length = children.reduce((len, { length }) => Math.max(len, length), 0), nullCount = props['nullBitmap'] ? -1 : 0 } = props; return new Data(type, offset, length, nullCount, [undefined, undefined, nullBitmap], children); } visitUnion(props) { const { ['type']: type, ['offset']: offset = 0, ['children']: children = [] } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const typeIds = toArrayBufferView(type.ArrayType, props['typeIds']); const { ['length']: length = typeIds.length, ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; if (DataType.isSparseUnion(type)) { return new Data(type, offset, length, nullCount, [undefined, undefined, nullBitmap, typeIds], children); } const valueOffsets = toInt32Array(props['valueOffsets']); return new Data(type, offset, length, nullCount, [valueOffsets, undefined, nullBitmap, typeIds], children); } visitDictionary(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.indices.ArrayType, props['data']); const { ['dictionary']: dictionary = new Vector([new MakeDataVisitor().visit({ type: type.dictionary })]) } = props; const { ['length']: length = data.length, ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0 } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap], [], dictionary); } visitInterval(props) { const { ['type']: type, ['offset']: offset = 0 } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const data = toArrayBufferView(type.ArrayType, props['data']); const { ['length']: length = data.length / strideForType(type), ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [undefined, data, nullBitmap]); } visitFixedSizeList(props) { const { ['type']: type, ['offset']: offset = 0, ['child']: child = new MakeDataVisitor().visit({ type: type.valueType }) } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const { ['length']: length = child.length / strideForType(type), ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0 } = props; return new Data(type, offset, length, nullCount, [undefined, undefined, nullBitmap], [child]); } visitMap(props) { const { ['type']: type, ['offset']: offset = 0, ['child']: child = new MakeDataVisitor().visit({ type: type.childType }) } = props; const nullBitmap = toUint8Array(props['nullBitmap']); const valueOffsets = toInt32Array(props['valueOffsets']); const { ['length']: length = valueOffsets.length - 1, ['nullCount']: nullCount = props['nullBitmap'] ? -1 : 0, } = props; return new Data(type, offset, length, nullCount, [valueOffsets, undefined, nullBitmap], [child]); } } export function makeData(props) { return new MakeDataVisitor().visit(props); } //# sourceMappingURL=data.mjs.map