@thi.ng/vectors/circular.d.ts

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

import type { ReadonlyVec, Vec } from "./api.js";
/**
 * Converts given angles (in radians) into polar coordinates and then computes
 * their mean angle (in radians).
 *
 * @remarks
 * Also see {@link cartesian2FromAngles}, {@link circularVariance},
 * {@link circularSD}.
 *
 * References:
 *
 * - https://en.wikipedia.org/wiki/Circular_mean
 *
 * @param angles
 */
export declare const circularMean: (angles: ReadonlyVec) => number;
/**
 * Circular version of {@link center} for given vector of angles.
 *
 * @param out
 * @param angles
 */
export declare const centerCircular: (out: Vec | null, angles: ReadonlyVec) => Vec<number>;
/**
 * Computes variance of given angles (in radians). Functional composition of
 * {@link centerCircular} and {@link variance}. Also see the latter for
 * explanation of the `corrected` param.
 *
 * @param angles
 * @param corrected
 */
export declare const circularVariance: (angles: ReadonlyVec, corrected?: boolean) => number;
/**
 * Computes standard deviation of given angles (in radians). Functional
 * composition of {@link centerCircular} and {@link sd}. Also see the latter for
 * explanation of the `corrected` param.
 *
 * @param angles
 * @param corrected
 */
export declare const circularSD: (angles: ReadonlyVec, corrected?: boolean) => number;
//# sourceMappingURL=circular.d.ts.map