faiss 0.2.0 → 0.2.4

data/vendor/faiss/faiss/Index2Layer.cpp

@@ -9,11 +9,12 @@
 
 #include <faiss/Index2Layer.h>
 
+#include <faiss/impl/platform_macros.h>
+#include <stdint.h>
+#include <cassert>
 #include <cinttypes>
 #include <cmath>
 #include <cstdio>
-#include <cassert>
-#include <stdint.h>
 
 #ifdef __SSE3__
 #include <immintrin.h>
@@ -23,39 +24,27 @@
 
 #include <faiss/IndexIVFPQ.h>
 
-#include <faiss/impl/FaissAssert.h>
-#include <faiss/utils/utils.h>
-#include <faiss/impl/AuxIndexStructures.h>
 #include <faiss/IndexFlat.h>
+#include <faiss/impl/AuxIndexStructures.h>
+#include <faiss/impl/FaissAssert.h>
 #include <faiss/utils/distances.h>
-
-
-/*
-#include <faiss/utils/Heap.h>
-
-#include <faiss/Clustering.h>
-
-#include <faiss/utils/hamming.h>
-
-
-*/
-
+#include <faiss/utils/utils.h>
 
 namespace faiss {
 
-
 /*************************************
  * Index2Layer implementation
  *************************************/
 
-
-Index2Layer::Index2Layer (Index * quantizer, size_t nlist,
-                          int M, int nbit,
-                          MetricType metric):
-    Index (quantizer->d, metric),
-    q1 (quantizer, nlist),
-    pq (quantizer->d, M, nbit)
-{
+Index2Layer::Index2Layer(
+        Index* quantizer,
+        size_t nlist,
+        int M,
+        int nbit,
+        MetricType metric)
+        : IndexFlatCodes(0, quantizer->d, metric),
+          q1(quantizer, nlist),
+          pq(quantizer->d, M, nbit) {
     is_trained = false;
     for (int nbyte = 0; nbyte < 7; nbyte++) {
         if ((1L << (8 * nbyte)) >= nlist) {
@@ -67,177 +56,94 @@ Index2Layer::Index2Layer (Index * quantizer, size_t nlist,
     code_size = code_size_1 + code_size_2;
 }
 
-Index2Layer::Index2Layer ()
-{
+Index2Layer::Index2Layer() {
     code_size = code_size_1 = code_size_2 = 0;
 }
 
-Index2Layer::~Index2Layer ()
-{}
+Index2Layer::~Index2Layer() {}
 
-void Index2Layer::train(idx_t n, const float* x)
-{
+void Index2Layer::train(idx_t n, const float* x) {
     if (verbose) {
-        printf ("training level-1 quantizer %" PRId64 " vectors in %dD\n",
-                n, d);
+        printf("training level-1 quantizer %" PRId64 " vectors in %dD\n", n, d);
     }
 
-    q1.train_q1 (n, x, verbose, metric_type);
+    q1.train_q1(n, x, verbose, metric_type);
 
     if (verbose) {
         printf("computing residuals\n");
     }
 
-    const float * x_in = x;
+    const float* x_in = x;
 
-    x = fvecs_maybe_subsample (
-         d, (size_t*)&n, pq.cp.max_points_per_centroid * pq.ksub,
-         x, verbose, pq.cp.seed);
+    x = fvecs_maybe_subsample(
+            d,
+            (size_t*)&n,
+            pq.cp.max_points_per_centroid * pq.ksub,
+            x,
+            verbose,
+            pq.cp.seed);
 
-    ScopeDeleter<float> del_x (x_in == x ? nullptr : x);
+    ScopeDeleter<float> del_x(x_in == x ? nullptr : x);
 
     std::vector<idx_t> assign(n); // assignement to coarse centroids
-    q1.quantizer->assign (n, x, assign.data());
+    q1.quantizer->assign(n, x, assign.data());
     std::vector<float> residuals(n * d);
     for (idx_t i = 0; i < n; i++) {
-        q1.quantizer->compute_residual (
-           x + i * d, residuals.data() + i * d, assign[i]);
+        q1.quantizer->compute_residual(
+                x + i * d, residuals.data() + i * d, assign[i]);
     }
 
     if (verbose)
-        printf ("training %zdx%zd product quantizer on %" PRId64 " vectors in %dD\n",
-                pq.M, pq.ksub, n, d);
+        printf("training %zdx%zd product quantizer on %" PRId64
+               " vectors in %dD\n",
+               pq.M,
+               pq.ksub,
+               n,
+               d);
     pq.verbose = verbose;
-    pq.train (n, residuals.data());
+    pq.train(n, residuals.data());
 
     is_trained = true;
 }
 
-void Index2Layer::add(idx_t n, const float* x)
-{
-    idx_t bs = 32768;
-    if (n > bs) {
-        for (idx_t i0 = 0; i0 < n; i0 += bs) {
-            idx_t i1 = std::min(i0 + bs, n);
-            if (verbose) {
-                printf("Index2Layer::add: adding %" PRId64 ":%" PRId64 " / %" PRId64 "\n",
-                       i0, i1, n);
-            }
-            add (i1 - i0, x + i0 * d);
-        }
-        return;
-    }
-
-    std::vector<idx_t> codes1 (n);
-    q1.quantizer->assign (n, x, codes1.data());
-    std::vector<float> residuals(n * d);
-    for (idx_t i = 0; i < n; i++) {
-        q1.quantizer->compute_residual (
-            x + i * d, residuals.data() + i * d, codes1[i]);
-    }
-    std::vector<uint8_t> codes2 (n * code_size_2);
-
-    pq.compute_codes (residuals.data(), codes2.data(), n);
-
-    codes.resize ((ntotal + n) * code_size);
-    uint8_t *wp = &codes[ntotal * code_size];
-
-    {
-        int i = 0x11223344;
-        const char *ip = (char*)&i;
-        FAISS_THROW_IF_NOT_MSG (ip[0] == 0x44,
-                                "works only on a little-endian CPU");
-    }
-
-    // copy to output table
-    for (idx_t i = 0; i < n; i++) {
-        memcpy (wp, &codes1[i], code_size_1);
-        wp += code_size_1;
-        memcpy (wp, &codes2[i * code_size_2], code_size_2);
-        wp += code_size_2;
-    }
-
-    ntotal += n;
-
-}
-
 void Index2Layer::search(
-    idx_t /*n*/,
-    const float* /*x*/,
-    idx_t /*k*/,
-    float* /*distances*/,
-    idx_t* /*labels*/) const {
-  FAISS_THROW_MSG("not implemented");
+        idx_t /*n*/,
+        const float* /*x*/,
+        idx_t /*k*/,
+        float* /*distances*/,
+        idx_t* /*labels*/) const {
+    FAISS_THROW_MSG("not implemented");
 }
 
+void Index2Layer::transfer_to_IVFPQ(IndexIVFPQ& other) const {
+    FAISS_THROW_IF_NOT(other.nlist == q1.nlist);
+    FAISS_THROW_IF_NOT(other.code_size == code_size_2);
+    FAISS_THROW_IF_NOT(other.ntotal == 0);
 
-void Index2Layer::reconstruct_n(idx_t i0, idx_t ni, float* recons) const
-{
-    std::vector<float> recons1(d);
-    FAISS_THROW_IF_NOT (i0 >= 0 && i0 + ni <= ntotal);
-    const uint8_t *rp = &codes[i0 * code_size];
-
-    for (idx_t i = 0; i < ni; i++) {
-        idx_t key = 0;
-        memcpy (&key, rp, code_size_1);
-        q1.quantizer->reconstruct (key, recons1.data());
-        rp += code_size_1;
-        pq.decode (rp, recons);
-        for (idx_t j = 0; j < d; j++) {
-            recons[j] += recons1[j];
-        }
-        rp += code_size_2;
-        recons += d;
-    }
-}
-
-void Index2Layer::transfer_to_IVFPQ (IndexIVFPQ & other) const
-{
-    FAISS_THROW_IF_NOT (other.nlist == q1.nlist);
-    FAISS_THROW_IF_NOT (other.code_size == code_size_2);
-    FAISS_THROW_IF_NOT (other.ntotal == 0);
-
-    const uint8_t *rp = codes.data();
+    const uint8_t* rp = codes.data();
 
     for (idx_t i = 0; i < ntotal; i++) {
         idx_t key = 0;
-        memcpy (&key, rp, code_size_1);
+        memcpy(&key, rp, code_size_1);
         rp += code_size_1;
-        other.invlists->add_entry (key, i, rp);
+        other.invlists->add_entry(key, i, rp);
         rp += code_size_2;
     }
 
     other.ntotal = ntotal;
-
-}
-
-
-
-void Index2Layer::reconstruct(idx_t key, float* recons) const
-{
-    reconstruct_n (key, 1, recons);
 }
 
-void Index2Layer::reset()
-{
-    ntotal = 0;
-    codes.clear ();
-}
-
-
 namespace {
 
-
 struct Distance2Level : DistanceComputer {
     size_t d;
     const Index2Layer& storage;
     std::vector<float> buf;
-    const float *q;
+    const float* q;
 
     const float *pq_l1_tab, *pq_l2_tab;
 
-    explicit Distance2Level(const Index2Layer& storage)
-        : storage(storage) {
+    explicit Distance2Level(const Index2Layer& storage) : storage(storage) {
         d = storage.d;
         FAISS_ASSERT(storage.pq.dsub == 4);
         pq_l2_tab = storage.pq.centroids.data();
@@ -250,67 +156,64 @@ struct Distance2Level : DistanceComputer {
         return fvec_L2sqr(buf.data() + d, buf.data(), d);
     }
 
-    void set_query(const float *x) override {
+    void set_query(const float* x) override {
         q = x;
     }
 };
 
 // well optimized for xNN+PQNN
 struct DistanceXPQ4 : Distance2Level {
-
     int M, k;
 
     explicit DistanceXPQ4(const Index2Layer& storage)
-        : Distance2Level (storage) {
-        const IndexFlat *quantizer =
-            dynamic_cast<IndexFlat*> (storage.q1.quantizer);
+            : Distance2Level(storage) {
+        const IndexFlat* quantizer =
+                dynamic_cast<IndexFlat*>(storage.q1.quantizer);
 
         FAISS_ASSERT(quantizer);
         M = storage.pq.M;
-        pq_l1_tab = quantizer->xb.data();
+        pq_l1_tab = quantizer->get_xb();
     }
 
-    float operator () (idx_t i) override {
+    float operator()(idx_t i) override {
 #ifdef __SSE3__
-        const uint8_t *code = storage.codes.data() + i * storage.code_size;
+        const uint8_t* code = storage.codes.data() + i * storage.code_size;
         long key = 0;
-        memcpy (&key, code, storage.code_size_1);
+        memcpy(&key, code, storage.code_size_1);
         code += storage.code_size_1;
 
         // walking pointers
-        const float *qa = q;
-        const __m128 *l1_t = (const __m128 *)(pq_l1_tab + d * key);
-        const __m128 *pq_l2_t = (const __m128 *)pq_l2_tab;
+        const float* qa = q;
+        const __m128* l1_t = (const __m128*)(pq_l1_tab + d * key);
+        const __m128* pq_l2_t = (const __m128*)pq_l2_tab;
         __m128 accu = _mm_setzero_ps();
 
         for (int m = 0; m < M; m++) {
             __m128 qi = _mm_loadu_ps(qa);
-            __m128 recons = l1_t[m] + pq_l2_t[*code++];
-            __m128 diff = qi - recons;
-            accu += diff * diff;
+            __m128 recons = _mm_add_ps(l1_t[m], pq_l2_t[*code++]);
+            __m128 diff = _mm_sub_ps(qi, recons);
+            accu = _mm_add_ps(accu, _mm_mul_ps(diff, diff));
             pq_l2_t += 256;
             qa += 4;
         }
 
-        accu = _mm_hadd_ps (accu, accu);
-        accu = _mm_hadd_ps (accu, accu);
-        return  _mm_cvtss_f32 (accu);
+        accu = _mm_hadd_ps(accu, accu);
+        accu = _mm_hadd_ps(accu, accu);
+        return _mm_cvtss_f32(accu);
 #else
         FAISS_THROW_MSG("not implemented for non-x64 platforms");
 #endif
     }
-
 };
 
 // well optimized for 2xNN+PQNN
 struct Distance2xXPQ4 : Distance2Level {
-
     int M_2, mi_nbits;
 
     explicit Distance2xXPQ4(const Index2Layer& storage)
-        : Distance2Level(storage) {
-        const MultiIndexQuantizer *mi =
-            dynamic_cast<MultiIndexQuantizer*> (storage.q1.quantizer);
+            : Distance2Level(storage) {
+        const MultiIndexQuantizer* mi =
+                dynamic_cast<MultiIndexQuantizer*>(storage.q1.quantizer);
 
         FAISS_ASSERT(mi);
         FAISS_ASSERT(storage.pq.M % 2 == 0);
@@ -319,59 +222,55 @@ struct Distance2xXPQ4 : Distance2Level {
         pq_l1_tab = mi->pq.centroids.data();
     }
 
-    float operator () (idx_t i) override {
-        const uint8_t *code = storage.codes.data() + i * storage.code_size;
+    float operator()(idx_t i) override {
+        const uint8_t* code = storage.codes.data() + i * storage.code_size;
         long key01 = 0;
-        memcpy (&key01, code, storage.code_size_1);
+        memcpy(&key01, code, storage.code_size_1);
         code += storage.code_size_1;
 #ifdef __SSE3__
 
         // walking pointers
-        const float *qa = q;
-        const __m128 *pq_l1_t = (const __m128 *)pq_l1_tab;
-        const __m128 *pq_l2_t = (const __m128 *)pq_l2_tab;
+        const float* qa = q;
+        const __m128* pq_l1_t = (const __m128*)pq_l1_tab;
+        const __m128* pq_l2_t = (const __m128*)pq_l2_tab;
         __m128 accu = _mm_setzero_ps();
 
         for (int mi_m = 0; mi_m < 2; mi_m++) {
             long l1_idx = key01 & ((1L << mi_nbits) - 1);
-            const __m128 * pq_l1 = pq_l1_t + M_2 * l1_idx;
+            const __m128* pq_l1 = pq_l1_t + M_2 * l1_idx;
 
             for (int m = 0; m < M_2; m++) {
                 __m128 qi = _mm_loadu_ps(qa);
-                __m128 recons = pq_l1[m] + pq_l2_t[*code++];
-                __m128 diff = qi - recons;
-                accu += diff * diff;
+                __m128 recons = _mm_add_ps(pq_l1[m], pq_l2_t[*code++]);
+                __m128 diff = _mm_sub_ps(qi, recons);
+                accu = _mm_add_ps(accu, _mm_mul_ps(diff, diff));
                 pq_l2_t += 256;
                 qa += 4;
             }
             pq_l1_t += M_2 << mi_nbits;
             key01 >>= mi_nbits;
         }
-        accu = _mm_hadd_ps (accu, accu);
-        accu = _mm_hadd_ps (accu, accu);
-        return  _mm_cvtss_f32 (accu);
+        accu = _mm_hadd_ps(accu, accu);
+        accu = _mm_hadd_ps(accu, accu);
+        return _mm_cvtss_f32(accu);
 #else
         FAISS_THROW_MSG("not implemented for non-x64 platforms");
 #endif
     }
-
 };
 
+} // namespace
 
-}  // namespace
-
-
-DistanceComputer * Index2Layer::get_distance_computer() const {
+DistanceComputer* Index2Layer::get_distance_computer() const {
 #ifdef __SSE3__
-    const MultiIndexQuantizer *mi =
-        dynamic_cast<MultiIndexQuantizer*> (q1.quantizer);
+    const MultiIndexQuantizer* mi =
+            dynamic_cast<MultiIndexQuantizer*>(q1.quantizer);
 
     if (mi && pq.M % 2 == 0 && pq.dsub == 4) {
         return new Distance2xXPQ4(*this);
     }
 
-    const IndexFlat *fl =
-        dynamic_cast<IndexFlat*> (q1.quantizer);
+    const IndexFlat* fl = dynamic_cast<IndexFlat*>(q1.quantizer);
 
     if (fl && pq.dsub == 4) {
         return new DistanceXPQ4(*this);
@@ -381,57 +280,60 @@ DistanceComputer * Index2Layer::get_distance_computer() const {
     return Index::get_distance_computer();
 }
 
-
 /* The standalone codec interface */
-size_t Index2Layer::sa_code_size () const
-{
-    return code_size;
-}
 
-void Index2Layer::sa_encode (idx_t n, const float *x, uint8_t *bytes) const
-{
-    FAISS_THROW_IF_NOT (is_trained);
-    std::unique_ptr<int64_t []> list_nos (new int64_t [n]);
-    q1.quantizer->assign (n, x, list_nos.get());
+void Index2Layer::sa_encode(idx_t n, const float* x, uint8_t* bytes) const {
+    FAISS_THROW_IF_NOT(is_trained);
+
+    idx_t bs = 32768;
+    if (n > bs) {
+        for (idx_t i0 = 0; i0 < n; i0 += bs) {
+            idx_t i1 = std::min(i0 + bs, n);
+            if (verbose) {
+                printf("Index2Layer::add: adding %" PRId64 ":%" PRId64
+                       " / %" PRId64 "\n",
+                       i0,
+                       i1,
+                       n);
+            }
+            sa_encode(i1 - i0, x + i0 * d, bytes + i0 * code_size);
+        }
+        return;
+    }
+
+    std::unique_ptr<int64_t[]> list_nos(new int64_t[n]);
+    q1.quantizer->assign(n, x, list_nos.get());
     std::vector<float> residuals(n * d);
     for (idx_t i = 0; i < n; i++) {
-        q1.quantizer->compute_residual (
-            x + i * d, residuals.data() + i * d, list_nos[i]);
+        q1.quantizer->compute_residual(
+                x + i * d, residuals.data() + i * d, list_nos[i]);
     }
-    pq.compute_codes (residuals.data(), bytes, n);
+    pq.compute_codes(residuals.data(), bytes, n);
 
     for (idx_t i = n - 1; i >= 0; i--) {
-        uint8_t * code = bytes + i * code_size;
-        memmove (code + code_size_1,
-                 bytes + i * code_size_2, code_size_2);
-        q1.encode_listno (list_nos[i], code);
+        uint8_t* code = bytes + i * code_size;
+        memmove(code + code_size_1, bytes + i * code_size_2, code_size_2);
+        q1.encode_listno(list_nos[i], code);
     }
-
 }
 
-void Index2Layer::sa_decode (idx_t n, const uint8_t *bytes, float *x) const
-{
-
+void Index2Layer::sa_decode(idx_t n, const uint8_t* bytes, float* x) const {
 #pragma omp parallel
     {
-        std::vector<float> residual (d);
+        std::vector<float> residual(d);
 
 #pragma omp for
         for (idx_t i = 0; i < n; i++) {
-            const uint8_t *code = bytes + i * code_size;
-            int64_t list_no = q1.decode_listno (code);
-            float *xi = x + i * d;
-            pq.decode (code + code_size_1, xi);
-            q1.quantizer->reconstruct (list_no, residual.data());
+            const uint8_t* code = bytes + i * code_size;
+            int64_t list_no = q1.decode_listno(code);
+            float* xi = x + i * d;
+            pq.decode(code + code_size_1, xi);
+            q1.quantizer->reconstruct(list_no, residual.data());
             for (int j = 0; j < d; j++) {
                 xi[j] += residual[j];
             }
         }
     }
-
 }
 
-
-
-
 } // namespace faiss

data/vendor/faiss/faiss/Index2Layer.h

@@ -11,75 +11,61 @@
 
 #include <vector>
 
-#include <faiss/IndexPQ.h>
+#include <faiss/IndexFlatCodes.h>
 #include <faiss/IndexIVF.h>
+#include <faiss/IndexPQ.h>
 
 namespace faiss {
 
 struct IndexIVFPQ;
 
-
-/** Same as an IndexIVFPQ without the inverted lists: codes are stored sequentially
+/** Same as an IndexIVFPQ without the inverted lists: codes are stored
+ * sequentially
  *
  * The class is mainly inteded to store encoded vectors that can be
  * accessed randomly, the search function is not implemented.
  */
-struct Index2Layer: Index {
+struct Index2Layer : IndexFlatCodes {
     /// first level quantizer
     Level1Quantizer q1;
 
     /// second level quantizer is always a PQ
     ProductQuantizer pq;
 
-    /// Codes. Size ntotal * code_size.
-    std::vector<uint8_t> codes;
-
     /// size of the code for the first level (ceil(log8(q1.nlist)))
     size_t code_size_1;
 
     /// size of the code for the second level
     size_t code_size_2;
 
-    /// code_size_1 + code_size_2
-    size_t code_size;
-
-    Index2Layer (Index * quantizer, size_t nlist,
-                 int M, int nbit = 8,
-                 MetricType metric = METRIC_L2);
+    Index2Layer(
+            Index* quantizer,
+            size_t nlist,
+            int M,
+            int nbit = 8,
+            MetricType metric = METRIC_L2);
 
-    Index2Layer ();
-    ~Index2Layer ();
+    Index2Layer();
+    ~Index2Layer();
 
     void train(idx_t n, const float* x) override;
 
-    void add(idx_t n, const float* x) override;
-
     /// not implemented
     void search(
-        idx_t n,
-        const float* x,
-        idx_t k,
-        float* distances,
-        idx_t* labels) const override;
+            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;
-
-    void reconstruct(idx_t key, float* recons) const override;
-
-    void reset() override;
-
-    DistanceComputer * get_distance_computer() const override;
+    DistanceComputer* get_distance_computer() const override;
 
     /// transfer the flat codes to an IVFPQ index
-    void transfer_to_IVFPQ(IndexIVFPQ & other) const;
-
+    void transfer_to_IVFPQ(IndexIVFPQ& other) const;
 
     /* The standalone codec interface */
-    size_t sa_code_size () const override;
-    void sa_encode (idx_t n, const float *x, uint8_t *bytes) const override;
-    void sa_decode (idx_t n, const uint8_t *bytes, float *x) const override;
-
+    void sa_encode(idx_t n, const float* x, uint8_t* bytes) const override;
+    void sa_decode(idx_t n, const uint8_t* bytes, float* x) const override;
 };
 
-
 } // namespace faiss