faiss 0.1.3 → 0.1.4

data/vendor/faiss/c_api/IndexFlat_c.h

@@ -1,115 +0,0 @@
-/**
- * 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.
- */
-
-// Copyright 2004-present Facebook. All Rights Reserved
-// -*- c -*-
-
-#ifndef FAISS_INDEX_FLAT_C_H
-#define FAISS_INDEX_FLAT_C_H
-
-#include "Index_c.h"
-#include "faiss_c.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-// forward declaration
-typedef enum FaissMetricType FaissMetricType;
-
-/** Opaque type for IndexFlat */
-FAISS_DECLARE_CLASS_INHERITED(IndexFlat, Index)
-
-int faiss_IndexFlat_new(FaissIndexFlat** p_index);
-
-int faiss_IndexFlat_new_with(FaissIndexFlat** p_index, idx_t d, FaissMetricType metric);
-
-/** get a pointer to the index's internal data (the `xb` field). The outputs
- * become invalid after any data addition or removal operation.
- * 
- * @param index   opaque pointer to index object
- * @param p_xb    output, the pointer to the beginning of `xb`.
- * @param p_size  output, the current size of `sb` in number of float values.
- */
-void faiss_IndexFlat_xb(FaissIndexFlat* index, float** p_xb, size_t* p_size);
-
-/** attempt a dynamic cast to a flat index, thus checking
- * check whether the underlying index type is `IndexFlat`.
- * 
- * @param index opaque pointer to index object
- * @return the same pointer if the index is a flat index, NULL otherwise
- */
-FAISS_DECLARE_INDEX_DOWNCAST(IndexFlat)
-
-FAISS_DECLARE_DESTRUCTOR(IndexFlat)
-
-/** compute distance with a subset of vectors
- *
- * @param index   opaque pointer to index object
- * @param x       query vectors, size n * d
- * @param labels  indices of the vectors that should be compared
- *                for each query vector, size n * k
- * @param distances
- *                corresponding output distances, size n * k
- */
-int faiss_IndexFlat_compute_distance_subset(
-    FaissIndex *index,
-    idx_t n,
-    const float *x,
-    idx_t k,
-    float *distances,
-    const idx_t *labels);
-
-/** Opaque type for IndexFlatIP */
-FAISS_DECLARE_CLASS_INHERITED(IndexFlatIP, Index)
-
-int faiss_IndexFlatIP_new(FaissIndexFlatIP** p_index);
-
-int faiss_IndexFlatIP_new_with(FaissIndexFlatIP** p_index, idx_t d);
-
-/** Opaque type for IndexFlatL2 */
-FAISS_DECLARE_CLASS_INHERITED(IndexFlatL2, Index)
-
-int faiss_IndexFlatL2_new(FaissIndexFlatL2** p_index);
-
-int faiss_IndexFlatL2_new_with(FaissIndexFlatL2** p_index, idx_t d);
-
-/** Opaque type for IndexFlatL2BaseShift
- *
- * same as an IndexFlatL2 but a value is subtracted from each distance
- */
-FAISS_DECLARE_CLASS_INHERITED(IndexFlatL2BaseShift, Index)
-
-int faiss_IndexFlatL2BaseShift_new(FaissIndexFlatL2BaseShift** p_index, idx_t d, size_t nshift, const float *shift);
-
-/** Opaque type for IndexRefineFlat
- *
- * Index that queries in a base_index (a fast one) and refines the
- * results with an exact search, hopefully improving the results.
- */
-FAISS_DECLARE_CLASS_INHERITED(IndexRefineFlat, Index)
-
-int faiss_IndexRefineFlat_new(FaissIndexRefineFlat** p_index, FaissIndex* base_index);
-
-FAISS_DECLARE_DESTRUCTOR(IndexRefineFlat)
-
-/** Opaque type for IndexFlat1D
- * 
- * optimized version for 1D "vectors"
- */
-FAISS_DECLARE_CLASS_INHERITED(IndexFlat1D, Index)
-
-int faiss_IndexFlat1D_new(FaissIndexFlat1D** p_index);
-int faiss_IndexFlat1D_new_with(FaissIndexFlat1D** p_index, int continuous_update);
-
-int faiss_IndexFlat1D_update_permutation(FaissIndexFlat1D* index);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif

data/vendor/faiss/c_api/IndexIVFFlat_c.cpp

@@ -1,64 +0,0 @@
-/**
- * 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.
- */
-
-// Copyright 2004-present Facebook. All Rights Reserved.
-// -*- c++ -*-
-
-#include "Index_c.h"
-#include "Clustering_c.h"
-#include "IndexIVFFlat_c.h"
-#include "IndexIVFFlat.h"
-#include "macros_impl.h"
-
-using faiss::Index;
-using faiss::IndexIVFFlat;
-using faiss::MetricType;
-
-DEFINE_DESTRUCTOR(IndexIVFFlat)
-DEFINE_INDEX_DOWNCAST(IndexIVFFlat)
-
-int faiss_IndexIVFFlat_new(FaissIndexIVFFlat** p_index) {
-    try {
-        *p_index = reinterpret_cast<FaissIndexIVFFlat*>(new IndexIVFFlat());
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexIVFFlat_new_with(FaissIndexIVFFlat** p_index,
-    FaissIndex* quantizer, size_t d, size_t nlist)
-{
-    try {
-        auto q = reinterpret_cast<Index*>(quantizer);
-        *p_index = reinterpret_cast<FaissIndexIVFFlat*>(new IndexIVFFlat(q, d, nlist));
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexIVFFlat_new_with_metric(
-    FaissIndexIVFFlat** p_index, FaissIndex* quantizer, size_t d, size_t nlist,
-    FaissMetricType metric)
-{
-    try {
-        auto q = reinterpret_cast<Index*>(quantizer);
-        auto m = static_cast<MetricType>(metric);
-        *p_index = reinterpret_cast<FaissIndexIVFFlat*>(new IndexIVFFlat(q, d, nlist, m));
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexIVFFlat_add_core(FaissIndexIVFFlat* index, idx_t n, 
-    const float * x, const idx_t *xids, const int64_t *precomputed_idx)
-{
-    try {
-        reinterpret_cast<IndexIVFFlat*>(index)->add_core(n, x, xids, precomputed_idx);
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexIVFFlat_update_vectors(FaissIndexIVFFlat* index, int nv,
-    idx_t *idx, const float *v)
-{
-    try {
-        reinterpret_cast<IndexIVFFlat*>(index)->update_vectors(nv, idx, v);
-    } CATCH_AND_HANDLE
-}

data/vendor/faiss/c_api/IndexIVFFlat_c.h

@@ -1,58 +0,0 @@
-/**
- * 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.
- */
-
-// Copyright 2004-present Facebook. All Rights Reserved.
-// -*- c -*-
-
-#ifndef FAISS_INDEX_IVF_FLAT_C_H
-#define FAISS_INDEX_IVF_FLAT_C_H
-
-#include "faiss_c.h"
-#include "Index_c.h"
-#include "Clustering_c.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/** Inverted file with stored vectors. Here the inverted file
- * pre-selects the vectors to be searched, but they are not otherwise
- * encoded, the code array just contains the raw float entries.
- */
-FAISS_DECLARE_CLASS(IndexIVFFlat)
-FAISS_DECLARE_DESTRUCTOR(IndexIVFFlat)
-FAISS_DECLARE_INDEX_DOWNCAST(IndexIVFFlat)
-
-int faiss_IndexIVFFlat_new(FaissIndexIVFFlat** p_index);
-
-int faiss_IndexIVFFlat_new_with(FaissIndexIVFFlat** p_index,
-    FaissIndex* quantizer, size_t d, size_t nlist);
-
-int faiss_IndexIVFFlat_new_with_metric(
-    FaissIndexIVFFlat** p_index, FaissIndex* quantizer, size_t d, size_t nlist,
-    FaissMetricType metric);
-
-int faiss_IndexIVFFlat_add_core(FaissIndexIVFFlat* index, idx_t n, 
-    const float * x, const idx_t *xids, const int64_t *precomputed_idx);
-
-/** Update a subset of vectors.
- *
- * The index must have a direct_map
- *
- * @param nv     nb of vectors to update
- * @param idx    vector indices to update, size nv
- * @param v      vectors of new values, size nv*d
- */
-int faiss_IndexIVFFlat_update_vectors(FaissIndexIVFFlat* index, int nv,
-    idx_t *idx, const float *v);
-
-#ifdef __cplusplus
-}
-#endif
-
-
-#endif

data/vendor/faiss/c_api/IndexIVF_c.cpp

@@ -1,99 +0,0 @@
-/**
- * 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.
- */
-
-// Copyright 2004-present Facebook. All Rights Reserved.
-// -*- c++ -*-
-
-#include "Index_c.h"
-#include "Clustering_c.h"
-#include "IndexIVF_c.h"
-#include "IndexIVF.h"
-#include "macros_impl.h"
-
-using faiss::IndexIVF;
-using faiss::IndexIVFStats;
-
-DEFINE_DESTRUCTOR(IndexIVF)
-DEFINE_INDEX_DOWNCAST(IndexIVF)
-
-/// number of possible key values
-DEFINE_GETTER(IndexIVF, size_t, nlist)
-/// number of probes at query time
-DEFINE_GETTER(IndexIVF, size_t, nprobe)
-/// quantizer that maps vectors to inverted lists
-DEFINE_GETTER_PERMISSIVE(IndexIVF, FaissIndex*, quantizer)
-
-/**
- * = 0: use the quantizer as index in a kmeans training
- * = 1: just pass on the training set to the train() of the quantizer
- * = 2: kmeans training on a flat index + add the centroids to the quantizer
- */
-DEFINE_GETTER(IndexIVF, char, quantizer_trains_alone)
-
-/// whether object owns the quantizer
-DEFINE_GETTER(IndexIVF, int, own_fields)
-
-using faiss::IndexIVF;
-
-int faiss_IndexIVF_merge_from(
-    FaissIndexIVF* index, FaissIndexIVF* other, idx_t add_id) {
-    try {
-        reinterpret_cast<IndexIVF*>(index)->merge_from(
-            *reinterpret_cast<IndexIVF*>(other), add_id);
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexIVF_copy_subset_to(
-    const FaissIndexIVF* index, FaissIndexIVF* other, int subset_type, idx_t a1,
-    idx_t a2) {
-    try {
-        reinterpret_cast<const IndexIVF*>(index)->copy_subset_to(
-            *reinterpret_cast<IndexIVF*>(other), subset_type, a1, a2);
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexIVF_search_preassigned (const FaissIndexIVF* index,
-    idx_t n, const float *x, idx_t k, const idx_t *assign,
-    const float *centroid_dis, float *distances, idx_t *labels,
-    int store_pairs) {
-    try {
-        reinterpret_cast<const IndexIVF*>(index)->search_preassigned(
-            n, x, k, assign, centroid_dis, distances, labels, store_pairs);
-   } CATCH_AND_HANDLE
-}
-
-size_t faiss_IndexIVF_get_list_size(const FaissIndexIVF* index, size_t list_no) {
-    return reinterpret_cast<const IndexIVF*>(index)->get_list_size(list_no);
-}
-
-int faiss_IndexIVF_make_direct_map(FaissIndexIVF* index,
-    int new_maintain_direct_map) {
-    try {
-        reinterpret_cast<IndexIVF*>(index)->make_direct_map(
-            static_cast<bool>(new_maintain_direct_map));
-    } CATCH_AND_HANDLE
-}
-
-double faiss_IndexIVF_imbalance_factor (const FaissIndexIVF* index) {
-    return reinterpret_cast<const IndexIVF*>(index)->invlists->imbalance_factor();
-}
-
-/// display some stats about the inverted lists
-void faiss_IndexIVF_print_stats (const FaissIndexIVF* index) {
-    reinterpret_cast<const IndexIVF*>(index)->invlists->print_stats();
-}
-
-/// get inverted lists ids
-void faiss_IndexIVF_invlists_get_ids (const FaissIndexIVF* index, size_t list_no, idx_t* invlist) {
-    const idx_t* list = reinterpret_cast<const IndexIVF*>(index)->invlists->get_ids(list_no);
-    size_t list_size = reinterpret_cast<const IndexIVF*>(index)->get_list_size(list_no);
-    memcpy(invlist, list, list_size*sizeof(idx_t));
-}
-
-void faiss_IndexIVFStats_reset(FaissIndexIVFStats* stats) {
-    reinterpret_cast<IndexIVFStats*>(stats)->reset();    
-}

data/vendor/faiss/c_api/IndexIVF_c.h

@@ -1,142 +0,0 @@
-/**
- * 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.
- */
-
-// Copyright 2004-present Facebook. All Rights Reserved.
-// -*- c -*-
-
-#ifndef FAISS_INDEX_IVF_C_H
-#define FAISS_INDEX_IVF_C_H
-
-#include "faiss_c.h"
-#include "Index_c.h"
-#include "Clustering_c.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/** Index based on a inverted file (IVF)
- *
- * In the inverted file, the quantizer (an Index instance) provides a
- * quantization index for each vector to be added. The quantization
- * index maps to a list (aka inverted list or posting list), where the
- * id of the vector is then stored.
- *
- * At search time, the vector to be searched is also quantized, and
- * only the list corresponding to the quantization index is
- * searched. This speeds up the search by making it
- * non-exhaustive. This can be relaxed using multi-probe search: a few
- * (nprobe) quantization indices are selected and several inverted
- * lists are visited.
- *
- * Sub-classes implement a post-filtering of the index that refines
- * the distance estimation from the query to databse vectors.
- */
-FAISS_DECLARE_CLASS_INHERITED(IndexIVF, Index)
-FAISS_DECLARE_DESTRUCTOR(IndexIVF)
-FAISS_DECLARE_INDEX_DOWNCAST(IndexIVF)
-
-/// number of possible key values
-FAISS_DECLARE_GETTER(IndexIVF, size_t, nlist)
-/// number of probes at query time
-FAISS_DECLARE_GETTER(IndexIVF, size_t, nprobe)
-/// quantizer that maps vectors to inverted lists
-FAISS_DECLARE_GETTER(IndexIVF, FaissIndex*, quantizer)
-/**
- * = 0: use the quantizer as index in a kmeans training
- * = 1: just pass on the training set to the train() of the quantizer
- * = 2: kmeans training on a flat index + add the centroids to the quantizer
- */
-FAISS_DECLARE_GETTER(IndexIVF, char, quantizer_trains_alone)
-
-/// whether object owns the quantizer
-FAISS_DECLARE_GETTER(IndexIVF, int, own_fields)
-
-/** moves the entries from another dataset to self. On output,
- * other is empty. add_id is added to all moved ids (for
- * sequential ids, this would be this->ntotal */
-int faiss_IndexIVF_merge_from(
-    FaissIndexIVF* index, FaissIndexIVF* other, idx_t add_id);
-
-/** copy a subset of the entries index to the other index
- *
- * if subset_type == 0: copies ids in [a1, a2)
- * if subset_type == 1: copies ids if id % a1 == a2
- * if subset_type == 2: copies inverted lists such that a1
- *                      elements are left before and a2 elements are after
- */
-int faiss_IndexIVF_copy_subset_to(
-    const FaissIndexIVF* index, FaissIndexIVF* other, int subset_type, idx_t a1,
-    idx_t a2);
-
-/** search a set of vectors, that are pre-quantized by the IVF
- *  quantizer. Fill in the corresponding heaps with the query
- *  results. search() calls this.
- *
- * @param n      nb of vectors to query
- * @param x      query vectors, size nx * d
- * @param assign coarse quantization indices, size nx * nprobe
- * @param centroid_dis
- *               distances to coarse centroids, size nx * nprobe
- * @param distance
- *               output distances, size n * k
- * @param labels output labels, size n * k
- * @param store_pairs store inv list index + inv list offset
- *                     instead in upper/lower 32 bit of result,
- *                     instead of ids (used for reranking).
- */
-int faiss_IndexIVF_search_preassigned (const FaissIndexIVF* index,
-    idx_t n, const float *x, idx_t k, const idx_t *assign,
-    const float *centroid_dis, float *distances, idx_t *labels,
-    int store_pairs);
-
-size_t faiss_IndexIVF_get_list_size(const FaissIndexIVF* index,
-    size_t list_no);
-
-/** intialize a direct map
- *
- * @param new_maintain_direct_map    if true, create a direct map,
- *                                   else clear it
- */
-int faiss_IndexIVF_make_direct_map(FaissIndexIVF* index,
-    int new_maintain_direct_map);
-
-/** Check the inverted lists' imbalance factor.
- *
- * 1= perfectly balanced, >1: imbalanced
- */
-double faiss_IndexIVF_imbalance_factor (const FaissIndexIVF* index);
-
-/// display some stats about the inverted lists of the index
-void faiss_IndexIVF_print_stats (const FaissIndexIVF* index);
-
-/// Get the IDs in an inverted list. IDs are written to `invlist`, which must be large enough
-//// to accommodate the full list.
-///
-/// @param list_no the list ID
-/// @param invlist output pointer to a slice of memory, at least as long as the list's size
-/// @see faiss_IndexIVF_get_list_size(size_t) 
-void faiss_IndexIVF_invlists_get_ids (const FaissIndexIVF* index, size_t list_no, idx_t* invlist);
-
-typedef struct FaissIndexIVFStats {
-    size_t nq;       // nb of queries run
-    size_t nlist;    // nb of inverted lists scanned
-    size_t ndis;     // nb of distancs computed
-} FaissIndexIVFStats;
-
-void faiss_IndexIVFStats_reset(FaissIndexIVFStats* stats);
-
-inline void faiss_IndexIVFStats_init(FaissIndexIVFStats* stats) {
-    faiss_IndexIVFStats_reset(stats);
-}
-
-#ifdef __cplusplus
-}
-#endif
-
-
-#endif