import type { ArrayLikeIterable, Fn, Fn0, Fn2, Fn3, Fn4, Fn6, Fn7, FnU2, ICopy, IEmpty, IEqualsDelta, ILength, Maybe, NumericArray, Tuple, TypedArray } from "@thi.ng/api"; import type { IRandom } from "@thi.ng/random"; export interface Vec extends Iterable, ILength { [id: number]: T; } export type BVec = Vec; export type ReadonlyVec = ArrayLikeIterable; export type ReadonlyBVec = ReadonlyVec; export type Vec2Like = Tuple | TypedArray; export type Vec3Like = Tuple | TypedArray; export type Vec4Like = Tuple | TypedArray; export type BVec2Like = Tuple; export type BVec3Like = Tuple; export type BVec4Like = Tuple; export interface StridedVec { buf: NumericArray; offset: number; stride: number; } export interface IVector extends Vec, ICopy, ICopyView, IEmpty, IEqualsDelta, StridedVec { } export interface ICopyView { copyView(): T; } export interface VectorConstructor { new (buf: NumericArray, offset?: number, stride?: number): T; } export interface MultiVecOp { /** * Adds / overwrites implementation for given vector size. * * @param dim - * @param op - */ add(dim: number, op: VOP): VOP; /** * Adds / overwrites default implementation (SHOULD support * arbitrary vector sizes). * * @param op - */ default(op: VOP): VOP; /** * Returns implementation for given vector size or default * implementation. * * @param dim - */ impl(dim?: number): Maybe; } export type VecPair = [Vec, Vec]; export type VecOpV = Fn2 | null, ReadonlyVec, Vec>; export type VecOpN = Fn2; export type VecOpVV = Fn3 | null, ReadonlyVec, ReadonlyVec, Vec>; export type VecOpVN = Fn3; export type VecOpVVV = Fn4 | null, ReadonlyVec, ReadonlyVec, ReadonlyVec, Vec>; export type VecOpVVN = Fn4; export type VecOpVNV = Fn4; export type VecOpVNN = Fn4; export type VecOpVVVVV = Fn6 | null, ReadonlyVec, ReadonlyVec, ReadonlyVec, ReadonlyVec, ReadonlyVec, Vec>; export type VecOpVVVVNN = Fn7; export type VecOpVO = (out: Vec | null, a: ReadonlyVec, b?: T) => Vec; export type VecOpVVO = (out: Vec | null, a: ReadonlyVec, b: ReadonlyVec, c?: O) => Vec; export type VecOpOO = (out: Vec | null, a?: A, b?: B) => Vec; export type VecOpOOO = (out: Vec | null, a?: A, b?: B, c?: C) => Vec; export type VecOpNO = (out: Vec | null, a: number, b?: O) => Vec; export type VecOpNNO = (out: Vec | null, a: number, b: number, c?: O) => Vec; export type VecOpRoV = Fn; export type VecOpRoVV = FnU2; export type VecOpRoVVO = (a: ReadonlyVec, b: ReadonlyVec, c?: O) => T; export type VecOpFN = (out: Vec | null, fn: Fn0, n?: number) => Vec; export type VecOpFNO = (out: Vec | null, fn?: Fn0, n?: number) => Vec; export type VecOpNFO = (out: Vec | null, n?: number, fn?: Fn0) => Vec; export type VecOpSV = (out: Vec | null, a: ReadonlyVec, io?: number, ia?: number, so?: number, sa?: number) => Vec; export type VecOpSGV = (out: Vec | null, a: ReadonlyVec, num: number, io?: number, ia?: number, so?: number, sa?: number) => Vec; export type VecOpSN = (out: Vec | null, n: number, io?: number, so?: number) => Vec; export type VecOpSGN = (out: Vec | null, n: number, num: number, io?: number, so?: number) => Vec; export type VecOpSVN = (out: Vec | null, a: ReadonlyVec, n: number, io?: number, ia?: number, so?: number, sa?: number) => Vec; export type VecOpSGVN = (out: Vec | null, a: ReadonlyVec, n: number, num: number, io?: number, ia?: number, so?: number, sa?: number) => Vec; export type VecOpSVV = (out: Vec | null, a: ReadonlyVec, b: ReadonlyVec, io?: number, ia?: number, ib?: number, so?: number, sa?: number, sb?: number) => Vec; export type VecOpSGVV = (out: Vec | null, a: ReadonlyVec, b: ReadonlyVec, num: number, io?: number, ia?: number, ib?: number, so?: number, sa?: number, sb?: number) => Vec; export type VecOpSVNV = (out: Vec | null, a: ReadonlyVec, n: number, b: ReadonlyVec, io?: number, ia?: number, ib?: number, so?: number, sa?: number, sb?: number) => Vec; export type VecOpSGVNV = (out: Vec | null, a: ReadonlyVec, n: number, b: ReadonlyVec, num: number, io?: number, ia?: number, ib?: number, so?: number, sa?: number, sb?: number) => Vec; export type VecOpSVVN = (out: Vec | null, a: ReadonlyVec, b: ReadonlyVec, n: number, io?: number, ia?: number, ib?: number, so?: number, sa?: number, sb?: number) => Vec; export type VecOpSGVVN = (out: Vec | null, a: ReadonlyVec, b: ReadonlyVec, n: number, num: number, io?: number, ia?: number, ib?: number, so?: number, sa?: number, sb?: number) => Vec; export type VecOpSVVV = (out: Vec | null, a: ReadonlyVec, b: ReadonlyVec, c: ReadonlyVec, io?: number, ia?: number, ib?: number, ic?: number, so?: number, sa?: number, sb?: number, sc?: number) => Vec; export type VecOpSGVVV = (out: Vec | null, a: ReadonlyVec, b: ReadonlyVec, c: ReadonlyVec, num: number, io?: number, ia?: number, ib?: number, ic?: number, so?: number, sa?: number, sb?: number, sc?: number) => Vec; export type VecOpSRoV = (a: ReadonlyVec, ia?: number, sa?: number) => T; export type VecOpSGRoV = (a: ReadonlyVec, num: number, ia?: number, sa?: number) => T; export type VecOpSRoVV = (a: ReadonlyVec, b: ReadonlyVec, ia?: number, ib?: number, sa?: number, sb?: number) => T; export type VecOpSVO = (out: Vec | null, a: ReadonlyVec, b?: T, io?: number, ia?: number, so?: number, sa?: number) => Vec; export type VecOpSGVO = (out: Vec | null, a: ReadonlyVec, num: number, b?: O, io?: number, ia?: number, so?: number, sa?: number) => Vec; export type VecOpSOO = (a: Vec | null, opt1?: A, opt2?: B, ia?: number, sa?: number) => Vec; export type VecOpSGOO = (a: Vec | null, num: number, opt1?: A, opt2?: B, ia?: number, sa?: number) => Vec; export type VecOpSOOO = (a: Vec | null, opt1?: A, opt2?: B, opt3?: C, ia?: number, sa?: number) => Vec; export type VecOpSGOOO = (a: Vec | null, num: number, opt1?: A, opt2?: B, opt3?: C, ia?: number, sa?: number) => Vec; export type VecOpSVVO = (out: Vec | null, a: ReadonlyVec, b: ReadonlyVec, opt?: O, io?: number, ia?: number, ib?: number, so?: number, sa?: number, sb?: number) => Vec; export type VecOpSGVVO = (out: Vec | null, a: ReadonlyVec, b: ReadonlyVec, num: number, opt?: O, io?: number, ia?: number, ib?: number, so?: number, sa?: number, sb?: number) => Vec; export type VecOpSGFN = (out: Vec | null, num: number, fn: Fn0, n?: number, io?: number, so?: number) => Vec; export type VecOpSFN = (out: Vec | null, fn: Fn0, n?: number, io?: number, so?: number) => Vec; export type MultiVecOpImpl = T & MultiVecOp; export type MultiVecOpV = MultiVecOpImpl>; export type MultiVecOpN = MultiVecOpImpl; export type MultiVecOpVV = MultiVecOpImpl>; export type MultiVecOpVN = MultiVecOpImpl; export type MultiVecOpVVV = MultiVecOpImpl>; export type MultiVecOpVVN = MultiVecOpImpl; export type MultiVecOpVNV = MultiVecOpImpl; export type MultiVecOpVNN = MultiVecOpImpl; export type MultiVecOpVVVVV = MultiVecOpImpl>; export type MultiVecOpVVVVNN = MultiVecOpImpl; export type MultiVecOpVO = MultiVecOpImpl>; export type MultiVecOpVVO = MultiVecOpImpl>; export type MultiVecOpOO = MultiVecOpImpl>; export type MultiVecOpOOO = MultiVecOpImpl>; export type MultiVecOpNNO = MultiVecOpImpl>; export type MultiVecOpRoV = MultiVecOpImpl>; export type MultiVecOpRoVV = MultiVecOpImpl>; export type MultiVecOpRoVVO = MultiVecOpImpl>; export type MultiVecOpFN = MultiVecOpImpl; export type MultiVecOpFNO = MultiVecOpImpl; export type MultiVecOpNFO = MultiVecOpImpl; export type MultiVecOpSFN = MultiVecOpImpl; export type BVecOpRoV = Fn; export type BVecOpV = VecOpV; export type BVecOpVV = VecOpVV; export type BVecOpVN = Fn3; export type ToBVecOpV = VecOpV; export type FromBVecOpV = VecOpV; export type MultiBVecOpV = MultiVecOpImpl; export type MultiBVecOpVV = MultiVecOpImpl; export type MultiBVecOpVN = MultiVecOpImpl; export type MultiBVecOpRoV = MultiVecOpImpl>; export type MultiToBVecOpV = MultiVecOpImpl; export type MultiFromBVecOpV = MultiVecOpImpl; export type CompareOp = Fn3; export type MultiCompareOp = MultiVecOpImpl; export type DistanceFn = VecOpRoVV; /** * An object of the ~70 most common vector operations implemented for a specific * vector size. See {@link VEC2}, {@link VEC3}, {@link VEC4}. * * @remarks * Using this interface simplifies other performance-critical use * cases/algorithms which target different dimensionalities (e.g. 2d/3d), but * which should use the size-optimized vector operations (avoiding the small * overhead of their nD vector versions which would likely be used otherwise). * * @example * ```ts tangle:../export/vec-api.ts * import { VEC2, VEC3, type Vec, type VecAPI } from "@thi.ng/vectors"; * * interface Particle { * pos: Vec; * dir: Vec; * targetDir: Vec; * speed: number; * turnSpeed: number; * } * * const updateParticle = (p: Particle, api: VecAPI) => { * // interpolate current direction toward target dir * api.mixN(null, p.dir, p.targetDir, p.turnSpeed); * // normalize direction * api.normalize(null, p.dir); * // add scaled direction to position (and store as new position) * return api.maddN(p.pos, p.dir, p.speed, p.pos); * }; * * // 2d version * * let p2d: Particle = { * pos: [10,20], dir: [0,1], targetDir: [1,0], speed: 5, turnSpeed: 0.1 * }; * * console.log( * updateParticle(p2d, VEC2) * ); * // [ 10.552, 24.969 ] * * // 3d version * * let p3d: Particle = { * pos: [10,20,30], dir: [0,1,0], targetDir: [0,0,1], speed: 5, turnSpeed: 0.1 * }; * * console.log( * updateParticle(p3d, VEC3) * ); * // [ 10, 24.969, 30.552 ] * ``` */ export interface VecAPI { ZERO: ReadonlyVec; ONE: ReadonlyVec; zeroes: Fn0; ones: Fn0; abs: VecOpV; acos: VecOpV; add: VecOpVV; addN: VecOpVN; addm: VecOpVVV; addmN: VecOpVVN; asin: VecOpV; atan: VecOpV; atan2: VecOpVV; ceil: VecOpV; clamp: VecOpVVV; clampN: VecOpVNN; clamp01: VecOpV; cos: VecOpV; degrees: VecOpV; dist: DistanceFn; distSq: DistanceFn; div: VecOpVV; divN: VecOpVN; dot: VecOpRoVV; eqDelta: VecOpRoVVO; equals: VecOpRoVV; exp: VecOpV; exp2: VecOpV; fit: VecOpVVVVV; fit01: VecOpVVV; floor: VecOpV; fmod: VecOpVV; fract: VecOpV; invSqrt: VecOpV; mag: VecOpRoV; magSq: VecOpRoV; limit: VecOpVN; log: VecOpV; log2: VecOpV; madd: VecOpVVV; maddN: VecOpVNV; major: VecOpRoV; max: VecOpVV; min: VecOpVV; minor: VecOpRoV; mix: VecOpVVV; mixN: VecOpVVN; mod: VecOpVV; modN: VecOpVN; msub: VecOpVVV; msubN: VecOpVNV; mul: VecOpVV; mulN: VecOpVN; normalize: VecOpVO; pow: VecOpVV; powN: VecOpVN; radians: VecOpV; random: VecOpOOO; randomDistrib: VecOpFNO; randMinMax: VecOpVVO; randNorm: VecOpOO; randNormDistrib: VecOpNFO; round: VecOpVV; set: VecOpV; setN: VecOpN; sign: VecOpV; sin: VecOpV; smoothstep: VecOpVVV; sqrt: VecOpV; step: VecOpVV; sub: VecOpVV; subN: VecOpVN; subm: VecOpVVV; submN: VecOpVVN; tan: VecOpV; trunc: VecOpV; eq: CompareOp; neq: CompareOp; gt: CompareOp; gte: CompareOp; lt: CompareOp; lte: CompareOp; } export interface ToStringOpts { /** * Number of fractional digits * * @defaultValue 3 */ prec: number; /** * If given, each formatted vector component will be padded to given number * of characters. */ width: number; /** * Inter-component delimiter. * * @defaultValue ", " */ delim: string; /** * Prefix/suffix wrapper strings. * * @defaultValue "[" and "]" */ wrap: ArrayLike; } export declare const MIN2: ReadonlyVec; export declare const MAX2: ReadonlyVec; export declare const ONE2: ReadonlyVec; export declare const ZERO2: ReadonlyVec; export declare const X2: ReadonlyVec; export declare const Y2: ReadonlyVec; export declare const MIN3: ReadonlyVec; export declare const MAX3: ReadonlyVec; export declare const ONE3: ReadonlyVec; export declare const ZERO3: ReadonlyVec; export declare const X3: ReadonlyVec; export declare const Y3: ReadonlyVec; export declare const Z3: ReadonlyVec; export declare const MIN4: ReadonlyVec; export declare const MAX4: ReadonlyVec; export declare const ONE4: ReadonlyVec; export declare const ZERO4: ReadonlyVec; export declare const X4: ReadonlyVec; export declare const Y4: ReadonlyVec; export declare const Z4: ReadonlyVec; export declare const W4: ReadonlyVec; //# sourceMappingURL=api.d.ts.map