Skip to main content

Documentation Index

Fetch the complete documentation index at: https://numpyts.dev/llms.txt

Use this file to discover all available pages before exploring further.

All trigonometric functions operate element-wise. Angles are in radians unless otherwise noted.

​
sin

Compute the sine, element-wise. 
function sin(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Angle in radians.
Returns: NDArray — Sine of each element. 
import * as np from 'numpy-ts';

const a = np.sin(np.array([0, Math.PI / 2, Math.PI]));
// array([0, 1, ~0])

​
cos

Compute the cosine, element-wise. 
function cos(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Angle in radians.
Returns: NDArray — Cosine of each element. 
import * as np from 'numpy-ts';

const a = np.cos(np.array([0, Math.PI / 2, Math.PI]));
// array([1, ~0, -1])

​
tan

Compute the tangent, element-wise. 
function tan(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Angle in radians.
Returns: NDArray — Tangent of each element. 
import * as np from 'numpy-ts';

const a = np.tan(np.array([0, Math.PI / 4]));
// array([0, 1])

​
arcsin

Compute the inverse sine, element-wise. Also available as the alias asin. 
function arcsin(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Values in the range [-1, 1].
Returns: NDArray — Angle in radians, in the range [-pi/2, pi/2]. 
import * as np from 'numpy-ts';

const a = np.arcsin(np.array([0, 0.5, 1]));
// array([0, 0.5236..., 1.5708...])  -- 0, pi/6, pi/2

// Alias
const b = np.asin(np.array([0, 1]));

​
arccos

Compute the inverse cosine, element-wise. Also available as the alias acos. 
function arccos(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Values in the range [-1, 1].
Returns: NDArray — Angle in radians, in the range [0, pi]. 
import * as np from 'numpy-ts';

const a = np.arccos(np.array([1, 0, -1]));
// array([0, 1.5708..., 3.1416...])  -- 0, pi/2, pi

// Alias
const b = np.acos(np.array([1, 0]));

​
arctan

Compute the inverse tangent, element-wise. Also available as the alias atan. 
function arctan(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Input values.
Returns: NDArray — Angle in radians, in the range [-pi/2, pi/2]. 
import * as np from 'numpy-ts';

const a = np.arctan(np.array([0, 1, -1]));
// array([0, 0.7854..., -0.7854...])  -- 0, pi/4, -pi/4

// Alias
const b = np.atan(np.array([0, 1]));

​
arctan2

Compute the two-argument inverse tangent, element-wise. Returns the angle of the point (x2, x1) with the positive x-axis. Also available as the alias atan2. 
function arctan2(x1: ArrayLike, x2: ArrayLike | number): NDArray
NameTypeDefaultDescription
x1ArrayLike-y-coordinates.
x2ArrayLike | number-x-coordinates.
Returns: NDArray — Angle in radians, in the range [-pi, pi]. 
import * as np from 'numpy-ts';

// Angle of (1, 1) is pi/4
const a = np.arctan2(np.array([1, 0, -1]), np.array([1, 1, 0]));
// array([0.7854..., 0, -1.5708...])

// Alias
const b = np.atan2(np.array([1]), np.array([1]));

​
hypot

Compute the hypotenuse sqrt(x1**2 + x2**2), element-wise. Avoids overflow for large values. 
function hypot(x1: ArrayLike, x2: ArrayLike | number): NDArray
NameTypeDefaultDescription
x1ArrayLike-First leg of the triangle.
x2ArrayLike | number-Second leg of the triangle.
Returns: NDArray — Element-wise hypotenuse. 
import * as np from 'numpy-ts';

const a = np.hypot(np.array([3, 5, 0]), np.array([4, 12, 1]));
// array([5, 13, 1])

​
degrees

Convert angles from radians to degrees. Equivalent to rad2deg. 
function degrees(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Angles in radians.
Returns: NDArray — Angles in degrees. 
import * as np from 'numpy-ts';

const a = np.degrees(np.array([0, Math.PI / 2, Math.PI]));
// array([0, 90, 180])

​
radians

Convert angles from degrees to radians. Equivalent to deg2rad. 
function radians(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Angles in degrees.
Returns: NDArray — Angles in radians. 
import * as np from 'numpy-ts';

const a = np.radians(np.array([0, 90, 180, 360]));
// array([0, 1.5708..., 3.1416..., 6.2832...])

​
deg2rad

Convert angles from degrees to radians. Equivalent to radians. 
function deg2rad(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Angles in degrees.
Returns: NDArray — Angles in radians.

​
rad2deg

Convert angles from radians to degrees. Equivalent to degrees. 
function rad2deg(x: ArrayLike): NDArray
NameTypeDefaultDescription
xArrayLike-Angles in radians.
Returns: NDArray — Angles in degrees.