numpy-ts 0.10.0 → 0.12.0

package/README.md

@@ -3,7 +3,7 @@
 ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
 [![npm version](https://img.shields.io/npm/v/numpy-ts)](https://www.npmjs.com/package/numpy-ts)
 ![bundle size](https://img.shields.io/bundlephobia/minzip/numpy-ts)
-![numpy api coverage](https://img.shields.io/badge/numpy_api_coverage-65%20%25-yellow)
+![numpy api coverage](https://img.shields.io/badge/numpy_api_coverage-81%20%25-yellow)
 
 ```
 ███╗   ██╗██╗   ██╗███╗   ███╗██████╗ ██╗   ██╗  ████████╗███████╗
@@ -24,7 +24,7 @@ npm install numpy-ts
 
 ## Why numpy-ts?
 
-- **📊 Extensive API** — **331 of 507 NumPy functions (65.3% coverage)**
+- **📊 Extensive API** — **411 of 507 NumPy functions (81.1% coverage)**
 - **✅ NumPy-validated** — 3000+ test cases cross-validated against Python NumPy
 - **🔒 Type-safe** — Full TypeScript support with shape and dtype inference
 - **🌐 Universal** — Works in Node.js and browsers with .npy/.npz file support
@@ -63,6 +63,9 @@ Progress toward complete NumPy API compatibility:
 | Category | Complete | Total | Status |
 |----------|----------|-------|--------|
 | **Arithmetic** | 29/29 | 100% | ✅ |
+| **Array Creation** | 35/35 | 100% | ✅ |
+| **Array Manipulation** | 46/46 | 100% | ✅ |
+| **Bit Operations** | 13/13 | 100% | ✅ |
 | **Broadcasting** | 3/3 | 100% | ✅ |
 | **Comparison** | 10/10 | 100% | ✅ |
 | **Exponential** | 9/9 | 100% | ✅ |
@@ -70,30 +73,27 @@ Progress toward complete NumPy API compatibility:
 | **Hyperbolic** | 9/9 | 100% | ✅ |
 | **I/O** | 8/8 | 100% | ✅ |
 | **Indexing** | 21/21 | 100% | ✅ |
+| **Linear Algebra** | 15/15 | 100% | ✅ |
+| **Linear Algebra (linalg)** | 31/31 | 100% | ✅ |
 | **Logic** | 24/24 | 100% | ✅ |
+| **Other Math** | 15/15 | 100% | ✅ |
+| **Polynomials** | 10/10 | 100% | ✅ |
+| **Reductions** | 36/36 | 100% | ✅ |
 | **Rounding** | 7/7 | 100% | ✅ |
 | **Searching** | 7/7 | 100% | ✅ |
+| **Set Operations** | 12/12 | 100% | ✅ |
 | **Sorting** | 6/6 | 100% | ✅ |
+| **Statistics** | 11/11 | 100% | ✅ |
 | **Trigonometric** | 16/16 | 100% | ✅ |
-| **Reductions** | 34/36 | 94% | 🟡 |
-| **Array Creation** | 33/35 | 94% | 🟡 |
-| **Array Manipulation** | 37/46 | 80% | 🟡 |
-| **Statistics** | 9/12 | 75% | 🟡 |
-| **Bit Operations** | 9/13 | 69% | 🟡 |
-| **NDArray Methods** | 34/53 | 64% | 🟡 |
-| **Linear Algebra (linalg)** | 19/31 | 61% | 🟡 |
-| **Linear Algebra** | 9/15 | 60% | 🟡 |
-| **Set Operations** | 7/12 | 58% | 🟡 |
+| **Type Checking** | 7/7 | 100% | ✅ |
+| **NDArray Methods** | 40/53 | 75% | 🟡 |
+| **Utilities** | 10/16 | 62% | 🟡 |
 | **Random** | 17/53 | 32% | 🔴 |
-| **Utilities** | 4/16 | 25% | 🔴 |
 | **FFT** | 0/18 | 0% | 🔴 |
-| **Other Math** | 0/15 | 0% | 🔴 |
-| **Polynomials** | 0/10 | 0% | 🔴 |
 | **String/Formatting** | 0/10 | 0% | 🔴 |
-| **Type Checking** | 0/7 | 0% | 🔴 |
-| **Unplanned** | 0/25 | 0% | 🔴 |
+| **Unplanned** | 0/26 | 0% | 🔴 |
 
-**Overall: 331/507 functions (65.3% complete)**
+**Overall: 411/507 functions (81.1% complete)**
 
 See the complete [API Reference](docs/API-REFERENCE.md) for detailed function list.
 
@@ -119,16 +119,29 @@ NumPy-compatible type system with automatic promotion:
 | `uint8` | ✅ | ✅ | |
 | **Other Numeric** ||||
 | `bool` | ✅ | ✅ | Stored as uint8 |
-| `complex64` | ✅ | ❌ | Not yet supported |
-| `complex128` | ✅ | ❌ | Not yet supported |
+| `complex64` | ✅ | ✅ | |
+| `complex128` | ✅ | ✅ | |
 | **Non-Numeric** ||||
 | `str_` | ✅ | ❌ | Not planned |
 | `bytes_` | ✅ | ❌ | Not planned |
 | `object_` | ✅ | ❌ | Not planned |
-| `datetime64` | ✅ | ❌ | Future consideration |
-| `timedelta64` | ✅ | ❌ | Future consideration |
+| `datetime64` | ✅ | ❌ | Not planned |
+| `timedelta64` | ✅ | ❌ | Not planned |
 
-**Supported: 11/20 numeric dtypes** • Complex and temporal types planned for future releases
+**Supported: 13/20 numeric dtypes**
+
+### Intentional Divergences from NumPy
+
+numpy-ts focuses on numeric array computing. The following NumPy features are **not planned**:
+
+| Feature | Why Not Included |
+|---------|------------------|
+| **Datetime/Timedelta** (`datetime64`, `timedelta64`) | JS has native `Date`; libraries like [date-fns](https://date-fns.org/) handle time math better |
+| **F-order memory layout** | Exists in NumPy for Fortran/BLAS interop, which doesn't exist in JS |
+| **Object dtype** (`object_`) | Defeats the purpose of typed arrays; use regular JS arrays instead |
+| **String/Bytes dtypes** (`str_`, `bytes_`, `U`, `S`) | JS strings are first-class; no need for fixed-width string arrays |
+
+These omissions keep the library focused and the bundle small. For string manipulation, datetime math, or heterogeneous data, use native JS/TS constructs alongside numpy-ts.
 
 ### NumPy Memory Model
 
@@ -243,9 +256,9 @@ arr.sum();  // Type: number
 
 | Feature | numpy-ts | numjs | ndarray | TensorFlow.js |
 |---------|----------|-------|---------|---------------|
-| NumPy API Coverage | 331/507 (65%) | ~20% | Different | ML-focused |
+| NumPy API Coverage | 411/507 (81%) | ~20% | Different | ML-focused |
 | TypeScript Native | ✅ Full | Partial | ❌ No | ✅ Yes |
-| NumPy Validated | ✅ 1365+ tests | Mostly | ❌ No | ❌ No |
+| NumPy Validated | ✅ 4500+ tests | Mostly | ❌ No | ❌ No |
 | .npy/.npz Files | ✅ v1/v2/v3 | ❌ No | ❌ No | ❌ No |
 | Broadcasting | ✅ Full | Limited | Limited | ✅ Full |
 | Bundle Size | <50kb | ~60kb | ~5kb | >100kb |