@thi.ng/tensors
Version:
1D/2D/3D/4D tensors with extensible polymorphic operations and customizable storage
316 lines • 14.7 kB
TypeScript
import type { Type as $Type, ICopy, IEqualsDelta, IEquiv, ILength, IRelease, Maybe, NumericArray } from "@thi.ng/api";
import type { Tensor1, Tensor2, Tensor3, Tensor4 } from "./tensor.js";
export interface TensorData<T = number> extends Iterable<T>, ILength {
[id: number]: T;
fill(x: T, start?: number, end?: number): TensorData<T>;
}
export type Type = $Type | "num" | "str";
export type NumType = $Type | "num";
export type Shape1 = [number];
export type Shape2 = [number, number];
export type Shape3 = [number, number, number];
export type Shape4 = [number, number, number, number];
export type Shape = Shape1 | Shape2 | Shape3 | Shape4;
export type ShapeTensor<S extends Shape, T> = S extends Shape4 ? Tensor4<T> : S extends Shape3 ? Tensor3<T> : S extends Shape2 ? Tensor2<T> : Tensor1<T>;
export type Nested<T> = T[] | T[][] | T[][][] | T[][][][];
export type NestedTensor<N extends Nested<T>, T> = N extends T[][][][] ? Tensor4<T> : N extends T[][][] ? Tensor3<T> : N extends T[][] ? Tensor2<T> : Tensor1<T>;
export interface TypeMap {
u8: number;
u8c: number;
i8: number;
u16: number;
i16: number;
u32: number;
i32: number;
f32: number;
f64: number;
num: number;
str: string;
}
export interface TensorOpts<T, S extends Shape> {
/**
* Tensor data. Unless {@link TensorOpts.copy} is false, by default will be
* copied to memory obtained from configured storage.
*/
data?: TensorData<T>;
/**
* Optionally configured storage provider. By default uses the
* datatype-specific implementation from global {@link STORAGE} registry.
*/
storage?: ITensorStorage<T>;
/**
* Optionally configured stride tuple. By default the strides will be
* obtained from the tensor shape and will be in row-major order.
*/
stride?: S;
/**
* Optional start index of the data values (only inteded to be used if
* {@link TensorOpts.data} is given).
*/
offset?: number;
/**
* Only used if {@link TensorOpts.data} is given. If true (default), the
* data will be copied to memory obtained from configured storage.
*/
copy?: boolean;
}
export interface TensorFromArrayOpts<T extends Type, V> {
type: T;
storage?: ITensorStorage<V>;
}
export interface ITensor<T = number> extends ICopy<ITensor<T>>, IEquiv, IEqualsDelta<ITensor<T>>, IRelease {
readonly type: Type;
readonly storage: ITensorStorage<T>;
readonly data: TensorData<T>;
readonly shape: number[];
readonly stride: number[];
readonly offset: number;
readonly length: number;
readonly dim: number;
readonly order: number[];
orderedShape: number[];
orderedStride: number[];
[Symbol.iterator](): IterableIterator<T>;
/**
* Internal use only. Creates a shallow view used for broadcasting
* operators. See {@link broadcast} for details.
*
* @param shape
* @param stride
*
* @internal
*/
broadcast<S extends Shape>(shape: S, stride: S): ShapeTensor<S, T>;
empty(storage?: ITensorStorage<T>): this;
/**
* Computes linear array index from given grid position. Reverse-op of
* {@link ITensor.position}.
*
* @param pos
*/
index(pos: NumericArray): number;
/**
* Computes nD grid position for given linear array index. Reverse-op of
* {@link ITensor.index}.
*
* @remarks
* **CAUTION:** Currently only supports tensors with positive strides,
* otherwise will yield incorrect results! Tensors with negative strides
* (aka flipped axes in reverse order) need to be first packed via
* {@link ITensor.pack}.
*
* @param index
*/
position(index: number): number[];
get(pos: NumericArray): T;
set(pos: NumericArray, value: T): this;
lo(pos: NumericArray): this;
hi(pos: NumericArray): this;
step(select: NumericArray): this;
pick(select: NumericArray): ITensor<T>;
pack(storage?: ITensorStorage<T>): this;
reshape<S extends Shape>(newShape: S, newStride?: S): ShapeTensor<S, T>;
resize<S extends Shape>(newShape: S, fill?: T, storage?: ITensorStorage<T>): ShapeTensor<S, T>;
transpose(order: NumericArray): this;
toJSON(): any;
}
export interface TensorCtor<T = number> {
new (type: Type, storage: ITensorStorage<T>, data: TensorData<T>, shape: number[], stride: number[], offset?: number): ITensor<T>;
}
export interface ITensorStorage<T> {
/**
* Attempts to allocate/create an array for given number of items. Throws an
* error if unsuccessful.
*
* @param size
*/
alloc(size: number): TensorData<T>;
/**
* Attempts to allocate/create an array for given iterable. Throws an
* error if unsuccessful.
*
* @param iter
*/
from(iter: Iterable<T>): TensorData<T>;
/**
* Attempts to release the array/memory used by given buffer. Returns true
* if successful.
*
* @param buf
*/
release(buf: TensorData<T>): boolean;
}
export type StorageRegistry = Record<Type, ITensorStorage<any>>;
export interface TensorOpT<T = number> {
(out: Tensor1<T> | null, a: Tensor1<T>): Tensor1<T>;
(out: Tensor2<T> | null, a: Tensor2<T>): Tensor2<T>;
(out: Tensor3<T> | null, a: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor4<T>): Tensor4<T>;
}
export interface TensorOpTT<T = number> {
(out: Tensor1<T> | null, a: Tensor1<T>, b: Tensor1<T>): Tensor1<T>;
(out: Tensor2<T> | null, a: Tensor1<T>, b: Tensor2<T>): Tensor2<T>;
(out: Tensor3<T> | null, a: Tensor1<T>, b: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor1<T>, b: Tensor4<T>): Tensor4<T>;
(out: Tensor2<T> | null, a: Tensor2<T>, b: Tensor1<T>): Tensor2<T>;
(out: Tensor2<T> | null, a: Tensor2<T>, b: Tensor2<T>): Tensor2<T>;
(out: Tensor3<T> | null, a: Tensor2<T>, b: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor2<T>, b: Tensor4<T>): Tensor4<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor1<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor2<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor3<T>, b: Tensor4<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor1<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor2<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor3<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor4<T>): Tensor4<T>;
}
export interface TensorOpTTT<T = number> {
(out: Tensor1<T> | null, a: Tensor1<T>, b: Tensor1<T>, c: Tensor1<T>): Tensor1<T>;
(out: Tensor2<T> | null, a: Tensor1<T>, b: Tensor1<T>, c: Tensor2<T>): Tensor2<T>;
(out: Tensor3<T> | null, a: Tensor1<T>, b: Tensor1<T>, c: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor1<T>, b: Tensor1<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor2<T> | null, a: Tensor1<T>, b: Tensor2<T>, c: Tensor1<T>): Tensor2<T>;
(out: Tensor2<T> | null, a: Tensor1<T>, b: Tensor2<T>, c: Tensor2<T>): Tensor2<T>;
(out: Tensor3<T> | null, a: Tensor1<T>, b: Tensor2<T>, c: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor1<T>, b: Tensor2<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor3<T> | null, a: Tensor1<T>, b: Tensor3<T>, c: Tensor1<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor1<T>, b: Tensor3<T>, c: Tensor2<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor1<T>, b: Tensor3<T>, c: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor1<T>, b: Tensor3<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor1<T>, b: Tensor4<T>, c: Tensor1<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor1<T>, b: Tensor4<T>, c: Tensor2<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor1<T>, b: Tensor4<T>, c: Tensor3<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor1<T>, b: Tensor4<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor2<T> | null, a: Tensor2<T>, b: Tensor1<T>, c: Tensor1<T>): Tensor2<T>;
(out: Tensor2<T> | null, a: Tensor2<T>, b: Tensor1<T>, c: Tensor2<T>): Tensor2<T>;
(out: Tensor3<T> | null, a: Tensor2<T>, b: Tensor1<T>, c: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor2<T>, b: Tensor1<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor2<T> | null, a: Tensor2<T>, b: Tensor2<T>, c: Tensor1<T>): Tensor2<T>;
(out: Tensor2<T> | null, a: Tensor2<T>, b: Tensor2<T>, c: Tensor2<T>): Tensor2<T>;
(out: Tensor3<T> | null, a: Tensor2<T>, b: Tensor2<T>, c: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor2<T>, b: Tensor2<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor3<T> | null, a: Tensor2<T>, b: Tensor3<T>, c: Tensor1<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor2<T>, b: Tensor3<T>, c: Tensor2<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor2<T>, b: Tensor3<T>, c: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor2<T>, b: Tensor3<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor2<T>, b: Tensor4<T>, c: Tensor1<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor2<T>, b: Tensor4<T>, c: Tensor2<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor2<T>, b: Tensor4<T>, c: Tensor3<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor2<T>, b: Tensor4<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor1<T>, c: Tensor1<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor1<T>, c: Tensor2<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor1<T>, c: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor3<T>, b: Tensor1<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor2<T>, c: Tensor1<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor2<T>, c: Tensor2<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor2<T>, c: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor3<T>, b: Tensor2<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor3<T>, c: Tensor1<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor3<T>, c: Tensor2<T>): Tensor3<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, b: Tensor3<T>, c: Tensor3<T>): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor3<T>, b: Tensor3<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor3<T>, b: Tensor4<T>, c: Tensor1<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor3<T>, b: Tensor4<T>, c: Tensor2<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor3<T>, b: Tensor4<T>, c: Tensor3<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor3<T>, b: Tensor4<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor1<T>, c: Tensor1<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor1<T>, c: Tensor2<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor1<T>, c: Tensor3<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor1<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor2<T>, c: Tensor1<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor2<T>, c: Tensor2<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor2<T>, c: Tensor3<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor2<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor3<T>, c: Tensor1<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor3<T>, c: Tensor2<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor3<T>, c: Tensor3<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor3<T>, c: Tensor4<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor4<T>, c: Tensor1<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor4<T>, c: Tensor2<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor4<T>, c: Tensor3<T>): Tensor4<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, b: Tensor4<T>, c: Tensor4<T>): Tensor4<T>;
}
export interface TensorOpN<A = number, B = A> {
(out: Tensor1<B>, n: A): Tensor1<B>;
(out: Tensor2<B>, n: A): Tensor2<B>;
(out: Tensor3<B>, n: A): Tensor3<B>;
(out: Tensor4<B>, n: A): Tensor4<B>;
}
export interface TensorOpTN<T = number> {
(out: Tensor1<T> | null, a: Tensor1<T>, n: T): Tensor1<T>;
(out: Tensor2<T> | null, a: Tensor2<T>, n: T): Tensor2<T>;
(out: Tensor3<T> | null, a: Tensor3<T>, n: T): Tensor3<T>;
(out: Tensor4<T> | null, a: Tensor4<T>, n: T): Tensor4<T>;
}
export interface TensorOpTNN<T = number> {
(out: Tensor1<T>, a: Tensor1<T>, n: T, m: T): Tensor1<T>;
(out: Tensor2<T>, a: Tensor2<T>, n: T, m: T): Tensor2<T>;
(out: Tensor3<T>, a: Tensor3<T>, n: T, m: T): Tensor3<T>;
(out: Tensor4<T>, a: Tensor4<T>, n: T, m: T): Tensor4<T>;
}
export type TensorOpRT<A, B, TA extends ITensor<A> = ITensor<A>> = (a: TA) => B;
export type TensorOpRTT<A, B, TA extends ITensor<A> = ITensor<A>> = (a: TA, b: TA) => B;
export interface MultiTensorOp<TOP> {
/**
* Adds / overwrites implementation for given tensor dimension.
*
* @param dim -
* @param op -
*/
add(dim: number, op: TOP): TOP;
/**
* Adds / overwrites default implementation (SHOULD support arbitrary tensor
* dimensions).
*
* @param op -
*/
default(op: TOP): TOP;
/**
* Returns implementation for given tensor dimension or default
* implementation.
*
* @param dim -
*/
impl(dim?: number): Maybe<TOP>;
}
export type MultiTensorOpImpl<T> = T & MultiTensorOp<T>;
/**
* Convolution kernel spec for use with {@link applyKernel}.
*
* @remarks
* Provided implementations:
*
* - {@link MAX2_MOORE}
* - {@link MAX2_VON_NEUMANN}
* - {@link MAXIMA2_MOORE}
* - {@link MAXIMA2_VON_NEUMANN}
*/
export interface KernelSpec<T = any> {
/**
* Kernel shape/size
*/
shape: Shape;
/**
* Windowed intialization. Returns initial accumulator for each new kernel
* window.
*/
init: () => T;
/**
* Windowed reduction function. Receives current accumulator, domain value
* and kernel-local coordinates. Returns updated accumulator.
*
* @param acc
* @param value
* @param coords
*/
reduce: (acc: T, value: number, ...coords: number[]) => T;
/**
* Windowed reducer result function. Produces final result from current
* accumulator.
*
* @param acc
*/
complete: (acc: T) => number;
}
//# sourceMappingURL=api.d.ts.map