Faiss

- Main Page
- Namespaces
- Classes
- Files

- File List

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
/data/users/matthijs/github_faiss/faiss/IndexIVFFlat.h
1 /**
2 * Copyright (c) 2015-present, Facebook, Inc.
3 * All rights reserved.
4 *
5 * This source code is licensed under the BSD+Patents license found in the
6 * LICENSE file in the root directory of this source tree.
7 */
8
9 // -*- c++ -*-
10
11 #ifndef FAISS_INDEX_IVF_FLAT_H
12 #define FAISS_INDEX_IVF_FLAT_H
13
14 #include "IndexIVF.h"
15
16
17
18
19 namespace faiss {
20
21 /** Inverted file with stored vectors. Here the inverted file
22 * pre-selects the vectors to be searched, but they are not otherwise
23 * encoded, the code array just contains the raw float entries.
24 */
25 struct IndexIVFFlat: IndexIVF {
26
27 IndexIVFFlat (
28 Index * quantizer, size_t d, size_t nlist_,
29 MetricType = METRIC_L2);
30
31 /// same as add_with_ids, with precomputed coarse quantizer
32 virtual void add_core (idx_t n, const float * x, const long *xids,
33 const long *precomputed_idx);
34
35 /// implemented for all IndexIVF* classes
36 void add_with_ids(idx_t n, const float* x, const long* xids) override;
37
38 void search_preassigned (idx_t n, const float *x, idx_t k,
39 const idx_t *assign,
40 const float *centroid_dis,
41 float *distances, idx_t *labels,
42 bool store_pairs) const override;
43
44 void range_search(
45 idx_t n,
46 const float* x,
47 float radius,
48 RangeSearchResult* result) const override;
49
50 /** Update a subset of vectors.
51 *
52 * The index must have a direct_map
53 *
54 * @param nv nb of vectors to update
55 * @param idx vector indices to update, size nv
56 * @param v vectors of new values, size nv*d
57 */
58 void update_vectors (int nv, idx_t *idx, const float *v);
59
60 void reconstruct_from_offset (long list_no, long offset,
61 float* recons) const override;
62
63 IndexIVFFlat () {}
64 };
65
66
67 } // namespace faiss
68
69 #endif
faiss::IndexIVF
Definition: IndexIVF.h:166
faiss::Index::assign
void assign(idx_t n, const float *x, idx_t *labels, idx_t k=1)
Definition: Index.cpp:34
faiss::IndexIVFFlat::range_search
void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result) const override
Definition: IndexIVFFlat.cpp:231
faiss::IndexIVFFlat
Definition: IndexIVFFlat.h:25
faiss::Index::d
int d
vector dimension
Definition: Index.h:64
faiss::IndexIVFFlat::add_with_ids
void add_with_ids(idx_t n, const float *x, const long *xids) override
implemented for all IndexIVF* classes
Definition: IndexIVFFlat.cpp:40
faiss::Index::idx_t
long idx_t
all indices are this type
Definition: Index.h:62
faiss::IndexIVFFlat::reconstruct_from_offset
void reconstruct_from_offset(long list_no, long offset, float *recons) const override
Definition: IndexIVFFlat.cpp:319
faiss::IndexIVFFlat::update_vectors
void update_vectors(int nv, idx_t *idx, const float *v)
Definition: IndexIVFFlat.cpp:283
faiss::RangeSearchResult
Definition: AuxIndexStructures.h:29
faiss::Index
Definition: Index.h:60
faiss::Level1Quantizer::quantizer
Index * quantizer
quantizer that maps vectors to inverted lists
Definition: IndexIVF.h:33
faiss::IndexIVFFlat::search_preassigned
void search_preassigned(idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs) const override
Definition: IndexIVFFlat.cpp:212
faiss::MetricType
MetricType
Some algorithms support both an inner product version and a L2 search version.
Definition: Index.h:43
faiss::IndexIVFFlat::add_core
virtual void add_core(idx_t n, const float *x, const long *xids, const long *precomputed_idx)
same as add_with_ids, with precomputed coarse quantizer
Definition: IndexIVFFlat.cpp:45