@thi.ng/tensors 0.1.0

package/package.json

@@ -0,0 +1,261 @@
+{
+  "name": "@thi.ng/tensors",
+  "version": "0.1.0",
+  "description": "1D/2D/3D/4D tensors with extensible polymorphic operations and customizable storage",
+  "type": "module",
+  "module": "./index.js",
+  "typings": "./index.d.ts",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thi-ng/umbrella.git"
+  },
+  "homepage": "https://thi.ng/tensors",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/postspectacular"
+    },
+    {
+      "type": "patreon",
+      "url": "https://patreon.com/thing_umbrella"
+    },
+    {
+      "type": "liberapay",
+      "url": "https://liberapay.com/thi.ng"
+    }
+  ],
+  "author": "Karsten Schmidt (https://thi.ng)",
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "yarn build:esbuild && yarn build:decl",
+    "build:decl": "tsc --declaration --emitDeclarationOnly",
+    "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
+    "clean": "bun ../../tools/src/clean-package.ts",
+    "doc": "typedoc --options ../../typedoc.json --out doc src/index.ts",
+    "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
+    "pub": "yarn npm publish --access public",
+    "test": "bun test",
+    "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
+  },
+  "dependencies": {
+    "@thi.ng/api": "^8.11.27",
+    "@thi.ng/arrays": "^2.11.0",
+    "@thi.ng/checks": "^3.7.7",
+    "@thi.ng/equiv": "^2.1.83",
+    "@thi.ng/errors": "^2.5.33",
+    "@thi.ng/math": "^5.11.27",
+    "@thi.ng/random": "^4.1.18",
+    "@thi.ng/strings": "^3.9.12",
+    "@thi.ng/vectors": "^8.1.0"
+  },
+  "devDependencies": {
+    "esbuild": "^0.25.3",
+    "typedoc": "^0.28.3",
+    "typescript": "^5.8.3"
+  },
+  "keywords": [
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "browser": {
+    "process": false,
+    "setTimeout": false
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "./*.js",
+    "./*.d.ts"
+  ],
+  "exports": {
+    ".": {
+      "default": "./index.js"
+    },
+    "./abs": {
+      "default": "./abs.js"
+    },
+    "./add": {
+      "default": "./add.js"
+    },
+    "./addn": {
+      "default": "./addn.js"
+    },
+    "./api": {
+      "default": "./api.js"
+    },
+    "./clamp": {
+      "default": "./clamp.js"
+    },
+    "./clampn": {
+      "default": "./clampn.js"
+    },
+    "./cos": {
+      "default": "./cos.js"
+    },
+    "./defopn": {
+      "default": "./defopn.js"
+    },
+    "./defoprt": {
+      "default": "./defoprt.js"
+    },
+    "./defoprtt": {
+      "default": "./defoprtt.js"
+    },
+    "./defopt": {
+      "default": "./defopt.js"
+    },
+    "./defoptn": {
+      "default": "./defoptn.js"
+    },
+    "./defoptnn": {
+      "default": "./defoptnn.js"
+    },
+    "./defoptt": {
+      "default": "./defoptt.js"
+    },
+    "./defopttt": {
+      "default": "./defopttt.js"
+    },
+    "./div": {
+      "default": "./div.js"
+    },
+    "./divn": {
+      "default": "./divn.js"
+    },
+    "./dot": {
+      "default": "./dot.js"
+    },
+    "./errors": {
+      "default": "./errors.js"
+    },
+    "./exp": {
+      "default": "./exp.js"
+    },
+    "./exp2": {
+      "default": "./exp2.js"
+    },
+    "./format": {
+      "default": "./format.js"
+    },
+    "./identity": {
+      "default": "./identity.js"
+    },
+    "./log": {
+      "default": "./log.js"
+    },
+    "./log2": {
+      "default": "./log2.js"
+    },
+    "./mag": {
+      "default": "./mag.js"
+    },
+    "./magsq": {
+      "default": "./magsq.js"
+    },
+    "./max": {
+      "default": "./max.js"
+    },
+    "./maxn": {
+      "default": "./maxn.js"
+    },
+    "./min": {
+      "default": "./min.js"
+    },
+    "./minn": {
+      "default": "./minn.js"
+    },
+    "./mul": {
+      "default": "./mul.js"
+    },
+    "./mulm": {
+      "default": "./mulm.js"
+    },
+    "./muln": {
+      "default": "./muln.js"
+    },
+    "./mulv": {
+      "default": "./mulv.js"
+    },
+    "./normalize": {
+      "default": "./normalize.js"
+    },
+    "./pow": {
+      "default": "./pow.js"
+    },
+    "./pown": {
+      "default": "./pown.js"
+    },
+    "./product": {
+      "default": "./product.js"
+    },
+    "./rand-distrib": {
+      "default": "./rand-distrib.js"
+    },
+    "./relu": {
+      "default": "./relu.js"
+    },
+    "./relun": {
+      "default": "./relun.js"
+    },
+    "./select": {
+      "default": "./select.js"
+    },
+    "./set": {
+      "default": "./set.js"
+    },
+    "./setn": {
+      "default": "./setn.js"
+    },
+    "./sigmoid": {
+      "default": "./sigmoid.js"
+    },
+    "./sin": {
+      "default": "./sin.js"
+    },
+    "./softmax": {
+      "default": "./softmax.js"
+    },
+    "./softplus": {
+      "default": "./softplus.js"
+    },
+    "./sqrt": {
+      "default": "./sqrt.js"
+    },
+    "./step": {
+      "default": "./step.js"
+    },
+    "./storage": {
+      "default": "./storage.js"
+    },
+    "./sub": {
+      "default": "./sub.js"
+    },
+    "./subn": {
+      "default": "./subn.js"
+    },
+    "./sum": {
+      "default": "./sum.js"
+    },
+    "./tan": {
+      "default": "./tan.js"
+    },
+    "./tanh": {
+      "default": "./tanh.js"
+    },
+    "./tensor": {
+      "default": "./tensor.js"
+    },
+    "./top": {
+      "default": "./top.js"
+    }
+  },
+  "thi.ng": {
+    "status": "alpha",
+    "year": 2018
+  },
+  "gitHead": "4354686a6fb1f82c09ea48f92f87786191b231a0\n"
+}

package/pow.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Componentwise computes `Math.pow` of given nD tensors and writes result to
+ * `out`. If `out` is null, mutates original. Multi-method.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const pow: import("./api.js").MultiTensorOpTT<number>;
+/**
+ * Same as {@link pow} for 1D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const pow1: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
+/**
+ * Same as {@link pow} for 2D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const pow2: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
+/**
+ * Same as {@link pow} for 3D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const pow3: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
+/**
+ * Same as {@link pow} for 4D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const pow4: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+//# sourceMappingURL=pow.d.ts.map

package/pow.js

@@ -0,0 +1,14 @@
+import { defOpTT } from "./defoptt.js";
+const [a, b, c, d, e] = defOpTT(Math.pow);
+const pow = a;
+const pow1 = b;
+const pow2 = c;
+const pow3 = d;
+const pow4 = e;
+export {
+  pow,
+  pow1,
+  pow2,
+  pow3,
+  pow4
+};

package/pown.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Componentwise computes `Math.pow` of given nD tensor and uniform scalar `n`.
+ * Writes result to `out`. If `out` is null, mutates `a`. Multi-method.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - scalar exponent
+ */
+export declare const powN: import("./api.js").MultiTensorOpTN<number>;
+/**
+ * Same as {@link powN} for 1D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - scalar exponent
+ */
+export declare const powN1: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
+/**
+ * Same as {@link powN} for 2D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - scalar exponent
+ */
+export declare const powN2: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
+/**
+ * Same as {@link powN} for 3D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - scalar exponent
+ */
+export declare const powN3: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
+/**
+ * Same as {@link powN} for 4D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - scalar exponent
+ */
+export declare const powN4: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+//# sourceMappingURL=pown.d.ts.map

package/pown.js

@@ -0,0 +1,14 @@
+import { defOpTN } from "./defoptn.js";
+const [a, b, c, d, e] = defOpTN(Math.pow);
+const powN = a;
+const powN1 = b;
+const powN2 = c;
+const powN3 = d;
+const powN4 = e;
+export {
+  powN,
+  powN1,
+  powN2,
+  powN3,
+  powN4
+};

package/product.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Componentwise product of given nD tensor. Multi-method.
+ *
+ * @param a - input tensor
+ */
+export declare const product: import("./api.js").MultiTensorOpRT<number, number>;
+/**
+ * Componentwise product of given 1D tensor.
+ *
+ * @param a - input tensor
+ */
+export declare const product1: import("./api.js").TensorOpRT<number, number, import("./tensor.js").Tensor1<number>>;
+/**
+ * Componentwise product of given 2D tensor.
+ *
+ * @param a - input tensor
+ */
+export declare const product2: import("./api.js").TensorOpRT<number, number, import("./tensor.js").Tensor2<number>>;
+/**
+ * Componentwise product of given 3D tensor.
+ *
+ * @param a - input tensor
+ */
+export declare const product3: import("./api.js").TensorOpRT<number, number, import("./tensor.js").Tensor3<number>>;
+/**
+ * Componentwise product of given 4D tensor.
+ *
+ * @param a - input tensor
+ */
+export declare const product4: import("./api.js").TensorOpRT<number, number, import("./tensor.js").Tensor4<number>>;
+//# sourceMappingURL=product.d.ts.map

package/product.js

@@ -0,0 +1,15 @@
+import { $mul } from "@thi.ng/vectors/ops";
+import { defOpRT } from "./defoprt.js";
+const [a, b, c, d, e] = defOpRT($mul, () => 1);
+const product = a;
+const product1 = b;
+const product2 = c;
+const product3 = d;
+const product4 = e;
+export {
+  product,
+  product1,
+  product2,
+  product3,
+  product4
+};

package/rand-distrib.d.ts

@@ -0,0 +1,49 @@
+import type { Fn0 } from "@thi.ng/api";
+import type { ITensor } from "./api.js";
+import type { Tensor1, Tensor2, Tensor3 } from "./tensor.js";
+/**
+ * Same as {@link randDistrib}, optimized for 1D tensors.
+ *
+ * @param a
+ * @param rnd
+ * @param n
+ */
+export declare const randDistrib1: (a: Tensor1, rnd?: () => number, n?: number) => Tensor1<number>;
+/**
+ * Same as {@link randDistrib}, optimized for 2D tensors.
+ *
+ * @param a
+ * @param rnd
+ * @param n
+ */
+export declare const randDistrib2: (a: Tensor2, rnd?: () => number, n?: number) => Tensor2<number>;
+/**
+ * Same as {@link randDistrib}, optimized for 3D tensors.
+ *
+ * @param a
+ * @param rnd
+ * @param n
+ */
+export declare const randDistrib3: (a: Tensor3, rnd?: () => number, n?: number) => Tensor3<number>;
+/**
+ * Randomizes given nD tensor `a`, with each component drawn from given random
+ * distribution function (default: gaussian/normal distribution) and scaled to
+ * `n` (default: 1).
+ *
+ * @remarks
+ * References:
+ *
+ * - https://docs.thi.ng/umbrella/random/#random-distributions
+ * - https://docs.thi.ng/umbrella/random/functions/normal.html
+ *
+ * @param a - tensor
+ * @param rnd - random distribution function
+ * @param n - scale factor
+ */
+export declare const randDistrib: {
+    (...args: any[]): any;
+    add(dim: number, fn: (a: ITensor, rnd?: Fn0<number>, n?: number) => ITensor): (a: ITensor, rnd?: Fn0<number>, n?: number) => ITensor;
+    default(fn: (a: ITensor, rnd?: Fn0<number>, n?: number) => ITensor): (a: ITensor, rnd?: Fn0<number>, n?: number) => ITensor;
+    impl(dim?: number): import("@thi.ng/api").Maybe<(a: ITensor, rnd?: Fn0<number>, n?: number) => ITensor>;
+};
+//# sourceMappingURL=rand-distrib.d.ts.map

package/rand-distrib.js

@@ -0,0 +1,52 @@
+import { normal as op } from "@thi.ng/random/distributions/normal";
+import { top } from "./top.js";
+const randDistrib1 = (a, rnd = op(), n = 1) => {
+  const {
+    data,
+    offset,
+    shape: [l],
+    stride: [s]
+  } = a;
+  for (let i = 0; i < l; i++) data[offset + i * s] = rnd() * n;
+  return a;
+};
+const randDistrib2 = (a, rnd = op(), n = 1) => {
+  const {
+    data: adata,
+    shape: [rows, cols],
+    stride: [txa, tya],
+    offset: offa
+  } = a;
+  for (let i = 0; i < rows; i++) {
+    const ia = offa + i * txa;
+    for (let j = 0; j < cols; j++) {
+      adata[ia + j * tya] = rnd() * n;
+    }
+  }
+  return a;
+};
+const randDistrib3 = (a, rnd = op(), n = 1) => {
+  const {
+    data: adata,
+    shape: [slices, rows, cols],
+    stride: [txa, tya, tza],
+    offset: offa
+  } = a;
+  for (let i = 0; i < slices; i++) {
+    const $offa = offa + i * txa;
+    for (let j = 0; j < rows; j++) {
+      const ia = $offa + j * tya;
+      for (let k = 0; k < cols; k++) {
+        adata[ia + k * tza] = rnd() * n;
+      }
+    }
+  }
+  return a;
+};
+const randDistrib = top(0, void 0, randDistrib1, randDistrib2, randDistrib3);
+export {
+  randDistrib,
+  randDistrib1,
+  randDistrib2,
+  randDistrib3
+};

package/relu.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Componentwise computes ReLU of given nD tensor and writes result to `out`. If
+ * `out` is null, mutates original. Multi-method.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const relu: import("./api.js").MultiTensorOpT<number>;
+/**
+ * Same as {@link relu} for 1D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const relu1: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
+/**
+ * Same as {@link relu} for 2D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const relu2: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
+/**
+ * Same as {@link relu} for 3D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const relu3: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
+/**
+ * Same as {@link relu} for 4D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ */
+export declare const relu4: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+//# sourceMappingURL=relu.d.ts.map

package/relu.js

@@ -0,0 +1,14 @@
+import { defOpT } from "./defopt.js";
+const [a, b, c, d, e] = defOpT((x) => x > 0 ? x : 0);
+const relu = a;
+const relu1 = b;
+const relu2 = c;
+const relu3 = d;
+const relu4 = e;
+export {
+  relu,
+  relu1,
+  relu2,
+  relu3,
+  relu4
+};

package/relun.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Componentwise computes leaky ReLU of given nD tensor (using slope `n` for
+ * negative inputs) and writes result to `out`. If `out` is null, mutates
+ * original. Multi-method.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - slope
+ */
+export declare const reluN: import("./api.js").MultiTensorOpTN<number>;
+/**
+ * Same as {@link reluN} for 1D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - slope
+ */
+export declare const reluN1: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
+/**
+ * Same as {@link reluN} for 2D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - slope
+ */
+export declare const reluN2: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
+/**
+ * Same as {@link reluN} for 3D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - slope
+ */
+export declare const reluN3: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
+/**
+ * Same as {@link reluN} for 4D tensors.
+ *
+ * @param out - output tensor
+ * @param a - input tensor
+ * @param n - slope
+ */
+export declare const reluN4: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+//# sourceMappingURL=relun.d.ts.map

package/relun.js

@@ -0,0 +1,14 @@
+import { defOpTN } from "./defoptn.js";
+const [a, b, c, d, e] = defOpTN((x, n) => x >= 0 ? x : x * n);
+const reluN = a;
+const reluN1 = b;
+const reluN2 = c;
+const reluN3 = d;
+const reluN4 = e;
+export {
+  reluN,
+  reluN1,
+  reluN2,
+  reluN3,
+  reluN4
+};