#include <VectorTransform.h>
Public Member Functions | |
| IndexPreTransform (Index *index) | |
| ! whether pointers are deleted in destructor | |
| IndexPreTransform (VectorTransform *ltrans, Index *index) | |
| ltrans is the last transform before the index | |
| void | prepend_transform (VectorTransform *ltrans) |
| void | train (idx_t n, const float *x) override |
| void | add (idx_t n, const float *x) override |
| void | add_with_ids (idx_t n, const float *x, const long *xids) override |
| void | reset () override |
| removes all elements from the database. | |
| long | remove_ids (const IDSelector &sel) override |
| void | search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const override |
| void | reconstruct_n (idx_t i0, idx_t ni, float *recons) const override |
| const float * | apply_chain (idx_t n, const float *x) const |
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) |
| virtual void | reconstruct (idx_t key, float *recons) const |
| void | compute_residual (const float *x, float *residual, idx_t key) const |
| void | display () const |
Public Attributes | |
| std::vector< VectorTransform * > | chain |
| Index * | index |
| ! chain of tranforms | |
| bool | own_fields |
| ! the sub-index | |
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 that applies a LinearTransform transform on vectors before handing them over to a sub-index
Definition at line 239 of file VectorTransform.h.
|
overridevirtual |
Add n vectors of dimension d to the index.
Vectors are implicitly assigned labels ntotal .. ntotal + n - 1 This function slices the input vectors in chuncks smaller than blocksize_add and calls add_core.
| x | input matrix, size n * d |
Implements faiss::Index.
Definition at line 841 of file VectorTransform.cpp.
|
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::Index.
Definition at line 850 of file VectorTransform.cpp.
| const float * IndexPreTransform::apply_chain | ( | idx_t | n, |
| const float * | x | ||
| ) | const |
apply the transforms in the chain. The returned float * may be equal to x, otherwise it should be deallocated.
Definition at line 826 of file VectorTransform.cpp.
Reconstruct vectors i0 to i0 + ni - 1
this function may not be defined for some indexes
| recons | reconstucted vector (size ni * d) |
Reimplemented from faiss::Index.
Definition at line 885 of file VectorTransform.cpp.
|
overridevirtual |
removes IDs from the index. Not supported by all indexes.
Reimplemented from faiss::Index.
Definition at line 878 of file VectorTransform.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.
Definition at line 863 of file VectorTransform.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.
Definition at line 790 of file VectorTransform.cpp.
1.8.5