@gkucmierz/utils 2.0.8 → 2.1.0

package/README.md

@@ -48,6 +48,9 @@ This library provides a wide range of mathematical functions and data structures
   - `heronsFormula`: Triangle area calculation.
   - `squareRoot`: Integer square root using Newton's method.
 
+- **Automata & Simulation**:
+  - `createLangtonsAnt`, `createUnlimitedGrid`: Infinite 2D grid and Langton's Ant cellular automaton engine (Project Euler 349 compatible).
+
 - **String & Encoding & Arrays**:
   - `base64`: Base64 and Base64Url encoding/decoding.
   - `copyCase`: Match case of a string to another.

package/main.mjs

@@ -53,6 +53,9 @@ import {
 import {
   heronsFormula, heronsFormulaBI
 } from './src/herons-formula.mjs'
+import {
+  createLangtonsAnt, createUnlimitedGrid
+} from './src/langtons-ant.mjs'
 import {
   lcm, lcmBI
 } from './src/lcm.mjs'
@@ -132,6 +135,7 @@ export * from './src/gpn.mjs';
 export * from './src/gray-code.mjs';
 export * from './src/heap.mjs';
 export * from './src/herons-formula.mjs';
+export * from './src/langtons-ant.mjs';
 export * from './src/lcm.mjs';
 export * from './src/list-node.mjs';
 export * from './src/lucas-lehmer.mjs';
@@ -154,5 +158,5 @@ export * from './src/square-root.mjs';
 export * from './src/tonelli-shanks.mjs';
 
 export default [
-  SetCnt, Trie, arrayHistogram, fromBase64, fromBase64Url, toBase64, toBase64Url, bijective2num, bijective2numBI, num2bijective, num2bijectiveBI, binarySearchArr, binarySearchGE, binarySearchLE, binarySearchRangeIncl, combinations, combinationsIterator, consumeIteratorNonBlocking, copyCase, egcd, factors, factorsBI, formatBigNumber, formatBigNumberBI, wrapFn, gcd, gcdBI, getType, gpn, gpnBI, bin2gray, gray2bin, Heap, heronsFormula, heronsFormulaBI, lcm, lcmBI, ListNode, lucasLehmerBI, axisAngleToMatrix4, crossProduct, dotProduct, getRotationMatrixFromVectors, multiplyMatrix4, normalize, projectToTrackball, matrixAsArray, memoize, mod, modBI, nChooseK, naturalSearch, nelderMead, particleSwarmOptimization, permutations, permutationsIterator, phi, phiBI, powMod, powModBI, randNormal, array2range, range2array, setSafeInterval, simulatedAnnealing, squareRoot, squareRootBI, tonelliShanksBI
+  SetCnt, Trie, arrayHistogram, fromBase64, fromBase64Url, toBase64, toBase64Url, bijective2num, bijective2numBI, num2bijective, num2bijectiveBI, binarySearchArr, binarySearchGE, binarySearchLE, binarySearchRangeIncl, combinations, combinationsIterator, consumeIteratorNonBlocking, copyCase, egcd, factors, factorsBI, formatBigNumber, formatBigNumberBI, wrapFn, gcd, gcdBI, getType, gpn, gpnBI, bin2gray, gray2bin, Heap, heronsFormula, heronsFormulaBI, createLangtonsAnt, createUnlimitedGrid, lcm, lcmBI, ListNode, lucasLehmerBI, axisAngleToMatrix4, crossProduct, dotProduct, getRotationMatrixFromVectors, multiplyMatrix4, normalize, projectToTrackball, matrixAsArray, memoize, mod, modBI, nChooseK, naturalSearch, nelderMead, particleSwarmOptimization, permutations, permutationsIterator, phi, phiBI, powMod, powModBI, randNormal, array2range, range2array, setSafeInterval, simulatedAnnealing, squareRoot, squareRootBI, tonelliShanksBI
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gkucmierz/utils",
-  "version": "2.0.8",
+  "version": "2.1.0",
   "type": "module",
   "description": "Usefull functions for solving programming tasks",
   "keywords": [
@@ -19,8 +19,10 @@
     "iterator",
     "javascript",
     "lcm",
+    "langtons-ant",
     "lucas-lehmer",
     "math",
+    "cellular-automaton",
     "memoize",
     "mersenne",
     "mod",

package/src/langtons-ant.mjs

@@ -0,0 +1,79 @@
+/**
+ * Creates an unlimited, dynamically expanding 2D grid using nested Maps.
+ * Ideal for sparse matrices or algorithms operating on an infinite plane (e.g., Langton's Ant, Game of Life).
+ * 
+ * @returns {Object} An object containing `get(x, y)` and `set(x, y, val)` methods.
+ */
+export const createUnlimitedGrid = () => {
+  const grid = new Map();
+
+  const getRow = y => {
+    let row;
+    if (!(row = grid.get(y))) {
+      row = new Map();
+      grid.set(y, row);
+    }
+    return row;
+  };
+  
+  const set = (x, y, val) => {
+    const row = getRow(y);
+    row.set(x, val);
+  };
+  
+  const get = (x, y) => {
+    const row = getRow(y);
+    return row.get(x) || 0;
+  };
+  
+  return { set, get };
+};
+
+/**
+ * Initializes a Langton's Ant automaton on a given grid.
+ * The ant follows standard rules: turns right on 0, turns left on 1, and flips the cell state.
+ * 
+ * @param {Object} grid - The grid interface containing `get(x, y)` and `set(x, y, val)` methods.
+ * @param {number} startX - The initial X coordinate of the ant.
+ * @param {number} startY - The initial Y coordinate of the ant.
+ * @param {number} [initialDir=-1] - The initial direction (0: TOP, 1: RIGHT, 2: BOTTOM, 3: LEFT). If -1, a random direction is chosen.
+ * @returns {Object} An object containing a `step()` method which advances the simulation by one tick and returns `{x, y, state}` of the modified cell.
+ */
+export const createLangtonsAnt = (grid, startX, startY, initialDir = -1) => {
+  const [X, Y] = [0, 1];
+  const [TOP, RIGHT, BOT, LEFT] = [0, 1, 2, 3];
+  const coordMap = new Map([
+    [TOP,   [ 0,-1]],
+    [RIGHT, [ 1, 0]],
+    [BOT,   [ 0, 1]],
+    [LEFT,  [-1, 0]],
+  ]);
+  
+  let dir = initialDir !== -1 ? initialDir : Math.floor(Math.random() * 4);
+  const pos = [startX, startY];
+  
+  const step = () => {
+    const currentState = grid.get(pos[X], pos[Y]);
+    const nextState = currentState === 0 ? 1 : 0;
+    
+    grid.set(pos[X], pos[Y], nextState);
+    
+    if (currentState === 0) {
+      dir = (dir + 1) % 4; // Turn Right
+    } else {
+      dir = (dir + 3) % 4; // Turn Left
+    }
+    
+    const move = coordMap.get(dir);
+    pos[X] += move[X];
+    pos[Y] += move[Y];
+    
+    return {
+      x: pos[X] - move[X],
+      y: pos[Y] - move[Y],
+      state: nextState
+    };
+  };
+  
+  return { step };
+};