faiss 0.1.3 → 0.1.4

data/vendor/faiss/c_api/AutoTune_c.h

@@ -1,66 +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_AUTO_TUNE_C_H
-#define FAISS_AUTO_TUNE_C_H
-
-#include "faiss_c.h"
-#include "Index_c.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/// possible values of a parameter, sorted from least to most expensive/accurate
-FAISS_DECLARE_CLASS(ParameterRange)
-
-FAISS_DECLARE_GETTER(ParameterRange, const char*, name)
-
-/// Getter for the values in the range. The output values are invalidated
-/// upon any other modification of the range.
-void faiss_ParameterRange_values(FaissParameterRange*, double**, size_t*);
-
-/** Uses a-priori knowledge on the Faiss indexes to extract tunable parameters.
- */
-FAISS_DECLARE_CLASS(ParameterSpace)
-
-FAISS_DECLARE_DESTRUCTOR(ParameterSpace)
-
-/// Parameter space default constructor
-int faiss_ParameterSpace_new(FaissParameterSpace** space);
-
-/// nb of combinations, = product of values sizes
-size_t faiss_ParameterSpace_n_combinations(const FaissParameterSpace*);
-
-/// get string representation of the combination
-/// by writing it to the given character buffer.
-/// A buffer size of 1000 ensures that the full name is collected.
-int faiss_ParameterSpace_combination_name(const FaissParameterSpace*, size_t, char*, size_t);
-
-/// set a combination of parameters described by a string
-int faiss_ParameterSpace_set_index_parameters(const FaissParameterSpace*, FaissIndex*, const char *);
-
-/// set a combination of parameters on an index
-int faiss_ParameterSpace_set_index_parameters_cno(const FaissParameterSpace*, FaissIndex*, size_t);
-
-/// set one of the parameters
-int faiss_ParameterSpace_set_index_parameter(const FaissParameterSpace*, FaissIndex*, const char *, double);
-
-/// print a description on stdout
-void faiss_ParameterSpace_display(const FaissParameterSpace*);
-
-/// add a new parameter (or return it if it exists)
-int faiss_ParameterSpace_add_range(FaissParameterSpace*, const char*, FaissParameterRange**);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif

data/vendor/faiss/c_api/Clustering_c.cpp

@@ -1,145 +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 "Clustering_c.h"
-#include "Clustering.h"
-#include "Index.h"
-#include <vector>
-#include "macros_impl.h"
-
-extern "C" {
-
-using faiss::Clustering;
-using faiss::ClusteringParameters;
-using faiss::Index;
-using faiss::ClusteringIterationStats;
-
-DEFINE_GETTER(Clustering, int, niter)
-DEFINE_GETTER(Clustering, int, nredo)
-DEFINE_GETTER(Clustering, int, verbose)
-DEFINE_GETTER(Clustering, int, spherical)
-DEFINE_GETTER(Clustering, int, update_index)
-DEFINE_GETTER(Clustering, int, frozen_centroids)
-
-DEFINE_GETTER(Clustering, int, min_points_per_centroid)
-DEFINE_GETTER(Clustering, int, max_points_per_centroid)
-
-DEFINE_GETTER(Clustering, int, seed)
-
-/// getter for d
-DEFINE_GETTER(Clustering, size_t, d)
-
-/// getter for k
-DEFINE_GETTER(Clustering, size_t, k)
-
-DEFINE_GETTER(ClusteringIterationStats, float, obj)
-DEFINE_GETTER(ClusteringIterationStats, double, time)
-DEFINE_GETTER(ClusteringIterationStats, double, time_search)
-DEFINE_GETTER(ClusteringIterationStats, double, imbalance_factor)
-DEFINE_GETTER(ClusteringIterationStats, int, nsplit)
-
-void faiss_ClusteringParameters_init(FaissClusteringParameters* params) {
-    ClusteringParameters d;
-    params->frozen_centroids = d.frozen_centroids;
-    params->max_points_per_centroid = d.max_points_per_centroid;
-    params->min_points_per_centroid = d.min_points_per_centroid;
-    params->niter = d.niter;
-    params->nredo = d.nredo;
-    params->seed = d.seed;
-    params->spherical = d.spherical;
-    params->update_index = d.update_index;
-    params->verbose = d.verbose;   
-}
-
-// This conversion is required because the two types are not memory-compatible
-inline ClusteringParameters from_faiss_c(const FaissClusteringParameters* params) {
-    ClusteringParameters o;
-    o.frozen_centroids = params->frozen_centroids;
-    o.max_points_per_centroid = params->max_points_per_centroid;
-    o.min_points_per_centroid = params->min_points_per_centroid;
-    o.niter = params->niter;
-    o.nredo = params->nredo;
-    o.seed = params->seed;
-    o.spherical = params->spherical;
-    o.update_index = params->update_index;
-    o.verbose = params->verbose;
-    return o;
-}
-
-/// getter for centroids (size = k * d)
-void faiss_Clustering_centroids(
-    FaissClustering* clustering, float** centroids, size_t* size) {
-    std::vector<float>& v = reinterpret_cast<Clustering*>(clustering)->centroids;
-    if (centroids) {
-        *centroids = v.data();
-    }
-    if (size) {
-        *size = v.size();
-    }
-}
-
-/// getter for iteration stats
-void faiss_Clustering_iteration_stats(
-    FaissClustering* clustering, FaissClusteringIterationStats** iteration_stats, size_t* size) {
-    std::vector<ClusteringIterationStats>& v = reinterpret_cast<Clustering*>(clustering)->iteration_stats;
-    if (iteration_stats) {
-        *iteration_stats = reinterpret_cast<FaissClusteringIterationStats*>(v.data());
-    }
-    if (size) {
-        *size = v.size();
-    }
-}
-
-/// the only mandatory parameters are k and d
-int faiss_Clustering_new(FaissClustering** p_clustering, int d, int k) {
-    try {
-        Clustering* c = new Clustering(d, k);
-        *p_clustering = reinterpret_cast<FaissClustering*>(c);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_Clustering_new_with_params(
-    FaissClustering** p_clustering, int d, int k, const FaissClusteringParameters* cp) {
-    try {
-        Clustering* c = new Clustering(d, k, from_faiss_c(cp));
-        *p_clustering = reinterpret_cast<FaissClustering*>(c);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-/// Index is used during the assignment stage
-int faiss_Clustering_train(
-    FaissClustering* clustering, idx_t n, const float* x, FaissIndex* index) {
-    try {
-        reinterpret_cast<Clustering*>(clustering)->train(
-            n, x, *reinterpret_cast<Index*>(index));
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-void faiss_Clustering_free(FaissClustering* clustering) {
-    delete reinterpret_cast<Clustering*>(clustering);
-}
-
-int faiss_kmeans_clustering (size_t d, size_t n, size_t k,
-                             const float *x,
-                             float *centroids,
-                             float *q_error) {
-    try {
-        float out = faiss::kmeans_clustering(d, n, k, x, centroids);
-        if (q_error) {
-            *q_error = out;
-        }
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-}

data/vendor/faiss/c_api/Clustering_c.h

@@ -1,123 +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_CLUSTERING_C_H
-#define FAISS_CLUSTERING_C_H
-
-#include "Index_c.h"
-#include "faiss_c.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/** Class for the clustering parameters. Can be passed to the
- * constructor of the Clustering object.
- */
-typedef struct FaissClusteringParameters {
-    int niter;          ///< clustering iterations
-    int nredo;          ///< redo clustering this many times and keep best
-
-    int verbose;       ///< (bool)
-    int spherical;     ///< (bool) do we want normalized centroids?
-    int update_index;  ///< (bool) update index after each iteration?
-    int frozen_centroids;  ///< (bool) use the centroids provided as input and do not change them during iterations
-
-    int min_points_per_centroid; ///< otherwise you get a warning
-    int max_points_per_centroid;  ///< to limit size of dataset
-
-    int seed; ///< seed for the random number generator
-} FaissClusteringParameters;
-
-
-/// Sets the ClusteringParameters object with reasonable defaults
-void faiss_ClusteringParameters_init(FaissClusteringParameters* params);
-
-
-/** clustering based on assignment - centroid update iterations
- *
- * The clustering is based on an Index object that assigns training
- * points to the centroids. Therefore, at each iteration the centroids
- * are added to the index.
- *
- * On output, the centroids table is set to the latest version
- * of the centroids and they are also added to the index. If the
- * centroids table it is not empty on input, it is also used for
- * initialization.
- *
- * To do several clusterings, just call train() several times on
- * different training sets, clearing the centroid table in between.
- */
-FAISS_DECLARE_CLASS(Clustering)
-
-FAISS_DECLARE_GETTER(Clustering, int, niter)
-FAISS_DECLARE_GETTER(Clustering, int, nredo)
-FAISS_DECLARE_GETTER(Clustering, int, verbose)
-FAISS_DECLARE_GETTER(Clustering, int, spherical)
-FAISS_DECLARE_GETTER(Clustering, int, update_index)
-FAISS_DECLARE_GETTER(Clustering, int, frozen_centroids)
-
-FAISS_DECLARE_GETTER(Clustering, int, min_points_per_centroid)
-FAISS_DECLARE_GETTER(Clustering, int, max_points_per_centroid)
-
-FAISS_DECLARE_GETTER(Clustering, int, seed)
-
-/// getter for d
-FAISS_DECLARE_GETTER(Clustering, size_t, d)
-
-/// getter for k
-FAISS_DECLARE_GETTER(Clustering, size_t, k)
-
-FAISS_DECLARE_CLASS(ClusteringIterationStats)
-FAISS_DECLARE_GETTER(ClusteringIterationStats, float, obj)
-FAISS_DECLARE_GETTER(ClusteringIterationStats, double, time)
-FAISS_DECLARE_GETTER(ClusteringIterationStats, double, time_search)
-FAISS_DECLARE_GETTER(ClusteringIterationStats, double, imbalance_factor)
-FAISS_DECLARE_GETTER(ClusteringIterationStats, int, nsplit)
-
-/// getter for centroids (size = k * d)
-void faiss_Clustering_centroids(
-    FaissClustering* clustering, float** centroids, size_t* size);
-
-/// getter for iteration stats
-void faiss_Clustering_iteration_stats(
-    FaissClustering* clustering, FaissClusteringIterationStats** iteration_stats, size_t* size);
-
-/// the only mandatory parameters are k and d
-int faiss_Clustering_new(FaissClustering** p_clustering, int d, int k);
-
-int faiss_Clustering_new_with_params(
-    FaissClustering** p_clustering, int d, int k, const FaissClusteringParameters* cp);
-
-int faiss_Clustering_train(
-    FaissClustering* clustering, idx_t n, const float* x, FaissIndex* index);
-
-void faiss_Clustering_free(FaissClustering* clustering);
-
-/** simplified interface
- *
- * @param d dimension of the data
- * @param n nb of training vectors
- * @param k nb of output centroids
- * @param x training set (size n * d)
- * @param centroids output centroids (size k * d)
- * @param q_error final quantization error
- * @return error code
- */
-int faiss_kmeans_clustering (size_t d, size_t n, size_t k,
-                       const float *x,
-                       float *centroids,
-                       float *q_error);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif

data/vendor/faiss/c_api/IndexFlat_c.cpp

@@ -1,140 +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 "IndexFlat_c.h"
-#include "IndexFlat.h"
-#include "Index.h"
-#include "macros_impl.h"
-
-extern "C" {
-
-using faiss::Index;
-using faiss::IndexFlat;
-using faiss::IndexFlatIP;
-using faiss::IndexFlatL2;
-using faiss::IndexFlatL2BaseShift;
-using faiss::IndexRefineFlat;
-using faiss::IndexFlat1D;
-
-DEFINE_DESTRUCTOR(IndexFlat)
-DEFINE_INDEX_DOWNCAST(IndexFlat)
-
-int faiss_IndexFlat_new(FaissIndexFlat** p_index) {
-    try {
-        *p_index = reinterpret_cast<FaissIndexFlat*>(new IndexFlat());
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexFlat_new_with(FaissIndexFlat** p_index, idx_t d, FaissMetricType metric) {
-    try {
-        IndexFlat* index = new IndexFlat(d, static_cast<faiss::MetricType>(metric));
-        *p_index = reinterpret_cast<FaissIndexFlat*>(index);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-void faiss_IndexFlat_xb(FaissIndexFlat* index, float** p_xb, size_t* p_size) {
-    auto& xb = reinterpret_cast<IndexFlat*>(index)->xb;
-    *p_xb = xb.data();
-    if (p_size) {
-        *p_size = xb.size();
-    }
-}
-
-int faiss_IndexFlat_compute_distance_subset(
-    FaissIndex* index,
-    idx_t n,
-    const float *x,
-    idx_t k,
-    float *distances,
-    const idx_t *labels) {
-    try {
-        reinterpret_cast<IndexFlat*>(index)->compute_distance_subset(
-            n, x, k, distances, labels);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexFlatIP_new(FaissIndexFlatIP** p_index) {
-    try {
-        IndexFlatIP* index = new IndexFlatIP();
-        *p_index = reinterpret_cast<FaissIndexFlatIP*>(index);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexFlatIP_new_with(FaissIndexFlatIP** p_index, idx_t d) {
-    try {
-        IndexFlatIP* index = new IndexFlatIP(d);
-        *p_index = reinterpret_cast<FaissIndexFlatIP*>(index);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexFlatL2_new(FaissIndexFlatL2** p_index) {
-    try {
-        IndexFlatL2* index = new IndexFlatL2();
-        *p_index = reinterpret_cast<FaissIndexFlatL2*>(index);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexFlatL2_new_with(FaissIndexFlatL2** p_index, idx_t d) {
-    try {
-        IndexFlatL2* index = new IndexFlatL2(d);
-        *p_index = reinterpret_cast<FaissIndexFlatL2*>(index);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexFlatL2BaseShift_new(FaissIndexFlatL2BaseShift** p_index, idx_t d, size_t nshift, const float *shift) {
-    try {
-        IndexFlatL2BaseShift* index = new IndexFlatL2BaseShift(d, nshift, shift);
-        *p_index = reinterpret_cast<FaissIndexFlatL2BaseShift*>(index);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexRefineFlat_new(FaissIndexRefineFlat** p_index, FaissIndex* base_index) {
-    try {
-        IndexRefineFlat* index = new IndexRefineFlat(
-            reinterpret_cast<faiss::Index*>(base_index));
-        *p_index = reinterpret_cast<FaissIndexRefineFlat*>(index);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-DEFINE_DESTRUCTOR(IndexRefineFlat)
-
-int faiss_IndexFlat1D_new(FaissIndexFlat1D** p_index) {
-    try {
-        IndexFlat1D* index = new IndexFlat1D();
-        *p_index = reinterpret_cast<FaissIndexFlat1D*>(index);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexFlat1D_new_with(FaissIndexFlat1D** p_index, int continuous_update) {
-    try {
-        IndexFlat1D* index = new IndexFlat1D(static_cast<bool>(continuous_update));
-        *p_index = reinterpret_cast<FaissIndexFlat1D*>(index);
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-int faiss_IndexFlat1D_update_permutation(FaissIndexFlat1D* index) {
-    try {
-        reinterpret_cast<IndexFlat1D*>(index)->update_permutation();
-        return 0;
-    } CATCH_AND_HANDLE
-}
-
-}