> ## Documentation Index
> Fetch the complete documentation index at: https://numpyts.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference Overview

> Complete API reference for numpy-ts -- 476 of 507 NumPy functions implemented in pure TypeScript.

# API Reference

numpy-ts implements **476 out of 507** NumPy functions (**93.9%** coverage) in pure TypeScript with zero dependencies. Every function is tested against NumPy for correctness.

> [!TIP]
>
> On top of full coverage, numpy-ts is **1.36x faster than NumPy on average** across 10,528 benchmarks. See the full [performance breakdown](https://numpyts.dev/performance.md).

## Coverage by category

| Category | Functions | Status |
| - | - | - |
| [NDArray Class & Methods](https://numpyts.dev/v1.7.x/api/ndarray/class.md) | 47/47 | 100% |
| [Array Creation](https://numpyts.dev/v1.7.x/api/creation/basic.md) | 35/35 | 100% |
| [Arithmetic](https://numpyts.dev/v1.7.x/api/math/arithmetic.md) | 29/29 | 100% |
| [Exponential & Logarithmic](https://numpyts.dev/v1.7.x/api/math/exponential.md) | 9/9 | 100% |
| [Trigonometric](https://numpyts.dev/v1.7.x/api/math/trigonometric.md) | 16/16 | 100% |
| [Hyperbolic](https://numpyts.dev/v1.7.x/api/math/hyperbolic.md) | 9/9 | 100% |
| [Rounding](https://numpyts.dev/v1.7.x/api/math/rounding.md) | 7/7 | 100% |
| [Other Math](https://numpyts.dev/v1.7.x/api/math/other-math.md) | 15/15 | 100% |
| [Array Manipulation](https://numpyts.dev/v1.7.x/api/manipulation/shape.md) | 46/46 | 100% |
| [Reductions](https://numpyts.dev/v1.7.x/api/reductions/basic.md) | 36/36 | 100% |
| [Statistics](https://numpyts.dev/v1.7.x/api/reductions/statistics.md) | 11/11 | 100% |
| [Linear Algebra](https://numpyts.dev/v1.7.x/api/linalg/products.md) | 38/38 | 100% |
| [Logic & Comparison](https://numpyts.dev/v1.7.x/api/logic/comparison.md) | 34/34 | 100% |
| [Sorting & Searching](https://numpyts.dev/v1.7.x/api/sorting/sort.md) | 13/13 | 100% |
| [Set Operations](https://numpyts.dev/v1.7.x/api/sets/set-ops.md) | 12/12 | 100% |
| [Bitwise](https://numpyts.dev/v1.7.x/api/bitwise/bitwise-ops.md) | 13/13 | 100% |
| [Indexing](https://numpyts.dev/v1.7.x/api/indexing/advanced-indexing.md) | 27/27 | 100% |
| [Gradient & Differences](https://numpyts.dev/v1.7.x/api/gradient/gradient-ops.md) | 3/3 | 100% |
| [Polynomials](https://numpyts.dev/v1.7.x/api/polynomials/polynomial-ops.md) | 10/10 | 100% |
| [Random](https://numpyts.dev/v1.7.x/api/random/overview.md) | 53/53 | 100% |
| [FFT](https://numpyts.dev/v1.7.x/api/fft/transforms.md) | 18/18 | 100% |
| [I/O](https://numpyts.dev/v1.7.x/api/io/npy-npz.md) | 8/8 | 100% |
| [Utilities](https://numpyts.dev/v1.7.x/api/utilities/type-checking.md) | 26/26 | 100% |
| Unplanned | 0/31 | -- |

## How to read this reference

Each function page follows a consistent format:

**Signature** -- The full TypeScript signature with generics and overloads where applicable.

```typescript theme={null}
function functionName(a: NDArray, axis?: number, keepdims?: boolean): NDArray | number;
```

**Parameter table** -- Every parameter listed with its type, default value, and description.

| Parameter | Type | Default | Description |
| - | - | - | - |
| `a` | `NDArray` | -- | Input array. |
| `axis` | `number` | `undefined` | Axis along which to operate. When `undefined`, operates on the flattened array. |
| `keepdims` | `boolean` | `false` | If `true`, reduced axes are kept as dimensions with size 1. |

**Return type** -- What the function returns (scalar when reducing all axes, `NDArray` when reducing along a single axis).

**Example** -- A short, runnable code snippet demonstrating typical usage.

> [!NOTE]
>
> All type signatures use the `NDArray` class from the default `numpy-ts` entry point. If you use the tree-shakeable `numpy-ts/core` entry point, return types are `NDArrayCore` instead. The API is otherwise identical.

## Intentionally unplanned features

The following NumPy features are **not implemented** by design (31 functions):

* **Datetime types** -- `datetime64` and `timedelta64` dtypes. Use native JavaScript `Date` or libraries like `date-fns` instead.
* **Fortran-order layout** -- `order='F'` parameter. All arrays use C-contiguous (row-major) layout.
* **Object dtype** -- `dtype=object`. JavaScript does not have an equivalent concept.
* **String dtypes** -- `dtype='U'` and `dtype='S'`. Use native JavaScript strings and typed arrays separately.

These exclusions keep the library focused on numeric computation where TypeScript can match or exceed NumPy's performance.

## Quick links

> [card] [NDArray Class](https://numpyts.dev/v1.7.x/api/ndarray/class.md)
>
> Properties, core methods, and the NDArray / NDArrayCore hierarchy.

> [card] [NDArray Methods](https://numpyts.dev/v1.7.x/api/ndarray/methods.md)
>
> 100+ chainable instance methods on NDArray (arithmetic, reductions, shape, linalg, and more).

> [card] [Array Creation](https://numpyts.dev/v1.7.x/api/creation/basic.md)
>
> array, zeros, ones, arange, linspace, eye, and all \*\_like variants.

> [card] [Linear Algebra](https://numpyts.dev/v1.7.x/api/linalg/products.md)
>
> linalg.inv, linalg.det, linalg.eig, linalg.svd, linalg.solve, and more.

> [card] [Random](https://numpyts.dev/v1.7.x/api/random/overview.md)
>
> 53 random number generation functions including distributions and sampling.

> [card] [FFT](https://numpyts.dev/v1.7.x/api/fft/transforms.md)
>
> Discrete Fourier transforms: fft, ifft, rfft, irfft, fft2, fftfreq, and more.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.