hipVS C API documentation

2025-10-17

2 min read time

Applies to Linux

• Core Routines
  • Resources Handle
    • cuvsResources_t
    • cuvsResourcesCreate()
    • cuvsResourcesDestroy()
    • cuvsStreamSet()
    • cuvsStreamGet()
    • cuvsStreamSync()
  • Error Handling
    • cuvsError_t
      • CUVS_ERROR
      • CUVS_SUCCESS
    • cuvsGetLastErrorText()
    • cuvsLogLastErrorText()
    • cuvsSetLastErrorText()
• Nearest Neighbors
  • Bruteforce
    • Index
      • cuvsBruteForceIndex_t
      • cuvsBruteForceIndexCreate()
      • cuvsBruteForceIndexDestroy()
      • cuvsBruteForceIndex
    • Index build
      • cuvsBruteForceBuild()
    • Index search
      • cuvsBruteForceSearch()
    • Index serialize
      • cuvsBruteForceSerialize()
      • cuvsBruteForceDeserialize()
  • IVF-Flat
    • Index build parameters
      • cuvsIvfFlatIndexParamsCreate()
      • cuvsIvfFlatIndexParamsDestroy()
      • cuvsIvfFlatIndexParams
    • Index search parameters
      • cuvsIvfFlatSearchParamsCreate()
      • cuvsIvfFlatSearchParamsDestroy()
      • cuvsIvfFlatSearchParams
    • Index
      • cuvsIvfFlatIndex_t
      • cuvsIvfFlatIndexCreate()
      • cuvsIvfFlatIndexDestroy()
      • cuvsIvfFlatIndex
    • Index build
      • cuvsIvfFlatBuild()
    • Index search
      • cuvsIvfFlatSearch()
    • Index serialize
      • cuvsIvfFlatSerialize()
      • cuvsIvfFlatDeserialize()
  • IVF-PQ
    • Index build parameters
      • codebook_gen
      • cuvsIvfPqIndexParamsCreate()
      • cuvsIvfPqIndexParamsDestroy()
      • cuvsIvfPqIndexParams
    • Index search parameters
      • cuvsIvfPqSearchParamsCreate()
      • cuvsIvfPqSearchParamsDestroy()
      • cuvsIvfPqSearchParams
    • Index
      • cuvsIvfPqIndex_t
      • cuvsIvfPqIndexCreate()
      • cuvsIvfPqIndexDestroy()
      • cuvsIvfPqIndex
    • Index build
      • cuvsIvfPqBuild()
    • Index search
      • cuvsIvfPqSearch()
    • Index serialize
      • cuvsIvfPqSerialize()
      • cuvsIvfPqDeserialize()
  • CAGRA
    • Index build parameters
      • cuvsCagraGraphBuildAlgo
      • cuvsCagraIndexParamsCreate()
      • cuvsCagraIndexParamsDestroy()
      • cuvsCagraCompressionParamsCreate()
      • cuvsCagraCompressionParamsDestroy()
      • cuvsCagraCompressionParams
      • cuvsCagraIndexParams
    • Index search parameters
      • cuvsCagraSearchAlgo
      • cuvsCagraHashMode
      • cuvsCagraSearchParamsCreate()
      • cuvsCagraSearchParamsDestroy()
      • cuvsCagraSearchParams
    • Index
      • cuvsCagraIndex_t
      • cuvsCagraIndexCreate()
      • cuvsCagraIndexDestroy()
      • cuvsCagraIndexGetDims()
      • cuvsCagraIndex
    • Index build
      • cuvsCagraBuild()
    • Index search
      • cuvsCagraSearch()
    • Index serialize
      • cuvsCagraSerialize()
      • cuvsCagraSerializeToHnswlib()
      • cuvsCagraDeserialize()
  • HNSW
    • Index search parameters
      • cuvsHnswSearchParamsCreate()
      • cuvsHnswSearchParamsDestroy()
      • cuvsHnswSearchParams
    • Index
      • cuvsHnswIndex_t
      • cuvsHnswIndexCreate()
      • cuvsHnswIndexDestroy()
      • cuvsHnswIndex
    • Index extend parameters
      • cuvsHnswExtendParamsCreate()
      • cuvsHnswExtendParamsDestroy()
      • cuvsHnswExtendParams
    • Index extend
      • cuvsHnswExtend()
    • Index load
      • cuvsHnswFromCagra()
    • Index search
      • cuvsHnswSearch()
    • Index serialize
      • cuvsHnswSerialize()
      • cuvsHnswDeserialize()
• Pairwise Distance
  • Pairwise Distance
    • cuvsPairwiseDistance()