@xtia/grid 0.0.13 → 0.1.1

package/README.md

@@ -1,6 +1,6 @@
 # `Grid`
 
-**Alpha**: Pre-0.1.0 API details may change
+**Beta**: Stable core, open to refinement pre-1.0.0
 
 ## Summary
 
@@ -22,7 +22,7 @@ npm i @xtia/grid
 ```
 
 ```ts
-import { Grid } from "@xtia/grid"; // ~4.8kb gzipped
+import { Grid } from "@xtia/grid"; // ~4.8kb gzipped (2.2kb + Pipe2D dep)
 
 // initialise a 30x20 Grid<number> of 0's
 const numGrid = Grid.solid(30, 20, 0);
@@ -32,7 +32,7 @@ numGrid.set(3, 3, 50);
 
 // initialise a chessboard
 const chessGrid = Grid.init(8, 8, (x, y) => 
-  (x + y) % 2 === 0 ? 'black' : 'white'
+	(x + y) % 2 === 0 ? 'black' : 'white'
 );
 
 // read a value
@@ -106,12 +106,11 @@ const lakeGrid = Grid.from(lakeRegion);
 
 ```ts
 const spriteMap = world.map(
-	type => type + ".png",
-	sprite => sprite.replace(/\..*/, '')
+	type => type + ".png", // add .png on parent-read
+	sprite => sprite.replace(/\..*/, '') // remove it on parent-write
 );
 
-world.set(0, 0, "mountain"); // modify the parent
-console.log(spriteMap.get(0, 0)); // read the transformed view: "mountain.png"
+console.log(spriteMap.get(0, 0)); // read the transformed view: "grass.png"
 spriteMap.set(1, 0, "forest.png"); // modify the view
 console.log(world.get(1, 0)); // read the parent: "forest"
 ```
@@ -144,7 +143,6 @@ const minimap = world.pipe
 	.floorCoordinates()
 	.crop(viewX, viewY, vw, vh)
 	.stretch(canvas.width, canvas.height);
-
 ```
 
 ## Cell interface
@@ -248,7 +246,7 @@ world.paste(snapshot);
 For persistent storage or transmission, Pipe2D can export as array:
 
 ```ts
-const saved = snapshot.toFlatArrayXY(); // ["mountain", "forest", "grass", ...]
+const saved = snapshot.toFlatArrayXY(); // ["grass", "forest", "grass", ...]
 
 const restoredSnapshot = Pipe2D.fromFlatArrayXY(saved);
 ```

package/lib/grid.d.ts

@@ -67,13 +67,8 @@ export declare class Grid<T> {
     fill(value: T): void;
     paste(source: Source2D<T>, x?: number, y?: number): void;
     writeMask(mask: Source2D<boolean> | GetXYFunc<boolean>): Grid<T>;
-    [Symbol.iterator](): IterableIterator<{
-        x: number;
-        y: number;
-        value: T;
-    }>;
+    [Symbol.iterator](): IterableIterator<T>;
     forEach(callback: (value: T, x: number, y: number) => void): void;
-    combine<U, R>(aux: Source2D<U>, cb: (source: T, aux: U) => R): GridBase<R>;
     map<U>(read: (initial: T, x: number, y: number) => U, write: (local: U, x: number, y: number) => T): Grid<U>;
     region(x: number, y: number, width: number, height: number): Grid<T>;
     scroll(xDelta: number, yDelta: number, fill: T): this;
@@ -90,7 +85,6 @@ export declare class GridBase<T> extends Grid<T> {
     batchUpdate(fn: () => void): void;
     constructor(source: Source2D<T>);
     on<K extends keyof EventMap<T>>(eventName: K, handler: (data: EventMap<T>[K]) => void): () => void;
-    private xyToIndex;
     private _set;
     private triggerChange;
 }

package/lib/grid.js

@@ -215,6 +215,9 @@ export class Grid {
         this.parentSet = parentSet;
         this.batch = batch;
         this.cells = new Pipe2D(this.width, this.height, (x, y) => {
+            if (x < 0 || x >= this.width || y < 0 || y >= this.height || !Number.isInteger(x) || !Number.isInteger(y)) {
+                throw new RangeError(`Cell coordinates must be bounded integers; got (${x}, ${y})`);
+            }
             return new Cell(x, y, this);
         }).strict().withCache();
         this.pipe = new Pipe2D(this);
@@ -261,7 +264,7 @@ export class Grid {
         this.batchUpdate(() => {
             for (let y = 0; y < this.height; y++) {
                 for (let x = 0; x < this.width; x++) {
-                    this.trySet(x, y, value);
+                    this.set(x, y, value);
                 }
             }
         });
@@ -271,7 +274,10 @@ export class Grid {
         this.batchUpdate(() => {
             for (let oy = 0; oy < source.height; oy++) {
                 for (let ox = 0; ox < source.width; ox++) {
-                    this.trySet(ox + x, oy + y, cachedSource.get(ox, oy));
+                    const tx = ox + x, ty = oy + y;
+                    if (tx < 0 || tx >= this.width || ty < 0 || ty >= this.height)
+                        continue;
+                    this.set(tx, ty, cachedSource.get(ox, oy));
                 }
             }
         });
@@ -290,7 +296,7 @@ export class Grid {
     *[Symbol.iterator]() {
         for (let y = 0; y < this.height; y++) {
             for (let x = 0; x < this.width; x++) {
-                yield { x, y, value: this.get(x, y) };
+                yield this.get(x, y);
             }
         }
     }
@@ -301,22 +307,11 @@ export class Grid {
             }
         }
     }
-    combine(aux, cb) {
-        const width = Math.min(this.width, aux.width);
-        const height = Math.min(this.height, aux.height);
-        return new GridBase({
-            width,
-            height,
-            get: (x, y) => {
-                return cb(this.get(x, y), aux.get(x, y));
-            }
-        });
-    }
     map(read, write) {
         return new Grid(this.width, this.height, (x, y) => read(this.parentGet(x, y), x, y), (x, y, value) => this.parentSet(x, y, write(value, x, y)), fn => this.batch(fn));
     }
     region(x, y, width, height) {
-        if (!Number.isInteger(x) || !Number.isInteger(y) || !Number.isInteger(width) || !Number.isInteger(height)) {
+        if (!Number.isInteger(x) || !Number.isInteger(y)) {
             throw new Error(`Region boundaries must be integer; got (${x}, ${y}), (${width} x ${height})`);
         }
         if (x < 0 || y < 0 || x + width > this.width || y + height > this.height) {
@@ -384,11 +379,12 @@ export class GridBase extends Grid {
         if (this.batchState.level == 0) {
             const changed = this.batchState.changedCells;
             this.batchState = null;
-            this.triggerChange(changed);
+            if (changed.size > 0)
+                this.triggerChange(changed);
         }
     }
     constructor(source) {
-        super(source.width, source.height, (x, y) => this.data[this.xyToIndex(x, y)], (x, y, value) => this._set(x, y, value), fn => this.batchUpdate(fn));
+        super(source.width, source.height, (x, y) => this.data[y * this.width + x], (x, y, value) => this._set(x, y, value), fn => this.batchUpdate(fn));
         this.eventHandlers = {};
         this.batchState = null;
         const sourcePipe = source instanceof Pipe2D
@@ -408,20 +404,11 @@ export class GridBase extends Grid {
             this.eventHandlers[eventName].splice(idx, 1);
         };
     }
-    xyToIndex(x, y) {
-        if (x < 0 || x >= this.width || y < 0 || y >= this.height) {
-            throw new Error(`Coordinates out of bounds: (${x}, ${y})`);
-        }
-        if (!Number.isInteger(x) || !Number.isInteger(y)) {
-            throw new Error(`Coordinates must be integer; got (${x}, ${y})`);
-        }
-        return y * this.width + x;
-    }
     _set(x, y, value) {
-        const idx = this.xyToIndex(x, y);
+        const idx = y * this.width + x;
         if (this.data[idx] === value)
             return;
-        this.data[this.xyToIndex(x, y)] = value;
+        this.data[idx] = value;
         if (this.batchState) {
             this.batchState.changedCells.add(this.cells.get(x, y));
             return;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.13",
+  "version": "0.1.1",
   "description": "2D store and utilities, with zero-copy regions and transform layers, pathfinding, Pipe2D interop",
   "name": "@xtia/grid",
   "exports": {
@@ -12,8 +12,7 @@
   "keywords": [
     "grid",
     "game-dev",
-    "pathfinding",
-    "cellular-automata"
+    "pathfinding"
   ],
   "scripts": {
     "build": "npx tsc",