faiss 0.2.0 → 0.2.1

data/vendor/faiss/faiss/utils/extra_distances-inl.h

@@ -0,0 +1,117 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/** In this file are the implementations of extra metrics beyond L2
+ *  and inner product */
+
+#include <faiss/utils/distances.h>
+#include <type_traits>
+
+namespace faiss {
+
+template <MetricType mt>
+struct VectorDistance {
+    size_t d;
+    float metric_arg;
+
+    inline float operator()(const float* x, const float* y) const;
+
+    // heap template to use for this type of metric
+    using C = typename std::conditional<
+            mt == METRIC_INNER_PRODUCT,
+            CMin<float, int64_t>,
+            CMax<float, int64_t>>::type;
+};
+
+template <>
+inline float VectorDistance<METRIC_L2>::operator()(
+        const float* x,
+        const float* y) const {
+    return fvec_L2sqr(x, y, d);
+}
+
+template <>
+inline float VectorDistance<METRIC_INNER_PRODUCT>::operator()(
+        const float* x,
+        const float* y) const {
+    return fvec_inner_product(x, y, d);
+}
+
+template <>
+inline float VectorDistance<METRIC_L1>::operator()(
+        const float* x,
+        const float* y) const {
+    return fvec_L1(x, y, d);
+}
+
+template <>
+inline float VectorDistance<METRIC_Linf>::operator()(
+        const float* x,
+        const float* y) const {
+    return fvec_Linf(x, y, d);
+    /*
+        float vmax = 0;
+        for (size_t i = 0; i < d; i++) {
+            float diff = fabs (x[i] - y[i]);
+            if (diff > vmax) vmax = diff;
+        }
+     return vmax;*/
+}
+
+template <>
+inline float VectorDistance<METRIC_Lp>::operator()(
+        const float* x,
+        const float* y) const {
+    float accu = 0;
+    for (size_t i = 0; i < d; i++) {
+        float diff = fabs(x[i] - y[i]);
+        accu += powf(diff, metric_arg);
+    }
+    return accu;
+}
+
+template <>
+inline float VectorDistance<METRIC_Canberra>::operator()(
+        const float* x,
+        const float* y) const {
+    float accu = 0;
+    for (size_t i = 0; i < d; i++) {
+        float xi = x[i], yi = y[i];
+        accu += fabs(xi - yi) / (fabs(xi) + fabs(yi));
+    }
+    return accu;
+}
+
+template <>
+inline float VectorDistance<METRIC_BrayCurtis>::operator()(
+        const float* x,
+        const float* y) const {
+    float accu_num = 0, accu_den = 0;
+    for (size_t i = 0; i < d; i++) {
+        float xi = x[i], yi = y[i];
+        accu_num += fabs(xi - yi);
+        accu_den += fabs(xi + yi);
+    }
+    return accu_num / accu_den;
+}
+
+template <>
+inline float VectorDistance<METRIC_JensenShannon>::operator()(
+        const float* x,
+        const float* y) const {
+    float accu = 0;
+    for (size_t i = 0; i < d; i++) {
+        float xi = x[i], yi = y[i];
+        float mi = 0.5 * (xi + yi);
+        float kl1 = -xi * log(mi / xi);
+        float kl2 = -yi * log(mi / yi);
+        accu += kl1 + kl2;
+    }
+    return 0.5 * accu;
+}
+
+} // namespace faiss

data/vendor/faiss/faiss/utils/extra_distances.cpp

@@ -7,16 +7,15 @@
 
 // -*- c++ -*-
 
-#include <faiss/utils/distances.h>
+#include <faiss/utils/extra_distances.h>
 
+#include <omp.h>
 #include <algorithm>
 #include <cmath>
-#include <omp.h>
-
 
-#include <faiss/utils/utils.h>
-#include <faiss/impl/FaissAssert.h>
 #include <faiss/impl/AuxIndexStructures.h>
+#include <faiss/impl/FaissAssert.h>
+#include <faiss/utils/utils.h>
 
 namespace faiss {
 
@@ -24,140 +23,43 @@ namespace faiss {
  * Distance functions (other than L2 and IP)
  ***************************************************************************/
 
-struct VectorDistanceL2 {
-    size_t d;
-
-    float operator () (const float *x, const float *y) const {
-        return fvec_L2sqr (x, y, d);
-    }
-};
-
-struct VectorDistanceL1 {
-    size_t d;
-
-    float operator () (const float *x, const float *y) const {
-        return fvec_L1 (x, y, d);
-    }
-};
-
-struct VectorDistanceLinf {
-    size_t d;
-
-    float operator () (const float *x, const float *y) const {
-        return fvec_Linf (x, y, d);
-        /*
-        float vmax = 0;
-        for (size_t i = 0; i < d; i++) {
-            float diff = fabs (x[i] - y[i]);
-            if (diff > vmax) vmax = diff;
-        }
-        return vmax;*/
-    }
-};
-
-struct VectorDistanceLp {
-    size_t d;
-    const float p;
-
-    float operator () (const float *x, const float *y) const {
-        float accu = 0;
-        for (size_t i = 0; i < d; i++) {
-            float diff = fabs (x[i] - y[i]);
-            accu += powf (diff, p);
-        }
-        return accu;
-    }
-};
-
-struct VectorDistanceCanberra {
-    size_t d;
-
-    float operator () (const float *x, const float *y) const {
-        float accu = 0;
-        for (size_t i = 0; i < d; i++) {
-            float xi = x[i], yi = y[i];
-            accu += fabs (xi - yi) / (fabs(xi) + fabs(yi));
-        }
-        return accu;
-    }
-};
-
-struct VectorDistanceBrayCurtis {
-    size_t d;
-
-    float operator () (const float *x, const float *y) const {
-        float accu_num = 0, accu_den = 0;
-        for (size_t i = 0; i < d; i++) {
-            float xi = x[i], yi = y[i];
-            accu_num += fabs (xi - yi);
-            accu_den += fabs (xi + yi);
-        }
-        return accu_num / accu_den;
-    }
-};
-
-struct VectorDistanceJensenShannon {
-    size_t d;
-
-    float operator () (const float *x, const float *y) const {
-        float accu = 0;
-
-        for (size_t i = 0; i < d; i++) {
-            float xi = x[i], yi = y[i];
-            float mi = 0.5 * (xi + yi);
-            float kl1 = - xi * log(mi / xi);
-            float kl2 = - yi * log(mi / yi);
-            accu += kl1 + kl2;
-        }
-        return 0.5 * accu;
-    }
-};
-
-
-
-
-
-
-
-
-
-
 namespace {
 
-template<class VD>
-void pairwise_extra_distances_template (
-                     VD vd,
-                     int64_t nq, const float *xq,
-                     int64_t nb, const float *xb,
-                     float *dis,
-                     int64_t ldq, int64_t ldb, int64_t ldd)
-{
-
-#pragma omp parallel for if(nq > 10)
+template <class VD>
+void pairwise_extra_distances_template(
+        VD vd,
+        int64_t nq,
+        const float* xq,
+        int64_t nb,
+        const float* xb,
+        float* dis,
+        int64_t ldq,
+        int64_t ldb,
+        int64_t ldd) {
+#pragma omp parallel for if (nq > 10)
     for (int64_t i = 0; i < nq; i++) {
-        const float *xqi = xq + i * ldq;
-        const float *xbj = xb;
-        float *disi = dis + ldd * i;
+        const float* xqi = xq + i * ldq;
+        const float* xbj = xb;
+        float* disi = dis + ldd * i;
 
         for (int64_t j = 0; j < nb; j++) {
-            disi[j] = vd (xqi, xbj);
+            disi[j] = vd(xqi, xbj);
             xbj += ldb;
         }
     }
 }
 
-
-template<class VD>
-void knn_extra_metrics_template (
+template <class VD>
+void knn_extra_metrics_template(
         VD vd,
-        const float * x,
-        const float * y,
-        size_t nx, size_t ny,
-        float_maxheap_array_t * res)
-{
+        const float* x,
+        const float* y,
+        size_t nx,
+        size_t ny,
+        float_maxheap_array_t* res) {
     size_t k = res->k;
     size_t d = vd.d;
-    size_t check_period = InterruptCallback::get_period_hint (ny * d);
+    size_t check_period = InterruptCallback::get_period_hint(ny * d);
     check_period *= omp_get_max_threads();
 
     for (size_t i0 = 0; i0 < nx; i0 += check_period) {
@@ -165,90 +67,84 @@ void knn_extra_metrics_template (
 
 #pragma omp parallel for
         for (int64_t i = i0; i < i1; i++) {
-            const float * x_i = x + i * d;
-            const float * y_j = y;
+            const float* x_i = x + i * d;
+            const float* y_j = y;
             size_t j;
-            float * simi = res->get_val(i);
-            int64_t * idxi = res->get_ids (i);
+            float* simi = res->get_val(i);
+            int64_t* idxi = res->get_ids(i);
 
-            maxheap_heapify (k, simi, idxi);
+            maxheap_heapify(k, simi, idxi);
             for (j = 0; j < ny; j++) {
-                float disij = vd (x_i, y_j);
+                float disij = vd(x_i, y_j);
 
                 if (disij < simi[0]) {
-                    maxheap_replace_top (k, simi, idxi, disij, j);
+                    maxheap_replace_top(k, simi, idxi, disij, j);
                 }
                 y_j += d;
             }
-            maxheap_reorder (k, simi, idxi);
+            maxheap_reorder(k, simi, idxi);
         }
-        InterruptCallback::check ();
+        InterruptCallback::check();
     }
-
 }
 
-
-template<class VD>
+template <class VD>
 struct ExtraDistanceComputer : DistanceComputer {
     VD vd;
     Index::idx_t nb;
-    const float *q;
-    const float *b;
+    const float* q;
+    const float* b;
 
-    float operator () (idx_t i) override {
-        return vd (q, b + i * vd.d);
+    float operator()(idx_t i) override {
+        return vd(q, b + i * vd.d);
     }
 
     float symmetric_dis(idx_t i, idx_t j) override {
-        return vd (b + j * vd.d, b + i * vd.d);
+        return vd(b + j * vd.d, b + i * vd.d);
     }
 
-    ExtraDistanceComputer(const VD & vd, const float *xb,
-                          size_t nb, const float *q = nullptr)
-        : vd(vd), nb(nb), q(q), b(xb) {}
+    ExtraDistanceComputer(
+            const VD& vd,
+            const float* xb,
+            size_t nb,
+            const float* q = nullptr)
+            : vd(vd), nb(nb), q(q), b(xb) {}
 
-    void set_query(const float *x) override {
+    void set_query(const float* x) override {
         q = x;
     }
 };
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 } // anonymous namespace
 
-void pairwise_extra_distances (
-                     int64_t d,
-                     int64_t nq, const float *xq,
-                     int64_t nb, const float *xb,
-                     MetricType mt, float metric_arg,
-                     float *dis,
-                     int64_t ldq, int64_t ldb, int64_t ldd)
-{
-    if (nq == 0 || nb == 0) return;
-    if (ldq == -1) ldq = d;
-    if (ldb == -1) ldb = d;
-    if (ldd == -1) ldd = nb;
-
-    switch(mt) {
-#define HANDLE_VAR(kw)                                          \
-     case METRIC_ ## kw: {                                      \
-        VectorDistance ## kw vd = {(size_t)d};                  \
-        pairwise_extra_distances_template (vd, nq, xq, nb, xb,  \
-                                           dis, ldq, ldb, ldd); \
-        break;                                                  \
+void pairwise_extra_distances(
+        int64_t d,
+        int64_t nq,
+        const float* xq,
+        int64_t nb,
+        const float* xb,
+        MetricType mt,
+        float metric_arg,
+        float* dis,
+        int64_t ldq,
+        int64_t ldb,
+        int64_t ldd) {
+    if (nq == 0 || nb == 0)
+        return;
+    if (ldq == -1)
+        ldq = d;
+    if (ldb == -1)
+        ldb = d;
+    if (ldd == -1)
+        ldd = nb;
+
+    switch (mt) {
+#define HANDLE_VAR(kw)                                            \
+    case METRIC_##kw: {                                           \
+        VectorDistance<METRIC_##kw> vd = {(size_t)d, metric_arg}; \
+        pairwise_extra_distances_template(                        \
+                vd, nq, xq, nb, xb, dis, ldq, ldb, ldd);          \
+        break;                                                    \
     }
         HANDLE_VAR(L2);
         HANDLE_VAR(L1);
@@ -256,33 +152,28 @@ void pairwise_extra_distances (
         HANDLE_VAR(Canberra);
         HANDLE_VAR(BrayCurtis);
         HANDLE_VAR(JensenShannon);
+        HANDLE_VAR(Lp);
 #undef HANDLE_VAR
-    case METRIC_Lp: {
-        VectorDistanceLp vd = {(size_t)d, metric_arg};
-        pairwise_extra_distances_template (vd, nq, xq, nb, xb,
-                                           dis, ldq, ldb, ldd);
-        break;
+        default:
+            FAISS_THROW_MSG("metric type not implemented");
     }
-    default:
-        FAISS_THROW_MSG ("metric type not implemented");
-    }
-
 }
 
-void knn_extra_metrics (
-        const float * x,
-        const float * y,
-        size_t d, size_t nx, size_t ny,
-        MetricType mt, float metric_arg,
-        float_maxheap_array_t * res)
-{
-
-    switch(mt) {
-#define HANDLE_VAR(kw)                                          \
-     case METRIC_ ## kw: {                                      \
-        VectorDistance ## kw vd = {(size_t)d};                  \
-        knn_extra_metrics_template (vd, x, y, nx, ny, res);     \
-        break;                                                  \
+void knn_extra_metrics(
+        const float* x,
+        const float* y,
+        size_t d,
+        size_t nx,
+        size_t ny,
+        MetricType mt,
+        float metric_arg,
+        float_maxheap_array_t* res) {
+    switch (mt) {
+#define HANDLE_VAR(kw)                                            \
+    case METRIC_##kw: {                                           \
+        VectorDistance<METRIC_##kw> vd = {(size_t)d, metric_arg}; \
+        knn_extra_metrics_template(vd, x, y, nx, ny, res);        \
+        break;                                                    \
     }
         HANDLE_VAR(L2);
         HANDLE_VAR(L1);
@@ -290,29 +181,25 @@ void knn_extra_metrics (
         HANDLE_VAR(Canberra);
         HANDLE_VAR(BrayCurtis);
         HANDLE_VAR(JensenShannon);
+        HANDLE_VAR(Lp);
 #undef HANDLE_VAR
-    case METRIC_Lp: {
-        VectorDistanceLp vd = {(size_t)d, metric_arg};
-        knn_extra_metrics_template (vd, x, y, nx, ny, res);
-        break;
-    }
-    default:
-        FAISS_THROW_MSG ("metric type not implemented");
+        default:
+            FAISS_THROW_MSG("metric type not implemented");
     }
-
 }
 
-DistanceComputer *get_extra_distance_computer (
+DistanceComputer* get_extra_distance_computer(
         size_t d,
-        MetricType mt, float metric_arg,
-        size_t nb, const float *xb)
-{
-
-    switch(mt) {
-#define HANDLE_VAR(kw)                                                  \
-     case METRIC_ ## kw: {                                              \
-        VectorDistance ## kw vd = {(size_t)d};                          \
-        return new ExtraDistanceComputer<VectorDistance ## kw>(vd, xb, nb); \
+        MetricType mt,
+        float metric_arg,
+        size_t nb,
+        const float* xb) {
+    switch (mt) {
+#define HANDLE_VAR(kw)                                                 \
+    case METRIC_##kw: {                                                \
+        VectorDistance<METRIC_##kw> vd = {(size_t)d, metric_arg};      \
+        return new ExtraDistanceComputer<VectorDistance<METRIC_##kw>>( \
+                vd, xb, nb);                                           \
     }
         HANDLE_VAR(L2);
         HANDLE_VAR(L1);
@@ -320,17 +207,11 @@ DistanceComputer *get_extra_distance_computer (
         HANDLE_VAR(Canberra);
         HANDLE_VAR(BrayCurtis);
         HANDLE_VAR(JensenShannon);
+        HANDLE_VAR(Lp);
 #undef HANDLE_VAR
-    case METRIC_Lp: {
-        VectorDistanceLp vd = {(size_t)d, metric_arg};
-        return new ExtraDistanceComputer<VectorDistanceLp> (vd, xb, nb);
-        break;
-    }
-    default:
-        FAISS_THROW_MSG ("metric type not implemented");
+        default:
+            FAISS_THROW_MSG("metric type not implemented");
     }
-
 }
 
-
 } // namespace faiss