@fluidframework/matrix 2.0.0-internal.3.0.2 → 2.0.0-internal.3.2.0

package/.eslintrc.js

@@ -4,27 +4,26 @@
  */
 
 module.exports = {
-    extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
+	extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
 
-    parserOptions: {
-        project: ["./tsconfig.json", "./src/test/tsconfig.json"],
-    },
-    rules: {
-        "@typescript-eslint/no-shadow": "off",
-        "space-before-function-paren": "off", // Off because it conflicts with typescript-formatter
+	parserOptions: {
+		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
+	},
+	rules: {
+		"@typescript-eslint/no-shadow": "off",
+		"space-before-function-paren": "off", // Off because it conflicts with typescript-formatter
 
-        // This library is used in the browser, so we don't want dependencies on most node libraries.
-        "import/no-nodejs-modules": ["error", { allow: ["events"] }],
-    },
-    overrides: [
-        {
-            // Rules only for test files
-            files: ["*.spec.ts", "src/test/**"],
-            rules: {
-                // Test files are run in node only so additional node libraries can be used.
-                "import/no-nodejs-modules": ["error", { allow: ["assert", "events"] }],
-
-            },
-        },
-    ],
+		// This library is used in the browser, so we don't want dependencies on most node libraries.
+		"import/no-nodejs-modules": ["error", { allow: ["events"] }],
+	},
+	overrides: [
+		{
+			// Rules only for test files
+			files: ["*.spec.ts", "src/test/**"],
+			rules: {
+				// Test files are run in node only so additional node libraries can be used.
+				"import/no-nodejs-modules": ["error", { allow: ["assert", "events"] }],
+			},
+		},
+	],
 };

package/.mocharc.js

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-'use strict';
+"use strict";
 
-const getFluidTestMochaConfig = require('@fluidframework/mocha-test-setup/mocharc-common');
+const getFluidTestMochaConfig = require("@fluidframework/mocha-test-setup/mocharc-common");
 
 const packageDir = __dirname;
 const config = getFluidTestMochaConfig(packageDir);

package/README.md

@@ -1,14 +1,14 @@
 # @fluidframework/matrix
 
-SharedMatrix is a rectangular 2D array of values.  Matrix values are a superset of JSON serializable types that includes embedded IFluidHandle references to Fluid object.
+SharedMatrix is a rectangular 2D array of values. Matrix values are a superset of JSON serializable types that includes embedded IFluidHandle references to Fluid object.
 
 ## Operations
 
 The SharedMatrix currently supports the following operations:
 
-* `insertCols(col, numCols)` / `removeCols(col, numCols)`
-* `insertRows(row, numRows)` / `removeRows(row, numRows)`
-* `setCells(row, col, numCols, values)` (values is a 1D array in row-major order)
+-   `insertCols(col, numCols)` / `removeCols(col, numCols)`
+-   `insertRows(row, numRows)` / `removeRows(row, numRows)`
+-   `setCells(row, col, numCols, values)` (values is a 1D array in row-major order)
 
 Insertion / removal operations are reconciled using Fluid sequence semantics, while setCells() uses Fluid map semantics.
 
@@ -16,8 +16,8 @@ Insertion / removal operations are reconciled using Fluid sequence semantics, wh
 
 The SharedMatrix data structure is comprised of:
 
-* Two 'PermutationVectors', which are used to process row/col insertion and removal ops
-* A sparse quadtree-like "physical store" for holding the cell values
+-   Two 'PermutationVectors', which are used to process row/col insertion and removal ops
+-   A sparse quadtree-like "physical store" for holding the cell values
 
 ### Permutation Vectors
 
@@ -57,7 +57,7 @@ physical row -> 1 | 8 .
 ```
 
 The next row/column to be inserted is assigned the next available physical address, regardless of
-where the row/col was logically inserted.  Deleted rows/cols are recycled after clearing the physical store.
+where the row/col was logically inserted. Deleted rows/cols are recycled after clearing the physical store.
 
 This indirection between logical row/col and storage row/col provides three functions:
 
@@ -66,12 +66,12 @@ This indirection between logical row/col and storage row/col provides three func
    updated).
 3. It enables us to "time-travel" to previous matrix versions when reconciling ops from remote clients.
 
-To support reconciliation, we use a MergeTree for each PermutationVector.  MergeTree is a B-Tree of order 7 that
+To support reconciliation, we use a MergeTree for each PermutationVector. MergeTree is a B-Tree of order 7 that
 temporarily maintains some extra metadata to reconcile ops while they are within the current collab window.
 
 ### Physical Storage
 
-Cell data is stored in a quadtree-like data structure that is a recursive subdivision of 16x16 tiles.  The
+Cell data is stored in a quadtree-like data structure that is a recursive subdivision of 16x16 tiles. The
 implementation leverages [Morton coding](https://en.wikipedia.org/wiki/Z-order_curve) to implement this as a cascade of
 fast 1D array accesses.
 
@@ -81,20 +81,20 @@ const keyLo = r0c0ToMorton2x16((row << 16) >>> 16, (col << 16) >>> 16);
 
 const level0 = this.root[keyHi];
 if (level0 !== undefined) {
-    const level1 = level0[byte0(keyLo)];
-    if (level1 !== undefined) {
-        const level2 = level1[byte1(keyLo)];
-        if (level2 !== undefined) {
-            const level3 = level2[byte2(keyLo)];
-            if (level3 !== undefined) {
-                return level3[byte3(keyLo)];
-            }
-        }
-    }
+	const level1 = level0[byte0(keyLo)];
+	if (level1 !== undefined) {
+		const level2 = level1[byte1(keyLo)];
+		if (level2 !== undefined) {
+			const level3 = level2[byte2(keyLo)];
+			if (level3 !== undefined) {
+				return level3[byte3(keyLo)];
+			}
+		}
+	}
 }
-return undefined;   // Empty region
+return undefined; // Empty region
 ```
 
 A benefit of storing the cell data in [Z-order](https://en.wikipedia.org/wiki/Z-order_curve) is that both row-major and
-col-major traversal benefit from prefetching and cache coherence.  Reading/writing to the physical storage along either
+col-major traversal benefit from prefetching and cache coherence. Reading/writing to the physical storage along either
 axis is typically within an order of magnitude compared to sequentially accessing a cache hot native JavaScript array.

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+	"extends": "@fluidframework/build-common/api-extractor-common-report.json"
 }

package/bench/bsp-set-optimizations.md

@@ -69,10 +69,10 @@ the BSP sets in general to be fairly simple.
 
 Now the memory footprint of the BSP set is thus:
 
-- Some general overhead for the whole BSP set, i.e. object cost
-- Linear in the number of keys used for the exact representation.
-  Usually tiny, because they replace whole subtrees and occur infrequently.
-- About 2.5 bits per node. I.e. **tiny**.
+-   Some general overhead for the whole BSP set, i.e. object cost
+-   Linear in the number of keys used for the exact representation.
+    Usually tiny, because they replace whole subtrees and occur infrequently.
+-   About 2.5 bits per node. I.e. **tiny**.
 
 All the algorithms recurse over the structure of the tree, so they should be able to run over this
 bit encoding as well. Chances are it would be a lot faster, but definitely consuming a lot less
@@ -81,4 +81,4 @@ memory than before.
 ## Application
 
 If we did this change, we might be able to use raw product sets as messages inside say a shared dictionary
-because the payload of the messages might be small enough for that.
+because the payload of the messages might be small enough for that.

package/bench/src/index.ts

@@ -6,25 +6,43 @@
 import { run } from "hotloop";
 
 (async () => {
-    console.group("Populated");
-    await run([
-        // { path: "./src/read/nativearray", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true } },
-        // { path: "./src/read/map", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true } },
-        { path: "./src/read/sparsearray2d", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true } },
-        { path: "./src/read/matrix/contiguous", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true } },
-        { path: "./src/read/matrix/fragmented", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true } },
-        // { path: "./src/read/tiled", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true } }
-    ]);
-    console.groupEnd();
+	console.group("Populated");
+	await run([
+		// { path: "./src/read/nativearray", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true } },
+		// { path: "./src/read/map", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true } },
+		{
+			path: "./src/read/sparsearray2d",
+			args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true },
+		},
+		{
+			path: "./src/read/matrix/contiguous",
+			args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true },
+		},
+		{
+			path: "./src/read/matrix/fragmented",
+			args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true },
+		},
+		// { path: "./src/read/tiled", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: true } }
+	]);
+	console.groupEnd();
 
-    console.group("Empty");
-    await run([
-        // { path: "./src/read/nativearray", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false } },
-        // { path: "./src/read/map", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false } },
-        { path: "./src/read/sparsearray2d", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false } },
-        { path: "./src/read/matrix/contiguous", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false } },
-        { path: "./src/read/matrix/fragmented", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false } },
-        // { path: "./src/read/tiled", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false } }
-    ]);
-    console.groupEnd();
+	console.group("Empty");
+	await run([
+		// { path: "./src/read/nativearray", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false } },
+		// { path: "./src/read/map", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false } },
+		{
+			path: "./src/read/sparsearray2d",
+			args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false },
+		},
+		{
+			path: "./src/read/matrix/contiguous",
+			args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false },
+		},
+		{
+			path: "./src/read/matrix/fragmented",
+			args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false },
+		},
+		// { path: "./src/read/tiled", args: { row: 0, col: 0, rowCount: 256, colCount: 256, fill: false } }
+	]);
+	console.groupEnd();
 })();

package/bench/src/read/map.ts

@@ -6,20 +6,26 @@
 import { pointwise } from "./test";
 
 export class Map256x256<T> {
-    private readonly cells = new Map<number, T>();
+	private readonly cells = new Map<number, T>();
 
-    public get rowCount() { return 256; }
-    public get colCount() { return 256; }
+	public get rowCount() {
+		return 256;
+	}
+	public get colCount() {
+		return 256;
+	}
 
-    public getCell(row: number, col: number) {
-        return this.cells.get((row << 8) + col);
-    }
+	public getCell(row: number, col: number) {
+		return this.cells.get((row << 8) + col);
+	}
 
-    public setCell(row: number, col: number, value: T) {
-        this.cells.set((row << 8) + col, value);
-    }
+	public setCell(row: number, col: number, value: T) {
+		this.cells.set((row << 8) + col, value);
+	}
 
-    public get matrixProducer() { return undefined as any; }
+	public get matrixProducer() {
+		return undefined as any;
+	}
 }
 
 pointwise(undefined, new Map256x256<number>());

package/bench/src/read/nativearray.ts

@@ -6,20 +6,26 @@
 import { pointwise } from "./test";
 
 export class Array256x256<T> {
-    private readonly cells: T[] = new Array(256 * 256).fill(0);
+	private readonly cells: T[] = new Array(256 * 256).fill(0);
 
-    public get rowCount() { return 256; }
-    public get colCount() { return 256; }
+	public get rowCount() {
+		return 256;
+	}
+	public get colCount() {
+		return 256;
+	}
 
-    public getCell(row: number, col: number) {
-        return this.cells[(row << 8) + col];
-    }
+	public getCell(row: number, col: number) {
+		return this.cells[(row << 8) + col];
+	}
 
-    public setCell(row: number, col: number, value: T) {
-        this.cells[(row << 8) + col] = value;
-    }
+	public setCell(row: number, col: number, value: T) {
+		this.cells[(row << 8) + col] = value;
+	}
 
-    public get matrixProducer() { return undefined as any; }
+	public get matrixProducer() {
+		return undefined as any;
+	}
 }
 
 pointwise(undefined, new Array256x256<number>());

package/bench/src/read/test.ts

@@ -9,24 +9,22 @@ import { fill, IMatrix } from "../imports";
 const { row, col, rowCount, colCount, fill: shouldFill } = getTestArgs();
 
 export function pointwise<T>(name: string | undefined, matrix: IMatrix<T>) {
-    if (shouldFill) {
-        fill(matrix, row, col, rowCount, colCount);
-    }
+	if (shouldFill) {
+		fill(matrix, row, col, rowCount, colCount);
+	}
 
-    benchmark(
-        `SUM ${name !== undefined ? name : matrix.constructor.name} (${
-            shouldFill
-                ? "full"
-                : "empty"
-        }) Pointwise Read ${rowCount}x${colCount} @${row},${col}`,
-        () => {
-            let sum = 0;
-            for (let r = row; r < rowCount; r++) {
-                for (let c = col; c < colCount; c++) {
-                    sum += (matrix.getCell(r, c) as any | 0);
-                }
-            }
-            return sum;
-        }
-    );
+	benchmark(
+		`SUM ${name !== undefined ? name : matrix.constructor.name} (${
+			shouldFill ? "full" : "empty"
+		}) Pointwise Read ${rowCount}x${colCount} @${row},${col}`,
+		() => {
+			let sum = 0;
+			for (let r = row; r < rowCount; r++) {
+				for (let c = col; c < colCount; c++) {
+					sum += matrix.getCell(r, c) as any | 0;
+				}
+			}
+			return sum;
+		},
+	);
 }