ordvec 0.5.0

Training-free ordinal & sign quantization for vector retrieval
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# MSRV and Feature Stability

This matrix is the release-facing build contract for downstream embedders,
packagers, and host systems. It complements the
[pre-1.0 compatibility policy](compatibility-policy.md), which defines how
compatibility-impacting changes are classified. The release artifact and wheel
target inventory lives in [artifact-platform-matrix.md](artifact-platform-matrix.md).

Current MSRV: Rust 1.89.

The MSRV applies to all Rust crates in this repository: `ordvec`,
`ordvec-manifest`, `ordvec-python`, `ordvec-manifest-python`, `ordvec-ffi`, and
the standalone `ordvec-fuzz` crate. The CI MSRV job, each `Cargo.toml` `rust-version`,
and the README MSRV badge/section must stay synchronized. Raising the MSRV is a
minor-version compatibility change and release notes must state the reason and
any migration note.

## Feature Matrix

| Surface | Default features | Stable default-off features | Optional dependency features | Experimental/internal features |
| --- | --- | --- | --- | --- |
| `ordvec` | none | `serde` derives `Serialize`/`Deserialize` for `SearchResults` only | `serde` | `experimental` exposes `MultiBucketBitmap`; `test-utils` is repo-test-only and has no public stability promise. |
| `ordvec-manifest` | `cli` | none | `cli`, `sqlite`, `sqlite-bundled` | none |
| `ordvec-python` | n/a | n/a | n/a | n/a |
| `ordvec-manifest-python` | n/a | n/a | n/a | n/a |
| `ordvec-ffi` | none | none | none | none |

SIMD dispatch in `ordvec` is not feature-gated. x86_64 dispatches AVX-512 and
AVX2 at runtime, aarch64 uses NEON, wasm32 can use `simd128` when the target is
built with that target feature, and other targets use the scalar fallback.
Host systems should not need BLAS, LAPACK, `ndarray`, `faer`, or a native graph
library to embed the core crate.

`ordvec-manifest` enables `cli` by default so `cargo install
ordvec-manifest` installs the command-line utility without extra flags. Library
consumers that do not need the CLI can use `default-features = false` to avoid
the `clap` dependency. The `sqlite` feature enables the local cache/audit
subcommands; `sqlite-bundled` adds the bundled SQLite build through `rusqlite`.

## Change Policy

New feature flags must declare a stability class before merging:

- stable default feature;
- stable default-off feature;
- optional dependency feature;
- experimental/default-off feature;
- internal repo-test-only feature.

Changing the default feature set is compatibility-impacting and must be
classified in release notes. Adding a new required system dependency, changing
wheel platform expectations, or making an optional dependency effectively
required is also compatibility-impacting.

Experimental and internal features can change before 1.0, but releases should
still call out changes likely to affect known downstream users. Stable feature
changes should include examples or migration notes when the visible build or
API surface changes.

## Release Checks

`python tests/release_publish_invariants.py` keeps the following in sync:

- lockstep crate and Python package versions;
- Rust MSRV declarations, README badge text, and CI MSRV toolchain;
- crates.io metadata, PyPI metadata, docs.rs feature policy, and package
  contents;
- release workflow and registry preflight expectations.

Release review should also compare touched code against this matrix so host
systems can embed `ordvec` without hidden platform or feature surprises.