hipVS C++ API documentation#
2025-10-17
5 min read time
Applies to Linux
- Cluster
- Distance
- Nearest Neighbors
- Bruteforce
- CAGRA
- Index build parameters
- Index search parameters
- Index extend parameters
- Index
- Index build
- Index search
- Index extend
- Index serialize
nn_descent_paramsiterative_search_paramsindex_params_typesearch_params_typeindex_typevalue_typedataset_index_typebuild_paramssearch_paramsrefinement_rateintermediate_graph_degreegraph_degreecompressiongraph_build_paramsguarantee_connectivityattach_dataset_on_buildmax_queriesitopk_sizemax_iterationsalgoteam_sizesearch_widthmin_iterationsthread_block_sizehashmap_modehashmap_min_bitlenhashmap_max_fill_ratenum_random_samplingsrand_xor_maskpersistentpersistent_lifetimepersistent_device_usagefiltering_ratemax_chunk_sizeoutput_index_paramsstrategyivf_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
- Filtering
- HNSW
- IVF-Flat
- IVF-PQ
- Index build parameters
- Index search parameters
- Index
- Index build
- Index extend
- Index search
- Index serialize
- 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
- Index
- Index build
graph_degreeintermediate_graph_degreemax_iterationstermination_thresholdreturn_distancesn_clustersindex_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
- Distributed ANN
- Vamana
- Index build parameters
- Index
- Index build
graph_degreevisited_sizevamana_itersalphamax_fractionbatch_basequeue_sizereverse_batchsizemetric()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
- 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::paramscuvs::preprocessing::quantize::scalar::quantizer
- Scalar
- Quantize
- Selection
- Stats