#include <IndexIVFPQ.h>
Public Member Functions | |
| IndexIVFPQR (Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits_per_idx, size_t M_refine, size_t nbits_per_idx_refine) | |
| void | reset () override |
| removes all elements from the database. | |
| long | remove_ids (const IDSelector &sel) override |
| void | train_residual (idx_t n, const float *x) override |
| trains the two product quantizers | |
| void | add_with_ids (idx_t n, const float *x, const long *xids) override |
| void | add_core (idx_t n, const float *x, const long *xids, const long *precomputed_idx=nullptr) |
| same as add_with_ids, but optionally use the precomputed list ids | |
| void | reconstruct_n (idx_t i0, idx_t ni, float *recons) const override |
| void | search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const override |
| void | merge_from_residuals (IndexIVF &other) override |
| used to implement merging | |
Public Member Functions inherited from faiss::IndexIVFPQ | |
| IndexIVFPQ (Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits_per_idx) | |
| void | add_core_o (idx_t n, const float *x, const long *xids, float *residuals_2, const long *precomputed_idx=nullptr) |
| void | train_residual_o (idx_t n, const float *x, float *residuals_2) |
| same as train_residual, also output 2nd level residuals | |
| void | reconstruct (idx_t key, float *recons) const override |
| size_t | find_duplicates (idx_t *ids, size_t *lims) const |
| void | encode (long key, const float *x, uint8_t *code) const |
| void | encode_multiple (size_t n, long *keys, const float *x, uint8_t *codes, bool compute_keys=false) const |
| void | decode_multiple (size_t n, const long *keys, const uint8_t *xcodes, float *x) const |
| inverse of encode_multiple | |
| virtual void | search_knn_with_key (size_t nx, const float *qx, const long *keys, const float *coarse_dis, float_maxheap_array_t *res, bool store_pairs=false) const |
| void | precompute_table () |
| build precomputed table More... | |
| void | copy_subset_to (IndexIVFPQ &other, int subset_type, long a1, long a2) const |
Public Member Functions inherited from faiss::IndexIVF | |
| IndexIVF (Index *quantizer, size_t d, size_t nlist, MetricType metric=METRIC_INNER_PRODUCT) | |
| void | train (idx_t n, const float *x) override |
| Trains the quantizer and calls train_residual to train sub-quantizers. | |
| void | add (idx_t n, const float *x) override |
| Quantizes x and calls add_with_key. | |
| virtual void | merge_from (IndexIVF &other, idx_t add_id) |
| size_t | get_list_size (size_t list_no) const |
| void | make_direct_map (bool new_maintain_direct_map=true) |
| double | imbalance_factor () const |
| 1= perfectly balanced, >1: imbalanced | |
| void | print_stats () const |
| display some stats about the inverted lists | |
Public Member Functions inherited from faiss::Index | |
| Index (idx_t d=0, MetricType metric=METRIC_INNER_PRODUCT) | |
| virtual void | range_search (idx_t n, const float *x, float radius, RangeSearchResult *result) const |
| void | assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) |
| void | compute_residual (const float *x, float *residual, idx_t key) const |
| void | display () const |
Public Attributes | |
| ProductQuantizer | refine_pq |
| 3rd level quantizer | |
| std::vector< uint8_t > | refine_codes |
| corresponding codes | |
| float | k_factor |
| factor between k requested in search and the k requested from the IVFPQ | |
Public Attributes inherited from faiss::IndexIVFPQ | |
| bool | by_residual |
| Encode residual or plain vector? | |
| int | use_precomputed_table |
| if by_residual, build precompute tables | |
| size_t | code_size |
| code size per vector in bytes | |
| ProductQuantizer | pq |
| produces the codes | |
| bool | do_polysemous_training |
| reorder PQ centroids after training? | |
| PolysemousTraining * | polysemous_training |
| if NULL, use default | |
| size_t | scan_table_threshold |
| use table computation or on-the-fly? | |
| size_t | max_codes |
| max nb of codes to visit to do a query | |
| int | polysemous_ht |
| Hamming thresh for polysemous filtering. | |
|
std::vector< std::vector < uint8_t > > | codes |
| std::vector< float > | precomputed_table |
Public Attributes inherited from faiss::IndexIVF | |
| size_t | nlist |
| number of possible key values | |
| size_t | nprobe |
| number of probes at query time | |
| Index * | quantizer |
| quantizer that maps vectors to inverted lists | |
| bool | quantizer_trains_alone |
| just pass over the trainset to quantizer | |
| bool | own_fields |
| whether object owns the quantizer | |
| ClusteringParameters | cp |
| to override default clustering params | |
| std::vector< std::vector< long > > | ids |
| Inverted lists for indexes. | |
| bool | maintain_direct_map |
| map for direct access to the elements. Enables reconstruct(). | |
| std::vector< long > | direct_map |
Public Attributes inherited from faiss::Index | |
| int | d |
| vector dimension | |
| idx_t | ntotal |
| total nb of indexed vectors | |
| bool | verbose |
| verbosity level | |
| bool | is_trained |
| set if the Index does not require training, or if training is done already | |
| MetricType | metric_type |
| type of metric this index uses for search | |
Additional Inherited Members | |
Public Types inherited from faiss::Index | |
| typedef long | idx_t |
| all indices are this type | |
Index with an additional level of PQ refinement
Definition at line 198 of file IndexIVFPQ.h.
|
overridevirtual |
Same as add, but stores xids instead of sequential ids.
The default implementation fails with an assertion, as it is not supported by all indexes.
| xids | if non-null, ids to store for the vectors (size n) |
Reimplemented from faiss::IndexIVFPQ.
Definition at line 1233 of file IndexIVFPQ.cpp.
Reconstruct a subset of the indexed vectors
| i0 | first vector to reconstruct |
| ni | nb of vectors to reconstruct |
| recons | output array of reconstructed vectors, size ni * d |
Reimplemented from faiss::IndexIVFPQ.
Definition at line 1345 of file IndexIVFPQ.cpp.
|
overridevirtual |
removes IDs from the index. Not supported by all indexes
Reimplemented from faiss::IndexIVFPQ.
Definition at line 1371 of file IndexIVFPQ.cpp.
|
overridevirtual |
query n vectors of dimension d to the index.
return at most k vectors. If there are not enough results for a query, the result array is padded with -1s.
| x | input vectors to search, size n * d |
| labels | output labels of the NNs, size n*k |
| distances | output pairwise distances, size n*k |
Reimplemented from faiss::IndexIVFPQ.
Definition at line 1256 of file IndexIVFPQ.cpp.
1.8.5