Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ describes**:

| Source | Published under |
| --- | --- |
| branch `main`, with `params.ndarray.version: v0.42.0` in `hugo.yaml` | `https://go-ndarray.github.io/docs/<MAJOR.MINOR>/`, here `/docs/0.42/` |
| branch `main`, with `params.ndarray.version: v0.43.1` in `hugo.yaml` | `https://go-ndarray.github.io/docs/<MAJOR.MINOR>/`, here `/docs/0.43/` |
| the newest version | also `https://go-ndarray.github.io/docs/latest/` |

`https://go-ndarray.github.io/docs/` redirects to `latest/`. Each push to
Expand Down
2 changes: 1 addition & 1 deletion content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ WebAssembly, with nothing to install — build a pipeline step by step (creation
| Creation | `New`, `Zeros`, `Ones`, `Full`, `Arange`, `Linspace`, `Eye`, `Identity`, `FromData` |
| Views & shape | `Slice` (`All`/`R`/`Rng`/`From`/`To`/`Step`), `Reshape`, `Ravel`, `Transpose`, `Copy` |
| Elementwise | `Add`/`Sub`/`Mul`/`Div` (+`*Scalar`, +`*Into`), `Map`, `Neg`, `Abs`, comparisons (`Greater`/`Equal`/… → Bool masks), `Maximum`/`Minimum`, `Logical*`, `Real`/`Imag`/`Conj`/`Angle` |
| Ufuncs | `Sqrt`, `Exp`, `Log`/`Log2`/`Log10`, `Sin`/`Cos`/`Tan`, `Floor`/`Ceil`/`Round`, `Square`, `Power` |
| Ufuncs | `Sqrt`, `Exp`, `Log`/`Log2`/`Log10`, `Sin`/`Cos`/`Tan`, `Floor`/`Ceil`, `Round` (half to even, as `np.round`; `RoundHalfAway` keeps the old rule), `Square`, `Power` |
| Reductions | `Sum`, `Mean`, `Max`/`Min`, `Prod`, `ArgMax`/`ArgMin`, `CumSum`/`CumProd`, `Clip`, `Where` (+ per-axis) |
| Indexing | `Slice` (basic indexing), `MaskSelect` (`a[mask]`), `Nonzero` (`flatnonzero`), `Take` (fancy indexing) |
| Manipulation | `Flatten`, `ExpandDims`, `Squeeze`, `Concatenate`, `Stack`, `VStack`, `HStack` |
Expand Down
2 changes: 1 addition & 1 deletion content/en/accuracy.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "What go-ndarray promises about its results: a stated error bound,
tags: [accuracy, numpy, math/big]
---

> Mirrored from [`README.md`](https://github.com/go-ndarray/ndarray/blob/v0.42.0/README.md#accuracy-contract) at v0.42.0.
> Mirrored from [`README.md`](https://github.com/go-ndarray/ndarray/blob/v0.43.1/README.md#accuracy-contract) at v0.43.1.

The contract is **correct, and as fast as possible**. "Correct" means a stated error bound, checked against an exact oracle. Equality with NumPy's bits is not the contract: wherever it holds today, it is how a function was ported, and a faster default that stays within its bound may replace it.

Expand Down
3 changes: 1 addition & 2 deletions content/en/dtypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "Why the dtype is a run-time property of one Array type, how arrays
tags: [dtypes, numpy]
---

> Mirrored from [`docs/design-dtypes.md`](https://github.com/go-ndarray/ndarray/blob/v0.42.0/docs/design-dtypes.md) at v0.42.0.
> Mirrored from [`docs/design-dtypes.md`](https://github.com/go-ndarray/ndarray/blob/v0.43.1/docs/design-dtypes.md) at v0.43.1.

> Status: implemented (Phase 2). Supersedes decision 4 of
> [plan-ndarray.md](roadmap.md) ("`float64` first").
Expand Down Expand Up @@ -111,7 +111,6 @@ dtype by dtype after correctness, `float32` first.
| NumPy | here | why |
|---|---|---|
| `float16` exists; `sqrt(int8)` is `float16` | no `float16`; `sqrt(int8)`, `sqrt(uint8)` and `sqrt(bool)` give `float32` | Go has no half-precision arithmetic; `float32` is the smallest type that holds the result exactly |
| `round` is half-to-even | half-away-from-zero (unchanged) | documented since v0.1.0 |
| `datetime64`, `str_`, `object`, structured dtypes | absent | out of scope for a numeric library |

## Element access
Expand Down
7 changes: 4 additions & 3 deletions content/en/linalg.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ description: "Solve, Inv, Det, Cholesky, QR, SVD, Eig and the rest of numpy.lina
tags: [linalg, numpy]
---

> Mirrored from [`docs/linalg.md`](https://github.com/go-ndarray/ndarray/blob/v0.42.0/docs/linalg.md) at v0.42.0.
> Mirrored from [`docs/linalg.md`](https://github.com/go-ndarray/ndarray/blob/v0.43.1/docs/linalg.md) at v0.43.1.

Package [`linalg`](https://pkg.go.dev/github.com/go-ndarray/ndarray@v0.42.0/linalg) gives ndarray arrays the functions of
Package [`linalg`](https://pkg.go.dev/github.com/go-ndarray/ndarray@v0.43.1/linalg) gives ndarray arrays the functions of
`numpy.linalg`, written in Go without cgo or assembly of its own: the
matrix products it relies on are the ndarray package's packed SIMD GEMM.
matrix products it relies on are the packed SIMD GEMM of [go-blas/blas](https://github.com/go-blas/blas), which
ndarray's `MatMul` uses too (the same kernels, moved there in v0.42.0, #122).

| numpy.linalg | linalg |
|---|---|
Expand Down
37 changes: 33 additions & 4 deletions content/en/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "go-ndarray against the pinned NumPy on one core, both sides: the m
tags: [performance, numpy, refbench]
---

> Mirrored from [`docs/perf.md`](https://github.com/go-ndarray/ndarray/blob/v0.42.0/docs/perf.md) at v0.42.0.
> Mirrored from [`docs/perf.md`](https://github.com/go-ndarray/ndarray/blob/v0.43.1/docs/perf.md) at v0.43.1.

The table is [perf-table.md](https://github.com/go-ndarray/ndarray/blob/v0.42.0/docs/perf-table.md), generated by
The table is [perf-table.md](https://github.com/go-ndarray/ndarray/blob/v0.43.1/docs/perf-table.md), generated by
[refbench](https://github.com/go-scikit/refbench) (go-scikit/refbench v0.3.0)
from [perf.json](https://github.com/go-ndarray/ndarray/blob/v0.42.0/docs/perf.json); nothing in it is edited by hand. The rules are
from [perf.json](https://github.com/go-ndarray/ndarray/blob/v0.43.1/docs/perf.json); nothing in it is edited by hand. The rules are
those of the go-scikit performance campaign
([go-scikit/roadmap#27](https://github.com/go-scikit/roadmap/issues/27)):

Expand All @@ -36,7 +36,7 @@ those of the go-scikit performance campaign
`TestRefSmoke` runs every NumPy call once.
- **One case per public function** (a function with several shapes of use has
several rows, `Array.SumAxis/axis0` and `/axis1`), or a named exemption with
its reason in [perf-exempt.md](https://github.com/go-ndarray/ndarray/blob/v0.42.0/docs/perf-exempt.md). CI fails on a public function
its reason in [perf-exempt.md](https://github.com/go-ndarray/ndarray/blob/v0.43.1/docs/perf-exempt.md). CI fails on a public function
with neither.

## What a row times
Expand Down Expand Up @@ -105,6 +105,35 @@ rounds:
element at a time. `Full` went from 131–135 µs to 84–104 µs. `Ones` calls
`Full`. `FullOf`, which fills the other dtypes, was not timed.

- Float64 `Abs`, `Neg`, `Square`, `Floor`, `Ceil` and `Round` run on the
go-simd/floats v0.23.0 kernels (above the parallel threshold, split across
cores as before) instead of a scalar loop through `Map`. The results are bit
for bit those of `math.Abs`, `-x`, `x*x`, `math.Floor`, `math.Ceil` and
`math.RoundToEven`. `Abs` and `Neg` keep NaN bits exactly; for `Square`,
`Floor`, `Ceil` and `Round` a signalling NaN may come back quieted
(`TestUnaryKernelsBitIdentical`: edge table, lengths 0–33 and one above the
threshold). `Round` is now half to even, as `np.round`; the old half away
from zero is `RoundHalfAway`, on the scalar path (see the README). `go test -bench Unary` (`benchmarks/unary_bench_test.go`), 10⁵
float64 including the result allocation, one pinned core of cfarm420
(`GOMAXPROCS=1`, `taskset -c 9`), a test binary of v0.42.0 and one of this
change, four interleaved rounds of 1 s, 1-minute load 2.34 at the start and
3.32 at the end. Before → after, range over the rounds:

| operation | before (µs) | after (µs) |
|---|---|---|
| `Abs` | 244–258 | 70–75 |
| `Neg` | 243–249 | 72–75 |
| `Square` | 243–247 | 72–80 |
| `Floor` | 432–457 | 73–81 |
| `Ceil` | 437–464 | 72–81 |
| `Round` (the old one was half away from zero) | 325–340 | 71–80 |

`Round` was measured in a second run of the same kind (four interleaved
rounds, load 2.25 to 2.42), v0.42.0 against this change. `RoundHalfAway`,
the control on the scalar path, takes 324–345 µs in the same run. These are
times of the Go code against itself; no NumPy ratio is claimed here, as the
new table run has not been made.

What remains of the allocation cause is Go's own cost. A CPU profile of a bare
`make([]float64, 100000)` shows about 60% garbage-collector marking (assists
in the allocating goroutine) and about 23% zeroing. NumPy frees each result
Expand Down
8 changes: 4 additions & 4 deletions content/en/random.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ description: "numpy.random with NumPy's numbers for the same seed: the bit gener
tags: [random, numpy]
---

> Mirrored from [`docs/random.md`](https://github.com/go-ndarray/ndarray/blob/v0.42.0/docs/random.md) at v0.42.0.
> Mirrored from [`docs/random.md`](https://github.com/go-ndarray/ndarray/blob/v0.43.1/docs/random.md) at v0.43.1.

Package [`random`](https://pkg.go.dev/github.com/go-ndarray/ndarray@v0.42.0/random) is `numpy.random` over go-ndarray arrays. Its goal
Package [`random`](https://pkg.go.dev/github.com/go-ndarray/ndarray@v0.43.1/random) is `numpy.random` over go-ndarray arrays. Its goal
is migration: a notebook moved from NumPy to Go keeps its numbers for the same
seed.

Expand All @@ -24,7 +24,7 @@ u, _ := random.Rand(3) // np.random.rand(3)
```

`Example`, `ExampleSeed` and `ExampleGenerator_ChoiceN` in
[`example_test.go`](https://github.com/go-ndarray/ndarray/blob/v0.42.0/random/example_test.go) print NumPy's own numbers.
[`example_test.go`](https://github.com/go-ndarray/ndarray/blob/v0.43.1/random/example_test.go) print NumPy's own numbers.

## What is implemented

Expand Down Expand Up @@ -142,7 +142,7 @@ random arguments. Used as-is, that made 3% of `np.random.randn` values and
10% of `lognormal` values one ULP off.

So `random` rounds `log`, `log1p`, `exp`, `expm1` and `pow` **correctly**
([`libm.go`](https://github.com/go-ndarray/ndarray/blob/v0.42.0/random/libm.go)): a fast evaluation to about 2⁻⁶⁸ with Ziv's
([`libm.go`](https://github.com/go-ndarray/ndarray/blob/v0.43.1/random/libm.go)): a fast evaluation to about 2⁻⁶⁸ with Ziv's
rounding test, and a double-double fallback (about 2⁻¹⁰⁰) for the one argument
in ~2¹⁵ that needs it. Checked against mpmath at 300 bits on 63,000 arguments
(0 misrounded; the committed `libm.json` keeps 8,400), and the fast paths
Expand Down
18 changes: 10 additions & 8 deletions content/en/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "The plan for go-ndarray and what ships today."
tags: [roadmap]
---

> Mirrored from [`docs/plan-ndarray.md`](https://github.com/go-ndarray/ndarray/blob/v0.42.0/docs/plan-ndarray.md) at v0.42.0.
> Mirrored from [`docs/plan-ndarray.md`](https://github.com/go-ndarray/ndarray/blob/v0.43.1/docs/plan-ndarray.md) at v0.43.1.

> Goal: a **pure-Go (CGO=0)** NumPy-style N-dimensional array library, as a
> **standalone, reusable** module with correct scalar kernels now and a clean
Expand Down Expand Up @@ -94,12 +94,14 @@ suite (plus the per-arch CI jobs already wired in `.github/workflows/ci.yml`).
non-positive m defaults to square), and `Reshape` `-1` dimension inference.
- **Ufuncs — DONE.** Unary math (`Sqrt`/`Exp`/`Log`/`Log2`/`Log10`/`Sin`/`Cos`/
`Tan`/`Floor`/`Ceil`/`Round`/`Square`/`Power`): `Sqrt` has a SIMD kernel,
`Exp`/`Log`/`Log10` run ports of Arm's optimized-routines (v0.2.0), and the
rest go through the `Map` seam over Go's `math`; and
broadcasting comparisons returning 0/1 float masks (`Equal`/`NotEqual`/
`Greater`/`GreaterEqual`/`Less`/`LessEqual`) plus pairwise `Maximum`/`Minimum`.
(`Round` is math.Round / half-away-from-zero, unlike numpy's banker's
rounding — documented.) A bool dtype for true masks is deferred to Phase 2.
`Exp`/`Log`/`Log10` run ports of Arm's optimized-routines (v0.2.0); since
v0.43.0 float64 `Abs`/`Neg`/`Square`/`Floor`/`Ceil`/`Round` run on
go-simd/floats vector kernels, and the rest go through the `Map` seam over
Go's `math`; and broadcasting comparisons returning 0/1 float masks
(`Equal`/`NotEqual`/`Greater`/`GreaterEqual`/`Less`/`LessEqual`) plus pairwise
`Maximum`/`Minimum`. `Round` rounds halves to even, as `np.round`, since
v0.43.0 (it was `math.Round`, half away from zero, before); `RoundHalfAway`
keeps that older rule. A bool dtype for true masks is deferred to Phase 2.
- **Manipulation — DONE.** `Flatten` (always copy), `ExpandDims`/`Squeeze`
(length-1 axis views), `Concatenate` (existing axis), `Stack` (new axis), and
the `VStack`/`HStack` conveniences with 1-D promotion. Negative axes
Expand All @@ -116,7 +118,7 @@ suite (plus the per-arch CI jobs already wired in `.github/workflows/ci.yml`).
NumPy. What follows is the history of the levers behind the kernel seam,
measured then against NumPy
2.2.4 (see [docs/perf.md](performance.md) and the repo's
[BENCHMARKS.md](https://github.com/go-ndarray/ndarray/blob/v0.42.0/BENCHMARKS.md)):
[BENCHMARKS.md](https://github.com/go-ndarray/ndarray/blob/v0.43.1/BENCHMARKS.md)):
- **Multicore.** `Add/Sub/Mul/Div/Map`, `Sum/Max/Min`, the axis reductions,
`Concatenate`/`Stack`, and the GEMM fan out across `GOMAXPROCS` above a size
threshold (small arrays stay serial). Plus an allocation fix: the
Expand Down
6 changes: 3 additions & 3 deletions content/en/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "How to report a vulnerability, what the library guarantees, and th
tags: [security]
---

> Mirrored from [`SECURITY.md`](https://github.com/go-ndarray/ndarray/blob/main/SECURITY.md) at v0.42.0.
> Mirrored from [`SECURITY.md`](https://github.com/go-ndarray/ndarray/blob/main/SECURITY.md) at v0.43.1.

## Reporting

Expand Down Expand Up @@ -80,7 +80,7 @@ standard library's known vulnerabilities; `govulncheck ./...` reports none.

## Audit log

**2026-11-15 (unreleased).** The GEMM moved to
**2026-11-15 (v0.42.0, #122).** The GEMM moved to
[go-blas/blas](https://github.com/go-blas/blas) v0.2.1 (the micro-kernels, their
wrappers, the packing and their fence tests, byte for byte; the audit of that
code is that repository's). What ndarray adds is `internal/blasmm`, which hands
Expand All @@ -92,7 +92,7 @@ on an axis longer than one (a broadcast or reversed view) is copied to a
contiguous matrix first. ndarray keeps the dot kernels (`dot_<arch>.go`), the
mat-vec and the thread pool, with their wrappers and fences.

**2026-11-12 (unreleased, #103).** The gather of `random`'s `Choice`
**2026-11-12 (v0.40.2, #115, Refs #103).** The gather of `random`'s `Choice`
(`takeAxis`, random/arrays.go) now copies bytes through `bytesOf`, an
`unsafe.Slice` view of a slice's backing array of exactly `Len()·size` bytes.
Every dtype the package stores is a fixed-size value without pointers
Expand Down
4 changes: 2 additions & 2 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# have used since the site was built with MkDocs and mike. The CI sets it
# through --baseURL, from params.ndarray.version below. This default is the
# same build.
baseURL: "https://go-ndarray.github.io/docs/0.42/"
baseURL: "https://go-ndarray.github.io/docs/0.43/"
title: "go-ndarray"
# themes/hextra is the tannevaled/hextra fork, pinned at a release tag:
# upstream Hextra plus opt-in features (partial menu items, combos,
Expand Down Expand Up @@ -100,7 +100,7 @@ params:
# The ndarray release these pages describe. Its minor version is the
# documentation's version label (v0.9.1 -> 0.9): the CI reads it here.
ndarray:
version: "v0.42.0"
version: "v0.43.1"

navbar:
displayTitle: true
Expand Down
Loading