For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogocuVS
GitHubCUDA-X
    • Home
    • Installation
  • Getting Started
    • Introduction
    • Integrations
    • Use-cases
  • User Guide
    • API Guide
    • Benchmarking Guide
    • Field Guide
    • References
  • Developer Guide
    • Coding Guidelines
    • Contributing
  • API Reference
    • C API Documentation
      • Cluster Kmeans
      • Core C API
      • Distance Distance
      • Distance Pairwise Distance
      • Neighbors Multi GPU Cagra
      • Neighbors Multi GPU Common
      • Neighbors Multi GPU IVF Flat
      • Neighbors Multi GPU IVF PQ
      • Neighbors All Neighbors
      • Neighbors Brute Force
      • Neighbors Cagra
      • Neighbors Common
      • Neighbors HNSW
      • Neighbors IVF Flat
      • Neighbors IVF PQ
      • Neighbors IVF SQ
      • Neighbors NN Descent
      • Neighbors Refine
      • Neighbors Tiered Index
      • Neighbors Vamana
      • Preprocessing Quantize Binary
      • Preprocessing PCA
      • Preprocessing Quantize PQ
      • Preprocessing Quantize Scalar
    • Cpp API Documentation
    • Python API Documentation
    • Java API Documentation
    • Rust API Documentation
    • Go API Documentation
  • Home
  • Installation
  • C
  • C++
  • Python
  • Java
  • Go
  • Rust
  • Getting Started
  • Introduction
  • Vector Search
  • Clustering
  • Compression
  • Vector Database
  • Tuning Indexes
  • Integrations
  • Use-cases
  • User Guide
  • API Guide
  • Common Types
  • Array Types
  • Dense Arrays
  • Sparse Arrays
  • Memory Management
  • Multi-GPU
  • Resources
  • Clustering Guide
  • K-Means
  • Single-linkage
  • Spectral Clustering
  • Indexing Guide
  • All-neighbors
  • Brute-force
  • CAGRA
  • IVF-Flat
  • IVF-PQ
  • Multi-GPU
  • NN-Descent
  • ScaNN
  • Vamana
  • Preprocessing Guide
  • Binary Quantizer
  • PCA
  • Product Quantization
  • Scalar Quantizer
  • Spectral Embedding
  • Other APIs
  • Dynamic Batching
  • K-selection
  • Pairwise Distances
  • Benchmarking Guide
  • Methodologies
  • cuVS Bench Tool
  • Introduction
  • Installation
  • Usage
  • Datasets
  • Backends
  • Field Guide
  • Compatibility
  • Integration Patterns
  • JIT Compilation
  • UDF Usage
  • References
  • Developer Guide
  • Coding Guidelines
  • C Guidelines
  • C++ Guidelines
  • Java Guidelines
  • Python Guidelines
  • ABI Stability
  • Link-time Optimization
  • Contributing
  • C API Documentation
  • Cluster Kmeans
  • Core C API
  • Distance Distance
  • Distance Pairwise Distance
  • Neighbors Multi GPU Cagra
  • Neighbors Multi GPU Common
  • Neighbors Multi GPU IVF Flat
  • Neighbors Multi GPU IVF PQ
  • Neighbors All Neighbors
  • Neighbors Brute Force
  • Neighbors Cagra
  • Neighbors Common
  • Neighbors HNSW
  • Neighbors IVF Flat
  • Neighbors IVF PQ
  • Neighbors IVF SQ
  • Neighbors NN Descent
  • Neighbors Refine
  • Neighbors Tiered Index
  • Neighbors Vamana
  • Preprocessing Quantize Binary
  • Preprocessing PCA
  • Preprocessing Quantize PQ
  • Preprocessing Quantize Scalar
  • Cpp API Documentation
  • Cluster Agglomerative
  • Cluster Kmeans
  • Cluster Spectral
  • Common Types
  • Execution Resources
  • Dense Array Views
  • Dense View Factories
  • Owning Dense Arrays
  • Owning Array Factories
  • Layouts and Extents
  • Sparse Array Types
  • Copy, Serialization, and Utility APIs
  • Errors and Logging
  • Distance Distance
  • Distance Grammian
  • Neighbors All Neighbors
  • Neighbors Ball Cover
  • Neighbors Brute Force
  • Neighbors Cagra
  • Neighbors Common
  • Neighbors Dynamic Batching
  • Neighbors Epsilon Neighborhood
  • Neighbors HNSW
  • Neighbors Composite Index
  • Neighbors IVF Flat
  • Neighbors IVF PQ
  • Neighbors IVF SQ
  • Neighbors NN Descent
  • Neighbors Refine
  • Neighbors Scann
  • Neighbors Tiered Index
  • Neighbors Vamana
  • Preprocessing Quantize Binary
  • Preprocessing PCA
  • Preprocessing Quantize PQ
  • Preprocessing Quantize Scalar
  • Preprocessing Spectral Embedding
  • Selection Select K
  • Stats Silhouette Score
  • Stats Trustworthiness Score
  • Util Cutlass Utils
  • Util File Io
  • Python API Documentation
  • Cluster Kmeans
  • Common
  • Distance
  • Neighbors Multi GPU Cagra
  • Neighbors Multi GPU IVF Flat
  • Neighbors Multi GPU IVF PQ
  • Neighbors All Neighbors
  • Neighbors Brute Force
  • Neighbors Cagra
  • Neighbors Filters
  • Neighbors HNSW
  • Neighbors IVF Flat
  • Neighbors IVF PQ
  • Neighbors IVF SQ
  • Neighbors NN Descent
  • Neighbors
  • Neighbors Tiered Index
  • Neighbors Vamana
  • Preprocessing Quantize Binary
  • Preprocessing PCA
  • Preprocessing Quantize PQ
  • Preprocessing Quantize Scalar
  • Java API Documentation
  • Com Nvidia cuVS Cuvsdevicematrix
  • Com Nvidia cuVS Cuvshostmatrix
  • Com Nvidia cuVS Cuvsmatrix
  • Com Nvidia cuVS Spi Cuvsprovider
  • Com Nvidia cuVS Cuvsresources
  • Com Nvidia cuVS Cuvsresourcesinfo
  • Com Nvidia cuVS Spi Cuvsserviceprovider
  • Com Nvidia cuVS Delegatingscopedaccess
  • Com Nvidia cuVS Gpuinfo
  • Com Nvidia cuVS Gpuinfoprovider
  • Com Nvidia cuVS Libraryexception
  • Com Nvidia cuVS Rowview
  • Com Nvidia cuVS Synchronizedcuvsresources
  • Com Nvidia cuVS Bruteforceindex
  • Com Nvidia cuVS Bruteforceindexparams
  • Com Nvidia cuVS Bruteforcequery
  • Com Nvidia cuVS Cagracompressionparams
  • Com Nvidia cuVS Cagraindex
  • Com Nvidia cuVS Cagraindexparams
  • Com Nvidia cuVS Cagramergeparams
  • Com Nvidia cuVS Cagraquery
  • Com Nvidia cuVS Cagrasearchparams
  • Com Nvidia cuVS Cuvsaceparams
  • Com Nvidia cuVS Cuvsivfpqindexparams
  • Com Nvidia cuVS Cuvsivfpqparams
  • Com Nvidia cuVS Cuvsivfpqsearchparams
  • Com Nvidia cuVS Hnswaceparams
  • Com Nvidia cuVS Hnswindex
  • Com Nvidia cuVS Hnswindexparams
  • Com Nvidia cuVS Hnswquery
  • Com Nvidia cuVS Hnswsearchparams
  • Com Nvidia cuVS Searchresults
  • Com Nvidia cuVS Tieredindex
  • Com Nvidia cuVS Tieredindexparams
  • Com Nvidia cuVS Tieredindexquery
  • Rust API Documentation
  • cuVS Cluster
  • cuVS Cluster Kmeans
  • cuVS Cluster Kmeans Params
  • cuVS
  • cuVS Dlpack
  • cuVS Error
  • cuVS Resources
  • cuVS Distance
  • cuVS Distance Type
  • cuVS Brute Force
  • cuVS Cagra
  • cuVS Cagra Index
  • cuVS Cagra Index Params
  • cuVS Cagra Search Params
  • cuVS IVF Flat
  • cuVS IVF Flat Index
  • cuVS IVF Flat Index Params
  • cuVS IVF Flat Search Params
  • cuVS IVF PQ
  • cuVS IVF PQ Index
  • cuVS IVF PQ Index Params
  • cuVS IVF PQ Search Params
  • cuVS Vamana
  • cuVS Vamana Index
  • cuVS Vamana Index Params
  • Go API Documentation
  • cuVS
  • Brute Force
  • Cagra
  • IVF Flat
  • IVF PQ
GitHubCUDA-X
On this page
  • Cluster
  • Common
  • Distance
  • Multi-GPU Neighbors
  • Nearest Neighbors
  • Preprocessing
API Reference

C API Documentation

||View as Markdown|

These pages are generated from the documented public headers in the cuVS source tree.

Cluster

  • K-Means

Common

  • C API

Distance

  • Distance
  • Pairwise Distance

Multi-GPU Neighbors

  • Multi-GPU Cagra
  • Multi-GPU Common
  • Multi-GPU IVF Flat
  • Multi-GPU IVF PQ

Nearest Neighbors

  • All Neighbors
  • Brute Force
  • Cagra
  • Common
  • HNSW
  • IVF Flat
  • IVF PQ
  • IVF SQ
  • NN Descent
  • Refine
  • Tiered Index
  • Vamana

Preprocessing

  • Binary
  • PCA
  • PQ
  • Scalar
Previous

Contributing

Next

Cluster Kmeans

NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.