faiss 0.2.0 → 0.2.1

data/vendor/faiss/faiss/Index2Layer.h

@@ -11,20 +11,20 @@
 
 #include <vector>
 
-#include <faiss/IndexPQ.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 : Index {
     /// first level quantizer
     Level1Quantizer q1;
 
@@ -43,12 +43,15 @@ struct Index2Layer: Index {
     /// 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;
 
@@ -56,11 +59,11 @@ struct Index2Layer: Index {
 
     /// 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;
 
@@ -68,18 +71,15 @@ struct Index2Layer: Index {
 
     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;
-
+    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;
 };
 
-
 } // namespace faiss

data/vendor/faiss/faiss/IndexBinary.cpp

@@ -17,61 +17,69 @@ namespace faiss {
 
 IndexBinary::~IndexBinary() {}
 
-void IndexBinary::train(idx_t, const uint8_t *) {
-  // Does nothing by default.
+void IndexBinary::train(idx_t, const uint8_t*) {
+    // Does nothing by default.
 }
 
-void IndexBinary::range_search(idx_t, const uint8_t *, int,
-                               RangeSearchResult *) const {
-  FAISS_THROW_MSG("range search not implemented");
+void IndexBinary::range_search(idx_t, const uint8_t*, int, RangeSearchResult*)
+        const {
+    FAISS_THROW_MSG("range search not implemented");
 }
 
-void IndexBinary::assign(idx_t n, const uint8_t *x, idx_t *labels, idx_t k) const {
-  std::vector<int> distances(n * k);
-  search(n, x, k, distances.data(), labels);
+void IndexBinary::assign(idx_t n, const uint8_t* x, idx_t* labels, idx_t k)
+        const {
+    std::vector<int> distances(n * k);
+    search(n, x, k, distances.data(), labels);
 }
 
-void IndexBinary::add_with_ids(idx_t, const uint8_t *, const idx_t *) {
-  FAISS_THROW_MSG("add_with_ids not implemented for this type of index");
+void IndexBinary::add_with_ids(idx_t, const uint8_t*, const idx_t*) {
+    FAISS_THROW_MSG("add_with_ids not implemented for this type of index");
 }
 
 size_t IndexBinary::remove_ids(const IDSelector&) {
-  FAISS_THROW_MSG("remove_ids not implemented for this type of index");
-  return 0;
+    FAISS_THROW_MSG("remove_ids not implemented for this type of index");
+    return 0;
 }
 
-void IndexBinary::reconstruct(idx_t, uint8_t *) const {
-  FAISS_THROW_MSG("reconstruct not implemented for this type of index");
+void IndexBinary::reconstruct(idx_t, uint8_t*) const {
+    FAISS_THROW_MSG("reconstruct not implemented for this type of index");
 }
 
-void IndexBinary::reconstruct_n(idx_t i0, idx_t ni, uint8_t *recons) const {
-  for (idx_t i = 0; i < ni; i++) {
-    reconstruct(i0 + i, recons + i * d);
-  }
+void IndexBinary::reconstruct_n(idx_t i0, idx_t ni, uint8_t* recons) const {
+    for (idx_t i = 0; i < ni; i++) {
+        reconstruct(i0 + i, recons + i * d);
+    }
 }
 
-void IndexBinary::search_and_reconstruct(idx_t n, const uint8_t *x, idx_t k,
-                                         int32_t *distances, idx_t *labels,
-                                         uint8_t *recons) const {
-  search(n, x, k, distances, labels);
-  for (idx_t i = 0; i < n; ++i) {
-    for (idx_t j = 0; j < k; ++j) {
-      idx_t ij = i * k + j;
-      idx_t key = labels[ij];
-      uint8_t *reconstructed = recons + ij * d;
-      if (key < 0) {
-        // Fill with NaNs
-        memset(reconstructed, -1, sizeof(*reconstructed) * d);
-      } else {
-        reconstruct(key, reconstructed);
-      }
+void IndexBinary::search_and_reconstruct(
+        idx_t n,
+        const uint8_t* x,
+        idx_t k,
+        int32_t* distances,
+        idx_t* labels,
+        uint8_t* recons) const {
+    FAISS_THROW_IF_NOT(k > 0);
+
+    search(n, x, k, distances, labels);
+    for (idx_t i = 0; i < n; ++i) {
+        for (idx_t j = 0; j < k; ++j) {
+            idx_t ij = i * k + j;
+            idx_t key = labels[ij];
+            uint8_t* reconstructed = recons + ij * d;
+            if (key < 0) {
+                // Fill with NaNs
+                memset(reconstructed, -1, sizeof(*reconstructed) * d);
+            } else {
+                reconstruct(key, reconstructed);
+            }
+        }
     }
-  }
 }
 
 void IndexBinary::display() const {
-  printf("Index: %s  -> %" PRId64 " elements\n", typeid (*this).name(), ntotal);
+    printf("Index: %s  -> %" PRId64 " elements\n",
+           typeid(*this).name(),
+           ntotal);
 }
 
-
-}  // namespace faiss
+} // namespace faiss

data/vendor/faiss/faiss/IndexBinary.h

@@ -11,17 +11,15 @@
 #define FAISS_INDEX_BINARY_H
 
 #include <cstdio>
-#include <typeinfo>
-#include <string>
 #include <sstream>
+#include <string>
+#include <typeinfo>
 
-#include <faiss/impl/FaissAssert.h>
 #include <faiss/Index.h>
-
+#include <faiss/impl/FaissAssert.h>
 
 namespace faiss {
 
-
 /// Forward declarations see AuxIndexStructures.h
 struct IDSelector;
 struct RangeSearchResult;
@@ -34,134 +32,144 @@ struct RangeSearchResult;
  * vectors.
  */
 struct IndexBinary {
-  using idx_t = Index::idx_t;    ///< all indices are this type
-  using component_t = uint8_t;
-  using distance_t = int32_t;
-
-  int d;                 ///< vector dimension
-  int code_size;   ///< number of bytes per vector ( = d / 8 )
-  idx_t ntotal;          ///< total nb of indexed vectors
-  bool verbose;          ///< verbosity level
-
-  /// set if the Index does not require training, or if training is done already
-  bool is_trained;
-
-  /// type of metric this index uses for search
-  MetricType metric_type;
-
-  explicit IndexBinary(idx_t d = 0, MetricType metric = METRIC_L2)
-      : d(d),
-        code_size(d / 8),
-        ntotal(0),
-        verbose(false),
-        is_trained(true),
-        metric_type(metric) {
+    using idx_t = Index::idx_t; ///< all indices are this type
+    using component_t = uint8_t;
+    using distance_t = int32_t;
+
+    int d;         ///< vector dimension
+    int code_size; ///< number of bytes per vector ( = d / 8 )
+    idx_t ntotal;  ///< total nb of indexed vectors
+    bool verbose;  ///< verbosity level
+
+    /// set if the Index does not require training, or if training is done
+    /// already
+    bool is_trained;
+
+    /// type of metric this index uses for search
+    MetricType metric_type;
+
+    explicit IndexBinary(idx_t d = 0, MetricType metric = METRIC_L2)
+            : d(d),
+              code_size(d / 8),
+              ntotal(0),
+              verbose(false),
+              is_trained(true),
+              metric_type(metric) {
         FAISS_THROW_IF_NOT(d % 8 == 0);
-      }
-
-  virtual ~IndexBinary();
-
-
-  /** Perform training on a representative set of vectors.
-   *
-   * @param n      nb of training vectors
-   * @param x      training vecors, size n * d / 8
-   */
-  virtual void train(idx_t n, const uint8_t *x);
-
-  /** Add n vectors of dimension d to the index.
-   *
-   * Vectors are implicitly assigned labels ntotal .. ntotal + n - 1
-   * @param x      input matrix, size n * d / 8
-   */
-  virtual void add(idx_t n, const uint8_t *x) = 0;
-
-  /** 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.
-   *
-   * @param xids if non-null, ids to store for the vectors (size n)
-   */
-  virtual void add_with_ids(idx_t n, const uint8_t *x, const idx_t *xids);
-
-  /** 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.
-   *
-   * @param x           input vectors to search, size n * d / 8
-   * @param labels      output labels of the NNs, size n*k
-   * @param distances   output pairwise distances, size n*k
-   */
-  virtual void search(idx_t n, const uint8_t *x, idx_t k,
-                      int32_t *distances, idx_t *labels) const = 0;
-
-  /** Query n vectors of dimension d to the index.
-   *
-   * return all vectors with distance < radius. Note that many indexes
-   * do not implement the range_search (only the k-NN search is
-   * mandatory). The distances are converted to float to reuse the
-   * RangeSearchResult structure, but they are integer. By convention,
-   * only distances < radius (strict comparison) are returned,
-   * ie. radius = 0 does not return any result and 1 returns only
-   * exact same vectors.
-   *
-   * @param x           input vectors to search, size n * d / 8
-   * @param radius      search radius
-   * @param result      result table
-   */
-  virtual void range_search(idx_t n, const uint8_t *x, int radius,
-                            RangeSearchResult *result) const;
-
-  /** Return the indexes of the k vectors closest to the query x.
-   *
-   * This function is identical to search but only returns labels of neighbors.
-   * @param x           input vectors to search, size n * d / 8
-   * @param labels      output labels of the NNs, size n*k
-   */
-  void assign(idx_t n, const uint8_t *x, idx_t *labels, idx_t k = 1) const;
-
-  /// Removes all elements from the database.
-  virtual void reset() = 0;
-
-  /** Removes IDs from the index. Not supported by all indexes.
-   */
-  virtual size_t remove_ids(const IDSelector& sel);
-
-  /** Reconstruct a stored vector.
-   *
-   * This function may not be defined for some indexes.
-   * @param key         id of the vector to reconstruct
-   * @param recons      reconstucted vector (size d / 8)
-   */
-  virtual void reconstruct(idx_t key, uint8_t *recons) const;
-
-
-  /** Reconstruct vectors i0 to i0 + ni - 1.
-   *
-   * This function may not be defined for some indexes.
-   * @param recons      reconstucted vectors (size ni * d / 8)
-   */
-  virtual void reconstruct_n(idx_t i0, idx_t ni, uint8_t *recons) const;
-
-  /** Similar to search, but also reconstructs the stored vectors (or an
-   * approximation in the case of lossy coding) for the search results.
-   *
-   * If there are not enough results for a query, the resulting array
-   * is padded with -1s.
-   *
-   * @param recons      reconstructed vectors size (n, k, d)
-   **/
-  virtual void search_and_reconstruct(idx_t n, const uint8_t *x, idx_t k,
-                                      int32_t *distances, idx_t *labels,
-                                      uint8_t *recons) const;
-
-  /** Display the actual class name and some more info. */
-  void display() const;
+    }
+
+    virtual ~IndexBinary();
+
+    /** Perform training on a representative set of vectors.
+     *
+     * @param n      nb of training vectors
+     * @param x      training vecors, size n * d / 8
+     */
+    virtual void train(idx_t n, const uint8_t* x);
+
+    /** Add n vectors of dimension d to the index.
+     *
+     * Vectors are implicitly assigned labels ntotal .. ntotal + n - 1
+     * @param x      input matrix, size n * d / 8
+     */
+    virtual void add(idx_t n, const uint8_t* x) = 0;
+
+    /** 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.
+     *
+     * @param xids if non-null, ids to store for the vectors (size n)
+     */
+    virtual void add_with_ids(idx_t n, const uint8_t* x, const idx_t* xids);
+
+    /** 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.
+     *
+     * @param x           input vectors to search, size n * d / 8
+     * @param labels      output labels of the NNs, size n*k
+     * @param distances   output pairwise distances, size n*k
+     */
+    virtual void search(
+            idx_t n,
+            const uint8_t* x,
+            idx_t k,
+            int32_t* distances,
+            idx_t* labels) const = 0;
+
+    /** Query n vectors of dimension d to the index.
+     *
+     * return all vectors with distance < radius. Note that many indexes
+     * do not implement the range_search (only the k-NN search is
+     * mandatory). The distances are converted to float to reuse the
+     * RangeSearchResult structure, but they are integer. By convention,
+     * only distances < radius (strict comparison) are returned,
+     * ie. radius = 0 does not return any result and 1 returns only
+     * exact same vectors.
+     *
+     * @param x           input vectors to search, size n * d / 8
+     * @param radius      search radius
+     * @param result      result table
+     */
+    virtual void range_search(
+            idx_t n,
+            const uint8_t* x,
+            int radius,
+            RangeSearchResult* result) const;
+
+    /** Return the indexes of the k vectors closest to the query x.
+     *
+     * This function is identical to search but only returns labels of
+     * neighbors.
+     * @param x           input vectors to search, size n * d / 8
+     * @param labels      output labels of the NNs, size n*k
+     */
+    void assign(idx_t n, const uint8_t* x, idx_t* labels, idx_t k = 1) const;
+
+    /// Removes all elements from the database.
+    virtual void reset() = 0;
+
+    /** Removes IDs from the index. Not supported by all indexes.
+     */
+    virtual size_t remove_ids(const IDSelector& sel);
+
+    /** Reconstruct a stored vector.
+     *
+     * This function may not be defined for some indexes.
+     * @param key         id of the vector to reconstruct
+     * @param recons      reconstucted vector (size d / 8)
+     */
+    virtual void reconstruct(idx_t key, uint8_t* recons) const;
+
+    /** Reconstruct vectors i0 to i0 + ni - 1.
+     *
+     * This function may not be defined for some indexes.
+     * @param recons      reconstucted vectors (size ni * d / 8)
+     */
+    virtual void reconstruct_n(idx_t i0, idx_t ni, uint8_t* recons) const;
+
+    /** Similar to search, but also reconstructs the stored vectors (or an
+     * approximation in the case of lossy coding) for the search results.
+     *
+     * If there are not enough results for a query, the resulting array
+     * is padded with -1s.
+     *
+     * @param recons      reconstructed vectors size (n, k, d)
+     **/
+    virtual void search_and_reconstruct(
+            idx_t n,
+            const uint8_t* x,
+            idx_t k,
+            int32_t* distances,
+            idx_t* labels,
+            uint8_t* recons) const;
+
+    /** Display the actual class name and some more info. */
+    void display() const;
 };
 
+} // namespace faiss
 
-}  // namespace faiss
-
-#endif  // FAISS_INDEX_BINARY_H
+#endif // FAISS_INDEX_BINARY_H