Class PointerSetBlock<T, K, R>

Class representing an expanded block in a PointerSet data store. These are created on demand, they are NOT intended to be instantiated directly.

Exported for the benefit of type checking and extension use cases.

Type Parameters

Hierarchy

  • PointerSetBase<T, K, R>
    • PointerSetBlock

Implements

Implemented by

Constructors

constructor

Properties

blockId blockIdMask blockSize blocks blocksAvail fields firstNextFree freeList mask names nextFree rawFields shift shiftDownFix shiftUpFix values wordSize

Methods

alloc available blocksCount drop dropEmpty entryCount erase free getBlockId getIndex getPointer getRawSlab raw raw16 raw32 raw8 rawAll ref refAll size totalAvailable value wipeBlock

Constructors

constructor

  • Class representing an expanded block in a PointerSet data store. These are created on demand, they are NOT intended to be instantiated directly.

    Exported for the benefit of type checking and extension use cases.

    Type Parameters

    Parameters

    • blocks: PointerSetBlock<T, K, R>[]
    • blocksAvail: Set<PointerSetBlock<T, K, R>>
    • names: { [ k in string]: FieldId }
    • wordSize: WordSize
    • shift: Shift
    • mask: Mask
    • blockIdMask: BlockIdMask
    • blockSize: BlockSize

    Returns PointerSetBlock<T, K, R>

Properties

blockId

blockId: BlockId

blockIdMask

blockIdMask: BlockIdMask

blockSize

blockSize: BlockSize

blocks

blocks: PointerSetBlock<T, K, R>[]

blocksAvail

blocksAvail: Set<PointerSetBlock<T, K, R>>

fields

fields: Uint32Array[]

firstNextFree

firstNextFree: FirstNextFree = ...

freeList

freeList: Stack

mask

mask: Mask

names

names: { [ k in string]: FieldId }

nextFree

nextFree: Index = ...

rawFields

rawFields: Uint32Array[]

shift

shift: Shift

shiftDownFix

shiftDownFix: ShiftDownFix

shiftUpFix

shiftUpFix: ShiftUpFix = ...

shifting UP to get a block id from a pointer always overflows in the same way, because we are converting from an int32 into a uint32

values

values: (undefined | T)[] = []

wordSize

wordSize: WordSize

Methods

alloc

  • Allocate a new pointer in the set, associated with the supplied value parameter.

    Any pointers passed in the refs argument are assigned as pointers stored in the associated fields slab.

    Any raw numeric values in the raws argument are stored in the associated rawFields slab.

    Parameters

    • value: T
    • Optional refs: RefSet<K>
    • Optional raw: RawSet<R>

    Returns Pointer

available

  • number of available spaces in a given block

    Parameters

    • blockId: number

    Returns number

blocksCount

  • Number of blocks in the PointerSet

    Returns number

drop

  • Drop block from the set, or wipeBlock() if the root block. Only allowed on the last block in the stack.

    Returns void

dropEmpty

  • Pop any empty blocks off the end of the stack.

    Returns void

entryCount

  • number of entries in a given block

    Parameters

    • blockId: number

    Returns number

erase

  • Mark a pointer location as free for re-use, delete its value from the values array, and set any refs and raw values to 0.

    See also free() for a faster version of this that does not set the data in the fields/rawFields slabs to 0.

    Parameters

    Returns void

free

  • Mark a Pointer location as free for re-use, and delete its value from the values array.

    Note that this does not delete raw values and references from the relevant data slabs, so it is still possible to dereference previously freed pointers, and get their former values.

    See erase() if you need this.

    Parameters

    Returns void

getBlockId

  • For internal use: get a BlockId from a Pointer

    Parameters

    Returns BlockId

getIndex

  • For internal use: get an Index from a Pointer

    Parameters

    Returns Index

getPointer

  • For internal use: get a Pointer from a BlockId and Index

    Parameters

    • blockId: BlockId
    • index: Index

    Returns Pointer

getRawSlab

  • Parameters

    • pointer: Pointer
    • field: FieldName<R>

    Returns Uint32Array

raw

  • Get the raw data from the supplied pointer, in the specified rawField

    Parameters

    • pointer: Pointer
    • field: FieldName<R>

    Returns number

  • Set the raw data from the supplied pointer, in the specified rawField

    Parameters

    • pointer: Pointer
    • field: FieldName<R>
    • val: number

    Returns number

raw16

  • Get the raw data from the supplied pointer, in the supplied rawField, as a 2-word Uint16Array view. Editing the view will update the value.

    Parameters

    • pointer: Pointer
    • field: FieldName<R>

    Returns Uint16ArrayLength2

  • Set the raw data for the supplied pointer, in the supplied rawField, to the values set in a 2-word Uint16Array. Returns a 2-word Uint16Array view. Editing the view will update the value.

    Parameters

    • pointer: Pointer
    • field: FieldName<R>
    • val: Uint16Array

    Returns Uint16ArrayLength2

raw32

  • Get the raw data from the supplied pointer, in the supplied rawField, as a 1-word Uint32Array view. Editing the view will update the value.

    Parameters

    • pointer: Pointer
    • field: FieldName<R>

    Returns Uint32ArrayLength1

  • Set the raw data for the supplied pointer, in the supplied rawField, to the values set in a 1-word Uint32Array. Returns a 1-word Uint32Array view. Editing the view will update the value.

    Parameters

    • pointer: Pointer
    • field: FieldName<R>
    • val: Uint32Array

    Returns Uint32ArrayLength1

raw8

  • Get the raw data from the supplied pointer, in the supplied rawField, as a 4-byte Uint8Array view. Editing the view will update the value.

    Parameters

    • pointer: Pointer
    • field: FieldName<R>

    Returns Uint8ArrayLength4

  • Set the raw data for the supplied pointer, in the supplied rawField, to the values set in a 4-byte Uint8Array. Returns a 4-byte Uint8Array view. Editing the view will update the value.

    Parameters

    • pointer: Pointer
    • field: FieldName<R>
    • val: Uint8Array

    Returns Uint8ArrayLength4

rawAll

  • get all raw values, or set zero or more in an object

    Parameters

    • pointer: Pointer
    • Optional raws: RawSet<R>

    Returns RawSet<R>

ref

  • Get the reference from the supplied pointer, in the specified field

    Parameters

    • pointer: Pointer
    • field: FieldName<K>

    Returns Pointer

  • Set the reference from the supplied pointer, in the specified field

    Parameters

    Returns Pointer

refAll

  • get all reference values, or set zero or more in an object

    Parameters

    • pointer: Pointer
    • Optional refs: RefSet<K>

    Returns RefSet<K>

size

  • Total number of entries in the entire PointerSet Note that it is always at least 1, because the root block's zero-entry is reserved for the nullPointer.

    Returns number

totalAvailable

  • Total number of available spaces in the entire PointerSet.

    Returns number

value

  • Get the data for a given pointer from the values array

    Parameters

    Returns undefined | T

  • Set the data for a given pointer in the values array

    Parameters

    Returns T

wipeBlock

  • Erase all data in the slab.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc