#include <IndexPQ.h>
Public Member Functions | |
| MultiIndexQuantizer (int d, size_t M, size_t nbits) | |
| number of bit per subvector index More... | |
| void | train (idx_t n, const float *x) override |
| void | search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const override |
| void | add (idx_t n, const float *x) override |
| add and reset will crash at runtime | |
| void | reset () override |
| removes all elements from the database. | |
| void | reconstruct (idx_t key, float *recons) const override |
Public Member Functions inherited from faiss::Index | |
| Index (idx_t d=0, MetricType metric=METRIC_L2) | |
| virtual void | add_with_ids (idx_t n, const float *x, const long *xids) |
| 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) |
| virtual long | remove_ids (const IDSelector &sel) |
| virtual void | reconstruct_n (idx_t i0, idx_t ni, float *recons) const |
| virtual void | search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons) const |
| void | compute_residual (const float *x, float *residual, idx_t key) const |
| void | display () const |
Public Attributes | |
| ProductQuantizer | pq |
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 | |
Quantizer where centroids are virtual: they are the Cartesian product of sub-centroids.
| faiss::MultiIndexQuantizer::MultiIndexQuantizer | ( | int | d, |
| size_t | M, | ||
| size_t | nbits | ||
| ) |
number of bit per subvector index
| d | dimension of the input vectors |
| M | number of subquantizers |
Definition at line 826 of file IndexPQ.cpp.
|
overridevirtual |
Reconstruct a stored vector (or an approximation if lossy coding)
this function may not be defined for some indexes
| key | id of the vector to reconstruct |
| recons | reconstucted vector (size d) |
Reimplemented from faiss::Index.
Definition at line 905 of file IndexPQ.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 |
Implements faiss::Index.
Reimplemented in faiss::MultiIndexQuantizer2.
Definition at line 849 of file IndexPQ.cpp.
|
overridevirtual |
Perform training on a representative set of vectors
| n | nb of training vectors |
| x | training vecors, size n * d |
Reimplemented from faiss::Index.
Reimplemented in faiss::MultiIndexQuantizer2.
Definition at line 837 of file IndexPQ.cpp.
1.8.5