@oasys/oecs 0.5.2 → 0.5.4

package/dist/core/ecs/archetype.d.cts

@@ -16,7 +16,7 @@ export interface ArchetypeEdge {
  * Cached resolution of a *multi*-component add out of this archetype: the
  * target archetype the union lands in, plus the pre-built src→target batch
  * transition map. Keyed (on the source archetype) by an exact N-tagged pack of
- * the added component ids — see `Store.addComponents` (#659).
+ * the added component ids — see `Store.addComponents`.
  *
  * Where `ArchetypeEdge` is the per-*component* edge the single-add path indexes
  * by `edges[component_id]`, this is the per-*set* edge the plural-add path looks
@@ -53,7 +53,7 @@ export type ColumnFactory = (componentId: ComponentID, fieldIdx: number, tag: Ty
  * across every SAB-backed archetype; after the handler returns,
  * `arch._flatColumns[i].buf.length` is guaranteed to be `>= arch.length +
  * additional`. Heap-backed archetypes leave this unset — their
- * `GrowableTypedArray` grows in place. (#171 §6.1.9 Phase 3)
+ * `GrowableTypedArray` grows in place.
  */
 export type ArchetypeGrowHandler = (arch: Archetype, additional: number) => void;
 /**
@@ -63,8 +63,7 @@ export type ArchetypeGrowHandler = (arch: Archetype, additional: number) => void
  * `removeEntity`, `moveEntityFrom`, `writeFields`, `setEdge`, and the
  * mutable `getColumn`) stays internal so query iteration can't bypass the
  * deferred-flush path that prevents iterator invalidation. This is the same
- * back door PR #163 closed for `Store`; issue #378 closed it again for
- * `Query`.
+ * back door that is closed for `Store` and closed again for `Query`.
  *
  * `id` is the archetype's opaque identity (not a mutator) — exposed so the
  * public `ECS.batchAddComponent`/`batchRemoveComponent` API can target an
@@ -73,16 +72,16 @@ export type ArchetypeGrowHandler = (arch: Archetype, additional: number) => void
 export interface ArchetypeView<out Defs extends readonly ComponentDef<any>[] = readonly ComponentDef<any>[]> {
     /** Opaque archetype identity. Pass to `ECS.batch_*_component`. */
     readonly id: ArchetypeID;
-    /** Number of **enabled** entities — the default-iteration bound (#577). Rows
+    /** Number of **enabled** entities — the default-iteration bound. Rows
      * `0..entityCount-1` are enabled; disabled rows (if any) sit contiguously at
      * `entityCount..totalCount-1`. `forEach` SoA loops read this, so they skip
      * disabled rows for free. Use `totalCount` to span disabled rows too. */
     readonly entityCount: number;
-    /** Total live rows, enabled + disabled (#577). Equal to `entityCount` unless
+    /** Total live rows, enabled + disabled. Equal to `entityCount` unless
      * some rows are disabled. Use for full-state work (serialization, snapshot,
      * determinism) that must see every entity regardless of enabled state. */
     readonly totalCount: number;
-    /** Number of disabled rows = `totalCount - entityCount` (#577). */
+    /** Number of disabled rows = `totalCount - entityCount`. */
     readonly disabledCount: number;
     /** Raw entity ID buffer (packed `EntityID`s). Valid data at indices
      * 0..totalCount-1 (enabled rows first, then disabled). */
@@ -91,7 +90,7 @@ export interface ArchetypeView<out Defs extends readonly ComponentDef<any>[] = r
     hasComponent(id: ComponentID): boolean;
     /** Get a single field's column (read-only). Valid data: indices
      * 0..entityCount-1. `def` must be a term of the iterating query
-     * (POLISH_AUDIT #6); the bare-`ArchetypeView` default stays permissive. */
+     *; the bare-`ArchetypeView` default stays permissive. */
     getColumnRead<D extends ComponentDef<any>, K extends string & keyof SchemaOf<D>>(def: D & DeclaredQueryTerm<Defs, D>, field: K): ReadonlyColumn;
     /** Tuple fetch of several of one component's columns —
      * `const [q, r] = arch.getColumnsRead(HexPos, "q", "r")`. One small
@@ -100,7 +99,7 @@ export interface ArchetypeView<out Defs extends readonly ComponentDef<any>[] = r
         [I in keyof K]: ReadonlyColumn;
     };
     /** Get a single field's column **if this archetype has the component**,
-     * else `undefined` — the optional-query fetch-if-present accessor (#575).
+     * else `undefined` — the optional-query fetch-if-present accessor.
      * The absent branch is expected (resolve the column pointer per archetype
      * span: present ⇒ column, absent ⇒ `undefined`), not an error. Same
      * advisory-readonly view and `reads`-access-check as `getColumnRead`. */
@@ -125,7 +124,7 @@ export declare class Archetype implements ArchetypeView {
     private readonly _entityIds;
     length: number;
     /**
-     * Enabled/disabled row partition (#577 — entity enable/disable). Rows
+     * Enabled/disabled row partition (entity enable/disable). Rows
      * `[0, enabled_count)` are enabled, `[enabled_count, length)` are disabled.
      * `enabled_count === length` (no disabled rows) is the common case — every
      * fast path below short-circuits on it, so an archetype that never disables
@@ -139,14 +138,14 @@ export declare class Archetype implements ArchetypeView {
     enabledCount: number;
     /**
      * Flush-epoch stamp + captured pre-counts for the Store's per-entity flush
-     * 0-crossing detector (#328, #812): `_flushAdds`/`_flushRemoves` stamp each
+     * 0-crossing detector: `_flushAdds`/`_flushRemoves` stamp each
      * archetype on first sight per flush (a few field accesses) instead of probing
      * a `Map<archetype_id, pre_count>` per entity — the same per-entity Map
-     * cost the destroy drain shed in #457. Both `_flushPreLen` and
+     * cost the destroy drain also avoids. Both `_flushPreLen` and
      * `_flushPreEnabled` are recorded so the settle pass can detect a 0-crossing
      * on either the total (`length`) or the enabled partition (`enabledCount`) —
-     * an enabled append into an all-disabled archetype crosses only the latter
-     * (#812). Owned by Store; pure scheduling bookkeeping, never folded into
+     * an enabled append into an all-disabled archetype crosses only the latter.
+     * Owned by Store; pure scheduling bookkeeping, never folded into
      * `stateHash`/snapshot.
      */
     _flushSeenEpoch: number;
@@ -171,13 +170,17 @@ export declare class Archetype implements ArchetypeView {
      */
     private readonly batchTransitionMaps;
     /**
-     * Per-set add-edge cache for `Store.addComponents` (#659), keyed by an
+     * Per-set add-edge cache for `Store.addComponents`, keyed by an
      * exact pack of the added component ids. Lazily allocated: most archetypes
      * never originate a plural add, so the Map stays `null` until the first one
      * is resolved — the single-add `edges[]` path never touches it.
      */
     private compositeAddEdges;
     readonly _flatColumns: ColumnBacking<AnyTypedArray>[];
+    _bufs: AnyTypedArray[];
+    private _eids;
+    private _rowCap;
+    private _colCap;
     /** Set by `fromColumnStore` to record which SAB archetype this Archetype
      * draws its column views from. `null` for the default heap-backed path
      * (no SAB linkage; `refreshViews` would be a no-op there and so
@@ -196,9 +199,66 @@ export declare class Archetype implements ArchetypeView {
      * archetype during construction; `null` on heap-backed archetypes (the
      * default `GrowableTypedArray` grows in place). Insertion methods call
      * `_invoke_grow(...)` below before any push that would overflow the
-     * current SAB row capacity. (#171 §6.1.9 Phase 3) */
+     * current SAB row capacity. */
     growHandler: ArchetypeGrowHandler | null;
     constructor(id: ArchetypeID, mask: BitSet, layouts?: ArchetypeColumnLayout[], initialCapacity?: number, columnFactory?: ColumnFactory);
+    /** Re-derive the `_bufs` / `_eids` / `_rowCap` row plane from the backing
+     * columns. The sole writer of all three — see the `_bufs` field doc for the
+     * invariant it restores. Cold: construction, `refreshViews`, tail of a grow. */
+    private _syncRowPlane;
+    /** Re-point every cached `eachChunk` column group at the current `_bufs`.
+     *
+     * Called only from `_syncRowPlane`, which is the only thing that can change a
+     * column's buffer identity — so after this runs, a cached group is correct by
+     * construction and `columnGroupMut` / `columnGroupRead` need no staleness test
+     * at all. That absence is the point: those two run once per archetype per
+     * `eachChunk` pass, which for a fragmented query is once per chunk, and this
+     * file already carries one hard-won lesson (`_onArchLenChange`): one more
+     * statement pushed that per-mutation function past V8's inlining budget, and
+     * it became much slower. We measured two earlier forms of this optimisation
+     * and rejected both for the same cause. A fill through a shared helper made
+     * fragmented iteration slower, and an inline test for a stale buffer also made
+     * it slower. Each loss was larger than the gain in system dispatch. Move the
+     * work to the cold path, and the gain stays with no loss.
+     *
+     * Refreshes in place, preserving object identity, for the same reason
+     * `_syncRowPlane` refills `_bufs` in place: a caller that captured the group
+     * sees fresh buffers rather than silently stale ones. */
+    private _refreshGroupCaches;
+    /** DEV-only: assert the row plane still addresses the live buffers.
+     *
+     * `_bufs`/`_eids` and `_flatColumns[i].buf`/`_entityIds.buf` are two paths to
+     * one buffer, and only the first is cached — the row ops index the cache while
+     * `getColumnRead` / `writeFields` read `.buf` fresh. Anything that changes a
+     * buffer's identity owes a `_syncRowPlane`; miss one and the two paths split
+     * silently, with row writes landing in an orphan that later reads never see.
+     *
+     * Checked at the boundaries that read `.buf` directly, and O(1): index 0 alone
+     * is enough, because `_syncRowPlane` rewrites every entry together — there is
+     * no way to desync one column and not the first. */
+    private _assertRowPlaneFresh;
+    /** Make room for `additional` more rows, growing if the append would
+     * overflow. Replaces the `this.length >= cols[0].buf.length` probe the append
+     * paths each open-coded — that read a column object and its buffer's length
+     * on every single-row append; this is one compare against a cached number.
+     *
+     * Both backings are handled by `_growRows` so callers don't branch: a
+     * SAB-backed archetype delegates to the store's `growHandler` (realloc +
+     * republish, which re-enters `refreshViews`), a heap-backed one
+     * (`growHandler === null`, the unit-test factory) grows each column in place.
+     * Either way the buffers may have moved, so the row plane is re-synced before
+     * returning — including when the grow throws. */
+    private _reserveRows;
+    /** Cold half of `_reserveRows`: the append genuinely doesn't fit, so grow.
+     * Never called on the fast path — see the caller. */
+    private _growRows;
+    /** Push `Archetype.length` down into each column's own logical length (and
+     * the entity-id array's). The row plane keeps `length` authoritative and never
+     * touches `_len`, so the columns' view of it goes stale between publishes.
+     * Nothing on the ECS hot paths reads it; the boundaries that DO — a
+     * reallocating `ensureCapacity`, `refreshView`'s shrink check, `view()` —
+     * publish first. */
+    private _publishRowCounts;
     /**
      * Build an Archetype whose columns are TypedArray views into a single
      * `ColumnStore`-managed `SharedArrayBuffer`. The store must contain an
@@ -208,7 +268,7 @@ export declare class Archetype implements ArchetypeView {
      * The resulting archetype is fixed-capacity at the SAB row capacity —
      * any operation that would push past it throws `StoreColumnOverflowError`.
      * To grow capacity, call `growColumnStore(...)` between ticks and then
-     * `refreshViews(newStore)` on this archetype (#171 §6.1.4 / §8.1).
+     * `refreshViews(newStore)` on this archetype.
      */
     static fromColumnStore(id: ArchetypeID, mask: BitSet, layouts: ArchetypeColumnLayout[], columnStore: ColumnStore, storeArchetypeId: number): Archetype;
     /** True iff this archetype was constructed via `fromColumnStore` and its
@@ -228,7 +288,7 @@ export declare class Archetype implements ArchetypeView {
      * expects.
      */
     refreshViews(newColumnStore: ColumnStore): void;
-    /** Enabled-row count — the default iteration bound (#577). See `enabled_count`.
+    /** Enabled-row count — the default iteration bound. See `enabled_count`.
      * Equals `length` whenever no entity is disabled (the common case).
      *
      * During an `includeDisabled()` query's `forEach`, the module flag
@@ -237,9 +297,9 @@ export declare class Archetype implements ArchetypeView {
      * transparently, with no change to the loop. Outside such iteration the flag is
      * false and this is `enabled_count`. */
     get entityCount(): number;
-    /** Total live rows incl. disabled (#577). */
+    /** Total live rows incl. disabled. */
     get totalCount(): number;
-    /** Disabled-row count (#577). */
+    /** Disabled-row count. */
     get disabledCount(): number;
     /** Raw entity ID buffer (packed `EntityID`s). Valid data at indices
      * 0..totalCount-1 (enabled rows first, then disabled). */
@@ -250,7 +310,7 @@ export declare class Archetype implements ArchetypeView {
      * cares about (it knows the two `entityIds` after the swap). The partition
      * primitives (`disableRow`/`enableRow`/`removeRow`/`_placeTail`) build on
      * this. Writes through each column's live backing buffer (`buf`), so it works
-     * for both heap- and SAB-backed columns. No-op when `a === b`. (#577) */
+     * for both heap- and SAB-backed columns. No-op when `a === b`. */
     swapRows(a: number, b: number): void;
     /**
      * Place a freshly-appended ENABLED entity (currently at the tail row `tail`,
@@ -259,11 +319,11 @@ export declare class Archetype implements ArchetypeView {
      *
      * Common case — no disabled rows (`enabled_count === tail`): the tail row IS
      * the next enabled slot, so this is just `enabled_count++` and returns `tail`
-     * (byte-for-byte the pre-#577 behaviour, `entityRow` untouched). Rare case —
+     * (byte-for-byte the earlier behaviour, `entityRow` untouched). Rare case —
      * disabled rows occupy `[enabled_count, tail)`: swap the appended row into the
      * first disabled slot and push that disabled occupant to the tail, updating
      * its `entityRow`. Requires `entityRow` in that case (a `DEV` guard fires
-     * if a caller appends into a disabled-bearing archetype without passing it). (#577) */
+     * if a caller appends into a disabled-bearing archetype without passing it). */
     private _placeTail;
     /**
      * Bulk analog of `_placeTail` for `count` freshly-appended enabled rows at
@@ -271,21 +331,21 @@ export declare class Archetype implements ArchetypeView {
      * start`): `enabled_count += count`, return `start`. The bulk callers
      * (`spawnMany`, batch ops) fall back to a per-entity append loop when the
      * target already has disabled rows, so the rare branch is a `DEV` guard
-     * rather than a block-rotation. (#577) */
+     * rather than a block-rotation. */
     private _placeTailBulk;
     /**
      * Disable the entity at `row` (precondition: enabled, `row < enabled_count`).
      * Swaps it to the end of the enabled region and shrinks the region, so it
      * lands in the disabled tail with its data intact — no archetype transition,
-     * O(1)+one row swap. Updates `entityRow` for both rows touched. (#577) */
+     * O(1)+one row swap. Updates `entityRow` for both rows touched. */
     disableRow(row: number, entityRow: Int32Array): void;
     /**
      * Enable the entity at `row` (precondition: disabled, `row >= enabled_count`).
      * Swaps it to the front of the disabled region and grows the enabled region.
-     * Updates `entityRow` for both rows touched. (#577) */
+     * Updates `entityRow` for both rows touched. */
     enableRow(row: number, entityRow: Int32Array): void;
     /**
-     * Partition-aware swap-remove that owns its `entityRow` updates (#577). The
+     * Partition-aware swap-remove that owns its `entityRow` updates. The
      * Store's destroy/move paths call this instead of `removeEntity`; it keeps the
      * enabled prefix contiguous in every case:
      *  - disabled row (`row >= enabled_count`): swap-remove within the disabled
@@ -297,9 +357,9 @@ export declare class Archetype implements ArchetypeView {
      * Updates `entityRow` for every relocated entity (never for the removed one —
      * the caller frees/repoints it). */
     removeRow(row: number, entityRow: Int32Array): void;
-    /** @internal — cold partition-aware tail of `removeRow` (#577): the
+    /** @internal — cold partition-aware tail of `removeRow`: the
      * disabled-bearing archetype case. Split out so the no-disabled fast path
-     * above stays small enough to inline (#649); see the doc on `removeRow`. */
+     * above stays small enough to inline; see the doc on `removeRow`. */
     private _removeRowPartitioned;
     get entityList(): Uint32Array;
     hasComponent(id: ComponentID): boolean;
@@ -309,7 +369,7 @@ export declare class Archetype implements ArchetypeView {
      * data: indices 0..entityCount-1. The `ReadonlyColumn` return is an
      * *advisory* compile-time barrier: it is the live mutable backing buffer,
      * so the `readonly` index signature blocks writes at the type layer only
-     * (a §10c-policed cast can still write through). For writes use the
+     * (a deliberate cast can still write through). For writes use the
      * mutable `getColumn` (tick-bumping) below.
      */
     getColumnRead<S extends ComponentSchema, K extends string & keyof S>(def: ComponentDef<S>, field: K): ReadonlyColumn;
@@ -326,8 +386,8 @@ export declare class Archetype implements ArchetypeView {
     };
     /**
      * Get a single field's column **if this archetype has the component**, else
-     * `undefined` — the fetch-if-present accessor for optional query terms (#575,
-     * Bevy `Option<&T>` / flecs `?`). An optional query (`q.optional(T)`) spans
+     * `undefined` — the fetch-if-present accessor for optional query terms
+     * (Bevy `Option<&T>` / flecs `?`). An optional query (`q.optional(T)`) spans
      * archetypes both with and without `T`; the caller branches once per
      * archetype span on the return:
      *
@@ -344,7 +404,7 @@ export declare class Archetype implements ArchetypeView {
      * depend on whether the current span happens to hold `T`. Two checks fire:
      * (1) `accessCheck.checkRead` — an optional read needs `reads:[T]` coverage
      * exactly as a required read does; (2) `accessCheck.checkOptionalFetch` —
-     * the iterating query must have declared `.optional(T)` (#592), the read-side
+     * the iterating query must have declared `.optional(T)`, the read-side
      * analog that makes the query term the fetch's authorization rather than inert
      * decoration. The return is the same advisory-readonly view `getColumnRead`
      * hands back.
@@ -389,9 +449,9 @@ export declare class Archetype implements ArchetypeView {
      * starting dstRow for the batch. Caller is responsible for tracking
      * entityIndex → row for every entity in the batch.
      *
-     * Collapses the N×C `push(0)` cost of N sequential `addEntity` calls
-     * into C `bulkAppendZeroes(count)` calls — the same pattern
-     * `bulkMoveAllFrom` (`:580`) uses for the move-with-data case (#330).
+     * Collapses the N×C per-element cost of N sequential `addEntity` calls into
+     * C `fill` calls, one for each column — the same pattern `bulkMoveAllFrom`
+     * uses for the move-with-data case.
      */
     addEntities(entityIds: Uint32Array, count?: number): number;
     /** Tag-optimized bulk add: skip the per-column zero-fill entirely. */
@@ -401,8 +461,8 @@ export declare class Archetype implements ArchetypeView {
      * `addEntitiesWithValues` appends run internally, lifted out so the spawn
      * path can pre-reserve capacity BEFORE it commits an entity slot. A SAB-cap
      * grow throws here (with the world untouched) instead of mid-append after the
-     * slot is already live — see `Store.spawn`/`spawnMany` (#775). No-op for a
-     * tag-only archetype (no SAB columns) or when no grow handler is installed. */
+     * slot is already live — see `Store.spawn`/`spawnMany`. Now just the
+     * public name for `_reserveRows`, which every append path shares. */
     ensureRowCapacity(additional: number): void;
     /** Append one entity, writing `flatValues[i]` straight into column `i`
      * (in `_flatColumns` order) — no zero-fill-then-overwrite. Bumps every
@@ -424,7 +484,7 @@ export declare class Archetype implements ArchetypeView {
     /**
      * Move an entity from src into this archetype (tag-only: no columns to copy).
      * Writes dstRow to _moveResult[0]; _moveResult[1] is always NO_SWAP (the
-     * partition-aware src/dst updates are owned internally, #577).
+     * partition-aware src/dst updates are owned internally).
      */
     moveEntityFromTag(src: Archetype, srcRow: number, entityId: EntityID, entityRow: Int32Array): void;
     /**
@@ -444,7 +504,7 @@ export declare class Archetype implements ArchetypeView {
     clearRows(): void;
     /**
      * Re-derive the host-side row bookkeeping after a snapshot is mounted onto a
-     * live world (#789, `Store.restoreInto`). A snapshot reloads the column bytes
+     * live world (`Store.restoreInto`). A snapshot reloads the column bytes
      * (dense SAB) but NOT the host-side `length` / `enabledCount` / `_entityIds`
      * back-reference — those are reconstructed here. `refreshViews` must have
      * already repointed the columns at the restored SAB.
@@ -452,7 +512,7 @@ export declare class Archetype implements ArchetypeView {
      * The caller scans the restored entity-index region to learn which entity
      * occupies each row and passes them in row order (`rowEntityIds[r]` is the
      * packed `EntityID` at row `r`; rows `[0, length)` are dense, enabled rows
-     * first then disabled per the #577 partition). `enabledCount` is the restored
+     * first then disabled per the partition). `enabledCount` is the restored
      * partition boundary. This is the inverse of the per-row `addEntity` /
      * `disableRow` bookkeeping the live run accumulated.
      */
@@ -465,12 +525,12 @@ export declare class Archetype implements ArchetypeView {
      * cache only covers single-component steps.
      */
     getBatchTransitionMap(target: Archetype): Int16Array;
-    /** Look up a cached plural-add transition by its packed key (#659). Returns
+    /** Look up a cached plural-add transition by its packed key. Returns
      * `undefined` until the first composite add out of this archetype plants the
      * lazy Map — the common case for archetypes that only ever see single adds. */
     getCompositeAddEdge(key: number): CompositeAddEdge | undefined;
     /** Cache a resolved plural-add transition (target + src→target map) under its
-     * packed key (#659), allocating the backing Map on first use. */
+     * packed key, allocating the backing Map on first use. */
     cacheCompositeAddEdge(key: number, target: ArchetypeID, map: Int16Array): void;
 }
 /** Reusable result buffer for move_entity_from/move_entity_from_tag. [dstRow, swapped_index] */