| 1 |
/* |
| 2 |
* Copyright (c) Meta Platforms, Inc. and affiliates. |
| 3 |
* |
| 4 |
* This source code is licensed under the MIT license found in the |
| 5 |
* LICENSE file in the root directory of this source tree. |
| 6 |
*/ |
| 7 |
|
| 8 |
// -*- c -*- |
| 9 |
|
| 10 |
#include <stdio.h> |
| 11 |
#include <stdlib.h> |
| 12 |
#include <time.h> |
| 13 |
|
| 14 |
#include "AutoTune_c.h" |
| 15 |
#include "IndexFlat_c.h" |
| 16 |
#include "Index_c.h" |
| 17 |
#include "clone_index_c.h" |
| 18 |
#include "error_c.h" |
| 19 |
#include "impl/AuxIndexStructures_c.h" |
| 20 |
#include "index_factory_c.h" |
| 21 |
#include "index_io_c.h" |
| 22 |
|
| 23 |
#define FAISS_TRY(C) \ |
| 24 |
{ \ |
| 25 |
if (C) { \ |
| 26 |
fprintf(stderr, "%s", faiss_get_last_error()); \ |
| 27 |
exit(-1); \ |
| 28 |
} \ |
| 29 |
} |
| 30 |
|
| 31 |
double drand() { |
| 32 |
return (double)rand() / (double)RAND_MAX; |
| 33 |
} |
| 34 |
|
| 35 |
int main() { |
| 36 |
time_t seed = time(NULL); |
| 37 |
srand(seed); |
| 38 |
printf("Generating some data...\n"); |
| 39 |
int d = 128; // dimension |
| 40 |
int nb = 100000; // database size |
| 41 |
int nq = 10000; // nb of queries |
| 42 |
float* xb = malloc(d * nb * sizeof(float)); |
| 43 |
float* xq = malloc(d * nq * sizeof(float)); |
| 44 |
|
| 45 |
for (int i = 0; i < nb; i++) { |
| 46 |
for (int j = 0; j < d; j++) |
| 47 |
xb[d * i + j] = drand(); |
| 48 |
xb[d * i] += i / 1000.; |
| 49 |
} |
| 50 |
for (int i = 0; i < nq; i++) { |
| 51 |
for (int j = 0; j < d; j++) |
| 52 |
xq[d * i + j] = drand(); |
| 53 |
xq[d * i] += i / 1000.; |
| 54 |
} |
| 55 |
|
| 56 |
printf("Building an index...\n"); |
| 57 |
|
| 58 |
FaissIndex* index = NULL; |
| 59 |
FAISS_TRY(faiss_index_factory( |
| 60 |
&index, d, "Flat", METRIC_L2)); // use factory to create index |
| 61 |
printf("is_trained = %s\n", |
| 62 |
faiss_Index_is_trained(index) ? "true" : "false"); |
| 63 |
FAISS_TRY(faiss_Index_add(index, nb, xb)); // add vectors to the index |
| 64 |
printf("ntotal = %lld\n", faiss_Index_ntotal(index)); |
| 65 |
|
| 66 |
printf("Searching...\n"); |
| 67 |
int k = 5; |
| 68 |
|
| 69 |
{ // sanity check: search 5 first vectors of xb |
| 70 |
idx_t* I = malloc(k * 5 * sizeof(idx_t)); |
| 71 |
float* D = malloc(k * 5 * sizeof(float)); |
| 72 |
FAISS_TRY(faiss_Index_search(index, 5, xb, k, D, I)); |
| 73 |
printf("I=\n"); |
| 74 |
for (int i = 0; i < 5; i++) { |
| 75 |
for (int j = 0; j < k; j++) |
| 76 |
printf("%5lld (d=%2.3f) ", I[i * k + j], D[i * k + j]); |
| 77 |
printf("\n"); |
| 78 |
} |
| 79 |
free(I); |
| 80 |
free(D); |
| 81 |
} |
| 82 |
{ // search xq |
| 83 |
idx_t* I = malloc(k * nq * sizeof(idx_t)); |
| 84 |
float* D = malloc(k * nq * sizeof(float)); |
| 85 |
FAISS_TRY(faiss_Index_search(index, nq, xq, k, D, I)); |
| 86 |
printf("I=\n"); |
| 87 |
for (int i = 0; i < 5; i++) { |
| 88 |
for (int j = 0; j < k; j++) |
| 89 |
printf("%5lld (d=%2.3f) ", I[i * k + j], D[i * k + j]); |
| 90 |
printf("\n"); |
| 91 |
} |
| 92 |
free(I); |
| 93 |
free(D); |
| 94 |
} |
| 95 |
{ // search xb first 5 but search parameters of id range [50, 100] |
| 96 |
idx_t* I = malloc(k * nq * sizeof(idx_t)); |
| 97 |
float* D = malloc(k * nq * sizeof(float)); |
| 98 |
FaissIDSelectorRange* sel = NULL; |
| 99 |
FAISS_TRY(faiss_IDSelectorRange_new(&sel, 50, 100)); |
| 100 |
FaissSearchParameters* params = NULL; |
| 101 |
FAISS_TRY(faiss_SearchParameters_new(¶ms, sel)); |
| 102 |
FAISS_TRY( |
| 103 |
faiss_Index_search_with_params(index, nq, xq, k, params, D, I)); |
| 104 |
printf("Searching w/ IDSelectorRange [50,100]\n"); |
| 105 |
printf("I=\n"); |
| 106 |
for (int i = 0; i < 5; i++) { |
| 107 |
for (int j = 0; j < k; j++) |
| 108 |
printf("%5lld (d=%2.3f) ", I[i * k + j], D[i * k + j]); |
| 109 |
printf("\n"); |
| 110 |
} |
| 111 |
free(I); |
| 112 |
free(D); |
| 113 |
faiss_SearchParameters_free(params); |
| 114 |
faiss_IDSelectorRange_free(sel); |
| 115 |
} |
| 116 |
|
| 117 |
{ // search xb first 5 but search parameters of id range [20,40] OR |
| 118 |
// [45,60] |
| 119 |
idx_t* I = malloc(k * nq * sizeof(idx_t)); |
| 120 |
float* D = malloc(k * nq * sizeof(float)); |
| 121 |
FaissIDSelectorRange* lhs_sel = NULL; |
| 122 |
FAISS_TRY(faiss_IDSelectorRange_new(&lhs_sel, 20, 40)); |
| 123 |
FaissIDSelectorRange* rhs_sel = NULL; |
| 124 |
FAISS_TRY(faiss_IDSelectorRange_new(&rhs_sel, 45, 60)); |
| 125 |
FaissIDSelectorOr* sel = NULL; |
| 126 |
FAISS_TRY(faiss_IDSelectorOr_new(&sel, lhs_sel, rhs_sel)); |
| 127 |
FaissSearchParameters* params = NULL; |
| 128 |
FAISS_TRY(faiss_SearchParameters_new(¶ms, sel)); |
| 129 |
FAISS_TRY( |
| 130 |
faiss_Index_search_with_params(index, nq, xq, k, params, D, I)); |
| 131 |
printf("Searching w/ IDSelectorRange [20,40] OR [45,60] \n"); |
| 132 |
printf("I=\n"); |
| 133 |
for (int i = 0; i < 5; i++) { |
| 134 |
for (int j = 0; j < k; j++) |
| 135 |
printf("%5lld (d=%2.3f) ", I[i * k + j], D[i * k + j]); |
| 136 |
printf("\n"); |
| 137 |
} |
| 138 |
free(I); |
| 139 |
free(D); |
| 140 |
faiss_SearchParameters_free(params); |
| 141 |
faiss_IDSelectorRange_free(lhs_sel); |
| 142 |
faiss_IDSelectorRange_free(rhs_sel); |
| 143 |
faiss_IDSelector_free(sel); |
| 144 |
} |
| 145 |
{ // search xb first 5 but search parameters of id range [20,40] AND |
| 146 |
// [15,35] = [20,35] |
| 147 |
idx_t* I = malloc(k * nq * sizeof(idx_t)); |
| 148 |
float* D = malloc(k * nq * sizeof(float)); |
| 149 |
FaissIDSelectorRange* lhs_sel = NULL; |
| 150 |
FAISS_TRY(faiss_IDSelectorRange_new(&lhs_sel, 20, 40)); |
| 151 |
FaissIDSelectorRange* rhs_sel = NULL; |
| 152 |
FAISS_TRY(faiss_IDSelectorRange_new(&rhs_sel, 15, 35)); |
| 153 |
FaissIDSelectorAnd* sel = NULL; |
| 154 |
FAISS_TRY(faiss_IDSelectorAnd_new(&sel, lhs_sel, rhs_sel)); |
| 155 |
FaissSearchParameters* params = NULL; |
| 156 |
FAISS_TRY(faiss_SearchParameters_new(¶ms, sel)); |
| 157 |
FAISS_TRY( |
| 158 |
faiss_Index_search_with_params(index, nq, xq, k, params, D, I)); |
| 159 |
printf("Searching w/ IDSelectorRange [20,40] AND [15,35] = [20,35]\n"); |
| 160 |
printf("I=\n"); |
| 161 |
for (int i = 0; i < 5; i++) { |
| 162 |
for (int j = 0; j < k; j++) |
| 163 |
printf("%5lld (d=%2.3f) ", I[i * k + j], D[i * k + j]); |
| 164 |
printf("\n"); |
| 165 |
} |
| 166 |
free(I); |
| 167 |
free(D); |
| 168 |
faiss_SearchParameters_free(params); |
| 169 |
faiss_IDSelectorRange_free(lhs_sel); |
| 170 |
faiss_IDSelectorRange_free(rhs_sel); |
| 171 |
faiss_IDSelector_free(sel); |
| 172 |
} |
| 173 |
|
| 174 |
printf("Saving index to disk...\n"); |
| 175 |
FAISS_TRY(faiss_write_index_fname(index, "example.index")); |
| 176 |
|
| 177 |
printf("Freeing index...\n"); |
| 178 |
faiss_Index_free(index); |
| 179 |
printf("Done.\n"); |
| 180 |
|
| 181 |
return 0; |
| 182 |
} |