Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Feature Flags

FlagDefaultDescription
cpuyesCPU construction and queries
gpunoWebGPU-accelerated construction and queries via wgpu
wasmnowasm-bindgen JS/TS bindings

cpu

The default. Everything builds and queries on the CPU with no GPU dependency. This is the correctness ground truth for every GPU path.

gpu

Adds wgpu and the GPU construction + query paths (FmIndex::build, locate_batch_gpu, find_mems_gpu / find_smems_gpu). Required for all GPU benchmarks and tests:

cargo test --features gpu
cargo bench --features gpu

wasm

Adds the wasm-bindgen bindings for browser use and implies gpu (browser WebGPU). Build the package with wasm-pack build --target web --features wasm. See WebAssembly.