C++ API Documentation

• Cluster
  • Cluster
    • Params
      • params
      • 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
  • Pairwise Distances
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
    • pairwise_distance()
• Nearest Neighbors
  • Bruteforce
    • Index
      • index
    • Index build
      • build()
      • build()
      • build()
      • build()
    • Index search
      • search()
      • search()
      • search()
      • search()
    • Index serialize
      • serialize()
      • serialize()
      • serialize()
      • serialize()
      • deserialize()
      • deserialize()
      • deserialize()
      • deserialize()
  • CAGRA
    • Index build parameters
      • index_params
    • Index search parameters
      • search_algo
      • hash_mode
      • search_params
    • Index extend parameters
      • extend_params
    • Index extend memory buffers
    • Index
      • 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
      • 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()
  • Dynamic Batching
    • Index build parameters
      • index_params
    • Index search parameters
      • search_params
    • Index
      • index
    • Index search
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
      • search()
  • HNSW
    • Index search parameters
    • Index
    • Index extend parameters
    • Index extend
    • Index load
    • Index search
    • Index serialize
  • IVF-Flat
    • Index build parameters
      • kIndexGroupSize
      • index_params
    • Index search parameters
      • list_data
      • search_params
      • list_spec
    • Index
      • 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
      • index_params
    • Index search parameters
      • search_params
    • Index
      • 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
      • index_params
    • Index
      • 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()
      • ~index()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • build()
      • has_enough_device_memory()
  • Refinement
    • Index
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
      • refine()
  • Distributed ANN
    • Index build parameters
      • distribution_mode
      • index_params
    • Search parameters
      • replicated_search_mode
      • sharded_merge_mode
      • 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()
• 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()
      • params
      • 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()