struct CPUClassConforms to
Hashable, Sendable, CustomStringConvertible, Equatablelet description = try index.describe()
print(description.metadata.dimensions, description.metadata.connectivity)
print(description.size, description.capacity, description.memoryUsage, description.cpuClass, description.shardsCount)
print(try index.count(key: 42), try index.contains(key: 42))
let reachability = try index.on(executor).health()
print(reachability.reachable, "of", reachability.audited, "entries reachable after", reachability.sweeps, "sweeps")
print(version(), capabilitiesCompiled(), capabilitiesAvailable())health audits how much of the graph a search reaches from its landmarks; entries it misses stay unfound until a refine re-links them.
API
StructCPUClassA CPU family USearch ships tuned variants for; dispatch reports its pick in this vocabulary, and a RAM or NVMe placement or executor may pin one.20
serialThe portable floor, with no SIMD assumptions.
static let serial: CPUClassintelHaswellHaswell-class x86: AVX2 and FMA.
static let intelHaswell: CPUClassintelSierraSierra Forest-class x86: AVX-VNNI without AVX-512.
static let intelSierra: CPUClassintelSkylakeSkylake-class x86: the AVX-512 foundation.
static let intelSkylake: CPUClassintelIcelakeIcelake-class x86: AVX-512 VNNI and VPOPCNT.
static let intelIcelake: CPUClassamdGenoaGenoa-class x86: native bf16 dot products over AVX-512.
static let amdGenoa: CPUClassintelSapphireSapphire Rapids-class x86: AVX-512 FP16 and the AMX tiles.
static let intelSapphire: CPUClassintelGraniteGranite Rapids-class x86: the AMX-FP16 tiles.
static let intelGranite: CPUClassintelDiamondDiamond Rapids-class x86: AVX10.2's FP8 conversions.
static let intelDiamond: CPUClassawsG2Graviton2-class Arm: the bare NEON floor.
static let awsG2: CPUClassappleM2Armv8.6 NEON with dot products and bf16.
static let appleM2: CPUClassappleM4Apple M4-class Arm: the SME outer-product tiles.
static let appleM4: CPUClassawsG5Graviton5-class Arm: Armv9.2.
static let awsG5: CPUClassnvidiaVeraVera-class Arm: FP8 dot products.
static let nvidiaVera: CPUClassalibabaC930Alibaba C930-class RISC-V: RVA23 vectors.
static let alibabaC930: CPUClasswasm32V128WebAssembly with fixed-width simd128.
static let wasm32V128: CPUClasswasm64ExtendedWebAssembly with relaxed SIMD, threads and 64-bit addressing.
static let wasm64Extended: CPUClassmonoversionedThe one class of a monoversioned build.
static let monoversioned: CPUClassdescriptionThe class as the library spells it.
var description: String { get }initReads a spelling back, and nil for one no class carries.
init?(name: String)StructGPUClassA GPU family USearch ships tuned variants for; a VRAM placement or executor may pin one.14
struct GPUClassConforms to
Hashable, Sendable, CustomStringConvertible, EquatablenvidiaAmpereAmpere-class NVIDIA, and every NVIDIA GPU without a class of its own.
static let nvidiaAmpere: GPUClassnvidiaAdaAda-class NVIDIA: the fp8 conversions.
static let nvidiaAda: GPUClassnvidiaHopperHopper-class NVIDIA.
static let nvidiaHopper: GPUClassnvidiaBlackwellBlackwell-class NVIDIA.
static let nvidiaBlackwell: GPUClassnvidiaBlackwellRTXConsumer Blackwell NVIDIA.
static let nvidiaBlackwellRTX: GPUClassnvidiaRubinRubin-class NVIDIA.
static let nvidiaRubin: GPUClassamdCDNA3CDNA3 AMD: gfx942.
static let amdCDNA3: GPUClassamdCDNA4CDNA4 AMD: gfx950.
static let amdCDNA4: GPUClassamdCDNA5CDNA5 AMD: gfx1250.
static let amdCDNA5: GPUClassappleMetal7Apple7-family GPUs, and every Apple GPU without a class of its own.
static let appleMetal7: GPUClassappleMetal9Apple9-family GPUs.
static let appleMetal9: GPUClassappleMetal10Apple10-family GPUs.
static let appleMetal10: GPUClassdescriptionThe class as the library spells it.
var description: String { get }initReads a spelling back, and nil for one no class carries.
init?(name: String)StructDenseIndexDescriptionA live index's frozen metadata and current counters, each read once, so under concurrent insertions they may come from slightly different moments.7
metadataThe frozen metric, quantization, dimensions and connectivity, as a checkpoint reports them.
var metadata: DenseMetadatasizeThe stored entries.
var size: IntcapacityThe entries hosted without growing again.
var capacity: IntmemoryUsageThe bytes the handle holds; traversal scratch is the executor's.
var memoryUsage: IntcpuClassThe CPU class whose kits the index dispatched to on RAM and NVMe; nil on VRAM.
var cpuClass: CPUClass?gpuClassThe GPU class whose kernels the index dispatched to on VRAM; nil on RAM and NVMe.
var gpuClass: GPUClass?shardsCountThe live shards, each a graph of its own.
var shardsCount: IntStructDenseReachabilityOne reachability audit: the population it judged, and how much of it a search reaches.4
auditedThe entries published when the audit started; compare reachable against this, never a later size.
var audited: IntreachableOf those, the entries a search reaches from the landmarks; the rest no search finds until a refinement re-links them.
var reachable: IntsweepsThe levels the sweep took to converge.
var sweeps: IntbackSweepsThe levels the sweep back toward the entry point took, where an audit sweeps both ways.
var backSweeps: IntFunctions
versionThe version of the linked library, like 3.0.0.
func version() -> StringcapabilitiesCompiledThe hardware capabilities the linked binary was compiled with, comma separated.
func capabilitiesCompiled() -> StringcapabilitiesAvailableThe hardware capabilities the current machine offers at runtime, comma separated.
func capabilitiesAvailable() -> String