Retrieval and Streaming

get exports the vectors stored under one key into the arena, as f32 unless scalar names another kind:

const stored = index.get(42n, arena); // The vectors under a key, as f32 DenseVectors
using bitsArena = new usearch.Arena();
const packed = index.get(42n, bitsArena, { scalar: usearch.Scalar.U1x8 }); // Or as packed bits, in another arena

get shapes its rows from the width and stride the call reports: stored.data holds stored.rows rows of stored.columns values, stored.stride bytes apart, and no rows when the key is absent.

A cursor walks the index instead; each shard’s watermark is read as the walk enters it, so an entry once passed is never revisited. Without start keys it yields every entry in storage order; with them, the starts’ own entries first, then the entries those link to breadth-first, each once. It lands each batch of up to wanted keys in the arena, and beside them the keys each links to when links asks; the vectors themselves come from get:

using cursor = index.on(executor).cursor();
for (let batch = cursor.next(1024, arena, { links: true }); batch.entries; batch = cursor.next(1024, arena, { links: true })) {
  writeOut(batch.keys, batch.links.get(0), batch.entries);
}

Cursors and streams keep their walk state rather than a thread: every pull is an ordinary call on the executor of the receiver that opened them, and each keeps its index alive until freed. No residency implements the stream yet, so the engine answers Status.Unsupported, and a stream reports no telemetry, since the ABI gives a resumable walk none.

§ Sampling

sample draws keys around focus, or across the whole index, each hanging from a shown or earlier draw and placed in three dimensions beside the shown keys already on screen, so a view grows one connected sample as it zooms. Equal seeds, shown keys and focus draw equally, and a larger wanted draws a superset. The shown keys, their coordinates and the focus are read in place, so a deferred sample holds those arrays until it is final.

const drawn = index.on(executor).sample(256, arena, { shown, shownCoordinates: places, focus: near, seed: 42 });
drawn.keys; // sixteen bytes per draw
drawn.entryOrdinals; // which of its key's entries each draw is
drawn.parents.get(0); // the shown or earlier draw it hangs from, empty for a root
drawn.coordinates.data; // three f32 values per draw