hipVS C++ API documentation

2025-10-17

5 min read time

Applies to Linux

• Cluster
  • Cluster
    • Params
      • cuvs::cluster::kmeans::params
      • cuvs::cluster::kmeans::balanced_params
    • K-means
      • fit()
      • fit()
      • fit()
      • fit()
      • fit()
      • fit()
      • fit()
      • predict()
      • predict()
      • predict()
      • predict()
      • predict()
      • fit_predict()
      • fit_predict()
      • fit_predict()
      • fit_predict()
      • fit_predict()
      • fit_predict()
      • transform()
      • transform()
    • K-means Helpers
  • Cluster
    • Params
      • Linkage
    • Single-linkage
      • single_linkage()
• Distance
  • Distance Types
    • cuvsDistanceType
      • L2Expanded
      • L2SqrtExpanded
      • CosineExpanded
      • L1
      • L2Unexpanded
      • L2SqrtUnexpanded
      • InnerProduct
      • Linf
      • Canberra
      • LpUnexpanded
      • CorrelationExpanded
      • JaccardExpanded
      • HellingerExpanded
      • Haversine
      • BrayCurtis
      • JensenShannon
      • HammingUnexpanded
      • KLDivergence
      • RusselRaoExpanded
      • DiceExpanded
      • BitwiseHamming
      • Precomputed
  • Pairwise Distances
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
• Nearest Neighbors
  • Bruteforce
    • Index
      • cuvs::neighbors::brute_force::index
    • Index build
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
    • Index search
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
    • Index serialize
      • serialize()
      • serialize()
      • serialize()
      • serialize()
      • deserialize()
      • deserialize()
      • deserialize()
      • deserialize()
  • CAGRA
    • Index build parameters
      • cuvs::neighbors::cagra::index_params
    • Index search parameters
      • search_algo
      • hash_mode
      • cuvs::neighbors::cagra::search_params
    • Index extend parameters
      • cuvs::neighbors::cagra::extend_params
    • Index
      • cuvs::neighbors::cagra::index
    • Index build
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
    • Index search
      • search()
      • search()
      • search()
      • search()
    • Index extend
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
    • Index serialize
      • nn_descent_params
      • iterative_search_params
      • index_params_type
      • search_params_type
      • index_type
      • value_type
      • dataset_index_type
      • build_params
      • search_params
      • refinement_rate
      • intermediate_graph_degree
      • graph_degree
      • compression
      • graph_build_params
      • guarantee_connectivity
      • attach_dataset_on_build
      • max_queries
      • itopk_size
      • max_iterations
      • algo
      • team_size
      • search_width
      • min_iterations
      • thread_block_size
      • hashmap_mode
      • hashmap_min_bitlen
      • hashmap_max_fill_rate
      • num_random_samplings
      • rand_xor_mask
      • persistent
      • persistent_lifetime
      • persistent_device_usage
      • filtering_rate
      • max_chunk_size
      • output_index_params
      • strategy
      • ivf_pq_params()
      • ivf_pq_params()
      • merge_params()
      • merge_params()
      • metric()
      • size()
      • dim()
      • graph_degree()
      • dataset()
      • data()
      • graph()
      • index()
      • index()
      • operator=()
      • operator=()
      • ~index()
      • index()
      • index()
      • update_dataset()
      • update_dataset()
      • update_dataset()
      • update_dataset()
      • update_dataset()
      • update_graph()
      • update_graph()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize_to_hnswlib()
      • serialize_to_hnswlib()
      • serialize_to_hnswlib()
      • serialize_to_hnswlib()
      • serialize_to_hnswlib()
      • serialize_to_hnswlib()
      • cuvs::neighbors::cagra::graph_build_params::ivf_pq_params
  • Dynamic Batching
    • Index build parameters
      • cuvs::neighbors::dynamic_batching::index_params
    • Index search parameters
      • cuvs::neighbors::dynamic_batching::search_params
    • Index
      • cuvs::neighbors::dynamic_batching::index
    • Index search
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
  • Filtering
    • FilterType
      • None
      • Bitmap
      • Bitset
    • cuvs::neighbors::filtering::base_filter
    • cuvs::neighbors::filtering::none_sample_filter
    • cuvs::neighbors::filtering::ivf_to_sample_filter
    • cuvs::neighbors::filtering::bitmap_filter
    • cuvs::neighbors::filtering::bitset_filter
  • HNSW
    • Index search parameters
      • cuvs::neighbors::hnsw::search_params
    • Index
      • cuvs::neighbors::hnsw::index
    • Index extend parameters
      • cuvs::neighbors::hnsw::extend_params
    • Index extend
      • extend()
      • extend()
      • extend()
    • Index load
      • from_cagra()
      • from_cagra()
      • from_cagra()
    • Index search
      • search()
      • search()
      • search()
    • Index serialize
      • serialize()
      • serialize()
      • serialize()
      • deserialize()
      • deserialize()
      • deserialize()
  • IVF-Flat
    • Index build parameters
      • kIndexGroupSize
      • cuvs::neighbors::ivf_flat::index_params
    • Index search parameters
      • list_data
      • cuvs::neighbors::ivf_flat::search_params
      • cuvs::neighbors::ivf_flat::list_spec
    • Index
      • cuvs::neighbors::ivf_flat::index
    • Index build
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
    • Index extend
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
    • Index search
      • search()
      • search()
      • search()
    • Index serialize
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
      • serialize()
      • deserialize()
  • IVF-PQ
    • Index build parameters
      • codebook_gen
      • cuvs::neighbors::ivf_pq::index_params
    • Index search parameters
      • cuvs::neighbors::ivf_pq::search_params
    • Index
      • cuvs::neighbors::ivf_pq::index
    • Index build
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
    • Index extend
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
    • Index search
      • search()
      • search()
      • search()
      • search()
    • Index serialize
      • serialize()
      • serialize()
      • deserialize()
      • deserialize()
    • Helper Methods
      • unpack()
      • unpack_contiguous()
      • pack()
      • pack_contiguous()
      • pack_list_data()
      • pack_contiguous_list_data()
      • unpack_list_data()
      • unpack_list_data()
      • unpack_contiguous_list_data()
      • reconstruct_list_data()
      • reconstruct_list_data()
      • reconstruct_list_data()
      • reconstruct_list_data()
      • reconstruct_list_data()
      • reconstruct_list_data()
      • reconstruct_list_data()
      • reconstruct_list_data()
      • extend_list_with_codes()
      • extend_list()
      • extend_list()
      • extend_list()
      • erase_list()
      • reset_index()
      • make_rotation_matrix()
      • set_centers()
      • extract_centers()
      • recompute_internal_state()
  • NN-Descent
    • Index build parameters
      • cuvs::neighbors::nn_descent::index_params
    • Index
      • cuvs::neighbors::nn_descent::index
    • Index build
      • graph_degree
      • intermediate_graph_degree
      • max_iterations
      • termination_threshold
      • return_distances
      • n_clusters
      • index_params()
      • index()
      • index()
      • metric()
      • size()
      • graph_degree()
      • graph()
      • distances()
      • index()
      • index()
      • operator=()
      • operator=()
      • ~index()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • has_enough_device_memory()
  • Refinement
    • Index
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
  • Distributed ANN
    • Index build parameters
      • distribution_mode
      • cuvs::neighbors::mg::index_params
    • Search parameters
      • replicated_search_mode
      • sharded_merge_mode
      • cuvs::neighbors::mg::search_params
    • Index build
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
    • Index extend
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
      • extend()
    • Index search
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
    • Index serialize
      • serialize()
      • serialize()
      • serialize()
      • serialize()
      • serialize()
      • serialize()
      • serialize()
      • serialize()
      • serialize()
      • serialize()
      • serialize()
    • Index deserialize
      • deserialize_flat()
      • deserialize_pq()
      • deserialize_cagra()
    • Distribute pre-built local index
      • distribute_flat()
      • distribute_pq()
      • distribute_cagra()
  • Vamana
    • Index build parameters
      • cuvs::neighbors::vamana::index_params
    • Index
      • cuvs::neighbors::vamana::index
    • Index build
      • graph_degree
      • visited_size
      • vamana_iters
      • alpha
      • max_fraction
      • batch_base
      • queue_size
      • reverse_batchsize
      • metric()
      • size()
      • dim()
      • graph_degree()
      • data()
      • graph()
      • medoid()
      • index()
      • index()
      • operator=()
      • operator=()
      • ~index()
      • index()
      • index()
      • update_graph()
      • update_graph()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
    • Index serialize
      • serialize()
      • serialize()
      • serialize()
• Preprocessing
  • Quantize
    • Scalar
      • train()
      • train()
      • transform()
      • transform()
      • inverse_transform()
      • inverse_transform()
      • train()
      • train()
      • transform()
      • transform()
      • inverse_transform()
      • inverse_transform()
      • train()
      • train()
      • transform()
      • transform()
      • inverse_transform()
      • inverse_transform()
      • cuvs::preprocessing::quantize::scalar::params
      • cuvs::preprocessing::quantize::scalar::quantizer
• Selection
  • Select-K
    • select_k()
    • select_k()
    • select_k()
    • select_k()
• Stats
  • Silhouette Score
    • silhouette_score()
    • silhouette_score_batched()
    • silhouette_score()
    • silhouette_score_batched()
  • Trustworthiness Score
    • trustworthiness_score()