faiss 0.2.0 → 0.2.1

data/vendor/faiss/faiss/impl/index_write.cpp

@@ -9,11 +9,14 @@
 
 #include <faiss/index_io.h>
 
+#include <faiss/impl/io.h>
+#include <faiss/impl/io_macros.h>
+
 #include <cstdio>
 #include <cstdlib>
 
-#include <sys/types.h>
 #include <sys/stat.h>
+#include <sys/types.h>
 
 #include <faiss/invlists/InvertedListsIOHook.h>
 
@@ -22,30 +25,32 @@
 #include <faiss/impl/io_macros.h>
 #include <faiss/utils/hamming.h>
 
+#include <faiss/Index2Layer.h>
 #include <faiss/IndexFlat.h>
-#include <faiss/VectorTransform.h>
-#include <faiss/IndexPreTransform.h>
-#include <faiss/IndexLSH.h>
-#include <faiss/IndexPQ.h>
+#include <faiss/IndexHNSW.h>
 #include <faiss/IndexIVF.h>
+#include <faiss/IndexIVFFlat.h>
 #include <faiss/IndexIVFPQ.h>
+#include <faiss/IndexIVFPQFastScan.h>
 #include <faiss/IndexIVFPQR.h>
-#include <faiss/Index2Layer.h>
-#include <faiss/IndexIVFFlat.h>
 #include <faiss/IndexIVFSpectralHash.h>
-#include <faiss/MetaIndexes.h>
-#include <faiss/IndexScalarQuantizer.h>
-#include <faiss/IndexHNSW.h>
+#include <faiss/IndexLSH.h>
 #include <faiss/IndexLattice.h>
+#include <faiss/IndexNSG.h>
+#include <faiss/IndexPQ.h>
 #include <faiss/IndexPQFastScan.h>
-#include <faiss/IndexIVFPQFastScan.h>
+#include <faiss/IndexPreTransform.h>
 #include <faiss/IndexRefine.h>
+#include <faiss/IndexResidual.h>
+#include <faiss/IndexScalarQuantizer.h>
+#include <faiss/MetaIndexes.h>
+#include <faiss/VectorTransform.h>
 
 #include <faiss/IndexBinaryFlat.h>
 #include <faiss/IndexBinaryFromFloat.h>
 #include <faiss/IndexBinaryHNSW.h>
-#include <faiss/IndexBinaryIVF.h>
 #include <faiss/IndexBinaryHash.h>
+#include <faiss/IndexBinaryIVF.h>
 
 /*************************************************************
  * The I/O format is the content of the class. For objects that are
@@ -68,112 +73,120 @@
 
 namespace faiss {
 
-
 /*************************************************************
  * Write
  **************************************************************/
-static void write_index_header (const Index *idx, IOWriter *f) {
-    WRITE1 (idx->d);
-    WRITE1 (idx->ntotal);
+static void write_index_header(const Index* idx, IOWriter* f) {
+    WRITE1(idx->d);
+    WRITE1(idx->ntotal);
     Index::idx_t dummy = 1 << 20;
-    WRITE1 (dummy);
-    WRITE1 (dummy);
-    WRITE1 (idx->is_trained);
-    WRITE1 (idx->metric_type);
+    WRITE1(dummy);
+    WRITE1(dummy);
+    WRITE1(idx->is_trained);
+    WRITE1(idx->metric_type);
     if (idx->metric_type > 1) {
-        WRITE1 (idx->metric_arg);
+        WRITE1(idx->metric_arg);
     }
 }
 
-void write_VectorTransform (const VectorTransform *vt, IOWriter *f) {
-    if (const LinearTransform * lt =
-           dynamic_cast < const LinearTransform *> (vt)) {
-        if (dynamic_cast<const RandomRotationMatrix *>(lt)) {
-            uint32_t h = fourcc ("rrot");
-            WRITE1 (h);
-        } else if (const PCAMatrix * pca =
-                   dynamic_cast<const PCAMatrix *>(lt)) {
-            uint32_t h = fourcc ("PcAm");
-            WRITE1 (h);
-            WRITE1 (pca->eigen_power);
-            WRITE1 (pca->random_rotation);
-            WRITE1 (pca->balanced_bins);
-            WRITEVECTOR (pca->mean);
-            WRITEVECTOR (pca->eigenvalues);
-            WRITEVECTOR (pca->PCAMat);
-        } else if (const ITQMatrix * itqm =
-                   dynamic_cast<const ITQMatrix *>(lt)) {
-            uint32_t h = fourcc ("Viqm");
-            WRITE1 (h);
-            WRITE1 (itqm->max_iter);
-            WRITE1 (itqm->seed);
+void write_VectorTransform(const VectorTransform* vt, IOWriter* f) {
+    if (const LinearTransform* lt = dynamic_cast<const LinearTransform*>(vt)) {
+        if (dynamic_cast<const RandomRotationMatrix*>(lt)) {
+            uint32_t h = fourcc("rrot");
+            WRITE1(h);
+        } else if (const PCAMatrix* pca = dynamic_cast<const PCAMatrix*>(lt)) {
+            uint32_t h = fourcc("PcAm");
+            WRITE1(h);
+            WRITE1(pca->eigen_power);
+            WRITE1(pca->random_rotation);
+            WRITE1(pca->balanced_bins);
+            WRITEVECTOR(pca->mean);
+            WRITEVECTOR(pca->eigenvalues);
+            WRITEVECTOR(pca->PCAMat);
+        } else if (const ITQMatrix* itqm = dynamic_cast<const ITQMatrix*>(lt)) {
+            uint32_t h = fourcc("Viqm");
+            WRITE1(h);
+            WRITE1(itqm->max_iter);
+            WRITE1(itqm->seed);
         } else {
             // generic LinearTransform (includes OPQ)
-            uint32_t h = fourcc ("LTra");
-            WRITE1 (h);
+            uint32_t h = fourcc("LTra");
+            WRITE1(h);
         }
-        WRITE1 (lt->have_bias);
-        WRITEVECTOR (lt->A);
-        WRITEVECTOR (lt->b);
-    } else if (const RemapDimensionsTransform *rdt =
-               dynamic_cast<const RemapDimensionsTransform *>(vt)) {
-        uint32_t h = fourcc ("RmDT");
-        WRITE1 (h);
-        WRITEVECTOR (rdt->map);
-    } else if (const NormalizationTransform *nt =
-               dynamic_cast<const NormalizationTransform *>(vt)) {
-        uint32_t h = fourcc ("VNrm");
-        WRITE1 (h);
-        WRITE1 (nt->norm);
-    } else if (const CenteringTransform *ct =
-               dynamic_cast<const CenteringTransform *>(vt)) {
-        uint32_t h = fourcc ("VCnt");
-        WRITE1 (h);
-        WRITEVECTOR (ct->mean);
-    } else if (const ITQTransform *itqt =
-               dynamic_cast<const ITQTransform*> (vt)) {
-        uint32_t h = fourcc ("Viqt");
-        WRITE1 (h);
-        WRITEVECTOR (itqt->mean);
-        WRITE1 (itqt->do_pca);
-        write_VectorTransform (&itqt->itq, f);
-        write_VectorTransform (&itqt->pca_then_itq, f);
+        WRITE1(lt->have_bias);
+        WRITEVECTOR(lt->A);
+        WRITEVECTOR(lt->b);
+    } else if (
+            const RemapDimensionsTransform* rdt =
+                    dynamic_cast<const RemapDimensionsTransform*>(vt)) {
+        uint32_t h = fourcc("RmDT");
+        WRITE1(h);
+        WRITEVECTOR(rdt->map);
+    } else if (
+            const NormalizationTransform* nt =
+                    dynamic_cast<const NormalizationTransform*>(vt)) {
+        uint32_t h = fourcc("VNrm");
+        WRITE1(h);
+        WRITE1(nt->norm);
+    } else if (
+            const CenteringTransform* ct =
+                    dynamic_cast<const CenteringTransform*>(vt)) {
+        uint32_t h = fourcc("VCnt");
+        WRITE1(h);
+        WRITEVECTOR(ct->mean);
+    } else if (
+            const ITQTransform* itqt = dynamic_cast<const ITQTransform*>(vt)) {
+        uint32_t h = fourcc("Viqt");
+        WRITE1(h);
+        WRITEVECTOR(itqt->mean);
+        WRITE1(itqt->do_pca);
+        write_VectorTransform(&itqt->itq, f);
+        write_VectorTransform(&itqt->pca_then_itq, f);
     } else {
-        FAISS_THROW_MSG ("cannot serialize this");
+        FAISS_THROW_MSG("cannot serialize this");
     }
     // common fields
-    WRITE1 (vt->d_in);
-    WRITE1 (vt->d_out);
-    WRITE1 (vt->is_trained);
+    WRITE1(vt->d_in);
+    WRITE1(vt->d_out);
+    WRITE1(vt->is_trained);
 }
 
-void write_ProductQuantizer (const ProductQuantizer *pq, IOWriter *f) {
-    WRITE1 (pq->d);
-    WRITE1 (pq->M);
-    WRITE1 (pq->nbits);
-    WRITEVECTOR (pq->centroids);
+void write_ProductQuantizer(const ProductQuantizer* pq, IOWriter* f) {
+    WRITE1(pq->d);
+    WRITE1(pq->M);
+    WRITE1(pq->nbits);
+    WRITEVECTOR(pq->centroids);
 }
 
-static void write_ScalarQuantizer (
-        const ScalarQuantizer *ivsc, IOWriter *f) {
-    WRITE1 (ivsc->qtype);
-    WRITE1 (ivsc->rangestat);
-    WRITE1 (ivsc->rangestat_arg);
-    WRITE1 (ivsc->d);
-    WRITE1 (ivsc->code_size);
-    WRITEVECTOR (ivsc->trained);
+void write_ResidualQuantizer(const ResidualQuantizer* rq, IOWriter* f) {
+    WRITE1(rq->d);
+    WRITE1(rq->M);
+    WRITEVECTOR(rq->nbits);
+    WRITE1(rq->is_trained);
+    WRITE1(rq->train_type);
+    WRITE1(rq->max_beam_size);
+    WRITEVECTOR(rq->codebooks);
 }
 
-void write_InvertedLists (const InvertedLists *ils, IOWriter *f) {
+static void write_ScalarQuantizer(const ScalarQuantizer* ivsc, IOWriter* f) {
+    WRITE1(ivsc->qtype);
+    WRITE1(ivsc->rangestat);
+    WRITE1(ivsc->rangestat_arg);
+    WRITE1(ivsc->d);
+    WRITE1(ivsc->code_size);
+    WRITEVECTOR(ivsc->trained);
+}
+
+void write_InvertedLists(const InvertedLists* ils, IOWriter* f) {
     if (ils == nullptr) {
-        uint32_t h = fourcc ("il00");
-        WRITE1 (h);
-    } else if (const auto & ails =
-               dynamic_cast<const ArrayInvertedLists *>(ils)) {
-        uint32_t h = fourcc ("ilar");
-        WRITE1 (h);
-        WRITE1 (ails->nlist);
-        WRITE1 (ails->code_size);
+        uint32_t h = fourcc("il00");
+        WRITE1(h);
+    } else if (
+            const auto& ails = dynamic_cast<const ArrayInvertedLists*>(ils)) {
+        uint32_t h = fourcc("ilar");
+        WRITE1(h);
+        WRITE1(ails->nlist);
+        WRITE1(ails->code_size);
         // here we store either as a full or a sparse data buffer
         size_t n_non0 = 0;
         for (size_t i = 0; i < ails->nlist; i++) {
@@ -182,329 +195,401 @@ void write_InvertedLists (const InvertedLists *ils, IOWriter *f) {
         }
         if (n_non0 > ails->nlist / 2) {
             uint32_t list_type = fourcc("full");
-            WRITE1 (list_type);
+            WRITE1(list_type);
             std::vector<size_t> sizes;
             for (size_t i = 0; i < ails->nlist; i++) {
-                sizes.push_back (ails->ids[i].size());
+                sizes.push_back(ails->ids[i].size());
             }
-            WRITEVECTOR (sizes);
+            WRITEVECTOR(sizes);
         } else {
             int list_type = fourcc("sprs"); // sparse
-            WRITE1 (list_type);
+            WRITE1(list_type);
             std::vector<size_t> sizes;
             for (size_t i = 0; i < ails->nlist; i++) {
                 size_t n = ails->ids[i].size();
                 if (n > 0) {
-                    sizes.push_back (i);
-                    sizes.push_back (n);
+                    sizes.push_back(i);
+                    sizes.push_back(n);
                 }
             }
-            WRITEVECTOR (sizes);
+            WRITEVECTOR(sizes);
         }
         // make a single contiguous data buffer (useful for mmapping)
         for (size_t i = 0; i < ails->nlist; i++) {
             size_t n = ails->ids[i].size();
             if (n > 0) {
-                WRITEANDCHECK (ails->codes[i].data(), n * ails->code_size);
-                WRITEANDCHECK (ails->ids[i].data(), n);
+                WRITEANDCHECK(ails->codes[i].data(), n * ails->code_size);
+                WRITEANDCHECK(ails->ids[i].data(), n);
             }
         }
 
     } else {
-        InvertedListsIOHook::lookup_classname(
-                typeid(*ils).name())->write(ils, f);
+        InvertedListsIOHook::lookup_classname(typeid(*ils).name())
+                ->write(ils, f);
     }
 }
 
-
-void write_ProductQuantizer (const ProductQuantizer*pq, const char *fname) {
+void write_ProductQuantizer(const ProductQuantizer* pq, const char* fname) {
     FileIOWriter writer(fname);
-    write_ProductQuantizer (pq, &writer);
+    write_ProductQuantizer(pq, &writer);
 }
 
-static void write_HNSW (const HNSW *hnsw, IOWriter *f) {
+static void write_HNSW(const HNSW* hnsw, IOWriter* f) {
+    WRITEVECTOR(hnsw->assign_probas);
+    WRITEVECTOR(hnsw->cum_nneighbor_per_level);
+    WRITEVECTOR(hnsw->levels);
+    WRITEVECTOR(hnsw->offsets);
+    WRITEVECTOR(hnsw->neighbors);
+
+    WRITE1(hnsw->entry_point);
+    WRITE1(hnsw->max_level);
+    WRITE1(hnsw->efConstruction);
+    WRITE1(hnsw->efSearch);
+    WRITE1(hnsw->upper_beam);
+}
 
-    WRITEVECTOR (hnsw->assign_probas);
-    WRITEVECTOR (hnsw->cum_nneighbor_per_level);
-    WRITEVECTOR (hnsw->levels);
-    WRITEVECTOR (hnsw->offsets);
-    WRITEVECTOR (hnsw->neighbors);
+static void write_NSG(const NSG* nsg, IOWriter* f) {
+    WRITE1(nsg->ntotal);
+    WRITE1(nsg->R);
+    WRITE1(nsg->L);
+    WRITE1(nsg->C);
+    WRITE1(nsg->search_L);
+    WRITE1(nsg->enterpoint);
+    WRITE1(nsg->is_built);
+
+    if (!nsg->is_built) {
+        return;
+    }
 
-    WRITE1 (hnsw->entry_point);
-    WRITE1 (hnsw->max_level);
-    WRITE1 (hnsw->efConstruction);
-    WRITE1 (hnsw->efSearch);
-    WRITE1 (hnsw->upper_beam);
+    constexpr int EMPTY_ID = -1;
+    auto& graph = nsg->final_graph;
+    int K = graph->K;
+    int N = graph->N;
+    FAISS_THROW_IF_NOT(N == nsg->ntotal);
+    FAISS_THROW_IF_NOT(K == nsg->R);
+    FAISS_THROW_IF_NOT(true == graph->own_fields);
+
+    int size = 0;
+    for (int i = 0; i < N; i++) {
+        for (int j = 0; j < K; j++) {
+            int id = graph->at(i, j);
+            if (id != EMPTY_ID) {
+                WRITE1(id);
+                size += 1;
+            } else {
+                break;
+            }
+        }
+        WRITE1(EMPTY_ID);
+    }
 }
 
-static void write_direct_map (const DirectMap *dm, IOWriter *f) {
-    char maintain_direct_map = (char)dm->type; // for backwards compatibility with bool
-    WRITE1 (maintain_direct_map);
-    WRITEVECTOR (dm->array);
+static void write_direct_map(const DirectMap* dm, IOWriter* f) {
+    char maintain_direct_map =
+            (char)dm->type; // for backwards compatibility with bool
+    WRITE1(maintain_direct_map);
+    WRITEVECTOR(dm->array);
     if (dm->type == DirectMap::Hashtable) {
         using idx_t = Index::idx_t;
         std::vector<std::pair<idx_t, idx_t>> v;
-        const std::unordered_map<idx_t, idx_t> & map = dm->hashtable;
-        v.resize (map.size());
+        const std::unordered_map<idx_t, idx_t>& map = dm->hashtable;
+        v.resize(map.size());
         std::copy(map.begin(), map.end(), v.begin());
-        WRITEVECTOR (v);
+        WRITEVECTOR(v);
     }
 }
 
-static void write_ivf_header (const IndexIVF *ivf, IOWriter *f) {
-    write_index_header (ivf, f);
-    WRITE1 (ivf->nlist);
-    WRITE1 (ivf->nprobe);
-    write_index (ivf->quantizer, f);
-    write_direct_map (&ivf->direct_map, f);
+static void write_ivf_header(const IndexIVF* ivf, IOWriter* f) {
+    write_index_header(ivf, f);
+    WRITE1(ivf->nlist);
+    WRITE1(ivf->nprobe);
+    write_index(ivf->quantizer, f);
+    write_direct_map(&ivf->direct_map, f);
 }
 
-void write_index (const Index *idx, IOWriter *f) {
-    if (const IndexFlat * idxf = dynamic_cast<const IndexFlat *> (idx)) {
-        uint32_t h = fourcc (
-              idxf->metric_type == METRIC_INNER_PRODUCT ? "IxFI" :
-              idxf->metric_type == METRIC_L2 ? "IxF2" : "IxFl");
-        WRITE1 (h);
-        write_index_header (idx, f);
-        WRITEVECTOR (idxf->xb);
-    } else if(const IndexLSH * idxl = dynamic_cast<const IndexLSH *> (idx)) {
-        uint32_t h = fourcc ("IxHe");
-        WRITE1 (h);
-        write_index_header (idx, f);
-        WRITE1 (idxl->nbits);
-        WRITE1 (idxl->rotate_data);
-        WRITE1 (idxl->train_thresholds);
-        WRITEVECTOR (idxl->thresholds);
-        WRITE1 (idxl->bytes_per_vec);
-        write_VectorTransform (&idxl->rrot, f);
-        WRITEVECTOR (idxl->codes);
-    } else if(const IndexPQ * idxp = dynamic_cast<const IndexPQ *> (idx)) {
-        uint32_t h = fourcc ("IxPq");
-        WRITE1 (h);
-        write_index_header (idx, f);
-        write_ProductQuantizer (&idxp->pq, f);
-        WRITEVECTOR (idxp->codes);
+void write_index(const Index* idx, IOWriter* f) {
+    if (const IndexFlat* idxf = dynamic_cast<const IndexFlat*>(idx)) {
+        uint32_t h =
+                fourcc(idxf->metric_type == METRIC_INNER_PRODUCT ? "IxFI"
+                               : idxf->metric_type == METRIC_L2  ? "IxF2"
+                                                                 : "IxFl");
+        WRITE1(h);
+        write_index_header(idx, f);
+        WRITEVECTOR(idxf->xb);
+    } else if (const IndexLSH* idxl = dynamic_cast<const IndexLSH*>(idx)) {
+        uint32_t h = fourcc("IxHe");
+        WRITE1(h);
+        write_index_header(idx, f);
+        WRITE1(idxl->nbits);
+        WRITE1(idxl->rotate_data);
+        WRITE1(idxl->train_thresholds);
+        WRITEVECTOR(idxl->thresholds);
+        WRITE1(idxl->bytes_per_vec);
+        write_VectorTransform(&idxl->rrot, f);
+        WRITEVECTOR(idxl->codes);
+    } else if (const IndexPQ* idxp = dynamic_cast<const IndexPQ*>(idx)) {
+        uint32_t h = fourcc("IxPq");
+        WRITE1(h);
+        write_index_header(idx, f);
+        write_ProductQuantizer(&idxp->pq, f);
+        WRITEVECTOR(idxp->codes);
         // search params -- maybe not useful to store?
-        WRITE1 (idxp->search_type);
-        WRITE1 (idxp->encode_signs);
-        WRITE1 (idxp->polysemous_ht);
-    } else if(const Index2Layer * idxp =
-              dynamic_cast<const Index2Layer *> (idx)) {
-        uint32_t h = fourcc ("Ix2L");
-        WRITE1 (h);
-        write_index_header (idx, f);
-        write_index (idxp->q1.quantizer, f);
-        WRITE1 (idxp->q1.nlist);
-        WRITE1 (idxp->q1.quantizer_trains_alone);
-        write_ProductQuantizer (&idxp->pq, f);
-        WRITE1 (idxp->code_size_1);
-        WRITE1 (idxp->code_size_2);
-        WRITE1 (idxp->code_size);
-        WRITEVECTOR (idxp->codes);
-    } else if(const IndexScalarQuantizer * idxs =
-              dynamic_cast<const IndexScalarQuantizer *> (idx)) {
-        uint32_t h = fourcc ("IxSQ");
-        WRITE1 (h);
-        write_index_header (idx, f);
-        write_ScalarQuantizer (&idxs->sq, f);
-        WRITEVECTOR (idxs->codes);
-    } else if(const IndexLattice * idxl =
-              dynamic_cast<const IndexLattice *> (idx)) {
-        uint32_t h = fourcc ("IxLa");
-        WRITE1 (h);
-        WRITE1 (idxl->d);
-        WRITE1 (idxl->nsq);
-        WRITE1 (idxl->scale_nbit);
-        WRITE1 (idxl->zn_sphere_codec.r2);
-        write_index_header (idx, f);
-        WRITEVECTOR (idxl->trained);
-    } else if(const IndexIVFFlatDedup * ivfl =
-              dynamic_cast<const IndexIVFFlatDedup *> (idx)) {
-        uint32_t h = fourcc ("IwFd");
-        WRITE1 (h);
-        write_ivf_header (ivfl, f);
+        WRITE1(idxp->search_type);
+        WRITE1(idxp->encode_signs);
+        WRITE1(idxp->polysemous_ht);
+    } else if (
+            const IndexResidual* idxr =
+                    dynamic_cast<const IndexResidual*>(idx)) {
+        uint32_t h = fourcc("IxRQ");
+        WRITE1(h);
+        write_index_header(idx, f);
+        write_ResidualQuantizer(&idxr->rq, f);
+        WRITE1(idxr->search_type);
+        WRITE1(idxr->norm_min);
+        WRITE1(idxr->norm_max);
+        WRITE1(idxr->code_size);
+        WRITEVECTOR(idxr->codes);
+    } else if (
+            const ResidualCoarseQuantizer* idxr =
+                    dynamic_cast<const ResidualCoarseQuantizer*>(idx)) {
+        uint32_t h = fourcc("ImRQ");
+        WRITE1(h);
+        write_index_header(idx, f);
+        write_ResidualQuantizer(&idxr->rq, f);
+        WRITE1(idxr->beam_factor);
+    } else if (
+            const Index2Layer* idxp = dynamic_cast<const Index2Layer*>(idx)) {
+        uint32_t h = fourcc("Ix2L");
+        WRITE1(h);
+        write_index_header(idx, f);
+        write_index(idxp->q1.quantizer, f);
+        WRITE1(idxp->q1.nlist);
+        WRITE1(idxp->q1.quantizer_trains_alone);
+        write_ProductQuantizer(&idxp->pq, f);
+        WRITE1(idxp->code_size_1);
+        WRITE1(idxp->code_size_2);
+        WRITE1(idxp->code_size);
+        WRITEVECTOR(idxp->codes);
+    } else if (
+            const IndexScalarQuantizer* idxs =
+                    dynamic_cast<const IndexScalarQuantizer*>(idx)) {
+        uint32_t h = fourcc("IxSQ");
+        WRITE1(h);
+        write_index_header(idx, f);
+        write_ScalarQuantizer(&idxs->sq, f);
+        WRITEVECTOR(idxs->codes);
+    } else if (
+            const IndexLattice* idxl = dynamic_cast<const IndexLattice*>(idx)) {
+        uint32_t h = fourcc("IxLa");
+        WRITE1(h);
+        WRITE1(idxl->d);
+        WRITE1(idxl->nsq);
+        WRITE1(idxl->scale_nbit);
+        WRITE1(idxl->zn_sphere_codec.r2);
+        write_index_header(idx, f);
+        WRITEVECTOR(idxl->trained);
+    } else if (
+            const IndexIVFFlatDedup* ivfl =
+                    dynamic_cast<const IndexIVFFlatDedup*>(idx)) {
+        uint32_t h = fourcc("IwFd");
+        WRITE1(h);
+        write_ivf_header(ivfl, f);
         {
-            std::vector<Index::idx_t> tab (2 * ivfl->instances.size());
+            std::vector<Index::idx_t> tab(2 * ivfl->instances.size());
             long i = 0;
-            for (auto it = ivfl->instances.begin();
-                 it != ivfl->instances.end(); ++it) {
+            for (auto it = ivfl->instances.begin(); it != ivfl->instances.end();
+                 ++it) {
                 tab[i++] = it->first;
                 tab[i++] = it->second;
             }
-            WRITEVECTOR (tab);
+            WRITEVECTOR(tab);
         }
-        write_InvertedLists (ivfl->invlists, f);
-    } else if(const IndexIVFFlat * ivfl =
-              dynamic_cast<const IndexIVFFlat *> (idx)) {
-        uint32_t h = fourcc ("IwFl");
-        WRITE1 (h);
-        write_ivf_header (ivfl, f);
-        write_InvertedLists (ivfl->invlists, f);
-    } else if(const IndexIVFScalarQuantizer * ivsc =
-              dynamic_cast<const IndexIVFScalarQuantizer *> (idx)) {
-        uint32_t h = fourcc ("IwSq");
-        WRITE1 (h);
-        write_ivf_header (ivsc, f);
-        write_ScalarQuantizer (&ivsc->sq, f);
-        WRITE1 (ivsc->code_size);
-        WRITE1 (ivsc->by_residual);
-        write_InvertedLists (ivsc->invlists, f);
-    } else if(const IndexIVFSpectralHash *ivsp =
-              dynamic_cast<const IndexIVFSpectralHash *>(idx)) {
-        uint32_t h = fourcc ("IwSh");
-        WRITE1 (h);
-        write_ivf_header (ivsp, f);
-        write_VectorTransform (ivsp->vt, f);
-        WRITE1 (ivsp->nbit);
-        WRITE1 (ivsp->period);
-        WRITE1 (ivsp->threshold_type);
-        WRITEVECTOR (ivsp->trained);
-        write_InvertedLists (ivsp->invlists, f);
-    } else if(const IndexIVFPQ * ivpq =
-              dynamic_cast<const IndexIVFPQ *> (idx)) {
-        const IndexIVFPQR * ivfpqr = dynamic_cast<const IndexIVFPQR *> (idx);
-
-        uint32_t h = fourcc (ivfpqr ? "IwQR" : "IwPQ");
-        WRITE1 (h);
-        write_ivf_header (ivpq, f);
-        WRITE1 (ivpq->by_residual);
-        WRITE1 (ivpq->code_size);
-        write_ProductQuantizer (&ivpq->pq, f);
-        write_InvertedLists (ivpq->invlists, f);
+        write_InvertedLists(ivfl->invlists, f);
+    } else if (
+            const IndexIVFFlat* ivfl = dynamic_cast<const IndexIVFFlat*>(idx)) {
+        uint32_t h = fourcc("IwFl");
+        WRITE1(h);
+        write_ivf_header(ivfl, f);
+        write_InvertedLists(ivfl->invlists, f);
+    } else if (
+            const IndexIVFScalarQuantizer* ivsc =
+                    dynamic_cast<const IndexIVFScalarQuantizer*>(idx)) {
+        uint32_t h = fourcc("IwSq");
+        WRITE1(h);
+        write_ivf_header(ivsc, f);
+        write_ScalarQuantizer(&ivsc->sq, f);
+        WRITE1(ivsc->code_size);
+        WRITE1(ivsc->by_residual);
+        write_InvertedLists(ivsc->invlists, f);
+    } else if (
+            const IndexIVFSpectralHash* ivsp =
+                    dynamic_cast<const IndexIVFSpectralHash*>(idx)) {
+        uint32_t h = fourcc("IwSh");
+        WRITE1(h);
+        write_ivf_header(ivsp, f);
+        write_VectorTransform(ivsp->vt, f);
+        WRITE1(ivsp->nbit);
+        WRITE1(ivsp->period);
+        WRITE1(ivsp->threshold_type);
+        WRITEVECTOR(ivsp->trained);
+        write_InvertedLists(ivsp->invlists, f);
+    } else if (const IndexIVFPQ* ivpq = dynamic_cast<const IndexIVFPQ*>(idx)) {
+        const IndexIVFPQR* ivfpqr = dynamic_cast<const IndexIVFPQR*>(idx);
+
+        uint32_t h = fourcc(ivfpqr ? "IwQR" : "IwPQ");
+        WRITE1(h);
+        write_ivf_header(ivpq, f);
+        WRITE1(ivpq->by_residual);
+        WRITE1(ivpq->code_size);
+        write_ProductQuantizer(&ivpq->pq, f);
+        write_InvertedLists(ivpq->invlists, f);
         if (ivfpqr) {
-            write_ProductQuantizer (&ivfpqr->refine_pq, f);
-            WRITEVECTOR (ivfpqr->refine_codes);
-            WRITE1 (ivfpqr->k_factor);
+            write_ProductQuantizer(&ivfpqr->refine_pq, f);
+            WRITEVECTOR(ivfpqr->refine_codes);
+            WRITE1(ivfpqr->k_factor);
         }
 
-    } else if(const IndexPreTransform * ixpt =
-              dynamic_cast<const IndexPreTransform *> (idx)) {
-        uint32_t h = fourcc ("IxPT");
-        WRITE1 (h);
-        write_index_header (ixpt, f);
+    } else if (
+            const IndexPreTransform* ixpt =
+                    dynamic_cast<const IndexPreTransform*>(idx)) {
+        uint32_t h = fourcc("IxPT");
+        WRITE1(h);
+        write_index_header(ixpt, f);
         int nt = ixpt->chain.size();
-        WRITE1 (nt);
+        WRITE1(nt);
         for (int i = 0; i < nt; i++)
-            write_VectorTransform (ixpt->chain[i], f);
-        write_index (ixpt->index, f);
-    } else if(const MultiIndexQuantizer * imiq =
-              dynamic_cast<const MultiIndexQuantizer *> (idx)) {
-        uint32_t h = fourcc ("Imiq");
-        WRITE1 (h);
-        write_index_header (imiq, f);
-        write_ProductQuantizer (&imiq->pq, f);
-    } else if(const IndexRefine * idxrf =
-              dynamic_cast<const IndexRefine *> (idx)) {
-        uint32_t h = fourcc ("IxRF");
-        WRITE1 (h);
-        write_index_header (idxrf, f);
-        write_index (idxrf->base_index, f);
-        write_index (idxrf->refine_index, f);
-        WRITE1 (idxrf->k_factor);
-    } else if(const IndexIDMap * idxmap =
-              dynamic_cast<const IndexIDMap *> (idx)) {
-        uint32_t h =
-            dynamic_cast<const IndexIDMap2 *> (idx) ? fourcc ("IxM2") :
-            fourcc ("IxMp");
+            write_VectorTransform(ixpt->chain[i], f);
+        write_index(ixpt->index, f);
+    } else if (
+            const MultiIndexQuantizer* imiq =
+                    dynamic_cast<const MultiIndexQuantizer*>(idx)) {
+        uint32_t h = fourcc("Imiq");
+        WRITE1(h);
+        write_index_header(imiq, f);
+        write_ProductQuantizer(&imiq->pq, f);
+    } else if (
+            const IndexRefine* idxrf = dynamic_cast<const IndexRefine*>(idx)) {
+        uint32_t h = fourcc("IxRF");
+        WRITE1(h);
+        write_index_header(idxrf, f);
+        write_index(idxrf->base_index, f);
+        write_index(idxrf->refine_index, f);
+        WRITE1(idxrf->k_factor);
+    } else if (
+            const IndexIDMap* idxmap = dynamic_cast<const IndexIDMap*>(idx)) {
+        uint32_t h = dynamic_cast<const IndexIDMap2*>(idx) ? fourcc("IxM2")
+                                                           : fourcc("IxMp");
         // no need to store additional info for IndexIDMap2
-        WRITE1 (h);
-        write_index_header (idxmap, f);
-        write_index (idxmap->index, f);
-        WRITEVECTOR (idxmap->id_map);
-    } else if(const IndexHNSW * idxhnsw =
-              dynamic_cast<const IndexHNSW *> (idx)) {
+        WRITE1(h);
+        write_index_header(idxmap, f);
+        write_index(idxmap->index, f);
+        WRITEVECTOR(idxmap->id_map);
+    } else if (const IndexHNSW* idxhnsw = dynamic_cast<const IndexHNSW*>(idx)) {
+        uint32_t h = dynamic_cast<const IndexHNSWFlat*>(idx) ? fourcc("IHNf")
+                : dynamic_cast<const IndexHNSWPQ*>(idx)      ? fourcc("IHNp")
+                : dynamic_cast<const IndexHNSWSQ*>(idx)      ? fourcc("IHNs")
+                : dynamic_cast<const IndexHNSW2Level*>(idx)  ? fourcc("IHN2")
+                                                             : 0;
+        FAISS_THROW_IF_NOT(h != 0);
+        WRITE1(h);
+        write_index_header(idxhnsw, f);
+        write_HNSW(&idxhnsw->hnsw, f);
+        write_index(idxhnsw->storage, f);
+    } else if (const IndexNSG* idxnsg = dynamic_cast<const IndexNSG*>(idx)) {
         uint32_t h =
-            dynamic_cast<const IndexHNSWFlat*>(idx)   ? fourcc("IHNf") :
-            dynamic_cast<const IndexHNSWPQ*>(idx)     ? fourcc("IHNp") :
-            dynamic_cast<const IndexHNSWSQ*>(idx)     ? fourcc("IHNs") :
-            dynamic_cast<const IndexHNSW2Level*>(idx) ? fourcc("IHN2") :
-            0;
-        FAISS_THROW_IF_NOT (h != 0);
-        WRITE1 (h);
-        write_index_header (idxhnsw, f);
-        write_HNSW (&idxhnsw->hnsw, f);
-        write_index (idxhnsw->storage, f);
-    } else if (const IndexPQFastScan *idxpqfs =
-               dynamic_cast<const IndexPQFastScan*>(idx)) {
+                dynamic_cast<const IndexNSGFlat*>(idx) ? fourcc("INSf") : 0;
+        FAISS_THROW_IF_NOT(h != 0);
+        WRITE1(h);
+        write_index_header(idxnsg, f);
+        WRITE1(idxnsg->GK);
+        WRITE1(idxnsg->build_type);
+        WRITE1(idxnsg->nndescent_S);
+        WRITE1(idxnsg->nndescent_R);
+        WRITE1(idxnsg->nndescent_L);
+        WRITE1(idxnsg->nndescent_iter);
+        write_NSG(&idxnsg->nsg, f);
+        write_index(idxnsg->storage, f);
+    } else if (
+            const IndexPQFastScan* idxpqfs =
+                    dynamic_cast<const IndexPQFastScan*>(idx)) {
         uint32_t h = fourcc("IPfs");
-        WRITE1 (h);
-        write_index_header (idxpqfs, f);
-        write_ProductQuantizer (&idxpqfs->pq, f);
-        WRITE1 (idxpqfs->implem);
-        WRITE1 (idxpqfs->bbs);
-        WRITE1 (idxpqfs->qbs);
-        WRITE1 (idxpqfs->ntotal2);
-        WRITE1 (idxpqfs->M2);
-        WRITEVECTOR (idxpqfs->codes);
-    } else if (const IndexIVFPQFastScan * ivpq =
-              dynamic_cast<const IndexIVFPQFastScan *> (idx)) {
-        uint32_t h = fourcc ("IwPf");
-        WRITE1 (h);
-        write_ivf_header (ivpq, f);
-        WRITE1 (ivpq->by_residual);
-        WRITE1 (ivpq->code_size);
-        WRITE1 (ivpq->bbs);
-        WRITE1 (ivpq->M2);
-        WRITE1 (ivpq->implem);
-        WRITE1 (ivpq->qbs2);
-        write_ProductQuantizer (&ivpq->pq, f);
-        write_InvertedLists (ivpq->invlists, f);
+        WRITE1(h);
+        write_index_header(idxpqfs, f);
+        write_ProductQuantizer(&idxpqfs->pq, f);
+        WRITE1(idxpqfs->implem);
+        WRITE1(idxpqfs->bbs);
+        WRITE1(idxpqfs->qbs);
+        WRITE1(idxpqfs->ntotal2);
+        WRITE1(idxpqfs->M2);
+        WRITEVECTOR(idxpqfs->codes);
+    } else if (
+            const IndexIVFPQFastScan* ivpq =
+                    dynamic_cast<const IndexIVFPQFastScan*>(idx)) {
+        uint32_t h = fourcc("IwPf");
+        WRITE1(h);
+        write_ivf_header(ivpq, f);
+        WRITE1(ivpq->by_residual);
+        WRITE1(ivpq->code_size);
+        WRITE1(ivpq->bbs);
+        WRITE1(ivpq->M2);
+        WRITE1(ivpq->implem);
+        WRITE1(ivpq->qbs2);
+        write_ProductQuantizer(&ivpq->pq, f);
+        write_InvertedLists(ivpq->invlists, f);
     } else {
-        FAISS_THROW_MSG ("don't know how to serialize this type of index");
+        FAISS_THROW_MSG("don't know how to serialize this type of index");
     }
 }
 
-void write_index (const Index *idx, FILE *f) {
+void write_index(const Index* idx, FILE* f) {
     FileIOWriter writer(f);
-    write_index (idx, &writer);
+    write_index(idx, &writer);
 }
 
-void write_index (const Index *idx, const char *fname) {
+void write_index(const Index* idx, const char* fname) {
     FileIOWriter writer(fname);
-    write_index (idx, &writer);
+    write_index(idx, &writer);
 }
 
-void write_VectorTransform (const VectorTransform *vt, const char *fname) {
+void write_VectorTransform(const VectorTransform* vt, const char* fname) {
     FileIOWriter writer(fname);
-    write_VectorTransform (vt, &writer);
+    write_VectorTransform(vt, &writer);
 }
 
-
 /*************************************************************
  * Write binary indexes
  **************************************************************/
 
-
-static void write_index_binary_header (const IndexBinary *idx, IOWriter *f) {
-    WRITE1 (idx->d);
-    WRITE1 (idx->code_size);
-    WRITE1 (idx->ntotal);
-    WRITE1 (idx->is_trained);
-    WRITE1 (idx->metric_type);
+static void write_index_binary_header(const IndexBinary* idx, IOWriter* f) {
+    WRITE1(idx->d);
+    WRITE1(idx->code_size);
+    WRITE1(idx->ntotal);
+    WRITE1(idx->is_trained);
+    WRITE1(idx->metric_type);
 }
 
-static void write_binary_ivf_header (const IndexBinaryIVF *ivf, IOWriter *f) {
-    write_index_binary_header (ivf, f);
-    WRITE1 (ivf->nlist);
-    WRITE1 (ivf->nprobe);
-    write_index_binary (ivf->quantizer, f);
-    write_direct_map (&ivf->direct_map, f);
+static void write_binary_ivf_header(const IndexBinaryIVF* ivf, IOWriter* f) {
+    write_index_binary_header(ivf, f);
+    WRITE1(ivf->nlist);
+    WRITE1(ivf->nprobe);
+    write_index_binary(ivf->quantizer, f);
+    write_direct_map(&ivf->direct_map, f);
 }
 
-static void write_binary_hash_invlists (
-        const IndexBinaryHash::InvertedListMap &invlists,
-        int b, IOWriter *f)
-{
+static void write_binary_hash_invlists(
+        const IndexBinaryHash::InvertedListMap& invlists,
+        int b,
+        IOWriter* f) {
     size_t sz = invlists.size();
-    WRITE1 (sz);
+    WRITE1(sz);
     size_t maxil = 0;
     for (auto it = invlists.begin(); it != invlists.end(); ++it) {
-        if(it->second.ids.size() > maxil) {
+        if (it->second.ids.size() > maxil) {
             maxil = it->second.ids.size();
         }
     }
     int il_nbit = 0;
-    while(maxil >= ((uint64_t)1 << il_nbit)) {
+    while (maxil >= ((uint64_t)1 << il_nbit)) {
         il_nbit++;
     }
     WRITE1(il_nbit);
@@ -513,25 +598,25 @@ static void write_binary_hash_invlists (
     // memmap it at some point
 
     // buffer for bitstrings
-    std::vector<uint8_t> buf (((b + il_nbit) * sz + 7) / 8);
-    BitstringWriter wr (buf.data(), buf.size());
+    std::vector<uint8_t> buf(((b + il_nbit) * sz + 7) / 8);
+    BitstringWriter wr(buf.data(), buf.size());
     for (auto it = invlists.begin(); it != invlists.end(); ++it) {
-        wr.write (it->first, b);
-        wr.write (it->second.ids.size(), il_nbit);
+        wr.write(it->first, b);
+        wr.write(it->second.ids.size(), il_nbit);
     }
-    WRITEVECTOR (buf);
+    WRITEVECTOR(buf);
 
     for (auto it = invlists.begin(); it != invlists.end(); ++it) {
-        WRITEVECTOR (it->second.ids);
-        WRITEVECTOR (it->second.vecs);
+        WRITEVECTOR(it->second.ids);
+        WRITEVECTOR(it->second.vecs);
     }
 }
 
 static void write_binary_multi_hash_map(
-        const IndexBinaryMultiHash::Map &map,
-        int b, size_t ntotal,
-        IOWriter *f)
-{
+        const IndexBinaryMultiHash::Map& map,
+        int b,
+        size_t ntotal,
+        IOWriter* f) {
     int id_bits = 0;
     while ((ntotal > ((Index::idx_t)1 << id_bits))) {
         id_bits++;
@@ -541,7 +626,7 @@ static void write_binary_multi_hash_map(
     WRITE1(sz);
     size_t nbit = (b + id_bits) * sz + ntotal * id_bits;
     std::vector<uint8_t> buf((nbit + 7) / 8);
-    BitstringWriter wr (buf.data(), buf.size());
+    BitstringWriter wr(buf.data(), buf.size());
     for (auto it = map.begin(); it != map.end(); ++it) {
         wr.write(it->first, b);
         wr.write(it->second.size(), id_bits);
@@ -549,80 +634,85 @@ static void write_binary_multi_hash_map(
             wr.write(id, id_bits);
         }
     }
-    WRITEVECTOR (buf);
+    WRITEVECTOR(buf);
 }
 
-void write_index_binary (const IndexBinary *idx, IOWriter *f) {
-    if (const IndexBinaryFlat *idxf =
-        dynamic_cast<const IndexBinaryFlat *> (idx)) {
-        uint32_t h = fourcc ("IBxF");
-        WRITE1 (h);
-        write_index_binary_header (idx, f);
-        WRITEVECTOR (idxf->xb);
-    } else if (const IndexBinaryIVF *ivf =
-               dynamic_cast<const IndexBinaryIVF *> (idx)) {
-        uint32_t h = fourcc ("IBwF");
-        WRITE1 (h);
-        write_binary_ivf_header (ivf, f);
-        write_InvertedLists (ivf->invlists, f);
-    } else if(const IndexBinaryFromFloat * idxff =
-              dynamic_cast<const IndexBinaryFromFloat *> (idx)) {
-        uint32_t h = fourcc ("IBFf");
-        WRITE1 (h);
-        write_index_binary_header (idxff, f);
-        write_index (idxff->index, f);
-    } else if (const IndexBinaryHNSW *idxhnsw =
-               dynamic_cast<const IndexBinaryHNSW *> (idx)) {
-        uint32_t h = fourcc ("IBHf");
-        WRITE1 (h);
-        write_index_binary_header (idxhnsw, f);
-        write_HNSW (&idxhnsw->hnsw, f);
-        write_index_binary (idxhnsw->storage, f);
-    } else if(const IndexBinaryIDMap * idxmap =
-              dynamic_cast<const IndexBinaryIDMap *> (idx)) {
-        uint32_t h =
-            dynamic_cast<const IndexBinaryIDMap2 *> (idx) ? fourcc ("IBM2") :
-            fourcc ("IBMp");
+void write_index_binary(const IndexBinary* idx, IOWriter* f) {
+    if (const IndexBinaryFlat* idxf =
+                dynamic_cast<const IndexBinaryFlat*>(idx)) {
+        uint32_t h = fourcc("IBxF");
+        WRITE1(h);
+        write_index_binary_header(idx, f);
+        WRITEVECTOR(idxf->xb);
+    } else if (
+            const IndexBinaryIVF* ivf =
+                    dynamic_cast<const IndexBinaryIVF*>(idx)) {
+        uint32_t h = fourcc("IBwF");
+        WRITE1(h);
+        write_binary_ivf_header(ivf, f);
+        write_InvertedLists(ivf->invlists, f);
+    } else if (
+            const IndexBinaryFromFloat* idxff =
+                    dynamic_cast<const IndexBinaryFromFloat*>(idx)) {
+        uint32_t h = fourcc("IBFf");
+        WRITE1(h);
+        write_index_binary_header(idxff, f);
+        write_index(idxff->index, f);
+    } else if (
+            const IndexBinaryHNSW* idxhnsw =
+                    dynamic_cast<const IndexBinaryHNSW*>(idx)) {
+        uint32_t h = fourcc("IBHf");
+        WRITE1(h);
+        write_index_binary_header(idxhnsw, f);
+        write_HNSW(&idxhnsw->hnsw, f);
+        write_index_binary(idxhnsw->storage, f);
+    } else if (
+            const IndexBinaryIDMap* idxmap =
+                    dynamic_cast<const IndexBinaryIDMap*>(idx)) {
+        uint32_t h = dynamic_cast<const IndexBinaryIDMap2*>(idx)
+                ? fourcc("IBM2")
+                : fourcc("IBMp");
         // no need to store additional info for IndexIDMap2
-        WRITE1 (h);
-        write_index_binary_header (idxmap, f);
-        write_index_binary (idxmap->index, f);
-        WRITEVECTOR (idxmap->id_map);
-    } else if (const IndexBinaryHash *idxh =
-               dynamic_cast<const IndexBinaryHash *> (idx)) {
-        uint32_t h = fourcc ("IBHh");
-        WRITE1 (h);
-        write_index_binary_header (idxh, f);
-        WRITE1 (idxh->b);
-        WRITE1 (idxh->nflip);
+        WRITE1(h);
+        write_index_binary_header(idxmap, f);
+        write_index_binary(idxmap->index, f);
+        WRITEVECTOR(idxmap->id_map);
+    } else if (
+            const IndexBinaryHash* idxh =
+                    dynamic_cast<const IndexBinaryHash*>(idx)) {
+        uint32_t h = fourcc("IBHh");
+        WRITE1(h);
+        write_index_binary_header(idxh, f);
+        WRITE1(idxh->b);
+        WRITE1(idxh->nflip);
         write_binary_hash_invlists(idxh->invlists, idxh->b, f);
-    } else if (const IndexBinaryMultiHash *idxmh =
-               dynamic_cast<const IndexBinaryMultiHash *> (idx)) {
-        uint32_t h = fourcc ("IBHm");
-        WRITE1 (h);
-        write_index_binary_header (idxmh, f);
-        write_index_binary (idxmh->storage, f);
-        WRITE1 (idxmh->b);
-        WRITE1 (idxmh->nhash);
-        WRITE1 (idxmh->nflip);
+    } else if (
+            const IndexBinaryMultiHash* idxmh =
+                    dynamic_cast<const IndexBinaryMultiHash*>(idx)) {
+        uint32_t h = fourcc("IBHm");
+        WRITE1(h);
+        write_index_binary_header(idxmh, f);
+        write_index_binary(idxmh->storage, f);
+        WRITE1(idxmh->b);
+        WRITE1(idxmh->nhash);
+        WRITE1(idxmh->nflip);
         for (int i = 0; i < idxmh->nhash; i++) {
             write_binary_multi_hash_map(
                     idxmh->maps[i], idxmh->b, idxmh->ntotal, f);
         }
     } else {
-        FAISS_THROW_MSG ("don't know how to serialize this type of index");
+        FAISS_THROW_MSG("don't know how to serialize this type of index");
     }
 }
 
-void write_index_binary (const IndexBinary *idx, FILE *f) {
+void write_index_binary(const IndexBinary* idx, FILE* f) {
     FileIOWriter writer(f);
     write_index_binary(idx, &writer);
 }
 
-void write_index_binary (const IndexBinary *idx, const char *fname) {
+void write_index_binary(const IndexBinary* idx, const char* fname) {
     FileIOWriter writer(fname);
-    write_index_binary (idx, &writer);
+    write_index_binary(idx, &writer);
 }
 
-
 } // namespace faiss