@thi.ng/vectors
Version:
Optimized 2d/3d/4d and arbitrary length vector operations, support for memory mapping/layouts
47 lines • 1.4 kB
TypeScript
import type { ReadonlyVec } from "./api.js";
/**
* Computes variance of vector components in `a`. If `isCentered` is
* false (default), the vector will first be {@link center}ed (copy) in order to
* compute the result.
*
* @remarks
* var(a) = magSq(a) / len(a). Returns 0 if `a` is empty.
*
* Reference:
* https://en.wikipedia.org/wiki/Variance
*
* @param a -
* @param isCentered -
*/
export declare const variance: (a: ReadonlyVec, isCentered?: boolean) => number;
/**
* Computes standard deviation of vector components in `a`. If `isCentered` is
* false (default), the vector will first be {@link center}ed (copy) in order to
* compute the result.
*
* @remarks
* sd = sqrt(magSq(a) / (len(a) - 1)). Returns 0 if len(a) < 2
*
* Reference:
* https://en.wikipedia.org/wiki/Standard_deviation
*
* @param a -
* @param isCentered -
*/
export declare const sd: (a: ReadonlyVec, isCentered?: boolean) => number;
/**
* Computes the standard error of vector components in `a`. If `isCentered` is
* false (default), the vector will first be {@link center}ed (copy) in order to
* compute the result.
*
* @remarks
* sderr(a) = sd(a) / sqrt(len(a))
*
* Reference:
* https://en.wikipedia.org/wiki/Standard_error
*
* @param a -
* @param isCentered -
*/
export declare const sdError: (a: ReadonlyVec, isCentered?: boolean) => number;
//# sourceMappingURL=variance.d.ts.map