@thi.ng/tensors 0.1.0 → 0.3.0

package/errors.d.ts

@@ -1,4 +1,5 @@
 import type { NumericArray } from "@thi.ng/api";
+import type { ITensor } from "./api.js";
 export declare const IllegalShapeError: {
     new (msg?: NumericArray | undefined): {
         origMessage: string;
@@ -12,4 +13,5 @@ export declare const IllegalShapeError: {
     stackTraceLimit: number;
 };
 export declare const illegalShape: (shape: NumericArray) => never;
+export declare const ensureShape: (t: ITensor<any>, shape: number[]) => false;
 //# sourceMappingURL=errors.d.ts.map

package/errors.js

@@ -1,9 +1,12 @@
 import { defError } from "@thi.ng/errors/deferror";
+import { equals } from "@thi.ng/vectors/equals";
 const IllegalShapeError = defError(() => "illegal shape");
 const illegalShape = (shape) => {
   throw new IllegalShapeError(shape);
 };
+const ensureShape = (t, shape) => !equals(t.shape, shape) && illegalShape(t.shape);
 export {
   IllegalShapeError,
+  ensureShape,
   illegalShape
 };

package/exp.d.ts

@@ -5,33 +5,5 @@
  * @param out - output tensor
  * @param a - input tensor
  */
-export declare const exp: import("./api.js").MultiTensorOpT<number>;
-/**
- * Same as {@link exp} for 1D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const exp_1: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
-/**
- * Same as {@link exp} for 2D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const exp_2: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
-/**
- * Same as {@link exp} for 3D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const exp_3: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
-/**
- * Same as {@link exp} for 4D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const exp_4: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+export declare const exp: import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpT<number>>;
 //# sourceMappingURL=exp.d.ts.map

package/exp.js

@@ -1,14 +1,5 @@
 import { defOpT } from "./defopt.js";
-const [a, b, c, d, e] = defOpT(Math.exp);
-const exp = a;
-const exp_1 = b;
-const exp_2 = c;
-const exp_3 = d;
-const exp_4 = e;
+const exp = defOpT(Math.exp);
 export {
-  exp,
-  exp_1,
-  exp_2,
-  exp_3,
-  exp_4
+  exp
 };

package/exp2.d.ts

@@ -5,33 +5,5 @@
  * @param out - output tensor
  * @param a - input tensor
  */
-export declare const exp2: import("./api.js").MultiTensorOpT<number>;
-/**
- * Same as {@link exp2} for 1D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const exp2_1: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
-/**
- * Same as {@link exp2} for 2D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const exp2_2: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
-/**
- * Same as {@link exp2} for 3D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const exp2_3: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
-/**
- * Same as {@link exp2} for 4D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const exp2_4: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+export declare const exp2: import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpT<number>>;
 //# sourceMappingURL=exp2.d.ts.map

package/exp2.js

@@ -1,14 +1,5 @@
 import { defOpT } from "./defopt.js";
-const [a, b, c, d, e] = defOpT((x) => 2 ** x);
-const exp2 = a;
-const exp2_1 = b;
-const exp2_2 = c;
-const exp2_3 = d;
-const exp2_4 = e;
+const exp2 = defOpT((x) => 2 ** x);
 export {
-  exp2,
-  exp2_1,
-  exp2_2,
-  exp2_3,
-  exp2_4
+  exp2
 };

package/filtered-indices.d.ts

@@ -0,0 +1,34 @@
+import type { Predicate } from "@thi.ng/api";
+/**
+ * Higher order function. Takes a predicate function and returns a new function
+ * which accepts a tensor and then returns an array of tensor component indices
+ * for which the predicate passed.
+ *
+ * @remarks
+ * Also see {@link nonZeroIndices}.
+ *
+ * @param pred
+ */
+export declare const filteredIndices: <T = number>(pred: Predicate<T>) => import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpRT<T, number[]>>;
+/**
+ * Returns an array of indices where the given tensor has non-zero component
+ * values.
+ *
+ * @param a
+ */
+export declare const nonZeroIndices: import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpRT<number, number[]>>;
+/**
+ * Returns an array of indices where the given tensor has negative component
+ * values.
+ *
+ * @param a
+ */
+export declare const negativeIndices: import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpRT<number, number[]>>;
+/**
+ * Returns an array of indices where the given tensor has positive component
+ * values.
+ *
+ * @param a
+ */
+export declare const positiveIndices: import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpRT<number, number[]>>;
+//# sourceMappingURL=filtered-indices.d.ts.map

package/filtered-indices.js

@@ -0,0 +1,17 @@
+import { defOpRT } from "./defoprt.js";
+const filteredIndices = (pred) => defOpRT(
+  (acc, data, i) => {
+    if (pred(data[i])) acc.push(i);
+    return acc;
+  },
+  () => []
+);
+const nonZeroIndices = filteredIndices((x) => x !== 0);
+const negativeIndices = filteredIndices((x) => x < 0);
+const positiveIndices = filteredIndices((x) => x > 0);
+export {
+  filteredIndices,
+  negativeIndices,
+  nonZeroIndices,
+  positiveIndices
+};

package/identity.d.ts

@@ -1,4 +1,11 @@
 import type { TensorOpts, Type } from "./api.js";
 import { Tensor2 } from "./tensor.js";
+/**
+ * Creates a square identity matrix of given `size` and options.
+ *
+ * @param type
+ * @param size
+ * @param opts
+ */
 export declare const identity: <T extends Exclude<Type, "str">>(type: T, size: number, opts?: Pick<TensorOpts<any, any>, "storage">) => Tensor2<number>;
 //# sourceMappingURL=identity.d.ts.map

package/identity.js

@@ -1,9 +1,10 @@
 import { STORAGE } from "./storage.js";
 import { Tensor2 } from "./tensor.js";
 const identity = (type, size, opts) => {
+  const n = size * size;
   const storage = opts?.storage || STORAGE[type];
-  const data = storage.alloc(size * size);
-  for (let i = 0; i < data.length; i += size + 1) data[i] = 1;
+  const data = storage.alloc(n);
+  for (let i = 0; i < n; i += size + 1) data[i] = 1;
   return new Tensor2(type, storage, data, [size, size], [size, 1]);
 };
 export {

package/index.d.ts

@@ -2,6 +2,7 @@ export * from "./abs.js";
 export * from "./add.js";
 export * from "./addn.js";
 export * from "./api.js";
+export * from "./broadcast.js";
 export * from "./clamp.js";
 export * from "./clampn.js";
 export * from "./cos.js";
@@ -13,12 +14,14 @@ export * from "./defoptn.js";
 export * from "./defoptnn.js";
 export * from "./defoptt.js";
 export * from "./defopttt.js";
+export * from "./diagonal.js";
 export * from "./div.js";
 export * from "./divn.js";
 export * from "./dot.js";
 export * from "./errors.js";
 export * from "./exp.js";
 export * from "./exp2.js";
+export * from "./filtered-indices.js";
 export * from "./format.js";
 export * from "./identity.js";
 export * from "./log.js";
@@ -38,6 +41,7 @@ export * from "./pow.js";
 export * from "./pown.js";
 export * from "./product.js";
 export * from "./rand-distrib.js";
+export * from "./range.js";
 export * from "./relu.js";
 export * from "./relun.js";
 export * from "./select.js";
@@ -53,6 +57,8 @@ export * from "./storage.js";
 export * from "./sub.js";
 export * from "./subn.js";
 export * from "./sum.js";
+export * from "./svd.js";
+export * from "./swap.js";
 export * from "./tan.js";
 export * from "./tanh.js";
 export * from "./tensor.js";

package/index.js

@@ -2,6 +2,7 @@ export * from "./abs.js";
 export * from "./add.js";
 export * from "./addn.js";
 export * from "./api.js";
+export * from "./broadcast.js";
 export * from "./clamp.js";
 export * from "./clampn.js";
 export * from "./cos.js";
@@ -13,12 +14,14 @@ export * from "./defoptn.js";
 export * from "./defoptnn.js";
 export * from "./defoptt.js";
 export * from "./defopttt.js";
+export * from "./diagonal.js";
 export * from "./div.js";
 export * from "./divn.js";
 export * from "./dot.js";
 export * from "./errors.js";
 export * from "./exp.js";
 export * from "./exp2.js";
+export * from "./filtered-indices.js";
 export * from "./format.js";
 export * from "./identity.js";
 export * from "./log.js";
@@ -38,6 +41,7 @@ export * from "./pow.js";
 export * from "./pown.js";
 export * from "./product.js";
 export * from "./rand-distrib.js";
+export * from "./range.js";
 export * from "./relu.js";
 export * from "./relun.js";
 export * from "./select.js";
@@ -53,6 +57,8 @@ export * from "./storage.js";
 export * from "./sub.js";
 export * from "./subn.js";
 export * from "./sum.js";
+export * from "./svd.js";
+export * from "./swap.js";
 export * from "./tan.js";
 export * from "./tanh.js";
 export * from "./tensor.js";

package/log.d.ts

@@ -5,33 +5,5 @@
  * @param out - output tensor
  * @param a - input tensor
  */
-export declare const log: import("./api.js").MultiTensorOpT<number>;
-/**
- * Same as {@link log} for 1D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const log_1: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
-/**
- * Same as {@link log} for 2D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const log_2: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
-/**
- * Same as {@link log} for 3D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const log_3: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
-/**
- * Same as {@link log} for 4D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const log_4: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+export declare const log: import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpT<number>>;
 //# sourceMappingURL=log.d.ts.map

package/log.js

@@ -1,14 +1,5 @@
 import { defOpT } from "./defopt.js";
-const [a, b, c, d, e] = defOpT(Math.log);
-const log = a;
-const log_1 = b;
-const log_2 = c;
-const log_3 = d;
-const log_4 = e;
+const log = defOpT(Math.log);
 export {
-  log,
-  log_1,
-  log_2,
-  log_3,
-  log_4
+  log
 };

package/log2.d.ts

@@ -5,33 +5,5 @@
  * @param out - output tensor
  * @param a - input tensor
  */
-export declare const log2: import("./api.js").MultiTensorOpT<number>;
-/**
- * Same as {@link log2} for 1D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const log2_1: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
-/**
- * Same as {@link log2} for 2D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const log2_2: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
-/**
- * Same as {@link log2} for 3D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const log2_3: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
-/**
- * Same as {@link log2} for 4D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const log2_4: import("./api.js").TensorOpT<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+export declare const log2: import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpT<number>>;
 //# sourceMappingURL=log2.d.ts.map

package/log2.js

@@ -1,14 +1,5 @@
 import { defOpT } from "./defopt.js";
-const [a, b, c, d, e] = defOpT(Math.log2);
-const log2 = a;
-const log2_1 = b;
-const log2_2 = c;
-const log2_3 = d;
-const log2_4 = e;
+const log2 = defOpT(Math.log2);
 export {
-  log2,
-  log2_1,
-  log2_2,
-  log2_3,
-  log2_4
+  log2
 };

package/mag.d.ts

@@ -1,3 +1,8 @@
 import type { ITensor } from "./api.js";
+/**
+ * Computes magnitude of given tensor. Also see {@link magSq}.
+ *
+ * @param a
+ */
 export declare const mag: (a: ITensor) => number;
 //# sourceMappingURL=mag.d.ts.map

package/magsq.d.ts

@@ -3,29 +3,5 @@
  *
  * @param a - input tensor
  */
-export declare const magSq: import("./api.js").MultiTensorOpRT<number, number>;
-/**
- * Squared magnitude of given 1D tensor.
- *
- * @param a - input tensor
- */
-export declare const magSq1: import("./api.js").TensorOpRT<number, number, import("./tensor.js").Tensor1<number>>;
-/**
- * Squared magnitude of given 2D tensor.
- *
- * @param a - input tensor
- */
-export declare const magSq2: import("./api.js").TensorOpRT<number, number, import("./tensor.js").Tensor2<number>>;
-/**
- * Squared magnitude of given 3D tensor.
- *
- * @param a - input tensor
- */
-export declare const magSq3: import("./api.js").TensorOpRT<number, number, import("./tensor.js").Tensor3<number>>;
-/**
- * Squared magnitude of given 4D tensor.
- *
- * @param a - input tensor
- */
-export declare const magSq4: import("./api.js").TensorOpRT<number, number, import("./tensor.js").Tensor4<number>>;
+export declare const magSq: import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpRT<number, number>>;
 //# sourceMappingURL=magsq.d.ts.map

package/magsq.js

@@ -1,17 +1,8 @@
 import { defOpRT } from "./defoprt.js";
-const [a, b, c, d, e] = defOpRT(
-  (acc, x) => acc + x * x,
+const magSq = defOpRT(
+  (acc, data, i) => acc + data[i] ** 2,
   () => 0
 );
-const magSq = a;
-const magSq1 = b;
-const magSq2 = c;
-const magSq3 = d;
-const magSq4 = e;
 export {
-  magSq,
-  magSq1,
-  magSq2,
-  magSq3,
-  magSq4
+  magSq
 };

package/max.d.ts

@@ -1,37 +1,12 @@
 /**
  * Componentwise computes `Math.max` of given nD tensors and writes result to
- * `out`. If `out` is null, mutates original. Multi-method.
+ * `out`. If `out` is null, creates a new tensor using `a`'s type and storage
+ * provider and shape as determined by broadcasting rules (see {@link broadcast}
+ * for details).
  *
  * @param out - output tensor
  * @param a - input tensor
+ * @param b - input tensor
  */
-export declare const max: import("./api.js").MultiTensorOpTT<number>;
-/**
- * Same as {@link max} for 1D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const max1: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
-/**
- * Same as {@link max} for 2D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const max2: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
-/**
- * Same as {@link max} for 3D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const max3: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
-/**
- * Same as {@link max} for 4D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const max4: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+export declare const max: import("./api.js").TensorOpTT<number>;
 //# sourceMappingURL=max.d.ts.map

package/max.js

@@ -1,14 +1,5 @@
 import { defOpTT } from "./defoptt.js";
-const [a, b, c, d, e] = defOpTT(Math.max);
-const max = a;
-const max1 = b;
-const max2 = c;
-const max3 = d;
-const max4 = e;
+const max = defOpTT(Math.max);
 export {
-  max,
-  max1,
-  max2,
-  max3,
-  max4
+  max
 };

package/maxn.d.ts

@@ -6,37 +6,5 @@
  * @param a - input tensor
  * @param n - scalar
  */
-export declare const maxN: import("./api.js").MultiTensorOpTN<number>;
-/**
- * Same as {@link maxN} for 1D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- * @param n - scalar
- */
-export declare const maxN1: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
-/**
- * Same as {@link maxN} for 2D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- * @param n - scalar
- */
-export declare const maxN2: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
-/**
- * Same as {@link maxN} for 3D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- * @param n - scalar
- */
-export declare const maxN3: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
-/**
- * Same as {@link maxN} for 4D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- * @param n - scalar
- */
-export declare const maxN4: import("./api.js").TensorOpTN<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+export declare const maxN: import("./api.js").MultiTensorOpImpl<import("./api.js").TensorOpTN<number>>;
 //# sourceMappingURL=maxn.d.ts.map

package/maxn.js

@@ -1,14 +1,5 @@
 import { defOpTN } from "./defoptn.js";
-const [a, b, c, d, e] = defOpTN(Math.max);
-const maxN = a;
-const maxN1 = b;
-const maxN2 = c;
-const maxN3 = d;
-const maxN4 = e;
+const maxN = defOpTN(Math.max);
 export {
-  maxN,
-  maxN1,
-  maxN2,
-  maxN3,
-  maxN4
+  maxN
 };

package/min.d.ts

@@ -1,37 +1,12 @@
 /**
  * Componentwise computes `Math.min` of given nD tensors and writes result to
- * `out`. If `out` is null, mutates original. Multi-method.
+ * `out`. If `out` is null, creates a new tensor using `a`'s type and storage
+ * provider and shape as determined by broadcasting rules (see {@link broadcast}
+ * for details).
  *
  * @param out - output tensor
  * @param a - input tensor
+ * @param b - input tensor
  */
-export declare const min: import("./api.js").MultiTensorOpTT<number>;
-/**
- * Same as {@link min} for 1D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const min1: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor1<number>, import("./tensor.js").Tensor1<number>>;
-/**
- * Same as {@link min} for 2D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const min2: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor2<number>, import("./tensor.js").Tensor2<number>>;
-/**
- * Same as {@link min} for 3D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const min3: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor3<number>, import("./tensor.js").Tensor3<number>>;
-/**
- * Same as {@link min} for 4D tensors.
- *
- * @param out - output tensor
- * @param a - input tensor
- */
-export declare const min4: import("./api.js").TensorOpTT<number, number, import("./tensor.js").Tensor4<number>, import("./tensor.js").Tensor4<number>>;
+export declare const min: import("./api.js").TensorOpTT<number>;
 //# sourceMappingURL=min.d.ts.map

package/min.js

@@ -1,14 +1,5 @@
 import { defOpTT } from "./defoptt.js";
-const [a, b, c, d, e] = defOpTT(Math.min);
-const min = a;
-const min1 = b;
-const min2 = c;
-const min3 = d;
-const min4 = e;
+const min = defOpTT(Math.min);
 export {
-  min,
-  min1,
-  min2,
-  min3,
-  min4
+  min
 };