@thi.ng/vectors/dist-cosine.d.ts

Optimized 2d/3d/4d and arbitrary length vector operations, support for memory mapping/layouts

import type { DistanceFn } from "./api.js";
/**
 * Cosine **similarity** metric. Result always in `[-1,1]` interval.
 *
 * @remarks
 * Similar to: `dot(a, b) / (magSq(a) * magSq(b))`. Returns zero if one of the
 * vectors is a zero-vector.
 *
 * Reference: https://en.wikipedia.org/wiki/Cosine_similarity
 *
 * @example
 * ```ts tangle:../export/dist-cosine.ts
 * import { distCosine } from "@thi.ng/vectors";
 *
 * console.log(
 *   distCosine([0, 1, 1, 0], [1, 1, 0, 0])
 * );
 * // 0.499999...
 * ```
 *
 * @param a -
 * @param b -
 */
export declare const distCosine: DistanceFn;
//# sourceMappingURL=dist-cosine.d.ts.map