Documentation / @interstellar-tools/equations / norm2pi

Function: norm2pi()

function norm2pi(x: number): number;

Defined in: helpers/misc.ts:104

Normalize an angle to the range [0, 2π).

This is commonly used to keep anomalies / angles within a canonical interval.

Parameters

Parameter	Type	Description
x	number	Angle in radians (or any unit, as long as TWO_PI matches that unit).

Returns

number

Equivalent angle in the range [0, 2π).

Example

norm2pi(7); // ~0.7168 (if radians)
norm2pi(-Math.PI / 2); // 3π/2