✨ feat: Add fill, fillfn, and iota.

Author: make-github-pseudonymous-again

README.md

@@ -1,15 +1,26 @@
 :icecream: [@array-like/fill](https://array-like.github.io/fill)
 ==
 
-ArrayLike filling functions for JavaScript.
+`ArrayLike` filling functions for JavaScript.
 See [docs](https://array-like.github.io/fill/index.html).
 
-> :building_construction: Caveat emptor! This is work in progress. Code may be
-> working. Documentation may be present. Coherence may be. Maybe.
+```js
+import {alloc} from '@array-like/alloc';
+import {iota} from '@array-like/fill';
 
-> :warning: Depending on your environment, the code may require
-> `regeneratorRuntime` to be defined, for instance by importing
-> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
+const a = alloc(100); // undefined undefined undefined ...
+iota(a, 0, 100, 0);
+a; // 0 1 2 3 4 ...
+
+import {fill} from '@array-like/fill';
+fill(a, 0, 100, -1);
+a; // -1 -1 -1 -1 -1 ...
+
+import {fillfn} from '@array-like/fill';
+fillfn(a, 0, 100, () => []);
+a; // [] [] [] [] [] ...
+a[0] !== a[1]; // true
+```
 
 [![License](https://img.shields.io/github/license/array-like/fill.svg)](https://raw.githubusercontent.com/array-like/fill/main/LICENSE)
 [![Version](https://img.shields.io/npm/v/@array-like/fill.svg)](https://www.npmjs.org/package/@array-like/fill)

doc/manual/usage.md

@@ -1,17 +1,6 @@
 # Usage
 
-> :warning: Depending on your environment, the code may require
-> `regeneratorRuntime` to be defined, for instance by importing
-> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
-
-First, require the polyfill at the entry point of your application
-```js
-await import('regenerator-runtime/runtime.js');
-// or
-import 'regenerator-runtime/runtime.js';
-```
-
-Then, import the library where needed
+Import the library where needed
 ```js
 const fill = await import('@array-like/fill');
 // or

package.json

@@ -63,6 +63,7 @@
   },
   "dependencies": {},
   "devDependencies": {
+    "@array-like/alloc": "^0.0.1",
     "@babel/core": "7.14.8",
     "@babel/preset-env": "7.14.8",
     "@babel/register": "7.14.5",

src/fill.js

@@ -0,0 +1,15 @@
+/**
+ * Fill.
+ *
+ * @param {{[x: number]: any}} a
+ * @param {number} i
+ * @param {number} j
+ * @param {any} v
+ */
+const fill = (a, i, j, v) => {
+	for (; i < j; ++i) {
+		a[i] = v;
+	}
+};
+
+export default fill;

src/fillfn.js

@@ -0,0 +1,13 @@
+/**
+ * Fillfn.
+ *
+ * @param {{[x: number]: any}} a
+ * @param {number} i
+ * @param {number} j
+ * @param {Function} fn
+ */
+const fillfn = (a, i, j, fn) => {
+	for (; i < j; ++i) a[i] = fn();
+};
+
+export default fillfn;

src/index.js

@@ -1,2 +1,3 @@
-const answer = 42;
-export default answer;
+export {default as fill} from './fill.js';
+export {default as fillfn} from './fillfn.js';
+export {default as iota} from './iota.js';

src/iota.js

@@ -0,0 +1,15 @@
+/**
+ * Iota.
+ *
+ * @param {{[x: number]: any}} a
+ * @param {number} i
+ * @param {number} j
+ * @param {any} v
+ */
+const iota = (a, i, j, v) => {
+	for (; i < j; ++i, ++v) {
+		a[i] = v;
+	}
+};
+
+export default iota;

test/src/_fixtures.js

@@ -0,0 +1,12 @@
+export const arrayTypes = [
+	Array,
+	Int8Array,
+	Int16Array,
+	Int32Array,
+	Uint8Array,
+	Uint16Array,
+	Uint32Array,
+	Uint8ClampedArray,
+	Float32Array,
+	Float64Array,
+];

test/src/api.js

@@ -0,0 +1,51 @@
+import test from 'ava';
+import {_calloc} from '@array-like/alloc';
+
+import {arrayTypes} from './_fixtures.js';
+
+import {fill} from '../../src/index.js';
+
+const macro = (t, type) => {
+	const calloc = _calloc(type);
+
+	const n = 100;
+	const a = calloc(n);
+
+	const reseta = () => {
+		for (let i = 0; i < n; ++i) {
+			a[i] = 0;
+		}
+	};
+
+	const check = (i, v) => {
+		t.deepEqual(a[i], v, `a[${i}] === ${v}`);
+	};
+
+	reseta();
+
+	fill(a, 2, 33, 2);
+	fill(a, 16, 87, 3);
+	fill(a, 47, 75, 5);
+	fill(a, 60, 100, 7);
+	fill(a, 80, 81, 11);
+
+	for (let i = 0; i < n; ++i) {
+		if (i === 80) {
+			check(i, 11);
+		} else if (i >= 60) {
+			check(i, 7);
+		} else if (i >= 47) {
+			check(i, 5);
+		} else if (i >= 16) {
+			check(i, 3);
+		} else if (i >= 2) {
+			check(i, 2);
+		} else {
+			check(i, 0);
+		}
+	}
+};
+
+macro.title = (title, type) => title ?? type.name;
+
+for (const type of arrayTypes) test(macro, type);