diff --git a/xml/AdditiveQuantizer_8h.xml b/xml/AdditiveQuantizer_8h.xml index c424e54d9a..dcb1427e98 100644 --- a/xml/AdditiveQuantizer_8h.xml +++ b/xml/AdditiveQuantizer_8h.xml @@ -1,5 +1,5 @@ - + AdditiveQuantizer.h cmath @@ -8,14 +8,36 @@ faiss/Index.h faiss/IndexFlat.h faiss/impl/Quantizer.h - faiss/impl/LocalSearchQuantizer.h - faiss/impl/ProductAdditiveQuantizer.h - faiss/impl/ResidualQuantizer.h faiss/IndexAdditiveQuantizer.h faiss/IndexAdditiveQuantizerFastScan.h faiss/IndexIVFAdditiveQuantizer.h faiss/IndexIVFAdditiveQuantizerFastScan.h + faiss/impl/LocalSearchQuantizer.h + faiss/impl/ProductAdditiveQuantizer.h + faiss/impl/ResidualQuantizer.h + + + + + + + + + + + + + + + + + + + + + + @@ -26,12 +48,38 @@ - - - + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + @@ -42,55 +90,55 @@ + + + + + + + + + - - - - - - - - - - - + + - - - - + + + + + + - - + + + - - + + + + + - - - - - - - - - - - - + + + + + + @@ -103,95 +151,47 @@ - - - + - - - - - + - - - - - - - + - - - - + + + + - + - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - faiss::AdditiveQuantizer faiss @@ -414,7 +414,7 @@ idx_t*labels, constfloat*centroid_norms)const; -virtual~AdditiveQuantizer(); +virtual~AdditiveQuantizer(); }; }//namespacefaiss diff --git a/xml/AlignedTable_8h.xml b/xml/AlignedTable_8h.xml index 5705191ad3..377f75cc8e 100644 --- a/xml/AlignedTable_8h.xml +++ b/xml/AlignedTable_8h.xml @@ -1,5 +1,5 @@ - + AlignedTable.h cassert @@ -8,7 +8,6 @@ cstring algorithm faiss/impl/platform_macros.h - faiss/impl/simd_result_handlers.h faiss/IndexAdditiveQuantizerFastScan.h faiss/IndexFastScan.h faiss/IndexIVFAdditiveQuantizerFastScan.h @@ -16,8 +15,17 @@ faiss/IndexIVFPQ.h faiss/IndexIVFPQFastScan.h faiss/IndexPQFastScan.h + faiss/impl/simd_result_handlers.h faiss/invlists/BlockInvertedLists.h + + + + + + + + @@ -34,115 +42,107 @@ - - - - - - - - - - + + + + + - - - - - - - - - - + + + - - - + + + - - - - - - - - - - - - - - - - - + + + - + - + - + - - - - + + + + + + - + - + - + - - - - + + - + - - - + + + - - - + + + + + + + + + + + + + + + + + + + + + faiss::AlignedTableTightAlloc @@ -248,7 +248,7 @@ returnptr[i]; } -~AlignedTableTightAlloc(){ +~AlignedTableTightAlloc(){ posix_memalign_free(ptr); } diff --git a/xml/AutoTune_8h.xml b/xml/AutoTune_8h.xml index 7431fe5cbe..2edd283f15 100644 --- a/xml/AutoTune_8h.xml +++ b/xml/AutoTune_8h.xml @@ -1,5 +1,5 @@ - + AutoTune.h stdint.h @@ -8,23 +8,6 @@ faiss/IndexBinary.h faiss/gpu/GpuAutoTune.h - - - - - - - - - - - - - - - - - @@ -37,21 +20,11 @@ - - - - - - - - - - - - - - - + + + + + @@ -60,14 +33,10 @@ - - - - - - - + + + @@ -76,6 +45,8 @@ + + @@ -83,6 +54,35 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -161,7 +161,7 @@ */ virtualdoubleevaluate(constfloat*D,constidx_t*I)const=0; -virtual~AutoTuneCriterion(){} +virtual~AutoTuneCriterion(){} }; structOneRecallAtRCriterion:AutoTuneCriterion{ @@ -171,7 +171,7 @@ doubleevaluate(constfloat*D,constidx_t*I)constoverride; -~OneRecallAtRCriterion()override{} +~OneRecallAtRCriterion()override{} }; structIntersectionCriterion:AutoTuneCriterion{ @@ -181,7 +181,7 @@ doubleevaluate(constfloat*D,constidx_t*I)constoverride; -~IntersectionCriterion()override{} +~IntersectionCriterion()override{} }; /** @@ -277,7 +277,7 @@ voiddisplay()const; ///addanewparameter(orreturnitifitexists) -ParameterRange&add_range(conststd::string&name); +ParameterRange&add_range(conststd::string&name); ///initializewithreasonableparametersfortheindex virtualvoidinitialize(constIndex*index); @@ -315,7 +315,7 @@ constAutoTuneCriterion&crit, OperatingPoints*ops)const; -virtual~ParameterSpace(){} +virtual~ParameterSpace(){} }; }//namespacefaiss diff --git a/xml/AuxIndexStructures_8h.xml b/xml/AuxIndexStructures_8h.xml index 13997977ad..87c8ed84cc 100644 --- a/xml/AuxIndexStructures_8h.xml +++ b/xml/AuxIndexStructures_8h.xml @@ -1,5 +1,5 @@ - + AuxIndexStructures.h stdint.h @@ -13,20 +13,12 @@ faiss/impl/ResultHandler.h faiss/impl/ScalarQuantizer.h - - - - - - + + + + - - - - - - @@ -45,20 +37,19 @@ - - - - - + + + + + + + - - + + - - - - - + + @@ -66,16 +57,49 @@ + + + + + + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -86,38 +110,22 @@ - - - - - - - - - - - - - - - - - - - - - - + + + + - + - + + + @@ -125,32 +133,24 @@ - + - - - + + + - - - + + + - - - + + + - - - - - - - - - - - + + + faiss::RangeSearchResult @@ -212,7 +212,7 @@ ///foreachquery virtualvoiddo_allocation(); -virtual~RangeSearchResult(); +virtual~RangeSearchResult(); }; /**************************************************************** @@ -241,7 +241,7 @@ explicitBufferList(size_tbuffer_size); -~BufferList(); +~BufferList(); ///createanewbuffer voidappend_buffer(); @@ -277,7 +277,7 @@ std::vector<RangeQueryResult>queries; ///beginanewresult -RangeQueryResult&new_result(idx_tqno); +RangeQueryResult&new_result(idx_tqno); /***************************************** *functionsusedattheendofthesearchtomergetheresult @@ -303,7 +303,7 @@ structFAISS_APIInterruptCallback{ virtualboolwant_interrupt()=0; -virtual~InterruptCallback(){} +virtual~InterruptCallback(){} //lockthatprotectsconcurrentcallstois_interrupted staticstd::mutexlock; diff --git a/xml/BinaryDistance_8cuh.xml b/xml/BinaryDistance_8cuh.xml index 3ec8b40c24..71fcb26df1 100644 --- a/xml/BinaryDistance_8cuh.xml +++ b/xml/BinaryDistance_8cuh.xml @@ -1,5 +1,5 @@ - + BinaryDistance.cuh diff --git a/xml/BinaryFlatIndex_8cuh.xml b/xml/BinaryFlatIndex_8cuh.xml index 7b49cd2263..04b8e36be8 100644 --- a/xml/BinaryFlatIndex_8cuh.xml +++ b/xml/BinaryFlatIndex_8cuh.xml @@ -1,5 +1,5 @@ - + BinaryFlatIndex.cuh diff --git a/xml/BlockInvertedLists_8h.xml b/xml/BlockInvertedLists_8h.xml index 4c45db5f82..a1b333d035 100644 --- a/xml/BlockInvertedLists_8h.xml +++ b/xml/BlockInvertedLists_8h.xml @@ -1,5 +1,5 @@ - + BlockInvertedLists.h faiss/index_io.h @@ -7,62 +7,26 @@ faiss/invlists/InvertedListsIOHook.h faiss/utils/AlignedTable.h - - - - - - - - - - + + + + - + - + - - - - - + - + - - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - @@ -75,24 +39,24 @@ - - - - + + + + - + + + + + - - - - - + @@ -107,14 +71,10 @@ - - - - - - - - + + + + @@ -129,12 +89,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::BlockInvertedLists faiss::BlockInvertedListsIOHook @@ -192,8 +192,8 @@ BlockInvertedLists(); size_tlist_size(size_tlist_no)constoverride; -constuint8_t*get_codes(size_tlist_no)constoverride; -constidx_t*get_ids(size_tlist_no)constoverride; +constuint8_t*get_codes(size_tlist_no)constoverride; +constidx_t*get_ids(size_tlist_no)constoverride; ///removeidsfromtheInvertedLists size_tremove_ids(constIDSelector&sel); @@ -217,13 +217,13 @@ //alsopadsnewdatawith0s voidresize(size_tlist_no,size_tnew_size)override; -~BlockInvertedLists()override; +~BlockInvertedLists()override; }; structBlockInvertedListsIOHook:InvertedListsIOHook{ BlockInvertedListsIOHook(); voidwrite(constInvertedLists*ils,IOWriter*f)constoverride; -InvertedLists*read(IOReader*f,intio_flags)constoverride; +InvertedLists*read(IOReader*f,intio_flags)constoverride; }; }//namespacefaiss diff --git a/xml/BlockSelectImpl_8cuh.xml b/xml/BlockSelectImpl_8cuh.xml index d35540cdc1..8621550ff4 100644 --- a/xml/BlockSelectImpl_8cuh.xml +++ b/xml/BlockSelectImpl_8cuh.xml @@ -1,5 +1,5 @@ - + BlockSelectImpl.cuh diff --git a/xml/BlockSelectKernel_8cuh.xml b/xml/BlockSelectKernel_8cuh.xml index ea27fc7427..bf6d2d85fa 100644 --- a/xml/BlockSelectKernel_8cuh.xml +++ b/xml/BlockSelectKernel_8cuh.xml @@ -1,5 +1,5 @@ - + BlockSelectKernel.cuh diff --git a/xml/BroadcastSum_8cuh.xml b/xml/BroadcastSum_8cuh.xml index 136dac9f0c..725ba7ff95 100644 --- a/xml/BroadcastSum_8cuh.xml +++ b/xml/BroadcastSum_8cuh.xml @@ -1,5 +1,5 @@ - + BroadcastSum.cuh diff --git a/xml/Clustering_8h.xml b/xml/Clustering_8h.xml index 39e4d5cb2d..1ce3f220ad 100644 --- a/xml/Clustering_8h.xml +++ b/xml/Clustering_8h.xml @@ -1,27 +1,16 @@ - + Clustering.h faiss/Index.h vector + faiss/IndexBinaryIVF.h + faiss/IndexIVF.h faiss/gpu/GpuCloner.h faiss/gpu/GpuIndexIVF.h faiss/impl/ProductQuantizer.h faiss/impl/ResidualQuantizer.h - faiss/IndexBinaryIVF.h - faiss/IndexIVF.h - - - - - - - - - - - @@ -30,21 +19,6 @@ - - - - - - - - - - - - - - - @@ -65,261 +39,287 @@ - - - - - - + + + + - + - - - - - + + - - - - - - - - - - - + + - - - - - - - - - + + - - - + + + + + - - - - - - - - - - - - + + + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + - - - + + + - - - - - + - - - - - + - + - - - - - - - + + + - - - - + + + + - + - - - - + + + + - - - + + + - - - + + + - - + + + + + + + + + + + + + + - - + + + + - + - + - + - + - - - - - + + + - - - - - + + + - - - - - - - - - + + + - - - + + + - - - + + + + + + + - - - - - + - + + + + + + + - - - - - - - + + + + + - - - + + + + + + + + + + + - + - + - + - + - + - + - - - + + + + + + + + + - - - + + + + + + + faiss::ClusteringParameters @@ -463,7 +463,7 @@ ///includesoptionalL2normalizationandnearestintegerrounding voidpost_process_centroids(); -virtual~Clustering(){} +virtual~Clustering(){} }; /**Exact1Dclusteringalgorithm @@ -477,7 +477,7 @@ voidtrain_exact(idx_tn,constfloat*x); -virtual~Clustering1D(){} +virtual~Clustering1D(){} }; structProgressiveDimClusteringParameters:ClusteringParameters{ @@ -490,9 +490,9 @@ /**generatesanindexsuitableforclusteringwhencalled*/ structProgressiveDimIndexFactory{ ///ownershiptransferredtocaller -virtualIndex*operator()(intdim); +virtualIndex*operator()(intdim); -virtual~ProgressiveDimIndexFactory(){} +virtual~ProgressiveDimIndexFactory(){} }; /**K-meansclusteringwithprogressivedimensionsused @@ -526,7 +526,7 @@ voidtrain(idx_tn,constfloat*x,ProgressiveDimIndexFactory&factory); -virtual~ProgressiveDimClustering(){} +virtual~ProgressiveDimClustering(){} }; /**simplifiedinterface diff --git a/xml/CoarseBitType_8h.xml b/xml/CoarseBitType_8h.xml index b65353dfc4..2d623d8b88 100644 --- a/xml/CoarseBitType_8h.xml +++ b/xml/CoarseBitType_8h.xml @@ -1,37 +1,37 @@ - + CoarseBitType.h cstdint faiss/cppcontrib/sa_decode/Level2-inl.h - - - + + + - - - - - - + + + + + + faiss::cppcontrib::detail::CoarseBitType faiss::cppcontrib::detail::CoarseBitType< 8 > @@ -64,12 +64,12 @@ template<> structCoarseBitType<8>{ -usingbit_type=uint8_t; +usingbit_type=uint8_t; }; template<> structCoarseBitType<16>{ -usingbit_type=uint16_t; +usingbit_type=uint16_t; }; }//namespacedetail diff --git a/xml/CodePacker_8h.xml b/xml/CodePacker_8h.xml index bf0229dbdd..ea33c45ef0 100644 --- a/xml/CodePacker_8h.xml +++ b/xml/CodePacker_8h.xml @@ -1,10 +1,22 @@ - + CodePacker.h faiss/MetricType.h faiss/impl/pq4_fast_scan.h + + + + + + + + + + + + @@ -16,21 +28,9 @@ - - - - - - - - - - - - @@ -106,7 +106,7 @@ //*code_size) )const; -virtual~CodePacker(){} +virtual~CodePacker(){} }; /**Trivialcodepackerwherecodesarestoredonebyone*/ diff --git a/xml/Comparators_8cuh.xml b/xml/Comparators_8cuh.xml index 005acb8cb7..f4945d7db9 100644 --- a/xml/Comparators_8cuh.xml +++ b/xml/Comparators_8cuh.xml @@ -1,5 +1,5 @@ - + Comparators.cuh diff --git a/xml/ConversionOperators_8cuh.xml b/xml/ConversionOperators_8cuh.xml index bf895e4e67..33e199d233 100644 --- a/xml/ConversionOperators_8cuh.xml +++ b/xml/ConversionOperators_8cuh.xml @@ -1,5 +1,5 @@ - + ConversionOperators.cuh diff --git a/xml/CopyUtils_8cuh.xml b/xml/CopyUtils_8cuh.xml index f4ec8e2026..04ddd775bb 100644 --- a/xml/CopyUtils_8cuh.xml +++ b/xml/CopyUtils_8cuh.xml @@ -1,5 +1,5 @@ - + CopyUtils.cuh diff --git a/xml/CuvsCagra_8cuh.xml b/xml/CuvsCagra_8cuh.xml index e2f190c157..a6994d0284 100644 --- a/xml/CuvsCagra_8cuh.xml +++ b/xml/CuvsCagra_8cuh.xml @@ -1,5 +1,5 @@ - + CuvsCagra.cuh diff --git a/xml/CuvsFlatIndex_8cuh.xml b/xml/CuvsFlatIndex_8cuh.xml index e308163558..62b1b19545 100644 --- a/xml/CuvsFlatIndex_8cuh.xml +++ b/xml/CuvsFlatIndex_8cuh.xml @@ -1,5 +1,5 @@ - + CuvsFlatIndex.cuh diff --git a/xml/CuvsIVFFlat_8cuh.xml b/xml/CuvsIVFFlat_8cuh.xml index 6de57b152c..34f6637137 100644 --- a/xml/CuvsIVFFlat_8cuh.xml +++ b/xml/CuvsIVFFlat_8cuh.xml @@ -1,5 +1,5 @@ - + CuvsIVFFlat.cuh diff --git a/xml/CuvsIVFPQ_8cuh.xml b/xml/CuvsIVFPQ_8cuh.xml index d21cfafd0c..5784039afe 100644 --- a/xml/CuvsIVFPQ_8cuh.xml +++ b/xml/CuvsIVFPQ_8cuh.xml @@ -1,5 +1,5 @@ - + CuvsIVFPQ.cuh diff --git a/xml/CuvsUtils_8h.xml b/xml/CuvsUtils_8h.xml index 0ec7012191..15c2066598 100644 --- a/xml/CuvsUtils_8h.xml +++ b/xml/CuvsUtils_8h.xml @@ -1,5 +1,5 @@ - + CuvsUtils.h faiss/MetricType.h @@ -7,41 +7,28 @@ faiss/gpu/utils/Tensor.cuh cuvs/distance/distance.h - - + + + + + - - - - + + + + - + - + - + - - - - - - - - + - + - - - - - - - - - @@ -54,64 +41,77 @@ - - + + + - - - - + + + + - + - + - + + + + + + + + + + + - - + + + + + + + - - + + - - + + - - - - - + + - - - + + - - - - - - - - - - - - - + + + + + + + + + + + + + + faiss faiss::gpu @@ -159,17 +159,17 @@ MetricTypemetric, boolexactDistance){ switch(metric){ -caseMetricType::METRIC_INNER_PRODUCT: +caseMetricType::METRIC_INNER_PRODUCT: returncuvsDistanceType::InnerProduct; -caseMetricType::METRIC_L2: +caseMetricType::METRIC_L2: returncuvsDistanceType::L2Expanded; -caseMetricType::METRIC_L1: +caseMetricType::METRIC_L1: returncuvsDistanceType::L1; -caseMetricType::METRIC_Linf: +caseMetricType::METRIC_Linf: returncuvsDistanceType::Linf; -caseMetricType::METRIC_Lp: +caseMetricType::METRIC_Lp: returncuvsDistanceType::LpUnexpanded; -caseMetricType::METRIC_Canberra: +caseMetricType::METRIC_Canberra: returncuvsDistanceType::Canberra; caseMetricType::METRIC_BrayCurtis: returncuvsDistanceType::BrayCurtis; diff --git a/xml/DeviceDefs_8cuh.xml b/xml/DeviceDefs_8cuh.xml index 0aa8ffd6cc..9b8fa6571e 100644 --- a/xml/DeviceDefs_8cuh.xml +++ b/xml/DeviceDefs_8cuh.xml @@ -1,5 +1,5 @@ - + DeviceDefs.cuh diff --git a/xml/DeviceTensor-inl_8cuh.xml b/xml/DeviceTensor-inl_8cuh.xml index b2c6a71424..63cf1255ef 100644 --- a/xml/DeviceTensor-inl_8cuh.xml +++ b/xml/DeviceTensor-inl_8cuh.xml @@ -1,5 +1,5 @@ - + DeviceTensor-inl.cuh diff --git a/xml/DeviceTensor_8cuh.xml b/xml/DeviceTensor_8cuh.xml index 9527f6e694..9d21c7c210 100644 --- a/xml/DeviceTensor_8cuh.xml +++ b/xml/DeviceTensor_8cuh.xml @@ -1,5 +1,5 @@ - + DeviceTensor.cuh diff --git a/xml/DeviceUtils_8h.xml b/xml/DeviceUtils_8h.xml index 14454e4f4f..d40b343b7e 100644 --- a/xml/DeviceUtils_8h.xml +++ b/xml/DeviceUtils_8h.xml @@ -1,5 +1,5 @@ - + DeviceUtils.h cublas_v2.h @@ -8,6 +8,32 @@ vector faiss/gpu/StandardGpuResources.h + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -20,9 +46,6 @@ - - - @@ -34,69 +57,46 @@ - - - - - - - - - - - + + + + + + + + - - - - - - - - + + - - - - - - - - - - - - - - - - + + - - - - + + + + - - - - + + + + @@ -105,7 +105,7 @@ faiss::gpu::CudaEvent faiss faiss::gpu - + CUDA_VERIFY X @@ -124,7 +124,7 @@ - + CUDA_TEST_ERROR @@ -139,9 +139,9 @@ - + - + @@ -242,7 +242,7 @@ classDeviceScope{ public: explicitDeviceScope(intdevice); -~DeviceScope(); +~DeviceScope(); private: intprevDevice_; @@ -252,7 +252,7 @@ classCublasHandleScope{ public: CublasHandleScope(); -~CublasHandleScope(); +~CublasHandleScope(); cublasHandle_tget(){ returnblasHandle_; @@ -267,9 +267,9 @@ public: ///Createsaneventandrecordsitinthisstream explicitCudaEvent(cudaStream_tstream,booltimer=false); -CudaEvent(constCudaEvent&event)=delete; -CudaEvent(CudaEvent&&event)noexcept; -~CudaEvent(); +CudaEvent(constCudaEvent&event)=delete; +CudaEvent(CudaEvent&&event)noexcept; +~CudaEvent(); inlinecudaEvent_tget(){ returnevent_; @@ -281,7 +281,7 @@ ///HavetheCPUwaitforthecompletionofthisevent voidcpuWaitOnEvent(); -CudaEvent&operator=(CudaEvent&&event)noexcept; +CudaEvent&operator=(CudaEvent&&event)noexcept; CudaEvent&operator=(CudaEvent&event)=delete; private: @@ -294,10 +294,10 @@ autoerr__=(X);\ FAISS_ASSERT_FMT(\ err__==cudaSuccess,\ -"CUDAerror%d%s",\ -(int)err__,\ -cudaGetErrorString(err__));\ -}while(0) +"CUDAerror%d%s",\ +(int)err__,\ +cudaGetErrorString(err__));\ +}while(0) ///WrappertosynchronouslyprobeforCUDAerrors //#defineFAISS_GPU_SYNC_ERROR1 diff --git a/xml/DeviceVector_8cuh.xml b/xml/DeviceVector_8cuh.xml index 7955881c67..bd62e7f369 100644 --- a/xml/DeviceVector_8cuh.xml +++ b/xml/DeviceVector_8cuh.xml @@ -1,5 +1,5 @@ - + DeviceVector.cuh diff --git a/xml/DirectMap_8h.xml b/xml/DirectMap_8h.xml index f5db2505bd..0c80b2fc77 100644 --- a/xml/DirectMap_8h.xml +++ b/xml/DirectMap_8h.xml @@ -1,11 +1,17 @@ - + DirectMap.h faiss/invlists/InvertedLists.h unordered_map faiss/IndexIVF.h + + + + + + @@ -14,8 +20,13 @@ - - + + + + + + + @@ -25,52 +36,39 @@ + + + - - - - - - - - - - - - - - - - + + - - - - - - - + + + - - - - + + + + + + - - - - - + + + + + @@ -79,130 +77,136 @@ - + + + - + - - - + - + - + - + - - - - + + + + - - - + + + - + + + + + + + + + - + - - - - - - - + + + - - - - + + + + - + - - - + + + - - - + + + - - - + + + - - - + + + - + - + - + - + - - - - - + + + - - - - - + + + - - - + + + - - - - + + + + + + + + - - - - - + - + + + + + + + - - - + + + @@ -211,12 +215,8 @@ - - - - - - + + faiss::DirectMap @@ -320,7 +320,7 @@ ///Thread-safewayofupdatingthedirect_map structDirectMapAdd{ -usingType=DirectMap::Type; +usingType=DirectMap::Type; DirectMap&direct_map; DirectMap::Typetype; @@ -335,7 +335,7 @@ ///addvectori(withidxids[i])atlist_noandoffset voidadd(size_ti,idx_tlist_no,size_toffset); -~DirectMapAdd(); +~DirectMapAdd(); }; }//namespacefaiss diff --git a/xml/DistanceComputer_8h.xml b/xml/DistanceComputer_8h.xml index 3201bbc187..59acf986c7 100644 --- a/xml/DistanceComputer_8h.xml +++ b/xml/DistanceComputer_8h.xml @@ -1,40 +1,11 @@ - + DistanceComputer.h faiss/Index.h - faiss/impl/ScalarQuantizer.h faiss/IndexFlatCodes.h + faiss/impl/ScalarQuantizer.h - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -55,225 +26,254 @@ - - - - - - + + + + - + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + - + - - - - + + + + + + + + - + - + - + - - - - - + - - - - - - - - - - - - - + - - - - - - - - - - - + - + - - - - - + - + - - - - - + - + - - - - + + + + - + + + + + + + + + - + - + + + + + - + + + + + + + + + + + - - - - - - + + + + - - - + + + + + + + + + + + + + - - - - - + - + - + - - - - + + + + - - - - - - + + + + - + - - - - - - - - - + - - - + + + - - - - - - - + + + - + - + - + - + + + + + + + + + + + - + + + + + - + + + + + + + - + - + - - - - - - - - - - - - - - - + + + + + + + + + - - - - + + + + + + + + - - - + + + + + + + faiss::DistanceComputer @@ -343,7 +343,7 @@ ///computedistancebetweentwostoredvectors virtualfloatsymmetric_dis(idx_ti,idx_tj)=0; -virtual~DistanceComputer(){} +virtual~DistanceComputer(){} }; /*Wrapthedistancecomputerintoonethatnegatesthe @@ -387,7 +387,7 @@ return-basedis->symmetric_dis(i,j); } -virtual~NegativeDistanceComputer(){ +virtual~NegativeDistanceComputer(){ deletebasedis; } }; @@ -412,7 +412,7 @@ ///computedistanceofcurrentquerytoanencodedvector virtualfloatdistance_to_code(constuint8_t*code)=0; -virtual~FlatCodesDistanceComputer(){} +virtual~FlatCodesDistanceComputer(){} }; }//namespacefaiss diff --git a/xml/DistanceUtils_8cuh.xml b/xml/DistanceUtils_8cuh.xml index f4ba3660ad..cbeb64309f 100644 --- a/xml/DistanceUtils_8cuh.xml +++ b/xml/DistanceUtils_8cuh.xml @@ -1,5 +1,5 @@ - + DistanceUtils.cuh diff --git a/xml/Distance_8cuh.xml b/xml/Distance_8cuh.xml index c0e8cb250d..bf7a249b8d 100644 --- a/xml/Distance_8cuh.xml +++ b/xml/Distance_8cuh.xml @@ -1,5 +1,5 @@ - + Distance.cuh diff --git a/xml/Doxyfile.xml b/xml/Doxyfile.xml new file mode 100644 index 0000000000..01d96551de --- /dev/null +++ b/xml/Doxyfile.xml @@ -0,0 +1,349 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/xml/FaissAssert_8h.xml b/xml/FaissAssert_8h.xml index 5f6e84e3f4..d4fb28b29d 100644 --- a/xml/FaissAssert_8h.xml +++ b/xml/FaissAssert_8h.xml @@ -1,5 +1,5 @@ - + FaissAssert.h faiss/impl/FaissException.h @@ -15,13 +15,27 @@ faiss/impl/HNSW.h faiss/impl/NNDescent.h faiss/impl/NSG.h - faiss/impl/simd_result_handlers.h faiss/impl/ThreadedIndex-inl.h + faiss/impl/simd_result_handlers.h faiss/utils/approx_topk/avx2-inl.h faiss/utils/approx_topk/generic.h faiss/utils/extra_distances-inl.h faiss/utils/simdlib_neon.h + + + + + + + + + + + + + + @@ -45,189 +59,125 @@ - - + + + + + - - - - - + + - - - - - - - - - - - - - - - - + + - - - - + + + + - - - - - - + + + + - + + + + + - - - - + + + + - + - - - - - + - + - + - - - - - - - - - + + + - - - - - + + + - - - - - + + + - - - - - + + + - - - - + + + + - - - - - - - - - + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - + + + - - - - + + + + - - - - - - - - - - + + + + - + - - - - - - - - - + - - - + + + @@ -235,57 +185,29 @@ - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - + - - - - - + - + - - - + + + - - @@ -293,6 +215,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -314,7 +260,7 @@ - + @@ -325,20 +271,74 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + FAISS_ASSERT X @@ -361,7 +361,7 @@ - + FAISS_ASSERT_MSG @@ -385,7 +385,7 @@ - + FAISS_ASSERT_FMT @@ -411,7 +411,7 @@ - + FAISS_THROW_MSG @@ -427,7 +427,7 @@ - + FAISS_THROW_FMT @@ -447,7 +447,7 @@ - + FAISS_THROW_IF_NOT @@ -464,7 +464,7 @@ - + FAISS_THROW_IF_MSG @@ -481,7 +481,7 @@ - + FAISS_THROW_IF_NOT_MSG @@ -512,9 +512,9 @@ - + - + @@ -546,44 +546,44 @@ do{\ if(!(X)){\ fprintf(stderr,\ -"Faissassertion'%s'failedin%s"\ -"at%s:%d\n",\ -#X,\ -__PRETTY_FUNCTION__,\ -__FILE__,\ -__LINE__);\ -abort();\ -}\ -}while(false) +"Faissassertion'%s'failedin%s"\ +"at%s:%d\n",\ +#X,\ +__PRETTY_FUNCTION__,\ +__FILE__,\ +__LINE__);\ +abort();\ +}\ +}while(false) #defineFAISS_ASSERT_MSG(X,MSG)\ do{\ if(!(X)){\ fprintf(stderr,\ -"Faissassertion'%s'failedin%s"\ -"at%s:%d;details:"MSG"\n",\ -#X,\ -__PRETTY_FUNCTION__,\ -__FILE__,\ -__LINE__);\ -abort();\ -}\ -}while(false) +"Faissassertion'%s'failedin%s"\ +"at%s:%d;details:"MSG"\n",\ +#X,\ +__PRETTY_FUNCTION__,\ +__FILE__,\ +__LINE__);\ +abort();\ +}\ +}while(false) #defineFAISS_ASSERT_FMT(X,FMT,...)\ do{\ if(!(X)){\ fprintf(stderr,\ -"Faissassertion'%s'failedin%s"\ -"at%s:%d;details:"FMT"\n",\ -#X,\ -__PRETTY_FUNCTION__,\ -__FILE__,\ -__LINE__,\ -__VA_ARGS__);\ -abort();\ -}\ -}while(false) +"Faissassertion'%s'failedin%s"\ +"at%s:%d;details:"FMT"\n",\ +#X,\ +__PRETTY_FUNCTION__,\ +__FILE__,\ +__LINE__,\ +__VA_ARGS__);\ +abort();\ +}\ +}while(false) /// ///Exceptionsforreturningusererrors @@ -612,25 +612,25 @@ #defineFAISS_THROW_IF_NOT(X)\ do{\ if(!(X)){\ -FAISS_THROW_FMT("Error:'%s'failed",#X);\ -}\ -}while(false) +FAISS_THROW_FMT("Error:'%s'failed",#X);\ +}\ +}while(false) #defineFAISS_THROW_IF_MSG(X,MSG)\ do{\ if(X){\ -FAISS_THROW_FMT("Error:'%s'failed:"MSG,#X);\ -}\ -}while(false) +FAISS_THROW_FMT("Error:'%s'failed:"MSG,#X);\ +}\ +}while(false) #defineFAISS_THROW_IF_NOT_MSG(X,MSG)FAISS_THROW_IF_MSG(!(X),MSG) #defineFAISS_THROW_IF_NOT_FMT(X,FMT,...)\ do{\ if(!(X)){\ -FAISS_THROW_FMT("Error:'%s'failed:"FMT,#X,__VA_ARGS__);\ -}\ -}while(false) +FAISS_THROW_FMT("Error:'%s'failed:"FMT,#X,__VA_ARGS__);\ +}\ +}while(false) #endif diff --git a/xml/FaissException_8h.xml b/xml/FaissException_8h.xml index 5ef29f42ed..537686fd4b 100644 --- a/xml/FaissException_8h.xml +++ b/xml/FaissException_8h.xml @@ -1,5 +1,5 @@ - + FaissException.h exception @@ -21,189 +21,119 @@ - - - - - + + + + + - - - - - - - - - - + + + + - - - - + + + + - - - - - - - - + + + + - - - - + + + + - + - - - - - + - + - + - - - - - - - - - + + + - - - - - + + + - - - - - + + + - - - - - + + + - - - - + + + + - - - - - - - - - + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - - - - + + + + - - - - - - - - - - + + + + - + - - - - - - - - - + - - - + + + @@ -211,57 +141,29 @@ - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - + - - - - - + - + - - - + + + - - @@ -269,16 +171,28 @@ - - - - - - - - + + + + + + + + + + + + + + + + - + + + + + @@ -302,7 +216,7 @@ - + @@ -313,18 +227,104 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::FaissException faiss::TransformedVectors @@ -365,7 +365,7 @@ intline); ///fromstd::exception -constchar*what()constnoexceptoverride; +constchar*what()constnoexceptoverride; std::stringmsg; }; @@ -373,7 +373,7 @@ ///Handlemultipleexceptionsfromworkerthreads,throwinganappropriate ///exceptionthataggregatestheinformation ///Thepairintisthethreadthatgeneratedtheexception -voidhandleExceptions( +voidhandleExceptions( std::vector<std::pair<int,std::exception_ptr>>&exceptions); /**RAIIobjectforasetofpossiblytransformedvectors(deallocatedonlyif @@ -386,7 +386,7 @@ own_x=x_orig!=x; } -~TransformedVectors(){ +~TransformedVectors(){ if(own_x){ delete[]x; } diff --git a/xml/FlatIndex_8cuh.xml b/xml/FlatIndex_8cuh.xml index d122866843..9dcb5d88a7 100644 --- a/xml/FlatIndex_8cuh.xml +++ b/xml/FlatIndex_8cuh.xml @@ -1,5 +1,5 @@ - + FlatIndex.cuh diff --git a/xml/Float16_8cuh.xml b/xml/Float16_8cuh.xml index 4be477b502..1aca992201 100644 --- a/xml/Float16_8cuh.xml +++ b/xml/Float16_8cuh.xml @@ -1,5 +1,5 @@ - + Float16.cuh diff --git a/xml/GeneralDistance_8cuh.xml b/xml/GeneralDistance_8cuh.xml index d4374aff2e..b2166de87f 100644 --- a/xml/GeneralDistance_8cuh.xml +++ b/xml/GeneralDistance_8cuh.xml @@ -1,5 +1,5 @@ - + GeneralDistance.cuh diff --git a/xml/GpuAutoTune_8h.xml b/xml/GpuAutoTune_8h.xml index 97e4452d54..d23859ba74 100644 --- a/xml/GpuAutoTune_8h.xml +++ b/xml/GpuAutoTune_8h.xml @@ -1,27 +1,10 @@ - + GpuAutoTune.h faiss/AutoTune.h faiss/Index.h - - - - - - - - - - - - - - - - - @@ -34,21 +17,11 @@ - - - - - - - - - - - - - - - + + + + + @@ -57,14 +30,10 @@ - - - - - - - + + + @@ -73,6 +42,8 @@ + + @@ -88,6 +59,35 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::gpu::GpuParameterSpace faiss diff --git a/xml/GpuClonerOptions_8h.xml b/xml/GpuClonerOptions_8h.xml index 94a8221200..f01705fe7d 100644 --- a/xml/GpuClonerOptions_8h.xml +++ b/xml/GpuClonerOptions_8h.xml @@ -1,5 +1,5 @@ - + GpuClonerOptions.h faiss/gpu/GpuIndicesOptions.h @@ -17,16 +17,16 @@ + + + + - - - - faiss::gpu::GpuClonerOptions faiss::gpu::GpuMultipleClonerOptions diff --git a/xml/GpuCloner_8h.xml b/xml/GpuCloner_8h.xml index 9311400aa4..b8c4c36db8 100644 --- a/xml/GpuCloner_8h.xml +++ b/xml/GpuCloner_8h.xml @@ -1,5 +1,5 @@ - + GpuCloner.h vector @@ -11,36 +11,6 @@ faiss/gpu/GpuIndex.h faiss/gpu/GpuIndicesOptions.h - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -49,59 +19,20 @@ - - - - - - - - - - - - - - - - - - - - - + + + + - + - + - + - + - - - - - - - - - - - - - - - - - - - - - - @@ -116,20 +47,16 @@ - - - - - - - - - - - - + + + + + + + + @@ -150,10 +77,10 @@ - - - - + + + + @@ -164,6 +91,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -178,9 +125,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::gpu::ToCPUCloner faiss::gpu::ToGpuCloner @@ -258,7 +258,7 @@ Index*clone_Index_to_shards(constIndex*index); ///mainfunction -Index*clone_Index(constIndex*index)override; +Index*clone_Index(constIndex*index)override; }; ///convertsanyGPUindexinsidegpu_indextoaCPUindex @@ -287,9 +287,9 @@ explicitGpuProgressiveDimIndexFactory(intngpu); -Index*operator()(intdim)override; +Index*operator()(intdim)override; -virtual~GpuProgressiveDimIndexFactory()override; +virtual~GpuProgressiveDimIndexFactory()override; }; /********************************************* diff --git a/xml/GpuDistance_8h.xml b/xml/GpuDistance_8h.xml index 7587761d81..3e7d31fdef 100644 --- a/xml/GpuDistance_8h.xml +++ b/xml/GpuDistance_8h.xml @@ -1,38 +1,9 @@ - + GpuDistance.h faiss/Index.h - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -53,6 +24,35 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::gpu::GpuDistanceParams faiss diff --git a/xml/GpuFaissAssert_8h.xml b/xml/GpuFaissAssert_8h.xml index 23c57dfd15..7c0d7f281f 100644 --- a/xml/GpuFaissAssert_8h.xml +++ b/xml/GpuFaissAssert_8h.xml @@ -1,10 +1,32 @@ - + GpuFaissAssert.h cuda.h faiss/impl/FaissAssert.h + + + + + + + + + + + + + + + + + + + + + + @@ -28,51 +50,29 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + - + GPU_FAISS_ASSERT X @@ -113,7 +113,7 @@ - + diff --git a/xml/GpuIcmEncoder_8h.xml b/xml/GpuIcmEncoder_8h.xml index 2f0c909680..b632e2efa9 100644 --- a/xml/GpuIcmEncoder_8h.xml +++ b/xml/GpuIcmEncoder_8h.xml @@ -1,21 +1,22 @@ - + GpuIcmEncoder.h faiss/impl/LocalSearchQuantizer.h memory - - - - - - - + + + + - + - + + + + + @@ -26,28 +27,51 @@ - - - - + + + + - + + + - - - - - + + + + + - - + + + + + + + - - + + + + + + + + + + + + + + + - - + + + + + @@ -75,29 +99,13 @@ - - - - - - - - - - - - - + + + + + + - - - - - - - - - @@ -131,62 +139,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -203,9 +155,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::gpu::GpuIcmEncoder faiss::gpu::GpuIcmEncoderFactory @@ -247,7 +247,7 @@ conststd::vector<GpuResourcesProvider*>&provs, conststd::vector<int>&devices); -~GpuIcmEncoder(); +~GpuIcmEncoder(); GpuIcmEncoder(constGpuIcmEncoder&)=delete; GpuIcmEncoder&operator=(constGpuIcmEncoder&)=delete; diff --git a/xml/GpuIndexBinaryFlat_8h.xml b/xml/GpuIndexBinaryFlat_8h.xml index 884e053a1d..af83d4e24b 100644 --- a/xml/GpuIndexBinaryFlat_8h.xml +++ b/xml/GpuIndexBinaryFlat_8h.xml @@ -1,5 +1,5 @@ - + GpuIndexBinaryFlat.h faiss/IndexBinaryFlat.h @@ -7,91 +7,20 @@ faiss/gpu/GpuResources.h memory - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - - - - - - - - - - - - - - - - - - - - - @@ -106,18 +35,14 @@ - - - - - - - - + + + + - + - + @@ -134,14 +59,32 @@ - - - - + + + + - + - + + + + + + + + + + + + + + + + + + + @@ -158,9 +101,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::gpu::GpuIndexBinaryFlatConfig faiss::gpu::GpuIndexBinaryFlat @@ -209,14 +209,14 @@ intdims, GpuIndexBinaryFlatConfigconfig=GpuIndexBinaryFlatConfig()); -~GpuIndexBinaryFlat()override; +~GpuIndexBinaryFlat()override; ///Returnsthedevicethatthisindexisresidenton intgetDevice()const; ///ReturnsareferencetoourGpuResourcesobjectthatmanagesmemory, ///streamandhandleresourcesontheGPU -std::shared_ptr<GpuResources>getResources(); +std::shared_ptr<GpuResources>getResources(); ///InitializeourselvesfromthegivenCPUindex;willoverwrite ///alldatainourselves diff --git a/xml/GpuIndexCagra_8h.xml b/xml/GpuIndexCagra_8h.xml index 90c16e9806..8148a17859 100644 --- a/xml/GpuIndexCagra_8h.xml +++ b/xml/GpuIndexCagra_8h.xml @@ -1,66 +1,32 @@ - + GpuIndexCagra.h faiss/IndexIVF.h faiss/gpu/GpuIndex.h faiss/gpu/GpuIndexIVFPQ.h - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - + - + + + - - - @@ -88,16 +54,29 @@ - - - - + + + + - + + + + + + + - - + + + + + + + + + @@ -107,158 +86,93 @@ - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - + - + - + - - - - - + - + - + + + + + - + - + - - - - - - - - - - - - - + + + + - + - + - - - - - - - - - - - + - + - + - + + + + + - + - - - - - - - - - - - - - + - + - - - - + + + + - + - + - - - - - - - - - - - - - - - - - + + + + - + - + - - - - - + + + @@ -278,12 +192,18 @@ - - - - + + + + - + + + + + + + @@ -294,26 +214,106 @@ - - + + + + + + + - - - - + + + + - + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::gpu::IVFPQBuildCagraConfig faiss::gpu::IVFPQSearchCagraConfig diff --git a/xml/GpuIndexFlat_8h.xml b/xml/GpuIndexFlat_8h.xml index b2da01b817..fa2bccbee8 100644 --- a/xml/GpuIndexFlat_8h.xml +++ b/xml/GpuIndexFlat_8h.xml @@ -1,40 +1,39 @@ - + GpuIndexFlat.h faiss/gpu/GpuIndex.h memory faiss/gpu/GpuIndexIVF.h - - - - + + + + - + - + - + + + - - + + + + + - - - - + + + + - + - - - - - - @@ -43,12 +42,6 @@ - - - - - - @@ -65,71 +58,88 @@ - - - - - - - - - - - - - - - - - - - - - - + + + + + + - + - - - - - - + + + + - - - - - + - + - - - - - + - + + + + + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -140,15 +150,9 @@ - - - - - - - - - + + + @@ -156,10 +160,6 @@ - - - - @@ -241,7 +241,7 @@ faiss::MetricTypemetric, GpuIndexFlatConfigconfig=GpuIndexFlatConfig()); -~GpuIndexFlat()override; +~GpuIndexFlat()override; ///InitializeourselvesfromthegivenCPUindex;willoverwrite ///alldatainourselves @@ -286,7 +286,7 @@ constidx_t*keys)constoverride; ///Forinternalaccess -inlineFlatIndex*getGpuData(){ +inlineFlatIndex*getGpuData(){ returndata_.get(); } diff --git a/xml/GpuIndexIVFFlat_8h.xml b/xml/GpuIndexIVFFlat_8h.xml index 3e48023336..fa65a8fc68 100644 --- a/xml/GpuIndexIVFFlat_8h.xml +++ b/xml/GpuIndexIVFFlat_8h.xml @@ -1,56 +1,11 @@ - + GpuIndexIVFFlat.h faiss/gpu/GpuIndexIVF.h faiss/impl/ScalarQuantizer.h memory - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -59,25 +14,18 @@ - - - - - - - - - - - + + + + - + - + - + - + @@ -106,16 +54,19 @@ - - - - - - + + + + - - + + + + + + + @@ -125,37 +76,36 @@ - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - + + + + - + - + + + + + @@ -172,11 +122,23 @@ - - - - - + + + + + + + + + + + + + + + + + @@ -184,18 +146,81 @@ - - - + + + + + + + + + + + + + - - + + + + + + + + + + + - - + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -229,93 +254,68 @@ + + + + + + + + + + + + + + + - - - - - - - - - + + - - + + - - - - - - - - - + + - - + + - - - - - - - - - - - - - + + + + + - - - - - + + - - - - - - - + + - - - - - - - + + - - + + - - - - - - - - - - - - - + + - - + + + + + + + + faiss::gpu::GpuIndexIVFFlatConfig @@ -387,7 +387,7 @@ faiss::MetricTypemetric=faiss::METRIC_L2, GpuIndexIVFFlatConfigconfig=GpuIndexIVFFlatConfig()); -~GpuIndexIVFFlat()override; +~GpuIndexIVFFlat()override; ///ReserveGPUmemoryinourinvertedlistsforthisnumberofvectors voidreserveMemory(size_tnumVecs); diff --git a/xml/GpuIndexIVFPQ_8h.xml b/xml/GpuIndexIVFPQ_8h.xml index ca045e7578..41bf3082bc 100644 --- a/xml/GpuIndexIVFPQ_8h.xml +++ b/xml/GpuIndexIVFPQ_8h.xml @@ -1,5 +1,5 @@ - + GpuIndexIVFPQ.h faiss/gpu/GpuIndexIVF.h @@ -8,61 +8,27 @@ vector faiss/gpu/GpuIndexCagra.h - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - + - + + + - - - @@ -90,16 +56,19 @@ - - - - - - + + + + - - + + + + + + + @@ -109,41 +78,38 @@ - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - + + + + - + - + + + + + + + @@ -160,97 +126,45 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - + - - - - - - - - - - - - - + - + - - - - + + + + - + - + - - - - - - - - - - - - - - - - - + + + + - + - + - - - - - + + + @@ -270,12 +184,18 @@ - - - - + + + + - + + + + + + + @@ -286,26 +206,106 @@ - - + + + + + + + - - - - + + + + - + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -411,7 +411,7 @@ faiss::MetricTypemetric=faiss::METRIC_L2, GpuIndexIVFPQConfigconfig=GpuIndexIVFPQConfig()); -~GpuIndexIVFPQ()override; +~GpuIndexIVFPQ()override; ///ReservespaceontheGPUfortheinvertedlistsfor`num` ///vectors,assumedequallydistributedamong diff --git a/xml/GpuIndexIVFScalarQuantizer_8h.xml b/xml/GpuIndexIVFScalarQuantizer_8h.xml index d40ef30bb6..4102095ea3 100644 --- a/xml/GpuIndexIVFScalarQuantizer_8h.xml +++ b/xml/GpuIndexIVFScalarQuantizer_8h.xml @@ -1,45 +1,33 @@ - + GpuIndexIVFScalarQuantizer.h faiss/IndexScalarQuantizer.h faiss/gpu/GpuIndexIVF.h memory - - - - - - - - + + + + - - - - - - + + + + - + - + - + - + - - - - - - @@ -50,46 +38,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -116,16 +64,33 @@ - - - - + + + + + + + + + + - - + + + + + + + + + + + + + @@ -135,37 +100,36 @@ - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - + + + + - + - + + + + + @@ -182,11 +146,23 @@ - - - - - + + + + + + + + + + + + + + + + + @@ -194,18 +170,81 @@ - - - + + + + + + + + + + + + + - - + + + + + + + + + + + - - + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -239,107 +278,68 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - + + - - + + - - - - - - - - - + + - - + + - - - - - - - - - - - - - + + + + + - - - - - + + - - - - - - - + + - - - - - - - + + - - + + - - - - - - - - - - - - - + + - - + + + + + + + + faiss::gpu::GpuIndexIVFScalarQuantizerConfig @@ -395,7 +395,7 @@ intdims, idx_tnlist, faiss::ScalarQuantizer::QuantizerTypeqtype, -faiss::MetricTypemetric=MetricType::METRIC_L2, +faiss::MetricTypemetric=MetricType::METRIC_L2, boolencodeResidual=true, GpuIndexIVFScalarQuantizerConfigconfig= GpuIndexIVFScalarQuantizerConfig()); @@ -408,12 +408,12 @@ intdims, idx_tnlist, faiss::ScalarQuantizer::QuantizerTypeqtype, -faiss::MetricTypemetric=MetricType::METRIC_L2, +faiss::MetricTypemetric=MetricType::METRIC_L2, boolencodeResidual=true, GpuIndexIVFScalarQuantizerConfigconfig= GpuIndexIVFScalarQuantizerConfig()); -~GpuIndexIVFScalarQuantizer()override; +~GpuIndexIVFScalarQuantizer()override; ///ReserveGPUmemoryinourinvertedlistsforthisnumberofvectors voidreserveMemory(size_tnumVecs); diff --git a/xml/GpuIndexIVF_8h.xml b/xml/GpuIndexIVF_8h.xml index e559eddea9..092661cde4 100644 --- a/xml/GpuIndexIVF_8h.xml +++ b/xml/GpuIndexIVF_8h.xml @@ -1,5 +1,5 @@ - + GpuIndexIVF.h faiss/Clustering.h @@ -12,61 +12,27 @@ faiss/gpu/GpuIndexIVFPQ.h faiss/gpu/GpuIndexIVFScalarQuantizer.h - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - + - + + + - - - @@ -94,16 +60,19 @@ - - - - - - + + + + - - + + + + + + + @@ -113,31 +82,26 @@ - - - - - - - - - - - - - - - - - - - + + + + - + - + + + + + + + + + + + @@ -154,24 +118,65 @@ - - + + + + + + + + + + + + + - - + + + + + + + + + + + - - - + + + + + + + + + - - + + + + + + + - - + + + + + + + - - + + + + + + + @@ -205,73 +210,72 @@ - - - - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + - - - - - - - + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -282,9 +286,9 @@ - - - + + + @@ -292,10 +296,6 @@ - - - - @@ -372,7 +372,7 @@ idx_tnlist, GpuIndexIVFConfigconfig=GpuIndexIVFConfig()); -~GpuIndexIVF()override; +~GpuIndexIVF()override; private: ///Sharedinitializationfunctions @@ -402,13 +402,13 @@ ///GPU-siderepresentation. ///Otherwise,itisconvertedtotheCPUformat. ///compliantformat,whilethenativeGPUformatmaydiffer. -virtualstd::vector<uint8_t>getListVectorData( +virtualstd::vector<uint8_t>getListVectorData( idx_tlistId, boolgpuFormat=false)const; ///Returnthevectorindicescontainedinaparticularinvertedlist,for ///debuggingpurposes. -virtualstd::vector<idx_t>getListIndices(idx_tlistId)const; +virtualstd::vector<idx_t>getListIndices(idx_tlistId)const; voidsearch_preassigned( idx_tn, diff --git a/xml/GpuIndex_8h.xml b/xml/GpuIndex_8h.xml index 9af276fd6c..b1ff5a7764 100644 --- a/xml/GpuIndex_8h.xml +++ b/xml/GpuIndex_8h.xml @@ -1,5 +1,5 @@ - + GpuIndex.h faiss/Index.h @@ -10,75 +10,6 @@ faiss/gpu/GpuIndexFlat.h faiss/gpu/GpuIndexIVF.h - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -107,6 +38,22 @@ + + + + + + + + + + + + + + + + @@ -121,49 +68,64 @@ - - - - - - - - - + + + + - + + + - - - + + + + + - - - + + - - - + + - - - - - + + + + + + + + + + + + + + - - + + + + - - + + + + + + + + + @@ -182,6 +144,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::gpu::GpuIndexConfig faiss::gpu::GpuIndex @@ -258,7 +258,7 @@ ///ReturnsareferencetoourGpuResourcesobjectthatmanagesmemory, ///streamandhandleresourcesontheGPU -std::shared_ptr<GpuResources>getResources(); +std::shared_ptr<GpuResources>getResources(); ///Settheminimumdatasizeforsearches(inMiB)forwhichweuse ///CPU->GPUpaging diff --git a/xml/GpuIndicesOptions_8h.xml b/xml/GpuIndicesOptions_8h.xml index c687857eac..cc436c5d3f 100644 --- a/xml/GpuIndicesOptions_8h.xml +++ b/xml/GpuIndicesOptions_8h.xml @@ -1,20 +1,14 @@ - + GpuIndicesOptions.h faiss/gpu/GpuCloner.h faiss/gpu/GpuClonerOptions.h faiss/gpu/GpuIndexIVF.h - - - - - - - - - + + + @@ -22,19 +16,23 @@ - - - - + + + + + + + + - + - + - - - + + + @@ -42,17 +40,19 @@ - - - - - - - + + + + + + + + + faiss diff --git a/xml/GpuResources_8h.xml b/xml/GpuResources_8h.xml index d89c5a995f..62f2acdf33 100644 --- a/xml/GpuResources_8h.xml +++ b/xml/GpuResources_8h.xml @@ -1,5 +1,5 @@ - + GpuResources.h cublas_v2.h @@ -14,6 +14,36 @@ faiss/gpu/utils/CuvsUtils.h faiss/gpu/utils/StackDeviceMemory.h + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -26,9 +56,6 @@ - - - @@ -40,66 +67,65 @@ + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - + + - - + + - - + + - - - - + + + + + + + + + + - + - + - + - - + + + - - - - - - + + + + + + + + @@ -112,23 +138,19 @@ - - - - - - - - - + + + - - - + + + + + - - - + + + @@ -144,46 +166,24 @@ - - - - - - - - - - - - - - - - - + + + - - - + + + - - - - - - - - - - - - + + + + @@ -378,8 +378,8 @@ cudaStream_tstr, void*p, size_tsz); -GpuMemoryReservation(GpuMemoryReservation&&m)noexcept; -~GpuMemoryReservation(); +GpuMemoryReservation(GpuMemoryReservation&&m)noexcept; +~GpuMemoryReservation(); GpuMemoryReservation&operator=(GpuMemoryReservation&&m); @@ -400,7 +400,7 @@ ///cuBLAShandles,CUDAstreamsandalldevicememoryallocationperformed classGpuResources{ public: -virtual~GpuResources(); +virtual~GpuResources(); ///Calltopre-allocateresourcesforaparticulardevice.Ifthisis ///notcalled,thenresourceswillbeallocatedatthefirsttime @@ -430,7 +430,7 @@ virtualvoidsetDefaultStream(intdevice,cudaStream_tstream)=0; ///Returnsthesetofalternativestreamsthatweuseforthegivendevice -virtualstd::vector<cudaStream_t>getAlternateStreams(intdevice)=0; +virtualstd::vector<cudaStream_t>getAlternateStreams(intdevice)=0; ///Memorymanagement ///Returnsanallocationfromthegivenmemoryspace,orderedwithrespect @@ -438,7 +438,7 @@ ///stream).Allallocationsaresizedinternallytobethenexthighest ///multipleof16bytes,andallallocationsreturnedareguaranteedtobe ///16bytealigned. -virtualvoid*allocMemory(constAllocRequest&req)=0; +virtualvoid*allocMemory(constAllocRequest&req)=0; ///Returnsapreviousallocation virtualvoiddeallocMemory(intdevice,void*in)=0; @@ -448,7 +448,7 @@ virtualsize_tgetTempMemoryAvailable(intdevice)const=0; ///ReturnstheavailableCPUpinnedmemorybuffer -virtualstd::pair<void*,size_t>getPinnedMemory()=0; +virtualstd::pair<void*,size_t>getPinnedMemory()=0; ///ReturnsthestreamonwhichweperformasyncCPU<->GPUcopies virtualcudaStream_tgetAsyncCopyStream(intdevice)=0; @@ -481,7 +481,7 @@ voidsyncDefaultStreamCurrentDevice(); ///CallsgetAlternateStreamsforthecurrentdevice -std::vector<cudaStream_t>getAlternateStreamsCurrentDevice(); +std::vector<cudaStream_t>getAlternateStreamsCurrentDevice(); ///CallsgetAsyncCopyStreamforthecurrentdevice cudaStream_tgetAsyncCopyStreamCurrentDevice(); @@ -491,10 +491,10 @@ ///interfacingstd::shared_ptrtoPython classGpuResourcesProvider{ public: -virtual~GpuResourcesProvider(); +virtual~GpuResourcesProvider(); ///Returnsthesharedresourcesobject -virtualstd::shared_ptr<GpuResources>getResources()=0; +virtualstd::shared_ptr<GpuResources>getResources()=0; }; ///AsimplewrapperforaGpuResourcesobjecttomakeaGpuResourcesProvider @@ -502,9 +502,9 @@ classGpuResourcesProviderFromInstance:publicGpuResourcesProvider{ public: explicitGpuResourcesProviderFromInstance(std::shared_ptr<GpuResources>p); -~GpuResourcesProviderFromInstance()override; +~GpuResourcesProviderFromInstance()override; -std::shared_ptr<GpuResources>getResources()override; +std::shared_ptr<GpuResources>getResources()override; private: std::shared_ptr<GpuResources>res_; diff --git a/xml/GpuScalarQuantizer_8cuh.xml b/xml/GpuScalarQuantizer_8cuh.xml index c82398b756..3a61fdcf12 100644 --- a/xml/GpuScalarQuantizer_8cuh.xml +++ b/xml/GpuScalarQuantizer_8cuh.xml @@ -1,5 +1,5 @@ - + GpuScalarQuantizer.cuh diff --git a/xml/HNSW_8h.xml b/xml/HNSW_8h.xml index e4215f72a0..3eefa4d515 100644 --- a/xml/HNSW_8h.xml +++ b/xml/HNSW_8h.xml @@ -1,5 +1,5 @@ - + HNSW.h queue @@ -14,6 +14,40 @@ faiss/IndexBinaryHNSW.h faiss/IndexHNSW.h + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -26,12 +60,6 @@ - - - - - - @@ -54,14 +82,6 @@ - - - - - - - - @@ -70,48 +90,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -144,59 +122,73 @@ - - + + + + + + + + + + - - - - - - - - - - - - - + + - - - - - + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - @@ -213,6 +205,14 @@ + + + + + + + + faiss::SearchParametersHNSW faiss::HNSW @@ -276,15 +276,15 @@ boolcheck_relative_distance=true; boolbounded_queue=true; -~SearchParametersHNSW(){} +~SearchParametersHNSW(){} }; structHNSW{ ///internalstorageofvectors(32bits:thisisexpensive) -usingstorage_idx_t=int32_t; +usingstorage_idx_t=int32_t; //fornowwedoonlythesedistances -usingC=CMax<float, int64_t>; +usingC=CMax<float, int64_t>; typedefstd::pair<float,storage_idx_t>Node; diff --git a/xml/Heap_8h.xml b/xml/Heap_8h.xml index 89619e183f..6fe066e477 100644 --- a/xml/Heap_8h.xml +++ b/xml/Heap_8h.xml @@ -1,5 +1,5 @@ - + Heap.h climits @@ -11,15 +11,15 @@ limits utility faiss/utils/ordered_key_value.h + faiss/IndexBinaryHash.h + faiss/IndexBinaryIVF.h + faiss/IndexIVF.h faiss/impl/HNSW.h faiss/impl/NNDescent.h faiss/impl/NSG.h faiss/impl/ProductQuantizer.h faiss/impl/ResultHandler.h faiss/impl/simd_result_handlers.h - faiss/IndexBinaryHash.h - faiss/IndexBinaryIVF.h - faiss/IndexIVF.h faiss/utils/approx_topk/avx2-inl.h faiss/utils/approx_topk/generic.h faiss/utils/approx_topk_hamming/approx_topk_hamming.h @@ -31,24 +31,6 @@ faiss/utils/hamming.h faiss/utils/utils.h - - - - - - - - - - - - - - - - - - @@ -81,270 +63,344 @@ + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + - - - + + + - + - + - - - - - - - - - - + + - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - + + - - - - - - - - - - + + + + - + - - - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - + - - - - - - - - + + + + - - - - - - - + + + - - - - - - - - + + + + - + - - - - - - - - - - - - - - - - - + - - - - - - - + + + - - - - - - + + + + - - - - - + - - - + + + - - - + + + - - - + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + @@ -354,11 +410,11 @@ - + - + - + @@ -367,126 +423,70 @@ - - - - - + + + - - - - - - - - - - - - - - - - - - - - + + + + - - - + + + - - - - + + + + - - - - - - - - - - - - - - - + + + - - - + + + - - - + + + - - - - - - - - - - - - + + + + - - - - - - - - - - - + + + + + + + - - - + - + - + - + - - - - - - - - - + - - - - faiss::HeapArray faiss @@ -975,12 +975,12 @@ T*val;///<values(distancesorsimilarities),sizenh*k ///Returnthelistofvaluesforaheap -T*get_val(size_tkey){ +T*get_val(size_tkey){ returnval+key*k; } ///Corresppondingidentifiers -TI*get_ids(size_tkey){ +TI*get_ids(size_tkey){ returnids+key*k; } diff --git a/xml/HostTensor-inl_8cuh.xml b/xml/HostTensor-inl_8cuh.xml index d03d6c91a9..bdb2f33579 100644 --- a/xml/HostTensor-inl_8cuh.xml +++ b/xml/HostTensor-inl_8cuh.xml @@ -1,5 +1,5 @@ - + HostTensor-inl.cuh diff --git a/xml/HostTensor_8cuh.xml b/xml/HostTensor_8cuh.xml index f8281df478..3356209b43 100644 --- a/xml/HostTensor_8cuh.xml +++ b/xml/HostTensor_8cuh.xml @@ -1,5 +1,5 @@ - + HostTensor.cuh diff --git a/xml/IDSelector_8h.xml b/xml/IDSelector_8h.xml index 8921f5c0b2..b3fe72dc21 100644 --- a/xml/IDSelector_8h.xml +++ b/xml/IDSelector_8h.xml @@ -1,30 +1,22 @@ - + IDSelector.h unordered_set vector faiss/MetricType.h - faiss/impl/ResultHandler.h - faiss/impl/simd_result_handlers.h faiss/IndexIDMap.h faiss/IndexIVF.h + faiss/impl/ResultHandler.h + faiss/impl/simd_result_handlers.h faiss/python/python_callbacks.h - - - - - - + + + + - - - - - - @@ -35,239 +27,247 @@ + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + - - - + + + - - - - - - + + + + - + + + + + - - - + + + + + + + - + + + + + + + + + - + - + + + - - - + - - - + + + + + - + + + + + + + + + - + - - - + + + + + - - - - + + + + + + + + - + - - - - + + + + - + + + + + - + + + + + + + + + + + + + + + + + + + - - - - - - - + + + - - - + + + + + + + + + + + - - - + + + - - - + + + + + + + + + - + - + - + - - - - + + + + - + - - - - - + + + - + - - - + + + - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - - - - - - - - - - - + + + - - - - - - + + faiss::IDSelector @@ -308,7 +308,7 @@ /**Encapsulatesasetofidstohandle.*/ structIDSelector{ virtualboolis_member(idx_tid)const=0; -virtual~IDSelector(){} +virtual~IDSelector(){} }; /**idsbetween[imin,imax)*/ @@ -331,7 +331,7 @@ size_t*jmin, size_t*jmax)const; -~IDSelectorRange()override{} +~IDSelectorRange()override{} }; /**Simplearrayofelements @@ -351,7 +351,7 @@ */ IDSelectorArray(size_tn,constidx_t*ids); boolis_member(idx_tid)constfinal; -~IDSelectorArray()override{} +~IDSelectorArray()override{} }; /**Idsfromaset. @@ -381,7 +381,7 @@ */ IDSelectorBatch(size_tn,constidx_t*indices); boolis_member(idx_tid)constfinal; -~IDSelectorBatch()override{} +~IDSelectorBatch()override{} }; /**Onebitperelement.Constructedwithabitmap,sizeceil(n/8). @@ -398,7 +398,7 @@ */ IDSelectorBitmap(size_tn,constuint8_t*bitmap); boolis_member(idx_tid)constfinal; -~IDSelectorBitmap()override{} +~IDSelectorBitmap()override{} }; /**revertsthemembershiptestofanotherselector*/ @@ -408,7 +408,7 @@ boolis_member(idx_tid)constfinal{ return!sel->is_member(id); } -virtual~IDSelectorNot(){} +virtual~IDSelectorNot(){} }; ///selectsallentries(usefulforbenchmarking) @@ -416,7 +416,7 @@ boolis_member(idx_tid)constfinal{ returntrue; } -virtual~IDSelectorAll(){} +virtual~IDSelectorAll(){} }; ///doesanANDoperationonthethetwogivenIDSelector'sis_membership @@ -429,7 +429,7 @@ boolis_member(idx_tid)constfinal{ returnlhs->is_member(id)&&rhs->is_member(id); } -virtual~IDSelectorAnd(){} +virtual~IDSelectorAnd(){} }; ///doesanORoperationonthethetwogivenIDSelector'sis_membership @@ -442,7 +442,7 @@ boolis_member(idx_tid)constfinal{ returnlhs->is_member(id)||rhs->is_member(id); } -virtual~IDSelectorOr(){} +virtual~IDSelectorOr(){} }; ///doesanXORoperationonthethetwogivenIDSelector'sis_membership @@ -455,7 +455,7 @@ boolis_member(idx_tid)constfinal{ returnlhs->is_member(id)^rhs->is_member(id); } -virtual~IDSelectorXOr(){} +virtual~IDSelectorXOr(){} }; }//namespacefaiss diff --git a/xml/IVFAppend_8cuh.xml b/xml/IVFAppend_8cuh.xml index e28ef5b416..6202b6820c 100644 --- a/xml/IVFAppend_8cuh.xml +++ b/xml/IVFAppend_8cuh.xml @@ -1,5 +1,5 @@ - + IVFAppend.cuh diff --git a/xml/IVFBase_8cuh.xml b/xml/IVFBase_8cuh.xml index f43b26af4a..9e736dbf2b 100644 --- a/xml/IVFBase_8cuh.xml +++ b/xml/IVFBase_8cuh.xml @@ -1,5 +1,5 @@ - + IVFBase.cuh diff --git a/xml/IVFFlatScan_8cuh.xml b/xml/IVFFlatScan_8cuh.xml index e7e7e6240f..35aab7ac35 100644 --- a/xml/IVFFlatScan_8cuh.xml +++ b/xml/IVFFlatScan_8cuh.xml @@ -1,5 +1,5 @@ - + IVFFlatScan.cuh diff --git a/xml/IVFFlat_8cuh.xml b/xml/IVFFlat_8cuh.xml index 0e8f2a621c..0a0b8f560a 100644 --- a/xml/IVFFlat_8cuh.xml +++ b/xml/IVFFlat_8cuh.xml @@ -1,5 +1,5 @@ - + IVFFlat.cuh diff --git a/xml/IVFInterleavedImpl_8cuh.xml b/xml/IVFInterleavedImpl_8cuh.xml index f2b81e4446..6b591567e2 100644 --- a/xml/IVFInterleavedImpl_8cuh.xml +++ b/xml/IVFInterleavedImpl_8cuh.xml @@ -1,5 +1,5 @@ - + IVFInterleavedImpl.cuh diff --git a/xml/IVFInterleaved_8cuh.xml b/xml/IVFInterleaved_8cuh.xml index 7172f20312..dfa363a967 100644 --- a/xml/IVFInterleaved_8cuh.xml +++ b/xml/IVFInterleaved_8cuh.xml @@ -1,5 +1,5 @@ - + IVFInterleaved.cuh diff --git a/xml/IVFPQ_8cuh.xml b/xml/IVFPQ_8cuh.xml index 03fe1f9b85..cfcf925949 100644 --- a/xml/IVFPQ_8cuh.xml +++ b/xml/IVFPQ_8cuh.xml @@ -1,5 +1,5 @@ - + IVFPQ.cuh diff --git a/xml/IVFUtils_8cuh.xml b/xml/IVFUtils_8cuh.xml index 858ab523f1..133bee5e37 100644 --- a/xml/IVFUtils_8cuh.xml +++ b/xml/IVFUtils_8cuh.xml @@ -1,5 +1,5 @@ - + IVFUtils.cuh diff --git a/xml/IVFlib_8h.xml b/xml/IVFlib_8h.xml index ce60c5d7b0..0b075dc9c0 100644 --- a/xml/IVFlib_8h.xml +++ b/xml/IVFlib_8h.xml @@ -1,24 +1,10 @@ - + IVFlib.h faiss/IndexIVF.h vector - - - - - - - - - - - - - - @@ -27,8 +13,27 @@ - - + + + + + + + + + + + + + + + + + + + + + @@ -56,26 +61,12 @@ - - - - - - + + + + - - - - - - - - - - - - @@ -86,20 +77,29 @@ - - - - - - - - + + + + + + + - - + + + + + + + - - + + + + + + + @@ -133,53 +133,53 @@ - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + + + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + faiss::ivflib::SlidingIndexWindow diff --git a/xml/IcmEncoder_8cuh.xml b/xml/IcmEncoder_8cuh.xml index d4ff38a35a..21be78434a 100644 --- a/xml/IcmEncoder_8cuh.xml +++ b/xml/IcmEncoder_8cuh.xml @@ -1,5 +1,5 @@ - + IcmEncoder.cuh diff --git a/xml/Index2Layer_8h.xml b/xml/Index2Layer_8h.xml index a1630ca7ec..25fba229d5 100644 --- a/xml/Index2Layer_8h.xml +++ b/xml/Index2Layer_8h.xml @@ -1,5 +1,5 @@ - + Index2Layer.h vector @@ -8,57 +8,52 @@ faiss/IndexPQ.h faiss/impl/platform_macros.h - - - - - - + + + - - - - - - + + + + - - - - - - - - + + + + + + + + + - + - + - - - + + + + + - - - @@ -85,13 +80,43 @@ - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -99,21 +124,27 @@ - - - - - - - - - - - + + + + + + + + + + + + + + + + + @@ -121,36 +152,29 @@ - - - - - - + + + + - + - - - - - - - - - - + + + + + + - - - - - - - - + + + + + + + @@ -184,78 +208,54 @@ - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::Index2Layer faiss @@ -313,7 +313,7 @@ MetricTypemetric=METRIC_L2); Index2Layer(); -~Index2Layer(); +~Index2Layer(); voidtrain(idx_tn,constfloat*x)override; @@ -326,7 +326,7 @@ idx_t*labels, constSearchParameters*params=nullptr)constoverride; -DistanceComputer*get_distance_computer()constoverride; +DistanceComputer*get_distance_computer()constoverride; ///transfertheflatcodestoanIVFPQindex voidtransfer_to_IVFPQ(IndexIVFPQ&other)const; diff --git a/xml/IndexAdditiveQuantizerFastScan_8h.xml b/xml/IndexAdditiveQuantizerFastScan_8h.xml index ff827204ee..9bc61c06f3 100644 --- a/xml/IndexAdditiveQuantizerFastScan_8h.xml +++ b/xml/IndexAdditiveQuantizerFastScan_8h.xml @@ -1,5 +1,5 @@ - + IndexAdditiveQuantizerFastScan.h faiss/IndexAdditiveQuantizer.h @@ -8,6 +8,28 @@ faiss/impl/ProductAdditiveQuantizer.h faiss/utils/AlignedTable.h + + + + + + + + + + + + + + + + + + + + + + @@ -28,41 +50,36 @@ - - - - - - + + + + - + - + - + - - - - - - - - + + + + - + - + + + + + - + - - - @@ -73,44 +90,33 @@ - - - - - - + + + + - - - + + + + + - + - - - - - - - - + + + - - - - - - - - - - - + + + + + @@ -132,39 +138,65 @@ + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - + + + + + + + - - + + + + + + + + + + + + + + + @@ -188,6 +220,10 @@ + + + + @@ -198,111 +234,75 @@ - - - - + + + + - + - + - + - + + + - - + + - - + + - - - - - - - - - - - - - + + - - - - - - - + + - - - - - - - - - - - - - - - + + - - - - - + + - - - - - - - - - - - - - + + + + + + + + - - + + - - + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + faiss::IndexAdditiveQuantizerFastScan @@ -347,7 +347,7 @@ structIndexAdditiveQuantizerFastScan:IndexFastScan{ AdditiveQuantizer*aq; -usingSearch_type_t=AdditiveQuantizer::Search_type_t; +usingSearch_type_t=AdditiveQuantizer::Search_type_t; boolrescale_norm=true; intnorm_scale=1; @@ -367,7 +367,7 @@ IndexAdditiveQuantizerFastScan(); -~IndexAdditiveQuantizerFastScan()override; +~IndexAdditiveQuantizerFastScan()override; ///buildfromanexistingIndexAQ explicitIndexAdditiveQuantizerFastScan( diff --git a/xml/IndexAdditiveQuantizer_8h.xml b/xml/IndexAdditiveQuantizer_8h.xml index c06734f1cf..6f9a989c79 100644 --- a/xml/IndexAdditiveQuantizer_8h.xml +++ b/xml/IndexAdditiveQuantizer_8h.xml @@ -1,5 +1,5 @@ - + IndexAdditiveQuantizer.h faiss/impl/AdditiveQuantizer.h @@ -12,6 +12,28 @@ faiss/impl/platform_macros.h faiss/IndexAdditiveQuantizerFastScan.h + + + + + + + + + + + + + + + + + + + + + + @@ -32,25 +54,14 @@ - - - - - + + + - - - - - - - + - - - @@ -61,44 +72,33 @@ - - - - - - + + + + - - - + + + + + - + - - - - - - - - + + + - - - - - - - - - - - + + + + + @@ -120,39 +120,49 @@ + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - - - + + + + + + + @@ -176,6 +186,10 @@ + + + + @@ -186,83 +200,69 @@ - - - - + + + + - + - + - + - + + + - - + + - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - + + - - - - - + + + + + + + + + + + - - + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + @@ -320,7 +320,7 @@ //thequantizer,thispointstotherelevantfieldintheinheriting //classes AdditiveQuantizer*aq; -usingSearch_type_t=AdditiveQuantizer::Search_type_t; +usingSearch_type_t=AdditiveQuantizer::Search_type_t; explicitIndexAdditiveQuantizer( idx_td, @@ -340,7 +340,7 @@ voidsa_decode(idx_tn,constuint8_t*bytes,float*x)constoverride; -FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; +FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; }; /**Indexbasedonaresidualquantizer.Storedvectorsare @@ -483,7 +483,7 @@ structSearchParametersResidualCoarseQuantizer:SearchParameters{ floatbeam_factor=4.0f; -~SearchParametersResidualCoarseQuantizer(){} +~SearchParametersResidualCoarseQuantizer(){} }; /**TheResidualCoarseQuantizerisabitspecializedcomparedtothe diff --git a/xml/IndexBinaryFlat_8h.xml b/xml/IndexBinaryFlat_8h.xml index 8ad8a1f960..fbbe06eb7b 100644 --- a/xml/IndexBinaryFlat_8h.xml +++ b/xml/IndexBinaryFlat_8h.xml @@ -1,44 +1,28 @@ - + IndexBinaryFlat.h vector faiss/IndexBinary.h faiss/utils/approx_topk/mode.h + faiss/IndexBinaryHNSW.h + faiss/IndexBinaryHash.h faiss/cppcontrib/factory_tools.h faiss/gpu/GpuIndexBinaryFlat.h - faiss/IndexBinaryHash.h - faiss/IndexBinaryHNSW.h - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - + + + + + + @@ -54,18 +38,14 @@ - - - - - - - - + + + + - + - + @@ -74,47 +54,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - + - + - - - - - + - - - - - - - - - - - + + + faiss::IndexBinaryFlat diff --git a/xml/IndexBinaryFromFloat_8h.xml b/xml/IndexBinaryFromFloat_8h.xml index 053278592a..7e6ede62da 100644 --- a/xml/IndexBinaryFromFloat_8h.xml +++ b/xml/IndexBinaryFromFloat_8h.xml @@ -1,37 +1,22 @@ - + IndexBinaryFromFloat.h faiss/IndexBinary.h - - - - + + + + - - - - - - - - - - - - - - - - - + + + + + - - - @@ -47,18 +32,10 @@ - - - - - - - - - - - - + + + + @@ -67,6 +44,29 @@ + + + + + + + + + + + + + + + + + + + + + + + faiss::IndexBinaryFromFloat faiss @@ -109,7 +109,7 @@ explicitIndexBinaryFromFloat(Index*index); -~IndexBinaryFromFloat(); +~IndexBinaryFromFloat(); voidadd(idx_tn,constuint8_t*x)override; diff --git a/xml/IndexBinaryHNSW_8h.xml b/xml/IndexBinaryHNSW_8h.xml index 88ebfaeb3d..254b20de6d 100644 --- a/xml/IndexBinaryHNSW_8h.xml +++ b/xml/IndexBinaryHNSW_8h.xml @@ -1,5 +1,5 @@ - + IndexBinaryHNSW.h faiss/IndexBinaryFlat.h @@ -7,6 +7,74 @@ faiss/utils/utils.h faiss/cppcontrib/factory_tools.h + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -19,12 +87,6 @@ - - - - - - @@ -47,14 +109,6 @@ - - - - - - - - @@ -63,62 +117,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -141,6 +139,10 @@ + + + + @@ -151,62 +153,14 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - + - - - @@ -223,19 +177,65 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -291,7 +291,7 @@ explicitIndexBinaryHNSW(intd,intM=32); explicitIndexBinaryHNSW(IndexBinary*storage,intM=32); -~IndexBinaryHNSW()override; +~IndexBinaryHNSW()override; DistanceComputer*get_distance_computer()const; diff --git a/xml/IndexBinaryHash_8h.xml b/xml/IndexBinaryHash_8h.xml index 333b454fae..0db578e029 100644 --- a/xml/IndexBinaryHash_8h.xml +++ b/xml/IndexBinaryHash_8h.xml @@ -1,5 +1,5 @@ - + IndexBinaryHash.h unordered_map @@ -9,44 +9,43 @@ faiss/impl/platform_macros.h faiss/utils/Heap.h - - - - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + + + + + + + @@ -64,11 +63,19 @@ - - + + + + + - - + + + + + + + @@ -92,6 +99,10 @@ + + + + @@ -102,59 +113,48 @@ - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::IndexBinaryHash faiss::IndexBinaryHash::InvertedList @@ -199,7 +199,7 @@ voidadd(idx_tid,size_tcode_size,constuint8_t*code); }; -usingInvertedListMap=std::unordered_map<idx_t,InvertedList>; +usingInvertedListMap=std::unordered_map<idx_t,InvertedList>; InvertedListMapinvlists; intb,nflip; @@ -254,7 +254,7 @@ boolown_fields; //mapshashvaluestotheidsthathashtothem -usingMap=std::unordered_map<idx_t,std::vector<idx_t>>; +usingMap=std::unordered_map<idx_t,std::vector<idx_t>>; //thedifferenthashes,sizenhash std::vector<Map>maps; @@ -267,7 +267,7 @@ IndexBinaryMultiHash(); -~IndexBinaryMultiHash(); +~IndexBinaryMultiHash(); voidreset()override; diff --git a/xml/IndexBinaryIVF_8h.xml b/xml/IndexBinaryIVF_8h.xml index d868f10e2a..34191393bf 100644 --- a/xml/IndexBinaryIVF_8h.xml +++ b/xml/IndexBinaryIVF_8h.xml @@ -1,5 +1,5 @@ - + IndexBinaryIVF.h vector @@ -9,30 +9,55 @@ faiss/utils/Heap.h faiss/cppcontrib/factory_tools.h - - + + + + + + + - - - - + + + + + + + + + + - - - - - - + + + + + + + + + + + + + + + - - - + + + + + + + + @@ -60,26 +85,12 @@ - - - - - - + + + + - - - - - - - - - - - - @@ -90,34 +101,29 @@ - - - - - - + + + + - + - + + + + + - + - - - - - - - - - - - - - - + + + + + + + @@ -151,60 +157,54 @@ - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -300,7 +300,7 @@ IndexBinaryIVF(); -~IndexBinaryIVF()override; +~IndexBinaryIVF()override; voidreset()override; @@ -480,7 +480,7 @@ intradius, RangeQueryResult&result)const=0; -virtual~BinaryInvertedListScanner(){} +virtual~BinaryInvertedListScanner(){} }; }//namespacefaiss diff --git a/xml/IndexBinary_8h.xml b/xml/IndexBinary_8h.xml index f8d9a5d466..bd69ec44fe 100644 --- a/xml/IndexBinary_8h.xml +++ b/xml/IndexBinary_8h.xml @@ -1,5 +1,5 @@ - + IndexBinary.h cstdio @@ -8,9 +8,6 @@ typeinfo faiss/Index.h faiss/AutoTune.h - faiss/gpu/GpuCloner.h - faiss/impl/ThreadedIndex.h - faiss/index_factory.h faiss/IndexBinaryFlat.h faiss/IndexBinaryFromFloat.h faiss/IndexBinaryHash.h @@ -18,49 +15,27 @@ faiss/IndexIDMap.h faiss/IndexReplicas.h faiss/IndexShards.h + faiss/gpu/GpuCloner.h + faiss/impl/ThreadedIndex.h + faiss/index_factory.h - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + @@ -69,6 +44,8 @@ + + @@ -76,66 +53,37 @@ - - - - - - + + + + - + - - - - - + + - - - - - - - + + - - - + + - - - + + + + + + + - - - - - - - - - - - - - - - - - - - - - - @@ -143,66 +91,118 @@ - + - + - + - + + + + + + + + + + + + + - + - - - - - - - + + + - - + + - - - - - - - - + + + + + + + + - + + + + + - + - + - + - + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + @@ -245,8 +245,8 @@ *vectors. */ structIndexBinary{ -usingcomponent_t=uint8_t; -usingdistance_t=int32_t; +usingcomponent_t=uint8_t; +usingdistance_t=int32_t; intd=0;///<vectordimension intcode_size=0;///<numberofbytespervector(=d/8) @@ -262,7 +262,7 @@ explicitIndexBinary(idx_td=0,MetricTypemetric=METRIC_L2); -virtual~IndexBinary(); +virtual~IndexBinary(); /**Performtrainingonarepresentativesetofvectors. * diff --git a/xml/IndexFastScan_8h.xml b/xml/IndexFastScan_8h.xml index 1da7671af4..591abfd1ca 100644 --- a/xml/IndexFastScan_8h.xml +++ b/xml/IndexFastScan_8h.xml @@ -1,5 +1,5 @@ - + IndexFastScan.h faiss/Index.h @@ -7,51 +7,6 @@ faiss/IndexAdditiveQuantizerFastScan.h faiss/IndexPQFastScan.h - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -80,19 +35,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + + @@ -102,14 +100,16 @@ + + + + + + - - - - faiss::IndexFastScan faiss::FastScanStats @@ -254,21 +254,30 @@ voidmerge_from(Index&otherIndex,idx_tadd_id=0)override; voidcheck_compatible_for_merge(constIndex&otherIndex)constoverride; -}; - -structFastScanStats{ -uint64_tt0,t1,t2,t3; -FastScanStats(){ -reset(); -} -voidreset(){ -memset(this,0,sizeof(*this)); -} -}; - -FAISS_APIexternFastScanStatsFastScan_stats; - -}//namespacefaiss + +///standalonecodesinterface(butthecodesareflattened) +size_tsa_code_size()constoverride{ +returncode_size; +} + +voidsa_encode(idx_tn,constfloat*x,uint8_t*bytes)constoverride{ +compute_codes(bytes,n,x); +} +}; + +structFastScanStats{ +uint64_tt0,t1,t2,t3; +FastScanStats(){ +reset(); +} +voidreset(){ +memset(this,0,sizeof(*this)); +} +}; + +FAISS_APIexternFastScanStatsFastScan_stats; + +}//namespacefaiss diff --git a/xml/IndexFlatCodes_8h.xml b/xml/IndexFlatCodes_8h.xml index 2eff503456..01486e611e 100644 --- a/xml/IndexFlatCodes_8h.xml +++ b/xml/IndexFlatCodes_8h.xml @@ -1,5 +1,5 @@ - + IndexFlatCodes.h faiss/Index.h @@ -8,12 +8,26 @@ faiss/Index2Layer.h faiss/IndexAdditiveQuantizer.h faiss/IndexFlat.h - faiss/IndexLattice.h faiss/IndexLSH.h + faiss/IndexLattice.h faiss/IndexNeuralNetCodec.h faiss/IndexPQ.h faiss/IndexScalarQuantizer.h + + + + + + + + + + + + + + @@ -24,6 +38,18 @@ + + + + + + + + + + + + @@ -35,56 +61,26 @@ + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + @@ -92,22 +88,22 @@ - - - - + + + + + + + + - + - + - + - - - - @@ -128,153 +124,157 @@ - - - + + + + + - - - - + + + + - + + + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - + - - - - - + - - - - - - - - - - - + - - - - - - - + - - - - - - - - - + + + - - - + + + - + - + - + + + - + - + - + + + + + + + - - - - - - - - - - - - - - - - + + - - - + + + + + + + + + - - - + + + + + + + + + faiss::IndexFlatCodes @@ -333,10 +333,10 @@ * *Thedefaultimplementationexplicitlydecodesthevectorwithsa_decode. */ -virtualFlatCodesDistanceComputer*get_FlatCodesDistanceComputer()const; +virtualFlatCodesDistanceComputer*get_FlatCodesDistanceComputer()const; -DistanceComputer*get_distance_computer()constoverride{ -returnget_FlatCodesDistanceComputer(); +DistanceComputer*get_distance_computer()constoverride{ +returnget_FlatCodesDistanceComputer(); } /**Searchimplementedbydecoding*/ diff --git a/xml/IndexFlat_8h.xml b/xml/IndexFlat_8h.xml index 52190b779c..242ca661b7 100644 --- a/xml/IndexFlat_8h.xml +++ b/xml/IndexFlat_8h.xml @@ -1,14 +1,36 @@ - + IndexFlat.h vector faiss/IndexFlatCodes.h - faiss/impl/AdditiveQuantizer.h faiss/IndexHNSW.h faiss/IndexNNDescent.h faiss/IndexNSG.h + faiss/impl/AdditiveQuantizer.h + + + + + + + + + + + + + + + + + + + + + + @@ -19,12 +41,16 @@ - - - - + + + + - + + + + + @@ -38,75 +64,89 @@ + + + + + + + + + + + + + + + + + - + + - - - + + + + + + + + + - + + + + - + + + + + + + + - - + + - - - - - - - - - - - - + + - - - - - - - + + + - - - - - + + + + + + + - - - - - - - - - + @@ -116,79 +156,39 @@ - - - - - - - + - + - + - + - - - - - - + + + + - - - - - - - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - + - - - - faiss::IndexFlat faiss::IndexFlatIP @@ -266,7 +266,7 @@ IndexFlat(){} -FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; +FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; /*Thestanadlonecodecinterface(justmemcopiesinthiscase)*/ voidsa_encode(idx_tn,constfloat*x,uint8_t*bytes)constoverride; @@ -293,7 +293,7 @@ IndexFlatL2(){} //overrideforl2normscache. -FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; +FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; //computeL2norms voidsync_l2norms(); diff --git a/xml/IndexHNSW_8h.xml b/xml/IndexHNSW_8h.xml index 90d2b4c72e..5cefd1baf5 100644 --- a/xml/IndexHNSW_8h.xml +++ b/xml/IndexHNSW_8h.xml @@ -1,5 +1,5 @@ - + IndexHNSW.h vector @@ -10,52 +10,34 @@ faiss/utils/utils.h faiss/cppcontrib/factory_tools.h - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - + + + + - + - + - + - + - - - - + + + + - + @@ -68,24 +50,47 @@ - - - + + + - + - - - - - + - + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + @@ -103,16 +108,25 @@ - - - - + + + + + + + + + + - - + + + + + @@ -132,39 +146,69 @@ - - - - + + + + - + + + + + - + + + + + + + + + + + + + + + + + - + + + + + - + - + - + - + - + + + + + - - - - + + + + + + @@ -172,83 +216,67 @@ - - - - - - - - - - - - + + + + + - + - + - + - + - + - - - - - - - - - - - - - + + + + - + - + - - - - - - - - - - - - - + + + + + + - - - - - + + + + + + + - - + + + + + + + @@ -282,126 +310,98 @@ - - - + + + - + - + + + + + - + - + - - - - - - - - + - + - + - - + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + - - - - - - - - - - - - - - - - - + + - - - - - - - + + - - + + - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - + + - - + + + + + + + + + + + + + + @@ -479,7 +479,7 @@ explicitIndexHNSW(intd=0,intM=32,MetricTypemetric=METRIC_L2); explicitIndexHNSW(Index*storage,intM=32); -~IndexHNSW()override; +~IndexHNSW()override; voidadd(idx_tn,constfloat*x)override; @@ -542,7 +542,7 @@ voidpermute_entries(constidx_t*perm); -DistanceComputer*get_distance_computer()constoverride; +DistanceComputer*get_distance_computer()constoverride; }; /**FlatindextoppedwithwithaHNSWstructuretoaccesselements diff --git a/xml/IndexIDMap_8h.xml b/xml/IndexIDMap_8h.xml index 86f4966744..168ff02e9f 100644 --- a/xml/IndexIDMap_8h.xml +++ b/xml/IndexIDMap_8h.xml @@ -1,5 +1,5 @@ - + IndexIDMap.h faiss/Index.h @@ -7,22 +7,36 @@ faiss/impl/IDSelector.h unordered_map vector - faiss/cppcontrib/factory_tools.h faiss/MetaIndexes.h + faiss/cppcontrib/factory_tools.h - - - - + + + + + + + + + + - - - - - + + + + + + + + + + + + + @@ -38,8 +52,11 @@ - - + + + + + @@ -51,54 +68,37 @@ - - + + + + + + + + + + - - - - - - - - - - - - - - - - + + + + + - - - - - - - - - - - - - + + - - - - - + + @@ -110,11 +110,11 @@ - + - + @@ -149,8 +149,8 @@ /**Indexthattranslatessearchresultstoids*/ template<typenameIndexT> structIndexIDMapTemplate:IndexT{ -usingcomponent_t=typenameIndexT::component_t; -usingdistance_t=typenameIndexT::distance_t; +usingcomponent_t=typenameIndexT::component_t; +usingdistance_t=typenameIndexT::distance_t; IndexT*index=nullptr;///!thesub-index boolown_fields=false;///!whetherpointersaredeletedindestructo @@ -193,22 +193,22 @@ size_tsa_code_size()constoverride; voidadd_sa_codes(idx_tn,constuint8_t*x,constidx_t*xids)override; -~IndexIDMapTemplate()override; +~IndexIDMapTemplate()override; IndexIDMapTemplate(){ own_fields=false; index=nullptr; } }; -usingIndexIDMap=IndexIDMapTemplate<Index>; -usingIndexBinaryIDMap=IndexIDMapTemplate<IndexBinary>; +usingIndexIDMap=IndexIDMapTemplate<Index>; +usingIndexBinaryIDMap=IndexIDMapTemplate<IndexBinary>; /**sameasIndexIDMapbutalsoprovidesanefficientreconstruction *implementationviaa2-wayindex*/ template<typenameIndexT> structIndexIDMap2Template:IndexIDMapTemplate<IndexT>{ -usingcomponent_t=typenameIndexT::component_t; -usingdistance_t=typenameIndexT::distance_t; +usingcomponent_t=typenameIndexT::component_t; +usingdistance_t=typenameIndexT::distance_t; std::unordered_map<idx_t,idx_t>rev_map; @@ -229,12 +229,12 @@ voidmerge_from(IndexT&otherIndex,idx_tadd_id=0)override; -~IndexIDMap2Template()override{} +~IndexIDMap2Template()override{} IndexIDMap2Template(){} }; -usingIndexIDMap2=IndexIDMap2Template<Index>; -usingIndexBinaryIDMap2=IndexIDMap2Template<IndexBinary>; +usingIndexIDMap2=IndexIDMap2Template<Index>; +usingIndexBinaryIDMap2=IndexIDMap2Template<IndexBinary>; //IDSelectorthattranslatestheidsusinganIDMap structIDSelectorTranslated:IDSelector{ diff --git a/xml/IndexIVFAdditiveQuantizerFastScan_8h.xml b/xml/IndexIVFAdditiveQuantizerFastScan_8h.xml index 5b0c334523..56dc1a50e7 100644 --- a/xml/IndexIVFAdditiveQuantizerFastScan_8h.xml +++ b/xml/IndexIVFAdditiveQuantizerFastScan_8h.xml @@ -1,5 +1,5 @@ - + IndexIVFAdditiveQuantizerFastScan.h memory @@ -9,49 +9,26 @@ faiss/impl/ProductAdditiveQuantizer.h faiss/utils/AlignedTable.h - - - - - - - + + + - - - - - + - - - - - - - - - - - - + + + + - + - - - - - - - - + - + - + @@ -62,28 +39,16 @@ - - - - - - - - - - - - - - + + + + + - - - @@ -110,60 +75,40 @@ - - - - - - + + + + - - - - - - - - - - - - - - - - - + - + - + - + - + - + - - - - - - + + + + - - - - - + - + - + + + + + @@ -176,18 +121,27 @@ - - - - - - - - - + + + + + - - + + + + + + + + + + + + + + + @@ -195,45 +149,56 @@ - - - - - - - - - - - - - + + + + - + - + + + + + - + - + - + - + - + + + + + - - - - + + + + - + - + + + + + + + + + + + + + @@ -250,87 +215,81 @@ - - - - - - - - + + + - - - + - + + + + + - + - + + + + + - + - - - - - - - - - - + + + + - + - + - + - + + + - - - - + + + + - + - + - + - + - + - - - - - + - - - - - + - + - - - - - + + + - - + + + + + + + + + @@ -348,24 +307,65 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::IndexIVFAdditiveQuantizerFastScan @@ -415,7 +415,7 @@ */ structIndexIVFAdditiveQuantizerFastScan:IndexIVFFastScan{ -usingSearch_type_t=AdditiveQuantizer::Search_type_t; +usingSearch_type_t=AdditiveQuantizer::Search_type_t; AdditiveQuantizer*aq; @@ -437,7 +437,7 @@ IndexIVFAdditiveQuantizerFastScan(); -~IndexIVFAdditiveQuantizerFastScan()override; +~IndexIVFAdditiveQuantizerFastScan()override; //builtfromanIndexIVFAQ explicitIndexIVFAdditiveQuantizerFastScan( @@ -477,80 +477,78 @@ constCoarseQuantized&cq, AlignedTable<float>&dis_tables, AlignedTable<float>&biases)constoverride; - -voidsa_decode(idx_tn,constuint8_t*bytes,float*x)constoverride; -}; - -structIndexIVFLocalSearchQuantizerFastScan -:IndexIVFAdditiveQuantizerFastScan{ -LocalSearchQuantizerlsq; - -IndexIVFLocalSearchQuantizerFastScan( -Index*quantizer, -size_td, -size_tnlist, -size_tM, -size_tnbits, -MetricTypemetric=METRIC_L2, -Search_type_tsearch_type=AdditiveQuantizer::ST_norm_lsq2x4, -intbbs=32); - -IndexIVFLocalSearchQuantizerFastScan(); -}; - -structIndexIVFResidualQuantizerFastScan:IndexIVFAdditiveQuantizerFastScan{ -ResidualQuantizerrq; - -IndexIVFResidualQuantizerFastScan( -Index*quantizer, -size_td, -size_tnlist, -size_tM, -size_tnbits, -MetricTypemetric=METRIC_L2, -Search_type_tsearch_type=AdditiveQuantizer::ST_norm_lsq2x4, -intbbs=32); - -IndexIVFResidualQuantizerFastScan(); -}; - -structIndexIVFProductLocalSearchQuantizerFastScan -:IndexIVFAdditiveQuantizerFastScan{ -ProductLocalSearchQuantizerplsq; - -IndexIVFProductLocalSearchQuantizerFastScan( -Index*quantizer, -size_td, -size_tnlist, -size_tnsplits, -size_tMsub, -size_tnbits, -MetricTypemetric=METRIC_L2, -Search_type_tsearch_type=AdditiveQuantizer::ST_norm_lsq2x4, -intbbs=32); - -IndexIVFProductLocalSearchQuantizerFastScan(); -}; - -structIndexIVFProductResidualQuantizerFastScan -:IndexIVFAdditiveQuantizerFastScan{ -ProductResidualQuantizerprq; - -IndexIVFProductResidualQuantizerFastScan( -Index*quantizer, -size_td, -size_tnlist, -size_tnsplits, -size_tMsub, -size_tnbits, -MetricTypemetric=METRIC_L2, -Search_type_tsearch_type=AdditiveQuantizer::ST_norm_lsq2x4, -intbbs=32); - -IndexIVFProductResidualQuantizerFastScan(); -}; - -}//namespacefaiss +}; + +structIndexIVFLocalSearchQuantizerFastScan +:IndexIVFAdditiveQuantizerFastScan{ +LocalSearchQuantizerlsq; + +IndexIVFLocalSearchQuantizerFastScan( +Index*quantizer, +size_td, +size_tnlist, +size_tM, +size_tnbits, +MetricTypemetric=METRIC_L2, +Search_type_tsearch_type=AdditiveQuantizer::ST_norm_lsq2x4, +intbbs=32); + +IndexIVFLocalSearchQuantizerFastScan(); +}; + +structIndexIVFResidualQuantizerFastScan:IndexIVFAdditiveQuantizerFastScan{ +ResidualQuantizerrq; + +IndexIVFResidualQuantizerFastScan( +Index*quantizer, +size_td, +size_tnlist, +size_tM, +size_tnbits, +MetricTypemetric=METRIC_L2, +Search_type_tsearch_type=AdditiveQuantizer::ST_norm_lsq2x4, +intbbs=32); + +IndexIVFResidualQuantizerFastScan(); +}; + +structIndexIVFProductLocalSearchQuantizerFastScan +:IndexIVFAdditiveQuantizerFastScan{ +ProductLocalSearchQuantizerplsq; + +IndexIVFProductLocalSearchQuantizerFastScan( +Index*quantizer, +size_td, +size_tnlist, +size_tnsplits, +size_tMsub, +size_tnbits, +MetricTypemetric=METRIC_L2, +Search_type_tsearch_type=AdditiveQuantizer::ST_norm_lsq2x4, +intbbs=32); + +IndexIVFProductLocalSearchQuantizerFastScan(); +}; + +structIndexIVFProductResidualQuantizerFastScan +:IndexIVFAdditiveQuantizerFastScan{ +ProductResidualQuantizerprq; + +IndexIVFProductResidualQuantizerFastScan( +Index*quantizer, +size_td, +size_tnlist, +size_tnsplits, +size_tMsub, +size_tnbits, +MetricTypemetric=METRIC_L2, +Search_type_tsearch_type=AdditiveQuantizer::ST_norm_lsq2x4, +intbbs=32); + +IndexIVFProductResidualQuantizerFastScan(); +}; + +}//namespacefaiss diff --git a/xml/IndexIVFAdditiveQuantizer_8h.xml b/xml/IndexIVFAdditiveQuantizer_8h.xml index 64bf8f83b7..ceae0b2df7 100644 --- a/xml/IndexIVFAdditiveQuantizer_8h.xml +++ b/xml/IndexIVFAdditiveQuantizer_8h.xml @@ -1,5 +1,5 @@ - + IndexIVFAdditiveQuantizer.h faiss/impl/AdditiveQuantizer.h @@ -12,33 +12,26 @@ faiss/impl/platform_macros.h faiss/IndexIVFAdditiveQuantizerFastScan.h - - - - - - - + + + - + - + + + + + - + - - - - - - - - + - + - + @@ -49,28 +42,16 @@ - - - - - - - - - - - - - - + + + + + - - - @@ -97,25 +78,63 @@ - - - - + + + + + + + + + + + + + + + + - - + + + + + - - + + + + + + + + + + + + + + + - - + + + + + - - + + + + + + + + + @@ -137,49 +156,65 @@ + + + + + + + + + + + + + + + + - - - - + + + + - + - - - - - - - - - - - - - - - - - - + + + - - + + + + + + + - - + + + + + + + - - + + + + + + + @@ -203,6 +238,10 @@ + + + + @@ -213,115 +252,76 @@ - - - - - - - - - - - - + + + + - - - - - + - + - - - - - - - - + + - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - - + + - - + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -376,7 +376,7 @@ AdditiveQuantizer*aq; intuse_precomputed_table=0;//forfutureuse -usingSearch_type_t=AdditiveQuantizer::Search_type_t; +usingSearch_type_t=AdditiveQuantizer::Search_type_t; IndexIVFAdditiveQuantizer( AdditiveQuantizer*aq, @@ -398,7 +398,7 @@ uint8_t*codes, boolinclude_listnos=false)constoverride; -InvertedListScanner*get_InvertedListScanner( +InvertedListScanner*get_InvertedListScanner( boolstore_pairs, constIDSelector*sel)constoverride; @@ -407,7 +407,7 @@ voidreconstruct_from_offset(int64_tlist_no,int64_toffset,float*recons) constoverride; -~IndexIVFAdditiveQuantizer()override; +~IndexIVFAdditiveQuantizer()override; }; /**IndexIVFbasedonaresidualquantizer.Storedvectorsare @@ -442,7 +442,7 @@ IndexIVFResidualQuantizer(); -virtual~IndexIVFResidualQuantizer(); +virtual~IndexIVFResidualQuantizer(); }; /**IndexIVFbasedonaresidualquantizer.Storedvectorsare @@ -469,7 +469,7 @@ IndexIVFLocalSearchQuantizer(); -virtual~IndexIVFLocalSearchQuantizer(); +virtual~IndexIVFLocalSearchQuantizer(); }; /**IndexIVFbasedonaproductresidualquantizer.Storedvectorsare @@ -498,7 +498,7 @@ IndexIVFProductResidualQuantizer(); -virtual~IndexIVFProductResidualQuantizer(); +virtual~IndexIVFProductResidualQuantizer(); }; /**IndexIVFbasedonaproductlocalsearchquantizer.Storedvectorsare @@ -527,7 +527,7 @@ IndexIVFProductLocalSearchQuantizer(); -virtual~IndexIVFProductLocalSearchQuantizer(); +virtual~IndexIVFProductLocalSearchQuantizer(); }; }//namespacefaiss diff --git a/xml/IndexIVFFastScan_8h.xml b/xml/IndexIVFFastScan_8h.xml index e7deda0052..6b06ad570d 100644 --- a/xml/IndexIVFFastScan_8h.xml +++ b/xml/IndexIVFFastScan_8h.xml @@ -1,5 +1,5 @@ - + IndexIVFFastScan.h memory @@ -8,36 +8,6 @@ faiss/IndexIVFAdditiveQuantizerFastScan.h faiss/IndexIVFPQFastScan.h - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -46,8 +16,19 @@ - - + + + + + + + + + + + + + @@ -75,25 +56,21 @@ - - - - + + + + - + + + - - - - - - - - - - - + + + + + @@ -105,30 +82,45 @@ - - - - - - + + + + - + - - - - - - - - + + + + + + + - - + + + + + + + - - + + + + + + + + + + + + + + + @@ -162,54 +154,66 @@ - - + + - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -228,10 +232,6 @@ - - - - faiss::IndexIVFFastScan faiss::IndexIVFFastScan::CoarseQuantized @@ -260,243 +260,260 @@ structNormTableScaler; structSIMDResultHandlerToFloat; - -/**FastscanversionofIVFPQandIVFAQ.Worksfor4-bitPQ/AQfornow. -* -*Thecodesintheinvertedlistsarenotstoredsequentiallybut -*groupedinblocksofsizebbs.Thismakesitpossibletoveryquickly -*computedistanceswithSIMDinstructions. -* -*Implementations(implem): -*0:auto-selectimplementation(default) -*1:orig'ssearch,re-implemented -*2:orig'ssearch,re-orderedbyinvlist -*10:optimizerint16search,collectresultsinheap,noqbs -*11:idem,collectresultsinreservoir -*12:optimizerint16search,collectresultsinheap,usesqbs -*13:idem,collectresultsinreservoir -*14:internallymultithreadedimplemovernq*nprobe -*15:samewithreservoir -* -*Forrangesearch,only10and12aresupported. -*add100totheimplemtoforcesingle-threadscanning(thecoarsequantizer -*maystillusemultiplethreads). -*/ - -structIndexIVFFastScan:IndexIVF{ -//sizeofthekernel -intbbs;//setatbuildtime - -size_tM; -size_tnbits; -size_tksub; - -//Mroundeduptoamultipleof2 -size_tM2; - -//search-timeimplementation -intimplem=0; -//skipsomepartsofthecomputation(fortiming) -intskip=0; - -//batchingfactorsatsearchtime(0=default) -intqbs=0; -size_tqbs2=0; - -IndexIVFFastScan( -Index*quantizer, -size_td, -size_tnlist, -size_tcode_size, -MetricTypemetric=METRIC_L2); - -IndexIVFFastScan(); - -voidinit_fastscan( -size_tM, -size_tnbits, -size_tnlist, -MetricTypemetric, -intbbs); - -//initializetheCodePackerintheInvertedLists -voidinit_code_packer(); - -~IndexIVFFastScan()override; - -///orig'sinvertedlists(fordebugging) -InvertedLists*orig_invlists=nullptr; - -voidadd_with_ids(idx_tn,constfloat*x,constidx_t*xids)override; - -//preparelook-uptables - -virtualboollookup_table_is_3d()const=0; +structQuantizer; + +/**FastscanversionofIVFPQandIVFAQ.Worksfor4-bitPQ/AQfornow. +* +*Thecodesintheinvertedlistsarenotstoredsequentiallybut +*groupedinblocksofsizebbs.Thismakesitpossibletoveryquickly +*computedistanceswithSIMDinstructions. +* +*Implementations(implem): +*0:auto-selectimplementation(default) +*1:orig'ssearch,re-implemented +*2:orig'ssearch,re-orderedbyinvlist +*10:optimizerint16search,collectresultsinheap,noqbs +*11:idem,collectresultsinreservoir +*12:optimizerint16search,collectresultsinheap,usesqbs +*13:idem,collectresultsinreservoir +*14:internallymultithreadedimplemovernq*nprobe +*15:samewithreservoir +* +*Forrangesearch,only10and12aresupported. +*add100totheimplemtoforcesingle-threadscanning(thecoarsequantizer +*maystillusemultiplethreads). +*/ + +structIndexIVFFastScan:IndexIVF{ +//sizeofthekernel +intbbs;//setatbuildtime + +size_tM; +size_tnbits; +size_tksub; + +//Mroundeduptoamultipleof2 +size_tM2; + +//search-timeimplementation +intimplem=0; +//skipsomepartsofthecomputation(fortiming) +intskip=0; + +//batchingfactorsatsearchtime(0=default) +intqbs=0; +size_tqbs2=0; + +//quantizerusedtopackthecodes +Quantizer*fine_quantizer=nullptr; + +IndexIVFFastScan( +Index*quantizer, +size_td, +size_tnlist, +size_tcode_size, +MetricTypemetric=METRIC_L2); + +IndexIVFFastScan(); + +///calledbyimplementations +voidinit_fastscan( +Quantizer*fine_quantizer, +size_tM, +size_tnbits, +size_tnlist, +MetricTypemetric, +intbbs); + +//initializetheCodePackerintheInvertedLists +voidinit_code_packer(); + +~IndexIVFFastScan()override; + +///orig'sinvertedlists(fordebugging) +InvertedLists*orig_invlists=nullptr; -//compactwayofconveyingcoarsequantizationresults -structCoarseQuantized{ -size_tnprobe; -constfloat*dis=nullptr; -constidx_t*ids=nullptr; -}; - -virtualvoidcompute_LUT( -size_tn, -constfloat*x, -constCoarseQuantized&cq, -AlignedTable<float>&dis_tables, -AlignedTable<float>&biases)const=0; - -voidcompute_LUT_uint8( -size_tn, -constfloat*x, -constCoarseQuantized&cq, -AlignedTable<uint8_t>&dis_tables, -AlignedTable<uint16_t>&biases, -float*normalizers)const; - -voidsearch( -idx_tn, -constfloat*x, -idx_tk, -float*distances, -idx_t*labels, -constSearchParameters*params=nullptr)constoverride; - -voidsearch_preassigned( -idx_tn, -constfloat*x, -idx_tk, -constidx_t*assign, -constfloat*centroid_dis, -float*distances, -idx_t*labels, -boolstore_pairs, -constIVFSearchParameters*params=nullptr, -IndexIVFStats*stats=nullptr)constoverride; - -voidrange_search( -idx_tn, -constfloat*x, -floatradius, -RangeSearchResult*result, -constSearchParameters*params=nullptr)constoverride; - -//internalsearchfuncs - -//dispatchtoimplementationsandparallelize -voidsearch_dispatch_implem( -idx_tn, -constfloat*x, -idx_tk, -float*distances, -idx_t*labels, -constCoarseQuantized&cq, -constNormTableScaler*scaler, -constIVFSearchParameters*params=nullptr)const; - -voidrange_search_dispatch_implem( -idx_tn, -constfloat*x, -floatradius, -RangeSearchResult&rres, -constCoarseQuantized&cq_in, -constNormTableScaler*scaler, -constIVFSearchParameters*params=nullptr)const; - -//impl1and2arejustforverification -template<classC> -voidsearch_implem_1( -idx_tn, -constfloat*x, -idx_tk, -float*distances, -idx_t*labels, -constCoarseQuantized&cq, -constNormTableScaler*scaler, -constIVFSearchParameters*params=nullptr)const; - -template<classC> -voidsearch_implem_2( -idx_tn, -constfloat*x, -idx_tk, -float*distances, -idx_t*labels, -constCoarseQuantized&cq, -constNormTableScaler*scaler, -constIVFSearchParameters*params=nullptr)const; - -//implem10and12arenotmultithreadedinternally,so -//exportsearchstats -voidsearch_implem_10( -idx_tn, -constfloat*x, -SIMDResultHandlerToFloat&handler, -constCoarseQuantized&cq, -size_t*ndis_out, -size_t*nlist_out, -constNormTableScaler*scaler, -constIVFSearchParameters*params=nullptr)const; - -voidsearch_implem_12( -idx_tn, -constfloat*x, -SIMDResultHandlerToFloat&handler, -constCoarseQuantized&cq, -size_t*ndis_out, -size_t*nlist_out, -constNormTableScaler*scaler, -constIVFSearchParameters*params=nullptr)const; - -//implem14ismultithreadedinternallyacrossnprobesandqueries -voidsearch_implem_14( -idx_tn, -constfloat*x, -idx_tk, -float*distances, -idx_t*labels, -constCoarseQuantized&cq, -intimpl, -constNormTableScaler*scaler, -constIVFSearchParameters*params=nullptr)const; - -//reconstructvectorsfrompackedinvlists -voidreconstruct_from_offset(int64_tlist_no,int64_toffset,float*recons) -constoverride; - -CodePacker*get_CodePacker()constoverride; +voidadd_with_ids(idx_tn,constfloat*x,constidx_t*xids)override; + +//preparelook-uptables + +virtualboollookup_table_is_3d()const=0; + +//compactwayofconveyingcoarsequantizationresults +structCoarseQuantized{ +size_tnprobe; +constfloat*dis=nullptr; +constidx_t*ids=nullptr; +}; + +virtualvoidcompute_LUT( +size_tn, +constfloat*x, +constCoarseQuantized&cq, +AlignedTable<float>&dis_tables, +AlignedTable<float>&biases)const=0; + +voidcompute_LUT_uint8( +size_tn, +constfloat*x, +constCoarseQuantized&cq, +AlignedTable<uint8_t>&dis_tables, +AlignedTable<uint16_t>&biases, +float*normalizers)const; + +voidsearch( +idx_tn, +constfloat*x, +idx_tk, +float*distances, +idx_t*labels, +constSearchParameters*params=nullptr)constoverride; + +voidsearch_preassigned( +idx_tn, +constfloat*x, +idx_tk, +constidx_t*assign, +constfloat*centroid_dis, +float*distances, +idx_t*labels, +boolstore_pairs, +constIVFSearchParameters*params=nullptr, +IndexIVFStats*stats=nullptr)constoverride; + +voidrange_search( +idx_tn, +constfloat*x, +floatradius, +RangeSearchResult*result, +constSearchParameters*params=nullptr)constoverride; + +//internalsearchfuncs + +//dispatchtoimplementationsandparallelize +voidsearch_dispatch_implem( +idx_tn, +constfloat*x, +idx_tk, +float*distances, +idx_t*labels, +constCoarseQuantized&cq, +constNormTableScaler*scaler, +constIVFSearchParameters*params=nullptr)const; + +voidrange_search_dispatch_implem( +idx_tn, +constfloat*x, +floatradius, +RangeSearchResult&rres, +constCoarseQuantized&cq_in, +constNormTableScaler*scaler, +constIVFSearchParameters*params=nullptr)const; + +//impl1and2arejustforverification +template<classC> +voidsearch_implem_1( +idx_tn, +constfloat*x, +idx_tk, +float*distances, +idx_t*labels, +constCoarseQuantized&cq, +constNormTableScaler*scaler, +constIVFSearchParameters*params=nullptr)const; + +template<classC> +voidsearch_implem_2( +idx_tn, +constfloat*x, +idx_tk, +float*distances, +idx_t*labels, +constCoarseQuantized&cq, +constNormTableScaler*scaler, +constIVFSearchParameters*params=nullptr)const; + +//implem10and12arenotmultithreadedinternally,so +//exportsearchstats +voidsearch_implem_10( +idx_tn, +constfloat*x, +SIMDResultHandlerToFloat&handler, +constCoarseQuantized&cq, +size_t*ndis_out, +size_t*nlist_out, +constNormTableScaler*scaler, +constIVFSearchParameters*params=nullptr)const; + +voidsearch_implem_12( +idx_tn, +constfloat*x, +SIMDResultHandlerToFloat&handler, +constCoarseQuantized&cq, +size_t*ndis_out, +size_t*nlist_out, +constNormTableScaler*scaler, +constIVFSearchParameters*params=nullptr)const; + +//implem14ismultithreadedinternallyacrossnprobesandqueries +voidsearch_implem_14( +idx_tn, +constfloat*x, +idx_tk, +float*distances, +idx_t*labels, +constCoarseQuantized&cq, +intimpl, +constNormTableScaler*scaler, +constIVFSearchParameters*params=nullptr)const; -//reconstructoriginvlists(fordebugging) -voidreconstruct_orig_invlists(); -}; +//reconstructvectorsfrompackedinvlists +voidreconstruct_from_offset(int64_tlist_no,int64_toffset,float*recons) +constoverride; -structIVFFastScanStats{ -uint64_ttimes[10]; -uint64_tt_compute_distance_tables,t_round; -uint64_tt_copy_pack,t_scan,t_to_flat; -uint64_treservoir_times[4]; -doublet_aq_encode; -doublet_aq_norm_encode; - -doubleMcy_at(inti){ -returntimes[i]/(1000*1000.0); -} - -doubleMcy_reservoir_at(inti){ -returnreservoir_times[i]/(1000*1000.0); -} -IVFFastScanStats(){ -reset(); -} -voidreset(){ -memset(this,0,sizeof(*this)); -} -}; - -FAISS_APIexternIVFFastScanStatsIVFFastScan_stats; +CodePacker*get_CodePacker()constoverride; + +//reconstructoriginvlists(fordebugging) +voidreconstruct_orig_invlists(); + +/**Decodeasetofvectors. +* +*NOTE:ThecodesintheIndexFastScanobjectarenon-contiguous. +*Butthismethodrequiresacontiguousrepresentation. +* +*@paramnnumberofvectors +*@parambytesinputencodedvectors,sizen*code_size +*@paramxoutputvectors,sizen*d +*/ +voidsa_decode(idx_tn,constuint8_t*bytes,float*x)constoverride; +}; + +structIVFFastScanStats{ +uint64_ttimes[10]; +uint64_tt_compute_distance_tables,t_round; +uint64_tt_copy_pack,t_scan,t_to_flat; +uint64_treservoir_times[4]; +doublet_aq_encode; +doublet_aq_norm_encode; -}//namespacefaiss +doubleMcy_at(inti){ +returntimes[i]/(1000*1000.0); +} + +doubleMcy_reservoir_at(inti){ +returnreservoir_times[i]/(1000*1000.0); +} +IVFFastScanStats(){ +reset(); +} +voidreset(){ +memset(this,0,sizeof(*this)); +} +}; + +FAISS_APIexternIVFFastScanStatsIVFFastScan_stats; + +}//namespacefaiss diff --git a/xml/IndexIVFFlat_8h.xml b/xml/IndexIVFFlat_8h.xml index a4abeb5d62..c1a17e593d 100644 --- a/xml/IndexIVFFlat_8h.xml +++ b/xml/IndexIVFFlat_8h.xml @@ -1,5 +1,5 @@ - + IndexIVFFlat.h stdint.h @@ -7,20 +7,6 @@ faiss/IndexIVF.h faiss/cppcontrib/factory_tools.h - - - - - - - - - - - - - - @@ -29,8 +15,19 @@ - - + + + + + + + + + + + + + @@ -58,26 +55,6 @@ - - - - - - - - - - - - - - - - - - - - @@ -88,6 +65,12 @@ + + + + + + @@ -98,20 +81,29 @@ - - - - - - - - + + + + + + + - - + + + + + + + - - + + + + + + + @@ -145,46 +137,54 @@ - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -250,7 +250,7 @@ uint8_t*codes, boolinclude_listnos=false)constoverride; -InvertedListScanner*get_InvertedListScanner( +InvertedListScanner*get_InvertedListScanner( boolstore_pairs, constIDSelector*sel)constoverride; diff --git a/xml/IndexIVFIndependentQuantizer_8h.xml b/xml/IndexIVFIndependentQuantizer_8h.xml index b41780fabe..4cdb3fab73 100644 --- a/xml/IndexIVFIndependentQuantizer_8h.xml +++ b/xml/IndexIVFIndependentQuantizer_8h.xml @@ -1,34 +1,10 @@ - + IndexIVFIndependentQuantizer.h faiss/IndexIVF.h faiss/VectorTransform.h - - - - - - - - - - - - - - - - - - - - - - - - @@ -37,8 +13,19 @@ - - + + + + + + + + + + + + + @@ -66,25 +53,29 @@ - - - - + + + + - + - - - - - - - - + + + + + - - + + + + + + + + + @@ -96,27 +87,28 @@ - - - - - - - - - - - + + + + + + + - - + + + + + + + - - - - + + + + - + @@ -151,46 +143,54 @@ - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::IndexIVFIndependentQuantizer faiss @@ -251,7 +251,7 @@ voidreset()override; -~IndexIVFIndependentQuantizer()override; +~IndexIVFIndependentQuantizer()override; }; }//namespacefaiss diff --git a/xml/IndexIVFPQFastScan_8h.xml b/xml/IndexIVFPQFastScan_8h.xml index 02c3f647c8..74fad47ed4 100644 --- a/xml/IndexIVFPQFastScan_8h.xml +++ b/xml/IndexIVFPQFastScan_8h.xml @@ -1,5 +1,5 @@ - + IndexIVFPQFastScan.h memory @@ -9,39 +9,28 @@ faiss/utils/AlignedTable.h faiss/cppcontrib/factory_tools.h - - - - - - - - - - + + + + - + - - - - - - + + + + - + - + - + - + - - - @@ -52,77 +41,107 @@ - - - - + + + + - + - - - - - - - - + - + - + - + - - - - - + - + + + - - + + + + + + + + + - - - - + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + - + - + - + - - - + + + + + - + + + + + - - - - + + + + + + @@ -130,21 +149,27 @@ - - - - - - - - - - - + + + + + + + + + + + + + + + + + @@ -152,46 +177,45 @@ - - - - + + + + - + + + + + + + + + + + + + + + - - - - + + + + - + - + - - - - - - - - - - - + + + + + - - - - - - - - - @@ -225,84 +249,60 @@ - - - - - - - - - - - - - - - - + + - - + + - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - + + - - - - - - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -405,11 +405,9 @@ constCoarseQuantized&cq, AlignedTable<float>&dis_tables, AlignedTable<float>&biases)constoverride; - -voidsa_decode(idx_tn,constuint8_t*bytes,float*x)constoverride; -}; - -}//namespacefaiss +}; + +}//namespacefaiss diff --git a/xml/IndexIVFPQR_8h.xml b/xml/IndexIVFPQR_8h.xml index c72d19c99f..3e683c035b 100644 --- a/xml/IndexIVFPQR_8h.xml +++ b/xml/IndexIVFPQR_8h.xml @@ -1,43 +1,32 @@ - + IndexIVFPQR.h vector faiss/IndexIVFPQ.h - - - - - - - - - - + + + + - + - - - - - - + + + + - + - + - + - + - - - @@ -48,77 +37,91 @@ - - - - + + + + - + - - - - - - - - + - + - + - + - - - - - + - + + + - - + + + + + + + + + + + + + - - - - + + + + - + - + + + + + - + - + - + - - - + + + + + - + + + + + - - - - + + + + + + @@ -126,21 +129,27 @@ - - - - - - - - - - - + + + + + + + + + + + + + + + + + @@ -148,36 +157,45 @@ - - - - - - + + + + - + - - - - - - - - - - + + + + + + - - - - - + + + + + + + - - + + + + + + + + + + + + + + + @@ -211,78 +229,60 @@ - - - - - - - - - - + + - - + + - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - + + - - - - - - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::IndexIVFPQR faiss diff --git a/xml/IndexIVFPQ_8h.xml b/xml/IndexIVFPQ_8h.xml index f1c292f950..eb84c57ce2 100644 --- a/xml/IndexIVFPQ_8h.xml +++ b/xml/IndexIVFPQ_8h.xml @@ -1,5 +1,5 @@ - + IndexIVFPQ.h vector @@ -10,39 +10,28 @@ faiss/IndexIVFPQFastScan.h faiss/IndexIVFPQR.h - - - - - - - - - - + + + + - + - - - - - - + + + + - + - + - + - + - - - @@ -53,16 +42,45 @@ - - - - + + + + - + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + + + + + @@ -80,41 +98,76 @@ - - - + + + + + + + + + + + + + + + + + - - + + + + + - - - + + + + + + + - - - - - - - + - + + + + + + + + + + + + + + + + + + + + + - + @@ -125,65 +178,22 @@ - - - - + + + + - - - - - - - - - - - - - - - - - - - - - + - - - - - + - + - + - - - - - - - - - - - + - - - - - - - - - @@ -216,70 +226,60 @@ - - + + - - + + - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - + + - - - - - - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -339,7 +339,7 @@ size_tscan_table_threshold;///<usetablecomputationoron-the-fly? intpolysemous_ht;///<Hammingthreshforpolysemousfiltering IVFPQSearchParameters():scan_table_threshold(0),polysemous_ht(0){} -~IVFPQSearchParameters(){} +~IVFPQSearchParameters(){} }; FAISS_APIexternsize_tprecomputed_table_max_bytes; @@ -448,7 +448,7 @@ constuint8_t*xcodes, float*x)const; -InvertedListScanner*get_InvertedListScanner( +InvertedListScanner*get_InvertedListScanner( boolstore_pairs, constIDSelector*sel)constoverride; diff --git a/xml/IndexIVFSpectralHash_8h.xml b/xml/IndexIVFSpectralHash_8h.xml index e5c29cc205..24806a5e5e 100644 --- a/xml/IndexIVFSpectralHash_8h.xml +++ b/xml/IndexIVFSpectralHash_8h.xml @@ -1,24 +1,10 @@ - + IndexIVFSpectralHash.h vector faiss/IndexIVF.h - - - - - - - - - - - - - - @@ -27,8 +13,19 @@ - - + + + + + + + + + + + + + @@ -56,23 +53,6 @@ - - - - - - - - - - - - - - - - - @@ -81,8 +61,11 @@ - - + + + + + @@ -94,20 +77,29 @@ - - - - - - - - + + + + + + + - - + + + + + + + - - + + + + + + + @@ -141,46 +133,54 @@ - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::IndexIVFSpectralHash faiss @@ -260,7 +260,7 @@ uint8_t*codes, boolinclude_listnos=false)constoverride; -InvertedListScanner*get_InvertedListScanner( +InvertedListScanner*get_InvertedListScanner( boolstore_pairs, constIDSelector*sel)constoverride; @@ -272,7 +272,7 @@ *index_factory(shouldendin"LSH")*/ voidreplace_vt(IndexPreTransform*index,boolown=false); -~IndexIVFSpectralHash()override; +~IndexIVFSpectralHash()override; }; }//namespacefaiss diff --git a/xml/IndexIVF_8h.xml b/xml/IndexIVF_8h.xml index 53020641af..b3d51531bb 100644 --- a/xml/IndexIVF_8h.xml +++ b/xml/IndexIVF_8h.xml @@ -1,5 +1,5 @@ - + IndexIVF.h stdint.h @@ -13,9 +13,7 @@ faiss/invlists/DirectMap.h faiss/invlists/InvertedLists.h faiss/utils/Heap.h - faiss/gpu/GpuIndexCagra.h - faiss/gpu/GpuIndexIVF.h - faiss/impl/index_read_utils.h + faiss/IVFlib.h faiss/Index2Layer.h faiss/IndexBinaryIVF.h faiss/IndexIVFAdditiveQuantizer.h @@ -26,23 +24,11 @@ faiss/IndexIVFSpectralHash.h faiss/IndexScalarQuantizer.h faiss/IndexShardsIVF.h + faiss/gpu/GpuIndexCagra.h + faiss/gpu/GpuIndexIVF.h + faiss/impl/index_read_utils.h faiss/invlists/OnDiskInvertedLists.h - faiss/IVFlib.h - - - - - - - - - - - - - - @@ -51,8 +37,19 @@ - - + + + + + + + + + + + + + @@ -80,26 +77,12 @@ - - - - - - + + + + - - - - - - - - - - - - @@ -110,20 +93,29 @@ - - - - - - - - + + + + + + + - - + + + + + + + - - + + + + + + + @@ -157,69 +149,75 @@ - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - + + + - - - - + + + + + + - - - - - + + + + + @@ -228,138 +226,140 @@ - + + + - + - - - + - + - + - + - - - - + + + + - - - + + + - + + + + + + + + + - + - - - - - - - + + + - - - - + + + + - + - - - + + + - - - + + + - - - + + + - - - + + + - + - + - + - + - - - - - + + + - - - - - + + + - - - + + + - - - - + + + + + + + + - - - - - + - + + + + + + + - - - + + + - - - - - - + + faiss::Level1Quantizer @@ -441,7 +441,7 @@ Level1Quantizer(); -~Level1Quantizer(); +~Level1Quantizer(); }; structSearchParametersIVF:SearchParameters{ @@ -451,11 +451,11 @@ ///contextobjecttopasstoInvertedLists void*inverted_list_context=nullptr; -virtual~SearchParametersIVF(){} +virtual~SearchParametersIVF(){} }; //thenewconventionputstheindextypeafterSearchParameters -usingIVFSearchParameters=SearchParametersIVF; +usingIVFSearchParameters=SearchParametersIVF; structInvertedListScanner; structIndexIVFStats; @@ -526,7 +526,7 @@ constIVFSearchParameters*params=nullptr, IndexIVFStats*stats=nullptr)const=0; -virtual~IndexIVFInterface(){} +virtual~IndexIVFInterface(){} }; /**Indexbasedonainvertedfile(IVF) @@ -690,7 +690,7 @@ * *Thedefaultsearchimplementationusesthistocomputethedistances */ -virtualInvertedListScanner*get_InvertedListScanner( +virtualInvertedListScanner*get_InvertedListScanner( boolstore_pairs=false, constIDSelector*sel=nullptr)const; @@ -787,7 +787,7 @@ idx_ta1, idx_ta2)const; -~IndexIVF()override; +~IndexIVF()override; size_tget_list_size(size_tlist_no)const{ returninvlists->list_size(list_no); @@ -812,7 +812,7 @@ size_tsa_code_size()constoverride; /**encodeasetofvectors -*sa_encodewillcallencode_vectorwithinclude_listno=true +*sa_encodewillcallencode_vectorswithinclude_listno=true *@paramnnbofvectorstoencode *@paramxthevectorstoencode *@parambytesoutputarrayforthecodes @@ -901,7 +901,7 @@ RangeQueryResult&result, size_t&list_size)const; -virtual~InvertedListScanner(){} +virtual~InvertedListScanner(){} }; //whethertocheckthatcoarsequantizersarethesame diff --git a/xml/IndexLSH_8h.xml b/xml/IndexLSH_8h.xml index f1fa4edb8e..2c98fed644 100644 --- a/xml/IndexLSH_8h.xml +++ b/xml/IndexLSH_8h.xml @@ -1,5 +1,5 @@ - + IndexLSH.h vector @@ -7,6 +7,20 @@ faiss/VectorTransform.h faiss/cppcontrib/factory_tools.h + + + + + + + + + + + + + + @@ -17,12 +31,20 @@ - - - - + + + + - + + + + + + + + + @@ -35,9 +57,29 @@ + + + + + + + + + + + + + + + + + + + + @@ -47,63 +89,21 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - faiss::IndexLSH faiss @@ -154,7 +154,7 @@ *@returnoutputvectors,sizen*bits.Maybethesamepointer *asx,otherwiseitshouldbedeletedbythecaller */ -constfloat*apply_preprocess(idx_tn,constfloat*x)const; +constfloat*apply_preprocess(idx_tn,constfloat*x)const; voidtrain(idx_tn,constfloat*x)override; @@ -170,7 +170,7 @@ ///train_thresholds) voidtransfer_thresholds(LinearTransform*vt); -~IndexLSH()override{} +~IndexLSH()override{} IndexLSH(); diff --git a/xml/IndexLattice_8h.xml b/xml/IndexLattice_8h.xml index 39119bfff6..a22a7595e8 100644 --- a/xml/IndexLattice_8h.xml +++ b/xml/IndexLattice_8h.xml @@ -1,11 +1,25 @@ - + IndexLattice.h vector faiss/IndexFlatCodes.h faiss/impl/lattice_Zn.h + + + + + + + + + + + + + + @@ -16,26 +30,6 @@ - - - - - - - - - - - - - - - - - - - - @@ -46,11 +40,11 @@ - - - - - + + + + + @@ -58,32 +52,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -94,6 +62,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::IndexLattice faiss diff --git a/xml/IndexNNDescent_8h.xml b/xml/IndexNNDescent_8h.xml index bb6b6dd061..89d168999b 100644 --- a/xml/IndexNNDescent_8h.xml +++ b/xml/IndexNNDescent_8h.xml @@ -1,5 +1,5 @@ - + IndexNNDescent.h vector @@ -8,30 +8,26 @@ faiss/utils/utils.h faiss/IndexNSG.h - - - - + + + + - + - + - + + + - - - - - - - - - - + + + + - + @@ -44,54 +40,23 @@ - - - + + + - + - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + @@ -99,45 +64,30 @@ - - - - - - - - - - - - - - - - - - - + + + + - + - - - + - + - - - - + + + + - + - + + + @@ -168,43 +118,53 @@ - - - - - + + + + + + + - - - - + + + + + + + + + + + + - + - + - + - - - - - - - + + + + + + + + - - - - - - - - + + + + + + + @@ -222,44 +182,84 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - faiss::IndexNNDescent faiss::IndexNNDescentFlat @@ -293,7 +293,7 @@ structIndexNNDescent:Index{ //internalstorageofvectors(32bits) -usingstorage_idx_t=NNDescent::storage_idx_t; +usingstorage_idx_t=NNDescent::storage_idx_t; ///Faissresultsare64-bit @@ -310,7 +310,7 @@ MetricTypemetric=METRIC_L2); explicitIndexNNDescent(Index*storage,intK=32); -~IndexNNDescent()override; +~IndexNNDescent()override; voidadd(idx_tn,constfloat*x)override; diff --git a/xml/IndexNSG_8h.xml b/xml/IndexNSG_8h.xml index 46edfb2164..ae88861044 100644 --- a/xml/IndexNSG_8h.xml +++ b/xml/IndexNSG_8h.xml @@ -1,5 +1,5 @@ - + IndexNSG.h vector @@ -10,48 +10,34 @@ faiss/impl/NSG.h faiss/utils/utils.h - - - - - - - - + + + + - - - - - - - - - - - - - - + + + + - + - + - + - + - - - - + + + + - + @@ -64,24 +50,61 @@ - - - + + + + + + + + + - + + + + + + + + + + + + + - - - - + + + + - + + + + + - - + + + + + + + + + + + + + + + + + @@ -99,16 +122,25 @@ - - - - + + + + + + + + + + - - + + + + + @@ -128,74 +160,38 @@ - - - - - - - - - - - - - + + + - + + + + + - + - + - + - - - - + + + + - + - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - + - - - @@ -206,8 +202,33 @@ - - + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -231,26 +252,73 @@ - - + + + + + - - + + + - - - - + + + + + + + + + + + + + + + + - - + + + + + - - + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + @@ -284,169 +352,101 @@ - - - - - - - - + + + + - - - + + + + + - + - + - + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - - - - - - - - + + - - + + - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - - - - - - - - - - - + + - - - - - - - + + - - + + - - + + - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - + + - - + + - - - - - - - - - - - + + + + + + + + faiss::IndexNSG @@ -512,7 +512,7 @@ explicitIndexNSG(intd=0,intR=32,MetricTypemetric=METRIC_L2); explicitIndexNSG(Index*storage,intR=32); -~IndexNSG()override; +~IndexNSG()override; voidbuild(idx_tn,constfloat*x,idx_t*knn_graph,intGK); diff --git a/xml/IndexNeuralNetCodec_8h.xml b/xml/IndexNeuralNetCodec_8h.xml index cf6d2f2f33..2969207833 100644 --- a/xml/IndexNeuralNetCodec_8h.xml +++ b/xml/IndexNeuralNetCodec_8h.xml @@ -1,11 +1,25 @@ - + IndexNeuralNetCodec.h vector faiss/IndexFlatCodes.h faiss/utils/NeuralNet.h + + + + + + + + + + + + + + @@ -26,37 +40,25 @@ - - - - - - + + + + - - - - - - - - - - - - - - - - - + + + + + + + @@ -68,25 +70,23 @@ - - - - - - - - - - - - - + + - - - - - + + + + + + + + + + + + + + faiss::IndexNeuralNetCodec @@ -128,7 +128,7 @@ voidsa_encode(idx_tn,constfloat*x,uint8_t*codes)constoverride; voidsa_decode(idx_tn,constuint8_t*codes,float*x)constoverride; -~IndexNeuralNetCodec(){} +~IndexNeuralNetCodec(){} }; structIndexQINCo:IndexNeuralNetCodec{ @@ -142,7 +142,7 @@ inth, MetricTypemetric=METRIC_L2); -~IndexQINCo(){} +~IndexQINCo(){} }; }//namespacefaiss diff --git a/xml/IndexPQFastScan_8h.xml b/xml/IndexPQFastScan_8h.xml index 5112fe8491..b76bce7512 100644 --- a/xml/IndexPQFastScan_8h.xml +++ b/xml/IndexPQFastScan_8h.xml @@ -1,5 +1,5 @@ - + IndexPQFastScan.h faiss/IndexFastScan.h @@ -8,24 +8,35 @@ faiss/utils/AlignedTable.h faiss/cppcontrib/factory_tools.h - - - - + + + + - + - + + + + + - + - + - + + + - - + + + + + + + @@ -37,17 +48,6 @@ - - - - - - - - - - - @@ -64,16 +64,29 @@ - - - - + + + + - + + + + + - - + + + + + + + + + + + @@ -81,57 +94,57 @@ - - - - - - - - - + + + + + + + + + + + + + + + + + + - - - - - - - - - - + + + + + + - - - - - - - - - - + + + + - + - + - + + + + + - - - @@ -165,64 +178,51 @@ - - + + + + + - - - - - - - - - - - - - - - - - - - - - + + - - - - - + + - - - - - - - - - - - - - - - - - + + - - + + + + + + + + + + + + + + + + + + + + + + + @@ -291,20 +291,11 @@ voidcompute_codes(uint8_t*codes,idx_tn,constfloat*x)constoverride; voidcompute_float_LUT(float*lut,idx_tn,constfloat*x)constoverride; - -/**Decodeasetofvectors. -* -*NOTE:ThecodesintheIndexPQFastScanobjectarenon-contiguous. -*Butthismethodrequiresacontiguousrepresentation. -* -*@paramnnumberofvectors -*@parambytesinputencodedvectors,sizen*code_size -*@paramxoutputvectors,sizen*d -*/ -voidsa_decode(idx_tn,constuint8_t*bytes,float*x)constoverride; -}; - -}//namespacefaiss + +voidsa_decode(idx_tn,constuint8_t*bytes,float*x)constoverride; +}; + +}//namespacefaiss diff --git a/xml/IndexPQ_8h.xml b/xml/IndexPQ_8h.xml index 8cd06daad1..8a8be7c728 100644 --- a/xml/IndexPQ_8h.xml +++ b/xml/IndexPQ_8h.xml @@ -1,5 +1,5 @@ - + IndexPQ.h stdint.h @@ -14,8 +14,27 @@ faiss/IndexNSG.h faiss/IndexPQFastScan.h - - + + + + + + + + + + + + + + + + + + + + + @@ -27,17 +46,6 @@ - - - - - - - - - - - @@ -54,16 +62,17 @@ - - - - - - + + + + - - + + + + + @@ -71,45 +80,41 @@ - - - - - - - - - + + + + + + + + + + + + + + + + + + - - - - - - - - - - + + + + + + - - - - - - - - - @@ -143,52 +148,57 @@ + + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -197,6 +207,16 @@ + + + + + + + + + + @@ -215,32 +235,12 @@ - - - - - - - - - - - - - - - - - - - - @@ -309,7 +309,7 @@ voidsa_decode(idx_tn,constuint8_t*bytes,float*x)constoverride; -FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; +FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; /****************************************************** *Polysemouscodesimplementation diff --git a/xml/IndexPreTransform_8h.xml b/xml/IndexPreTransform_8h.xml index 77d73fbd03..35c4831483 100644 --- a/xml/IndexPreTransform_8h.xml +++ b/xml/IndexPreTransform_8h.xml @@ -1,18 +1,38 @@ - + IndexPreTransform.h faiss/Index.h faiss/VectorTransform.h faiss/cppcontrib/factory_tools.h - - - - + + + + + + + + + + + + + + + + + + + + + + + + @@ -24,16 +44,22 @@ + + + + + + + + - - - - - - - + + + + + @@ -44,35 +70,9 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -176,13 +176,13 @@ ///applythetransformsinthechain.Thereturnedfloat*maybe ///equaltox,otherwiseitshouldbedeallocated. -constfloat*apply_chain(idx_tn,constfloat*x)const; +constfloat*apply_chain(idx_tn,constfloat*x)const; ///Reversethetransformsinthechain.Maynotbeimplementedfor ///alltransformsinthechainormayreturnapproximateresults. voidreverse_chain(idx_tn,constfloat*xt,float*x)const; -DistanceComputer*get_distance_computer()constoverride; +DistanceComputer*get_distance_computer()constoverride; /*standalonecodecinterface*/ size_tsa_code_size()constoverride; @@ -192,7 +192,7 @@ voidmerge_from(Index&otherIndex,idx_tadd_id=0)override; voidcheck_compatible_for_merge(constIndex&otherIndex)constoverride; -~IndexPreTransform()override; +~IndexPreTransform()override; }; }//namespacefaiss diff --git a/xml/IndexRefine_8h.xml b/xml/IndexRefine_8h.xml index 8fff47a771..0042841ad1 100644 --- a/xml/IndexRefine_8h.xml +++ b/xml/IndexRefine_8h.xml @@ -1,33 +1,10 @@ - + IndexRefine.h faiss/Index.h faiss/cppcontrib/factory_tools.h - - - - - - - - - - - - - - - - - - - - - - - @@ -42,30 +19,53 @@ + + + + + + - - - - + + + + + + + + + + + + + + + + + + + + + - - - - + + + + faiss::IndexRefineSearchParameters faiss::IndexRefine @@ -93,7 +93,7 @@ floatk_factor=1; SearchParameters*base_index_params=nullptr;//non-owning -virtual~IndexRefineSearchParameters()=default; +virtual~IndexRefineSearchParameters()=default; }; /**Indexthatqueriesinabase_index(afastone)andrefinesthe @@ -152,7 +152,7 @@ ///accurate voidsa_decode(idx_tn,constuint8_t*bytes,float*x)constoverride; -~IndexRefine()override; +~IndexRefine()override; }; /**VersionwheretherefinementindexisanIndexFlat.Ithasoneadditional diff --git a/xml/IndexReplicas_8h.xml b/xml/IndexReplicas_8h.xml index d3ab55c653..208099cd91 100644 --- a/xml/IndexReplicas_8h.xml +++ b/xml/IndexReplicas_8h.xml @@ -1,83 +1,27 @@ - + IndexReplicas.h faiss/Index.h faiss/IndexBinary.h faiss/impl/ThreadedIndex.h - faiss/gpu/perf/IndexWrapper.h faiss/MetaIndexes.h + faiss/gpu/perf/IndexWrapper.h - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - - @@ -92,34 +36,57 @@ - - + + + + + + + + + - - + + + + + - - - - + + + + + + - + - - - - - - + + + + + + + + + + - - + + + + + + + + + @@ -137,53 +104,78 @@ - - - - - - + + + + - + - - - - + + + + - + - + - + - + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + - - - + + + + + + + + + + + + + + + + @@ -192,6 +184,14 @@ + + + + + + + + faiss::IndexReplicasTemplate faiss @@ -222,8 +222,8 @@ template<typenameIndexT> classIndexReplicasTemplate:publicThreadedIndex<IndexT>{ public: -usingcomponent_t=typenameIndexT::component_t; -usingdistance_t=typenameIndexT::distance_t; +usingcomponent_t=typenameIndexT::component_t; +usingdistance_t=typenameIndexT::distance_t; ///Thedimensionthatallsub-indicesmustsharewillbethedimensionof ///thefirstsub-indexadded @@ -284,8 +284,8 @@ voidonAfterRemoveIndex(IndexT*index)override; }; -usingIndexReplicas=IndexReplicasTemplate<Index>; -usingIndexBinaryReplicas=IndexReplicasTemplate<IndexBinary>; +usingIndexReplicas=IndexReplicasTemplate<Index>; +usingIndexBinaryReplicas=IndexReplicasTemplate<IndexBinary>; }//namespacefaiss diff --git a/xml/IndexRowwiseMinMax_8h.xml b/xml/IndexRowwiseMinMax_8h.xml index af6044a3ef..22fe88f449 100644 --- a/xml/IndexRowwiseMinMax_8h.xml +++ b/xml/IndexRowwiseMinMax_8h.xml @@ -1,5 +1,5 @@ - + IndexRowwiseMinMax.h cstdint @@ -7,32 +7,6 @@ faiss/Index.h faiss/impl/platform_macros.h - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -47,12 +21,6 @@ - - - - - - @@ -65,6 +33,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::IndexRowwiseMinMaxBase faiss::IndexRowwiseMinMaxFP16 @@ -125,7 +125,7 @@ explicitIndexRowwiseMinMaxBase(Index*index); IndexRowwiseMinMaxBase(); -~IndexRowwiseMinMaxBase()override; +~IndexRowwiseMinMaxBase()override; voidadd(idx_tn,constfloat*x)override; voidsearch( diff --git a/xml/IndexScalarQuantizer_8h.xml b/xml/IndexScalarQuantizer_8h.xml index ac305d134b..683da5d0da 100644 --- a/xml/IndexScalarQuantizer_8h.xml +++ b/xml/IndexScalarQuantizer_8h.xml @@ -1,5 +1,5 @@ - + IndexScalarQuantizer.h stdint.h @@ -7,34 +7,10 @@ faiss/IndexFlatCodes.h faiss/IndexIVF.h faiss/impl/ScalarQuantizer.h - faiss/gpu/GpuIndexIVFScalarQuantizer.h faiss/IndexHNSW.h faiss/IndexNSG.h + faiss/gpu/GpuIndexIVFScalarQuantizer.h - - - - - - - - - - - - - - - - - - - - - - - - @@ -43,25 +19,28 @@ - - - - - - - + + + + - + - + - + - + - + + + + + - + + + @@ -90,31 +69,49 @@ - - - - + + + + + + + + + + - - - - - - - - - - - + + + + + - - - + + + + + + + + + + + + + + + + + + + + + @@ -126,26 +123,45 @@ - - - - - + + + + + - - - - + + + + + + + + - - + + + + + + + - - + + + + + + + - - + + + + + + + @@ -179,103 +195,87 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + + + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + - + - - - - - + + + + + faiss::IndexScalarQuantizer faiss::IndexIVFScalarQuantizer @@ -336,7 +336,7 @@ idx_t*labels, constSearchParameters*params=nullptr)constoverride; -FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; +FlatCodesDistanceComputer*get_FlatCodesDistanceComputer()constoverride; /*standalonecodecinterface*/ voidsa_encode(idx_tn,constfloat*x,uint8_t*bytes)constoverride; @@ -381,7 +381,7 @@ constidx_t*precomputed_idx, void*inverted_list_context=nullptr)override; -InvertedListScanner*get_InvertedListScanner( +InvertedListScanner*get_InvertedListScanner( boolstore_pairs, constIDSelector*sel)constoverride; diff --git a/xml/IndexShardsIVF_8h.xml b/xml/IndexShardsIVF_8h.xml index 9c4cdfc9a2..7d35dabfe1 100644 --- a/xml/IndexShardsIVF_8h.xml +++ b/xml/IndexShardsIVF_8h.xml @@ -1,59 +1,45 @@ - + IndexShardsIVF.h faiss/IndexIVF.h faiss/IndexShards.h - - - - - - - - + + + + - - - - - - - - - - + + + + - + - + - - - - - + - + - - - - - - - + + + + - + + + + + + + - - - @@ -81,28 +67,15 @@ - - - - + + + + - + + + - - - - - - - - - - - - - - - @@ -112,6 +85,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -122,26 +127,55 @@ - - - - - - - - + + + + + + + + + - - + + + + + + + + + + + + + + + - - + + + + + + + - - + + + + + + + - - + + + + + + + @@ -189,111 +223,77 @@ + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + - - + + - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - - - - - - - - - - - - - - - - - + + - - + + - - - - - - - - - - - - - + + - - - - - - - - - + + - - + + faiss::IndexShardsIVF diff --git a/xml/IndexShards_8h.xml b/xml/IndexShards_8h.xml index aab8994c4f..03331ca8c2 100644 --- a/xml/IndexShards_8h.xml +++ b/xml/IndexShards_8h.xml @@ -1,5 +1,5 @@ - + IndexShards.h faiss/Index.h @@ -8,20 +8,33 @@ faiss/IndexShardsIVF.h faiss/MetaIndexes.h - - - - + + + + - + - + - + + + - - + + + + + + + + + + + + + @@ -33,104 +46,48 @@ - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - + - + - + - + - - - - - - - - - + + + + - + - + - - - - - - - - - - - - - - - - + + + + - + - - - - - + - - - @@ -147,33 +104,76 @@ - - - - - - + + + + - + + + + + - + - - - - - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -184,14 +184,14 @@ - - - - + + + + faiss::IndexShardsTemplate faiss @@ -220,8 +220,8 @@ */ template<typenameIndexT> structIndexShardsTemplate:publicThreadedIndex<IndexT>{ -usingcomponent_t=typenameIndexT::component_t; -usingdistance_t=typenameIndexT::distance_t; +usingcomponent_t=typenameIndexT::component_t; +usingdistance_t=typenameIndexT::distance_t; /** *Thedimensionthatallsub-indicesmustsharewillbethedimensionof @@ -307,8 +307,8 @@ voidonAfterRemoveIndex(IndexT*index)override; }; -usingIndexShards=IndexShardsTemplate<Index>; -usingIndexBinaryShards=IndexShardsTemplate<IndexBinary>; +usingIndexShards=IndexShardsTemplate<Index>; +usingIndexBinaryShards=IndexShardsTemplate<IndexBinary>; }//namespacefaiss diff --git a/xml/IndexUtils_8h.xml b/xml/IndexUtils_8h.xml index 76fd980314..7d3fd8f9ee 100644 --- a/xml/IndexUtils_8h.xml +++ b/xml/IndexUtils_8h.xml @@ -1,19 +1,28 @@ - + IndexUtils.h faiss/Index.h - - - - + + + + + + + + + + - - + + + + + @@ -21,11 +30,16 @@ - - + + + + + + + - - + + @@ -33,25 +47,11 @@ - - - - - - - - - - - - - + + - - - - - + + faiss diff --git a/xml/IndexWrapper-inl_8h.xml b/xml/IndexWrapper-inl_8h.xml index 365c819748..615803f036 100644 --- a/xml/IndexWrapper-inl_8h.xml +++ b/xml/IndexWrapper-inl_8h.xml @@ -1,10 +1,30 @@ - + IndexWrapper-inl.h faiss/impl/FaissAssert.h faiss/gpu/perf/IndexWrapper.h + + + + + + + + + + + + + + + + + + + + @@ -28,56 +48,36 @@ - - + + + + + - - - - - + + - - + + + + - - - - - - - - - - - - - - - - - - - - - - faiss faiss::gpu diff --git a/xml/IndexWrapper_8h.xml b/xml/IndexWrapper_8h.xml index b8a1732161..96fdc1e0a1 100644 --- a/xml/IndexWrapper_8h.xml +++ b/xml/IndexWrapper_8h.xml @@ -1,5 +1,5 @@ - + IndexWrapper.h faiss/IndexReplicas.h @@ -9,77 +9,89 @@ vector faiss/gpu/perf/IndexWrapper-inl.h - - - - - - - + + + + - + - + - + - - - - - + - + + + + + - + - + - + - + - - - - - - - - - - + + + + - + + + - - + + + + + - - - + + + + + + + - - - - - - - - + + + + + + + + + + + + + + + + + - - + + + + + @@ -97,127 +109,70 @@ - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - + - + - + - + + + - - - - - - - + + + + - + - + - + - + - - - - - - - - - - + + + + - + - + - - - - - - - - - - - - - - - - - - - + + + + - + - - - - - + - - - @@ -234,49 +189,94 @@ - - - - - - - - + + + + - - - - - + - - - - + + + + - + - + - + - + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::gpu::IndexWrapper faiss diff --git a/xml/Index_8h.xml b/xml/Index_8h.xml index 5492fc6205..0fe78d033b 100644 --- a/xml/Index_8h.xml +++ b/xml/Index_8h.xml @@ -1,5 +1,5 @@ - + Index.h faiss/MetricType.h @@ -9,6 +9,18 @@ typeinfo faiss/AutoTune.h faiss/Clustering.h + faiss/IndexBinary.h + faiss/IndexFastScan.h + faiss/IndexFlatCodes.h + faiss/IndexIDMap.h + faiss/IndexIVF.h + faiss/IndexPreTransform.h + faiss/IndexRefine.h + faiss/IndexReplicas.h + faiss/IndexRowwiseMinMax.h + faiss/IndexShards.h + faiss/MetaIndexes.h + faiss/VectorTransform.h faiss/gpu/GpuAutoTune.h faiss/gpu/GpuCloner.h faiss/gpu/GpuDistance.h @@ -19,51 +31,16 @@ faiss/impl/AdditiveQuantizer.h faiss/impl/DistanceComputer.h faiss/impl/HNSW.h - faiss/impl/io.h - faiss/impl/kmeans1d.h faiss/impl/NNDescent.h faiss/impl/NSG.h faiss/impl/ProductAdditiveQuantizer.h - faiss/impl/residual_quantizer_encode_steps.h faiss/impl/ThreadedIndex.h + faiss/impl/io.h + faiss/impl/kmeans1d.h + faiss/impl/residual_quantizer_encode_steps.h faiss/index_factory.h - faiss/IndexBinary.h - faiss/IndexFastScan.h - faiss/IndexFlatCodes.h - faiss/IndexIDMap.h - faiss/IndexIVF.h - faiss/IndexPreTransform.h - faiss/IndexRefine.h - faiss/IndexReplicas.h - faiss/IndexRowwiseMinMax.h - faiss/IndexShards.h - faiss/MetaIndexes.h faiss/utils/extra_distances.h - faiss/VectorTransform.h - - - - - - - - - - - - - - - - - - - - - - - @@ -84,677 +61,700 @@ - - - - - - + + + + - + - - - - - - - - - + + - - - - - - - - - - - + + - - - - - - - - + - - - + + - - - - - - - + + - - - - - - + + + + + + - + + + + + - + - + - + - + - - - - - - - + + + - - - - + + + + - + - + - + - - - - - + - + - - - - - - - - - + - + - + - - - - - - - - - + - + - + - + - + - - - - - + - - - - - + - - - - - + - + - + - + - + - + - - - - - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + - + + + + + + + + + - + - + + + + + + + + + + + + + + + + + - - - - + + + + + + + + + + + + + + + + + + + + - - + + + + + + - - - + + + + + + + - - - - + + + + - + + + + + - + + + + + + + + + + + + + + + + + + + + + - + - - - - - - - + + + + + + + - - - - + + + + + + + + + + + + + + + + + + + + + + - + + + + + - - - + + + + + - - - - + + + + + + + + + + - + - + - - - + + + - - - + + + + + + + - - - + + + + + - - - + + + - + + + + + + + + + + + - - - - - - + + + + - - - + + + + + + + + + + + + + - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - - - + - + - - - - - - + + + + - - - - + + + + - - - - + + + + - + + + + + + + + + - - - - - + - - - - - + - - - + + + - - - + - - - + + + - - - - - - - - - - + + + + + + + + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - - - - - + + + - - - + + + - - - - + + + + - + + + + + + + + + - + - - - - - - - - + + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - + - + - + - - - - - - - - - - - + - + - + + + + + - - - - - - - - - - - - - + + + + + - + - + + + + + - + - + - + - - - - + + + + + + + + - - - - - - - - + + + + - + + + + + - + - + - + - - - - - - - - - - - - - - - - - + - - - - - - - + - - - - - + - - - - - + - + - + + + + + - + - + - - - - - - - - + + + + + + - + - + - + - - - - - - + + + + + + + + - + - + - - - - - - - + + + - + + + + + + + + + + + + + - + - + - - - - - - - - - - - - - - - - - + + + - - - + + + - - - + + + faiss::SearchParameters faiss::Index faiss - + FAISS_VERSION_MAJOR 1 @@ -823,9 +823,9 @@ - + - + @@ -862,8 +862,8 @@ #endif #defineVERSION_STRING\ FAISS_TOSTRING(FAISS_VERSION_MAJOR)\ -"."FAISS_TOSTRING(FAISS_VERSION_MINOR)"."FAISS_TOSTRING(\ -FAISS_VERSION_PATCH) +"."FAISS_TOSTRING(FAISS_VERSION_MINOR)"."FAISS_TOSTRING(\ +FAISS_VERSION_PATCH) /** *@namespacefaiss @@ -908,8 +908,8 @@ *althoughtheinternalrepresentationmayvary. */ structIndex{ -usingcomponent_t=float; -usingdistance_t=float; +usingcomponent_t=float; +usingdistance_t=float; intd;///<vectordimension idx_tntotal;///<totalnbofindexedvectors @@ -931,7 +931,7 @@ metric_type(metric), metric_arg(0){} -virtual~Index(); +virtual~Index(); /**Performtrainingonarepresentativesetofvectors * @@ -1107,7 +1107,7 @@ *DistanceComputerisimplementedforindexesthatsupportrandom *accessoftheirvectors. */ -virtualDistanceComputer*get_distance_computer()const; +virtualDistanceComputer*get_distance_computer()const; /*Thestandalonecodecinterface*/ diff --git a/xml/InterleavedCodes_8h.xml b/xml/InterleavedCodes_8h.xml index 47a5a4aa99..b3b0ef0ac0 100644 --- a/xml/InterleavedCodes_8h.xml +++ b/xml/InterleavedCodes_8h.xml @@ -1,13 +1,10 @@ - + InterleavedCodes.h stdint.h vector - - - @@ -16,6 +13,9 @@ + + + diff --git a/xml/InvertedListsIOHook_8h.xml b/xml/InvertedListsIOHook_8h.xml index 2218f35514..ade9151669 100644 --- a/xml/InvertedListsIOHook_8h.xml +++ b/xml/InvertedListsIOHook_8h.xml @@ -1,5 +1,5 @@ - + InvertedListsIOHook.h faiss/impl/io.h @@ -8,39 +8,25 @@ faiss/invlists/BlockInvertedLists.h faiss/invlists/OnDiskInvertedLists.h - - - - + + + + - - - - - - - - + - + + + - - - - - - - - - - - - - - + + + + + @@ -54,24 +40,20 @@ - - - - + + + + - - - - - - - - - - + + + + + + @@ -84,12 +66,26 @@ - - + + + - - + + + + + + + + + + + + + + + @@ -102,6 +98,10 @@ + + + + faiss::InvertedListsIOHook faiss @@ -145,7 +145,7 @@ virtualvoidwrite(constInvertedLists*ils,IOWriter*f)const=0; ///calledwhenthefourccmatchesthisclass'sfourcc -virtualInvertedLists*read(IOReader*f,intio_flags)const=0; +virtualInvertedLists*read(IOReader*f,intio_flags)const=0; /**readfromaArrayInvertedListsintothisinvertedlisttype. *Forthistowork,thecallbackhastobeenabledandtheio_flaghasto @@ -153,14 +153,14 @@ * *(defaultimplementationfails) */ -virtualInvertedLists*read_ArrayInvertedLists( +virtualInvertedLists*read_ArrayInvertedLists( IOReader*f, intio_flags, size_tnlist, size_tcode_size, conststd::vector<size_t>&sizes)const; -virtual~InvertedListsIOHook(){} +virtual~InvertedListsIOHook(){} /****************************Managethesetofcallbacks******/ diff --git a/xml/InvertedLists_8h.xml b/xml/InvertedLists_8h.xml index db14513079..db617901ab 100644 --- a/xml/InvertedLists_8h.xml +++ b/xml/InvertedLists_8h.xml @@ -1,16 +1,22 @@ - + InvertedLists.h faiss/MetricType.h vector - faiss/gpu/test/TestUtils.h faiss/IndexIVF.h + faiss/gpu/test/TestUtils.h faiss/invlists/BlockInvertedLists.h faiss/invlists/DirectMap.h faiss/invlists/InvertedListsIOHook.h faiss/python/python_callbacks.h + + + + + + @@ -19,9 +25,6 @@ - - - @@ -30,68 +33,61 @@ + + + - - - - - - - - - - - - - + + + + + + + - - + + - - - - - - - + + + + + - - - - + + - + - + + + - - - + - + @@ -101,136 +97,140 @@ - - - - - - - - - - - - - - - - + + + + - - - - - + + + - - - + + + + + + + - + - + - - - - - - - + + + - - - - + + + + - + - - - - + + + + - - - + + + - - - + + + - - - - - - + + - + - + - + - + - - - - - + + + - - - - - + + + - - - + + + - - - - + + + + + + + + - - - - - + - + + + + + + + - - - + + + + + + + + + + + - + - - - + + + + + + + + + + + + + + + @@ -240,13 +240,13 @@ - - - + + + - - - + + + faiss::InvertedListsIterator @@ -289,7 +289,7 @@ namespacefaiss{ structInvertedListsIterator{ -virtual~InvertedListsIterator(); +virtual~InvertedListsIterator(); virtualboolis_available()const=0; virtualvoidnext()=0; virtualstd::pair<idx_t,constuint8_t*>get_id_and_codes()=0; @@ -311,7 +311,7 @@ InvertedLists(size_tnlist,size_tcode_size); -virtual~InvertedLists(); +virtual~InvertedLists(); ///usedforBlockInvertedLists,wherethecodesarepackedintogroups ///andtheindividualcodesizeismeaningless @@ -328,14 +328,14 @@ * *@returncodessizelist_size*code_size */ -virtualconstuint8_t*get_codes(size_tlist_no)const=0; +virtualconstuint8_t*get_codes(size_tlist_no)const=0; /**gettheidsforaninvertedlist *mustbereleasedbyrelease_ids * *@returnidssizelist_size */ -virtualconstidx_t*get_ids(size_tlist_no)const=0; +virtualconstidx_t*get_ids(size_tlist_no)const=0; ///releasecodesreturnedbyget_codes(defaultimplementationisnop virtualvoidrelease_codes(size_tlist_no,constuint8_t*codes)const; @@ -348,7 +348,7 @@ ///@returnasinglecodeinaninvertedlist ///(shouldbedeallocatedwithrelease_codes) -virtualconstuint8_t*get_single_code(size_tlist_no,size_toffset)const; +virtualconstuint8_t*get_single_code(size_tlist_no,size_toffset)const; ///preparethefollowinglists(defaultdoesnothing) ///alistcanbe-1hencethesignedlong @@ -362,7 +362,7 @@ const; ///getiterableforliststhatuse_iterator -virtualInvertedListsIterator*get_iterator( +virtualInvertedListsIterator*get_iterator( size_tlist_no, void*inverted_list_context=nullptr)const; @@ -469,7 +469,7 @@ size_tlist_no; ScopedIds(constInvertedLists*il,size_tlist_no) -:il(il),ids(il->get_ids(list_no)),list_no(list_no){} +:il(il),ids(il->get_ids(list_no)),list_no(list_no){} constidx_t*get(){ returnids; @@ -479,7 +479,7 @@ returnids[i]; } -~ScopedIds(){ +~ScopedIds(){ il->release_ids(list_no,ids); } }; @@ -490,18 +490,18 @@ size_tlist_no; ScopedCodes(constInvertedLists*il,size_tlist_no) -:il(il),codes(il->get_codes(list_no)),list_no(list_no){} +:il(il),codes(il->get_codes(list_no)),list_no(list_no){} ScopedCodes(constInvertedLists*il,size_tlist_no,size_toffset) :il(il), -codes(il->get_single_code(list_no,offset)), +codes(il->get_single_code(list_no,offset)), list_no(list_no){} constuint8_t*get(){ returncodes; } -~ScopedCodes(){ +~ScopedCodes(){ il->release_codes(list_no,codes); } }; @@ -515,8 +515,8 @@ ArrayInvertedLists(size_tnlist,size_tcode_size); size_tlist_size(size_tlist_no)constoverride; -constuint8_t*get_codes(size_tlist_no)constoverride; -constidx_t*get_ids(size_tlist_no)constoverride; +constuint8_t*get_codes(size_tlist_no)constoverride; +constidx_t*get_ids(size_tlist_no)constoverride; size_tadd_entries( size_tlist_no, @@ -539,7 +539,7 @@ boolis_empty(size_tlist_no,void*inverted_list_context=nullptr) constoverride; -~ArrayInvertedLists()override; +~ArrayInvertedLists()override; }; /***************************************************************** @@ -578,8 +578,8 @@ HStackInvertedLists(intnil,constInvertedLists**ils); size_tlist_size(size_tlist_no)constoverride; -constuint8_t*get_codes(size_tlist_no)constoverride; -constidx_t*get_ids(size_tlist_no)constoverride; +constuint8_t*get_codes(size_tlist_no)constoverride; +constidx_t*get_ids(size_tlist_no)constoverride; voidprefetch_lists(constidx_t*list_nos,intnlist)constoverride; @@ -588,11 +588,11 @@ idx_tget_single_id(size_tlist_no,size_toffset)constoverride; -constuint8_t*get_single_code(size_tlist_no,size_toffset) +constuint8_t*get_single_code(size_tlist_no,size_toffset) constoverride; }; -usingConcatenatedInvertedLists=HStackInvertedLists; +usingConcatenatedInvertedLists=HStackInvertedLists; ///verticalsliceofindexesinanotherInvertedLists structSliceInvertedLists:ReadOnlyInvertedLists{ @@ -602,15 +602,15 @@ SliceInvertedLists(constInvertedLists*il,idx_ti0,idx_ti1); size_tlist_size(size_tlist_no)constoverride; -constuint8_t*get_codes(size_tlist_no)constoverride; -constidx_t*get_ids(size_tlist_no)constoverride; +constuint8_t*get_codes(size_tlist_no)constoverride; +constidx_t*get_ids(size_tlist_no)constoverride; voidrelease_codes(size_tlist_no,constuint8_t*codes)constoverride; voidrelease_ids(size_tlist_no,constidx_t*ids)constoverride; idx_tget_single_id(size_tlist_no,size_toffset)constoverride; -constuint8_t*get_single_code(size_tlist_no,size_toffset) +constuint8_t*get_single_code(size_tlist_no,size_toffset) constoverride; voidprefetch_lists(constidx_t*list_nos,intnlist)constoverride; @@ -624,15 +624,15 @@ VStackInvertedLists(intnil,constInvertedLists**ils); size_tlist_size(size_tlist_no)constoverride; -constuint8_t*get_codes(size_tlist_no)constoverride; -constidx_t*get_ids(size_tlist_no)constoverride; +constuint8_t*get_codes(size_tlist_no)constoverride; +constidx_t*get_ids(size_tlist_no)constoverride; voidrelease_codes(size_tlist_no,constuint8_t*codes)constoverride; voidrelease_ids(size_tlist_no,constidx_t*ids)constoverride; idx_tget_single_id(size_tlist_no,size_toffset)constoverride; -constuint8_t*get_single_code(size_tlist_no,size_toffset) +constuint8_t*get_single_code(size_tlist_no,size_toffset) constoverride; voidprefetch_lists(constidx_t*list_nos,intnlist)constoverride; @@ -650,15 +650,15 @@ MaskedInvertedLists(constInvertedLists*il0,constInvertedLists*il1); size_tlist_size(size_tlist_no)constoverride; -constuint8_t*get_codes(size_tlist_no)constoverride; -constidx_t*get_ids(size_tlist_no)constoverride; +constuint8_t*get_codes(size_tlist_no)constoverride; +constidx_t*get_ids(size_tlist_no)constoverride; voidrelease_codes(size_tlist_no,constuint8_t*codes)constoverride; voidrelease_ids(size_tlist_no,constidx_t*ids)constoverride; idx_tget_single_id(size_tlist_no,size_toffset)constoverride; -constuint8_t*get_single_code(size_tlist_no,size_toffset) +constuint8_t*get_single_code(size_tlist_no,size_toffset) constoverride; voidprefetch_lists(constidx_t*list_nos,intnlist)constoverride; @@ -673,15 +673,15 @@ StopWordsInvertedLists(constInvertedLists*il,size_tmaxsize); size_tlist_size(size_tlist_no)constoverride; -constuint8_t*get_codes(size_tlist_no)constoverride; -constidx_t*get_ids(size_tlist_no)constoverride; +constuint8_t*get_codes(size_tlist_no)constoverride; +constidx_t*get_ids(size_tlist_no)constoverride; voidrelease_codes(size_tlist_no,constuint8_t*codes)constoverride; voidrelease_ids(size_tlist_no,constidx_t*ids)constoverride; idx_tget_single_id(size_tlist_no,size_toffset)constoverride; -constuint8_t*get_single_code(size_tlist_no,size_toffset) +constuint8_t*get_single_code(size_tlist_no,size_toffset) constoverride; voidprefetch_lists(constidx_t*list_nos,intnlist)constoverride; diff --git a/xml/L2Norm_8cuh.xml b/xml/L2Norm_8cuh.xml index 387d1a083a..fbc11a691d 100644 --- a/xml/L2Norm_8cuh.xml +++ b/xml/L2Norm_8cuh.xml @@ -1,5 +1,5 @@ - + L2Norm.cuh diff --git a/xml/L2Select_8cuh.xml b/xml/L2Select_8cuh.xml index 4f3ec6d259..f15ca03d4a 100644 --- a/xml/L2Select_8cuh.xml +++ b/xml/L2Select_8cuh.xml @@ -1,5 +1,5 @@ - + L2Select.cuh diff --git a/xml/Level2-avx2-inl_8h.xml b/xml/Level2-avx2-inl_8h.xml index 1ae7c53103..980fbc87b3 100644 --- a/xml/Level2-avx2-inl_8h.xml +++ b/xml/Level2-avx2-inl_8h.xml @@ -1,5 +1,5 @@ - + Level2-avx2-inl.h immintrin.h @@ -7,23 +7,6 @@ cstdint faiss/cppcontrib/detail/UintReader.h - - - - - - - - - - - - - - - - - @@ -32,9 +15,6 @@ - - - @@ -47,6 +27,26 @@ + + + + + + + + + + + + + + + + + + + + faiss::cppcontrib::Index2LevelDecoder faiss @@ -295,27 +295,27 @@ QPOS_LEFT_GE_8, QPOS_LEFT_GE_4, false>{ -staticconstexprintptr_tFINE_SIZE=2; +staticconstexprintptr_tFINE_SIZE=2; -staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; -staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; +staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; //coarsequantizerstorage -staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); +staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); //coarsequantizerbytesstartfrom0 //finequantizerbytesstartfromN_COARSE_ELEMENTS_BYTES -staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; -staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= +staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; +staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= N_COARSE_ELEMENTS*COARSE_BITS; -staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= +staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= (N_COARSE_ELEMENTS_BITS+7)/8; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -732,27 +732,27 @@ QPOS_LEFT_GE_8, QPOS_LEFT_GE_4, false>{ -staticconstexprintptr_tFINE_SIZE=4; +staticconstexprintptr_tFINE_SIZE=4; -staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; -staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; +staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; //coarsequantizerstorage -staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); +staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); //coarsequantizerbytesstartfrom0 //finequantizerbytesstartfromN_COARSE_ELEMENTS_BYTES -staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; -staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= +staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; +staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= N_COARSE_ELEMENTS*COARSE_BITS; -staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= +staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= (N_COARSE_ELEMENTS_BITS+7)/8; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -1121,25 +1121,25 @@ true, true, false>{ -staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; -staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; +staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; //coarsequantizerstorage -staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); +staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); //coarsequantizerbytesstartfrom0 //finequantizerbytesstartfromN_COARSE_ELEMENTS_BYTES -staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; -staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= +staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; +staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= N_COARSE_ELEMENTS*COARSE_BITS; -staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= +staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= (N_COARSE_ELEMENTS_BITS+7)/8; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -1478,25 +1478,25 @@ false, true, false>{ -staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; -staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; +staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; //coarsequantizerstorage -staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); +staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); //coarsequantizerbytesstartfrom0 //finequantizerbytesstartfromN_COARSE_ELEMENTS_BYTES -staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; -staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= +staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; +staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= N_COARSE_ELEMENTS*COARSE_BITS; -staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= +staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= (N_COARSE_ELEMENTS_BITS+7)/8; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -1931,20 +1931,20 @@ intptr_tCOARSE_BITS=8, intptr_tFINE_BITS=8> structIndex2LevelDecoder{ -static_assert( +static_assert( COARSE_BITS==8||COARSE_BITS==10||COARSE_BITS==12|| COARSE_BITS==16, "Only8,10,12or16bitsarecurrentlysupportedforCOARSE_BITS"); -static_assert( +static_assert( FINE_BITS==8||FINE_BITS==10||FINE_BITS==12|| FINE_BITS==16, "Only8,10,12or16bitsarecurrentlysupportedforFINE_BITS"); -staticconstexprintptr_tdim=DIM; -staticconstexprintptr_tcoarseSize=COARSE_SIZE; -staticconstexprintptr_tfineSize=FINE_SIZE; -staticconstexprintptr_tcoarseBits=COARSE_BITS; -staticconstexprintptr_tfineBits=FINE_BITS; +staticconstexprintptr_tdim=DIM; +staticconstexprintptr_tcoarseSize=COARSE_SIZE; +staticconstexprintptr_tfineSize=FINE_SIZE; +staticconstexprintptr_tcoarseBits=COARSE_BITS; +staticconstexprintptr_tfineBits=FINE_BITS; //Process1sample. staticvoidstore( diff --git a/xml/Level2-inl_8h.xml b/xml/Level2-inl_8h.xml index 64562b4976..fcbddf618d 100644 --- a/xml/Level2-inl_8h.xml +++ b/xml/Level2-inl_8h.xml @@ -1,5 +1,5 @@ - + Level2-inl.h cstddef @@ -8,6 +8,12 @@ faiss/impl/platform_macros.h faiss/cppcontrib/SaDecodeKernels.h + + + + + + @@ -28,21 +34,15 @@ + + + - - - - - - - - - @@ -106,25 +106,25 @@ intptr_tCOARSE_BITS=8, intptr_tFINE_BITS=8> structIndex2LevelDecoder{ -static_assert( +static_assert( COARSE_BITS==8||COARSE_BITS==16, "Only8or16bitsarecurrentlysupportedforCOARSE_BITS"); -static_assert( +static_assert( FINE_BITS==8, "Only8bitsiscurrentlysupportedforFINE_BITS"); -staticconstexprintptr_tdim=DIM; -staticconstexprintptr_tcoarseSize=COARSE_SIZE; -staticconstexprintptr_tfineSize=FINE_SIZE; -staticconstexprintptr_tcoarseBits=COARSE_BITS; -staticconstexprintptr_tfineBits=FINE_BITS; +staticconstexprintptr_tdim=DIM; +staticconstexprintptr_tcoarseSize=COARSE_SIZE; +staticconstexprintptr_tfineSize=FINE_SIZE; +staticconstexprintptr_tcoarseBits=COARSE_BITS; +staticconstexprintptr_tfineBits=FINE_BITS; //coarsequantizerstorage -usingcoarse_storage_type= +usingcoarse_storage_type= typenamedetail::CoarseBitType<COARSE_BITS>::bit_type; -staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); +staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //Process1sample. //PerformsoutputStore=decoded(code) diff --git a/xml/Level2-neon-inl_8h.xml b/xml/Level2-neon-inl_8h.xml index 83fe090d47..fe6eb931d1 100644 --- a/xml/Level2-neon-inl_8h.xml +++ b/xml/Level2-neon-inl_8h.xml @@ -1,5 +1,5 @@ - + Level2-neon-inl.h arm_neon.h @@ -7,6 +7,14 @@ cstdint faiss/cppcontrib/detail/UintReader.h + + + + + + + + @@ -19,9 +27,6 @@ - - - @@ -30,23 +35,18 @@ + + + + + + - - - - - - - - - - - faiss::cppcontrib::Index2LevelDecoder faiss @@ -251,27 +251,27 @@ QPOS_LEFT_GE_8, QPOS_LEFT_GE_4, false>{ -staticconstexprintptr_tFINE_SIZE=4; +staticconstexprintptr_tFINE_SIZE=4; -staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; -staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; +staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; //coarsequantizerstorage -staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); +staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); //coarsequantizerbytesstartfrom0 //finequantizerbytesstartfromN_COARSE_ELEMENTS_BYTES -staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; -staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= +staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; +staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= N_COARSE_ELEMENTS*COARSE_BITS; -staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= +staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= (N_COARSE_ELEMENTS_BITS+7)/8; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -890,25 +890,25 @@ true, true, false>{ -staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; -staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; +staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; //coarsequantizerstorage -staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); +staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); //coarsequantizerbytesstartfrom0 //finequantizerbytesstartfromN_COARSE_ELEMENTS_BYTES -staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; -staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= +staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; +staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= N_COARSE_ELEMENTS*COARSE_BITS; -staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= +staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= (N_COARSE_ELEMENTS_BITS+7)/8; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -1413,25 +1413,25 @@ false, true, false>{ -staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; -staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tcoarseCentroidIdx=CPOS/COARSE_SIZE; +staticconstexprintptr_tcoarseCentroidOffset=CPOS%COARSE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; //coarsequantizerstorage -staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); +staticconstexprintptr_tCOARSE_TABLE_BYTES=(1<<COARSE_BITS); //coarsequantizerbytesstartfrom0 //finequantizerbytesstartfromN_COARSE_ELEMENTS_BYTES -staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; -staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= +staticconstexprintptr_tN_COARSE_ELEMENTS=DIM/COARSE_SIZE; +staticconstexprintptr_tN_COARSE_ELEMENTS_BITS= N_COARSE_ELEMENTS*COARSE_BITS; -staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= +staticconstexprintptr_tN_COARSE_ELEMENTS_BYTES= (N_COARSE_ELEMENTS_BITS+7)/8; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -2020,20 +2020,20 @@ intptr_tCOARSE_BITS=8, intptr_tFINE_BITS=8> structIndex2LevelDecoder{ -static_assert( +static_assert( COARSE_BITS==8||COARSE_BITS==10||COARSE_BITS==12|| COARSE_BITS==16, "Only8,10,12or16bitsarecurrentlysupportedforCOARSE_BITS"); -static_assert( +static_assert( FINE_BITS==8||FINE_BITS==10||FINE_BITS==12|| FINE_BITS==16, "Only8,10,12or16bitsarecurrentlysupportedforFINE_BITS"); -staticconstexprintptr_tdim=DIM; -staticconstexprintptr_tcoarseSize=COARSE_SIZE; -staticconstexprintptr_tfineSize=FINE_SIZE; -staticconstexprintptr_tcoarseBits=COARSE_BITS; -staticconstexprintptr_tfineBits=FINE_BITS; +staticconstexprintptr_tdim=DIM; +staticconstexprintptr_tcoarseSize=COARSE_SIZE; +staticconstexprintptr_tfineSize=FINE_SIZE; +staticconstexprintptr_tcoarseBits=COARSE_BITS; +staticconstexprintptr_tfineBits=FINE_BITS; //Process1sample. staticvoidstore( diff --git a/xml/Limits_8cuh.xml b/xml/Limits_8cuh.xml index 65ab1365ab..401ad7df1b 100644 --- a/xml/Limits_8cuh.xml +++ b/xml/Limits_8cuh.xml @@ -1,5 +1,5 @@ - + Limits.cuh diff --git a/xml/LoadStoreOperators_8cuh.xml b/xml/LoadStoreOperators_8cuh.xml index c833aac90c..72d097a56f 100644 --- a/xml/LoadStoreOperators_8cuh.xml +++ b/xml/LoadStoreOperators_8cuh.xml @@ -1,5 +1,5 @@ - + LoadStoreOperators.cuh diff --git a/xml/LocalSearchQuantizer_8h.xml b/xml/LocalSearchQuantizer_8h.xml index 6061e6e6b9..7f2cb60fe2 100644 --- a/xml/LocalSearchQuantizer_8h.xml +++ b/xml/LocalSearchQuantizer_8h.xml @@ -1,5 +1,5 @@ - + LocalSearchQuantizer.h stdint.h @@ -10,22 +10,23 @@ faiss/impl/AdditiveQuantizer.h faiss/impl/platform_macros.h faiss/utils/utils.h - faiss/gpu/GpuIcmEncoder.h - faiss/impl/ProductAdditiveQuantizer.h faiss/IndexAdditiveQuantizer.h faiss/IndexIVFAdditiveQuantizer.h + faiss/gpu/GpuIcmEncoder.h + faiss/impl/ProductAdditiveQuantizer.h - - - - - - - + + + + - + - + + + + + @@ -36,28 +37,43 @@ - - - - + + + + - + + + - - - - - - - - + + + + + - - + + + + + + + + + + + + + + + - - + + + + + @@ -85,29 +101,13 @@ - - - - - - - - - - - - - + + + + + + - - - - - - - - - @@ -141,54 +141,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -205,55 +157,103 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - - - - + + + + + + - - - - + + + + + + + + - - - - - - - - - - - - - - - - + + + + + + + + + + faiss::LocalSearchQuantizer @@ -342,7 +342,7 @@ LocalSearchQuantizer(); -~LocalSearchQuantizer()override; +~LocalSearchQuantizer()override; //Trainthelocalsearchquantizer voidtrain(size_tn,constfloat*x)override; @@ -480,7 +480,7 @@ virtualIcmEncoder*get(constLocalSearchQuantizer*lsq){ returnnewIcmEncoder(lsq); } -virtual~IcmEncoderFactory(){} +virtual~IcmEncoderFactory(){} }; /**Ahelperstructtocountconsumingtimeduringtraining. @@ -510,7 +510,7 @@ voidfinish(); -~LSQTimerScope(); +~LSQTimerScope(); }; }//namespacelsq diff --git a/xml/LookupTableScaler_8h.xml b/xml/LookupTableScaler_8h.xml index 58c9e3e751..c8cfafee18 100644 --- a/xml/LookupTableScaler_8h.xml +++ b/xml/LookupTableScaler_8h.xml @@ -1,14 +1,11 @@ - + LookupTableScaler.h cstdint cstdlib faiss/utils/simdlib.h - - - @@ -19,11 +16,11 @@ - - - - - + + + + + @@ -37,18 +34,21 @@ - - - - - - + + + + + + + + + faiss::DummyScaler faiss::NormTableScaler @@ -81,7 +81,7 @@ ///no-ophandler structDummyScaler{ -staticconstexprintnscale=0; +staticconstexprintnscale=0; inlinesimd32uint8lookup(constsimd32uint8&,constsimd32uint8&)const{ FAISS_THROW_MSG("DummyScaler::lookupshouldnotbecalled."); @@ -125,7 +125,7 @@ ///consumes2x4bitstoencodeanormasascalaradditivequantizer ///thenormisscaledbecauseitsrangeiflargerthanothercomponents structNormTableScaler{ -staticconstexprintnscale=2; +staticconstexprintnscale=2; intscale_int; simd16uint16scale_simd; diff --git a/xml/MathOperators_8cuh.xml b/xml/MathOperators_8cuh.xml index afa0cbc1e7..fdf132cd54 100644 --- a/xml/MathOperators_8cuh.xml +++ b/xml/MathOperators_8cuh.xml @@ -1,5 +1,5 @@ - + MathOperators.cuh diff --git a/xml/MatrixMult-inl_8cuh.xml b/xml/MatrixMult-inl_8cuh.xml index d40d8032d2..86903873d5 100644 --- a/xml/MatrixMult-inl_8cuh.xml +++ b/xml/MatrixMult-inl_8cuh.xml @@ -1,5 +1,5 @@ - + MatrixMult-inl.cuh diff --git a/xml/MatrixMult_8cuh.xml b/xml/MatrixMult_8cuh.xml index bae7106750..e343ad3037 100644 --- a/xml/MatrixMult_8cuh.xml +++ b/xml/MatrixMult_8cuh.xml @@ -1,5 +1,5 @@ - + MatrixMult.cuh diff --git a/xml/MatrixStats_8h.xml b/xml/MatrixStats_8h.xml index c9e1227d03..1382a3ca17 100644 --- a/xml/MatrixStats_8h.xml +++ b/xml/MatrixStats_8h.xml @@ -1,5 +1,5 @@ - + MatrixStats.h stdint.h @@ -22,21 +22,21 @@ - - - + + + - - - + + + faiss::MatrixStats faiss::MatrixStats::PerDimStats diff --git a/xml/MergeNetworkBlock_8cuh.xml b/xml/MergeNetworkBlock_8cuh.xml index 8d8f6cd47e..711cdd983f 100644 --- a/xml/MergeNetworkBlock_8cuh.xml +++ b/xml/MergeNetworkBlock_8cuh.xml @@ -1,5 +1,5 @@ - + MergeNetworkBlock.cuh diff --git a/xml/MergeNetworkUtils_8cuh.xml b/xml/MergeNetworkUtils_8cuh.xml index 9fa187f31f..a0b776f9d1 100644 --- a/xml/MergeNetworkUtils_8cuh.xml +++ b/xml/MergeNetworkUtils_8cuh.xml @@ -1,5 +1,5 @@ - + MergeNetworkUtils.cuh diff --git a/xml/MergeNetworkWarp_8cuh.xml b/xml/MergeNetworkWarp_8cuh.xml index 13880f286e..2721119094 100644 --- a/xml/MergeNetworkWarp_8cuh.xml +++ b/xml/MergeNetworkWarp_8cuh.xml @@ -1,5 +1,5 @@ - + MergeNetworkWarp.cuh diff --git a/xml/MetaIndexes_8h.xml b/xml/MetaIndexes_8h.xml index 243f064509..8de134cb1e 100644 --- a/xml/MetaIndexes_8h.xml +++ b/xml/MetaIndexes_8h.xml @@ -1,5 +1,5 @@ - + MetaIndexes.h faiss/Index.h @@ -8,45 +8,34 @@ faiss/IndexShards.h vector - - - - + + + + - + - + - + + + - - - - - - - + + + + - + - + - - - - - + - + - - - - - - @@ -61,8 +50,25 @@ - - + + + + + + + + + + + + + + + + + + + @@ -78,103 +84,58 @@ - - - - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - + - + - + - + - - - - - - - - - + + + + - + - + - - - - - - - - - - - - - + + + + - + - + - + + + + + - + - - - - - + - - - @@ -191,43 +152,82 @@ - - - - - - + + + + - + - - - - + + + + - + - + - + - + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::IndexSplitVectors faiss::IndexRandom @@ -285,7 +285,7 @@ voidreset()override; -~IndexSplitVectors()override; +~IndexSplitVectors()override; }; /**indexthatreturnsrandomresults. @@ -314,7 +314,7 @@ voidreset()override; -~IndexRandom()override; +~IndexRandom()override; }; }//namespacefaiss diff --git a/xml/MetricType_8h.xml b/xml/MetricType_8h.xml index e9d903890b..752644cc6d 100644 --- a/xml/MetricType_8h.xml +++ b/xml/MetricType_8h.xml @@ -1,16 +1,22 @@ - + MetricType.h faiss/impl/platform_macros.h + faiss/Index.h faiss/gpu/utils/CuvsUtils.h faiss/impl/AuxIndexStructures.h faiss/impl/CodePacker.h faiss/impl/IDSelector.h - faiss/Index.h faiss/invlists/InvertedLists.h faiss/utils/extra_distances-inl.h + + + + + + @@ -25,789 +31,783 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - + + + + - + - + - - - - - + - + - + - - - + + + - - - - + + + + - + - - - - - + - + - + - + - + - + - + - - - - - - - - - - - - - + - + - + - + - - - - - + - + - - - - - - - - - + + + - + - - - - - - - - - + - + - + - + - + - - - - - + - - - - - + - - - - - + - + - + - + - + - + - - - - - + + + - - - - + + + + - - - - - - - - - + + + - - - - + + + + - + - + - + - + - + - + - + - + - + - + - + + + + + - + - + - + - - - - + + + + + + + + - + + + + + + + + + - + + + + + - + - + + + + + - + - - - - - + - - - - - + - - - - - - - - - - - - + + + + - + + + + + + + + + + + + + - + - + - - - - - - - + + + + + + + - - - - + + + + - + - + - + - - - - - - - - - - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - + - - - - - - - - - + - + - - - - - + - - - - + + + + - - - + + + - - - - + + + + - + - - - - - - - - - - - - - - - - - - - - + + + + - + - - - - - - - - - - - - - - - - - + + + - - - - - - - - - + - + - + - - - - - - - - - + + + - - - + + + - - - - - - - - - - + + + + - + + + + + + + + + - + + + + + + + + + + + + + - + - + - + - + - + + + + + - - - - + + + + - - - + + + + + - - - - + + + + - + - - - + + + - - - - + + + + - + - + - - - + + + + + + + - - - - + + + + + + + + + + + + - + - + - + - + - + - + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + + + + + + + + + + + + + - + + + + + - + - + - + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + + + + + - + - + - + + + + + - + + + + + - + - + + + + + + + - - - - + + + + - + - - - - - + - + - + - + + + + + - + - + - + - - - - - - - - - - - - + + + + - + + + + + - + + + + + - + + + + + - + - + - + - - - - - - - - - + - + - + - + - + - + - - - - + + + + - - - - - + - + - + + + + + - + - + - - - - - + - - - - - - - - + + + + + + - + - + - + - - - - + + + + + + + + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + - + + + + + + + + + - + - + - + - - - + + + - - - - - - - - - - - + + + - - - + + + - - - + + + - - - - + + + + + + + + - - - - - - + + faiss @@ -859,11 +859,11 @@ }; ///allvectorindicesarethistype -usingidx_t=int64_t; +usingidx_t=int64_t; ///thisfunctionisusedtodistinguishbetweenminandmaxindexessince ///weneedtosupportsimilarityanddis-similaritymetricsinaflexibleway -constexprboolis_similarity_metric(MetricTypemetric_type){ +constexprboolis_similarity_metric(MetricTypemetric_type){ return((metric_type==METRIC_INNER_PRODUCT)|| (metric_type==METRIC_Jaccard)); } diff --git a/xml/MinMax-inl_8h.xml b/xml/MinMax-inl_8h.xml index 717a9c3849..727e7669bc 100644 --- a/xml/MinMax-inl_8h.xml +++ b/xml/MinMax-inl_8h.xml @@ -1,14 +1,11 @@ - + MinMax-inl.h cstddef cstdint faiss/cppcontrib/SaDecodeKernels.h - - - @@ -20,6 +17,9 @@ + + + @@ -58,7 +58,7 @@ template<typenameSubIndexT> structIndexMinMaxDecoder{ -staticconstexprintptr_tdim=SubIndexT::dim; +staticconstexprintptr_tdim=SubIndexT::dim; //Process1sample. //PerformsoutputStore=scaler*decoded(code)+minv diff --git a/xml/MinMaxFP16-inl_8h.xml b/xml/MinMaxFP16-inl_8h.xml index 69a9113db4..340406c25b 100644 --- a/xml/MinMaxFP16-inl_8h.xml +++ b/xml/MinMaxFP16-inl_8h.xml @@ -1,5 +1,5 @@ - + MinMaxFP16-inl.h cstddef @@ -7,14 +7,14 @@ faiss/utils/fp16.h faiss/cppcontrib/SaDecodeKernels.h - - - - + + + + - + - + @@ -25,9 +25,6 @@ - - - @@ -36,24 +33,27 @@ - - - - - + + + - + + + - - + + - - + + + + + @@ -95,7 +95,7 @@ template<typenameSubIndexT> structIndexMinMaxFP16Decoder{ -staticconstexprintptr_tdim=SubIndexT::dim; +staticconstexprintptr_tdim=SubIndexT::dim; //Process1sample. //PerformsoutputStore=scaler*decoded(code)+minv diff --git a/xml/NNDescent_8h.xml b/xml/NNDescent_8h.xml index f2c938417f..a40e174eed 100644 --- a/xml/NNDescent_8h.xml +++ b/xml/NNDescent_8h.xml @@ -1,5 +1,5 @@ - + NNDescent.h algorithm @@ -16,6 +16,40 @@ faiss/utils/random.h faiss/IndexNNDescent.h + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -28,19 +62,33 @@ - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + @@ -50,48 +98,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -124,85 +130,85 @@ - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - + + + + + - - - - - - - - - - - - - + + - - + + - - - - - + + - - + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -213,12 +219,6 @@ - - - - - - faiss::nndescent::Neighbor faiss::nndescent::Nhood @@ -321,13 +321,13 @@ }//namespacenndescent structNNDescent{ -usingstorage_idx_t=int; +usingstorage_idx_t=int; -usingKNNGraph=std::vector<nndescent::Nhood>; +usingKNNGraph=std::vector<nndescent::Nhood>; explicitNNDescent(constintd,constintK); -~NNDescent(); +~NNDescent(); voidbuild(DistanceComputer&qdis,constintn,boolverbose); @@ -353,14 +353,14 @@ voidupdate(); ///SampleasmallnumberofpointstoevaluatethequalityofKNNGbuilt -voidgenerate_eval_set( +voidgenerate_eval_set( DistanceComputer&qdis, std::vector<int>&c, std::vector<std::vector<int>>&v, intN); ///EvaluatethequalityofKNNGbuilt -floateval_recall( +floateval_recall( std::vector<int>&ctrl_points, std::vector<std::vector<int>>&acc_eval_set); diff --git a/xml/NSG_8h.xml b/xml/NSG_8h.xml index a685f761eb..8c0a482379 100644 --- a/xml/NSG_8h.xml +++ b/xml/NSG_8h.xml @@ -1,5 +1,5 @@ - + NSG.h memory @@ -13,43 +13,26 @@ faiss/utils/random.h faiss/IndexNSG.h - - - - - - + + + + - + - + - - - - - - - - + - + - - - - - - + + + + - - - - - - @@ -68,23 +51,31 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + + + + + + + + + + @@ -108,20 +99,13 @@ - - - - - - - - - - - - - - + + + + + + + @@ -155,55 +139,71 @@ - - + + + + + + + + + + - - - - - - - - - - - - - + + - - + + - - - - - + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -336,9 +336,9 @@ structNSG{ ///internalstorageofvectors(32bits:thisisexpensive) -usingstorage_idx_t=int32_t; -usingNode=nsg::Node; -usingNeighbor=nsg::Neighbor; +usingstorage_idx_t=int32_t; +usingNode=nsg::Node; +usingNeighbor=nsg::Neighbor; intntotal=0;///<nbofnodes diff --git a/xml/NeuralNet_8h.xml b/xml/NeuralNet_8h.xml index 2aee5ec3fb..8d531acbc4 100644 --- a/xml/NeuralNet_8h.xml +++ b/xml/NeuralNet_8h.xml @@ -1,5 +1,5 @@ - + NeuralNet.h cstdint @@ -7,15 +7,6 @@ vector faiss/IndexNeuralNetCodec.h - - - - - - - - - @@ -26,6 +17,15 @@ + + + + + + + + + @@ -97,8 +97,8 @@ } }; -usingTensor2D=Tensor2DTemplate<float>; -usingInt32Tensor2D=Tensor2DTemplate<int32_t>; +usingTensor2D=Tensor2DTemplate<float>; +usingInt32Tensor2D=Tensor2DTemplate<int32_t>; ///minimaltranslationofnn.Linear structLinear{ @@ -178,7 +178,7 @@ virtualnn::Tensor2Ddecode(constnn::Int32Tensor2D&codes)const=0; virtualnn::Int32Tensor2Dencode(constnn::Tensor2D&x)const=0; -virtual~NeuralNetCodec(){} +virtual~NeuralNetCodec(){} }; structQINCo:NeuralNetCodec{ @@ -196,7 +196,7 @@ nn::Int32Tensor2Dencode(constnn::Tensor2D&x)constoverride; -virtual~QINCo(){} +virtual~QINCo(){} }; }//namespacefaiss diff --git a/xml/NoTypeTensor_8cuh.xml b/xml/NoTypeTensor_8cuh.xml index daaea83060..7d4e8ea661 100644 --- a/xml/NoTypeTensor_8cuh.xml +++ b/xml/NoTypeTensor_8cuh.xml @@ -1,5 +1,5 @@ - + NoTypeTensor.cuh diff --git a/xml/OnDiskInvertedLists_8h.xml b/xml/OnDiskInvertedLists_8h.xml index e156986230..b6f9e6b86b 100644 --- a/xml/OnDiskInvertedLists_8h.xml +++ b/xml/OnDiskInvertedLists_8h.xml @@ -1,5 +1,5 @@ - + OnDiskInvertedLists.h list @@ -9,23 +9,6 @@ faiss/index_io.h faiss/invlists/InvertedListsIOHook.h - - - - - - - - - - - - - - - - - @@ -34,8 +17,19 @@ - - + + + + + + + + + + + + + @@ -63,25 +57,79 @@ - - - + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + - - + + + + + + + + + + + - - + + + + + + + - - + + + + + + + + + + + + + + + + + @@ -99,31 +147,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - @@ -156,80 +179,57 @@ - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - + + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::OnDiskOneList faiss::OnDiskInvertedLists @@ -301,7 +301,7 @@ *listsinparallel. */ structOnDiskInvertedLists:InvertedLists{ -usingList=OnDiskOneList; +usingList=OnDiskOneList; //sizenlist std::vector<List>lists; @@ -324,8 +324,8 @@ OnDiskInvertedLists(size_tnlist,size_tcode_size,constchar*filename); size_tlist_size(size_tlist_no)constoverride; -constuint8_t*get_codes(size_tlist_no)constoverride; -constidx_t*get_ids(size_tlist_no)constoverride; +constuint8_t*get_codes(size_tlist_no)constoverride; +constidx_t*get_ids(size_tlist_no)constoverride; size_tadd_entries( size_tlist_no, @@ -358,7 +358,7 @@ voidprefetch_lists(constidx_t*list_nos,intnlist)constoverride; -~OnDiskInvertedLists()override; +~OnDiskInvertedLists()override; //private @@ -385,8 +385,8 @@ structOnDiskInvertedListsIOHook:InvertedListsIOHook{ OnDiskInvertedListsIOHook(); voidwrite(constInvertedLists*ils,IOWriter*f)constoverride; -InvertedLists*read(IOReader*f,intio_flags)constoverride; -InvertedLists*read_ArrayInvertedLists( +InvertedLists*read(IOReader*f,intio_flags)constoverride; +InvertedLists*read_ArrayInvertedLists( IOReader*f, intio_flags, size_tnlist, diff --git a/xml/PQ-avx2-inl_8h.xml b/xml/PQ-avx2-inl_8h.xml index f424048114..241788588a 100644 --- a/xml/PQ-avx2-inl_8h.xml +++ b/xml/PQ-avx2-inl_8h.xml @@ -1,5 +1,5 @@ - + PQ-avx2-inl.h immintrin.h @@ -7,20 +7,14 @@ cstdint faiss/cppcontrib/detail/UintReader.h - - - - + + + + - + - - - - - - @@ -33,20 +27,26 @@ - - - - - - - - + + + + + + + + + + + + + + faiss::cppcontrib::IndexPQDecoder faiss @@ -266,14 +266,14 @@ QPOS_LEFT_GE_8, QPOS_LEFT_GE_4, false>{ -staticconstexprintptr_tFINE_SIZE=2; +staticconstexprintptr_tFINE_SIZE=2; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -624,14 +624,14 @@ QPOS_LEFT_GE_8, QPOS_LEFT_GE_4, false>{ -staticconstexprintptr_tFINE_SIZE=4; +staticconstexprintptr_tFINE_SIZE=4; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -929,12 +929,12 @@ true, true, false>{ -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -1202,12 +1202,12 @@ false, true, false>{ -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -1555,14 +1555,14 @@ //SuitableforPQ[1]x16 template<intptr_tDIM,intptr_tFINE_SIZE,intptr_tFINE_BITS=8> structIndexPQDecoder{ -static_assert( +static_assert( FINE_BITS==8||FINE_BITS==10||FINE_BITS==12|| FINE_BITS==16, "Only8,10,12or16bitsarecurrentlysupportedforFINE_BITS"); -staticconstexprintptr_tdim=DIM; -staticconstexprintptr_tfineSize=FINE_SIZE; -staticconstexprintptr_tfineBits=FINE_BITS; +staticconstexprintptr_tdim=DIM; +staticconstexprintptr_tfineSize=FINE_SIZE; +staticconstexprintptr_tfineBits=FINE_BITS; //Process1sample. staticvoidstore( diff --git a/xml/PQ-inl_8h.xml b/xml/PQ-inl_8h.xml index d3d5676395..ee6ae68553 100644 --- a/xml/PQ-inl_8h.xml +++ b/xml/PQ-inl_8h.xml @@ -1,5 +1,5 @@ - + PQ-inl.h cstddef @@ -14,12 +14,12 @@ - - - + + + @@ -64,15 +64,15 @@ //SuitableforPQ[1]x8 template<intptr_tDIM,intptr_tFINE_SIZE,intptr_tFINE_BITS=8> structIndexPQDecoder{ -static_assert( +static_assert( FINE_BITS==8, "Only8bitsiscurrentlysupportedforFINE_BITS"); -staticconstexprintptr_tdim=DIM; -staticconstexprintptr_tfineSize=FINE_SIZE; -staticconstexprintptr_tfineBits=FINE_BITS; +staticconstexprintptr_tdim=DIM; +staticconstexprintptr_tfineSize=FINE_SIZE; +staticconstexprintptr_tfineBits=FINE_BITS; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //Process1sample. //PerformsoutputStore=decoded(code) diff --git a/xml/PQ-neon-inl_8h.xml b/xml/PQ-neon-inl_8h.xml index 0d6992c1e9..15d1cdc52c 100644 --- a/xml/PQ-neon-inl_8h.xml +++ b/xml/PQ-neon-inl_8h.xml @@ -1,5 +1,5 @@ - + PQ-neon-inl.h arm_neon.h @@ -7,23 +7,6 @@ cstdint faiss/cppcontrib/detail/UintReader.h - - - - - - - - - - - - - - - - - @@ -32,9 +15,6 @@ - - - @@ -47,6 +27,26 @@ + + + + + + + + + + + + + + + + + + + + faiss::cppcontrib::IndexPQDecoder faiss @@ -225,14 +225,14 @@ QPOS_LEFT_GE_8, QPOS_LEFT_GE_4, false>{ -staticconstexprintptr_tFINE_SIZE=4; +staticconstexprintptr_tFINE_SIZE=4; -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -670,12 +670,12 @@ true, true, false>{ -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -998,12 +998,12 @@ false, true, false>{ -staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; -staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; +staticconstexprintptr_tfineCentroidIdx=CPOS/FINE_SIZE; +staticconstexprintptr_tfineCentroidOffset=CPOS%FINE_SIZE; -staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; +staticconstexprintptr_tQPOS_LEFT=FINE_SIZE-fineCentroidOffset; -staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); +staticconstexprintptr_tFINE_TABLE_BYTES=(1<<FINE_BITS); //process1sample staticvoidstore( @@ -1390,14 +1390,14 @@ //SuitableforPQ[1]x16 template<intptr_tDIM,intptr_tFINE_SIZE,intptr_tFINE_BITS=8> structIndexPQDecoder{ -static_assert( +static_assert( FINE_BITS==8||FINE_BITS==10||FINE_BITS==12|| FINE_BITS==16, "Only8,10,12or16bitsarecurrentlysupportedforFINE_BITS"); -staticconstexprintptr_tdim=DIM; -staticconstexprintptr_tfineSize=FINE_SIZE; -staticconstexprintptr_tfineBits=FINE_BITS; +staticconstexprintptr_tdim=DIM; +staticconstexprintptr_tfineSize=FINE_SIZE; +staticconstexprintptr_tfineBits=FINE_BITS; //Process1sample. staticvoidstore( diff --git a/xml/PQCodeDistances-inl_8cuh.xml b/xml/PQCodeDistances-inl_8cuh.xml index 1ee981d5d4..b6328fe0c1 100644 --- a/xml/PQCodeDistances-inl_8cuh.xml +++ b/xml/PQCodeDistances-inl_8cuh.xml @@ -1,5 +1,5 @@ - + PQCodeDistances-inl.cuh diff --git a/xml/PQCodeDistances_8cuh.xml b/xml/PQCodeDistances_8cuh.xml index 099ab7ffa3..9066a82105 100644 --- a/xml/PQCodeDistances_8cuh.xml +++ b/xml/PQCodeDistances_8cuh.xml @@ -1,5 +1,5 @@ - + PQCodeDistances.cuh diff --git a/xml/PQCodeLoad_8cuh.xml b/xml/PQCodeLoad_8cuh.xml index c65920b6a8..40bcc17400 100644 --- a/xml/PQCodeLoad_8cuh.xml +++ b/xml/PQCodeLoad_8cuh.xml @@ -1,5 +1,5 @@ - + PQCodeLoad.cuh diff --git a/xml/PQScanMultiPassNoPrecomputed-inl_8cuh.xml b/xml/PQScanMultiPassNoPrecomputed-inl_8cuh.xml index 3c43296ec7..e28bf51ca0 100644 --- a/xml/PQScanMultiPassNoPrecomputed-inl_8cuh.xml +++ b/xml/PQScanMultiPassNoPrecomputed-inl_8cuh.xml @@ -1,5 +1,5 @@ - + PQScanMultiPassNoPrecomputed-inl.cuh diff --git a/xml/PQScanMultiPassNoPrecomputed_8cuh.xml b/xml/PQScanMultiPassNoPrecomputed_8cuh.xml index 288c274c29..3936a194d3 100644 --- a/xml/PQScanMultiPassNoPrecomputed_8cuh.xml +++ b/xml/PQScanMultiPassNoPrecomputed_8cuh.xml @@ -1,5 +1,5 @@ - + PQScanMultiPassNoPrecomputed.cuh diff --git a/xml/PQScanMultiPassPrecomputed_8cuh.xml b/xml/PQScanMultiPassPrecomputed_8cuh.xml index de745812c6..9455a77240 100644 --- a/xml/PQScanMultiPassPrecomputed_8cuh.xml +++ b/xml/PQScanMultiPassPrecomputed_8cuh.xml @@ -1,5 +1,5 @@ - + PQScanMultiPassPrecomputed.cuh diff --git a/xml/Pair_8cuh.xml b/xml/Pair_8cuh.xml index 126855dd42..d5e9a7d743 100644 --- a/xml/Pair_8cuh.xml +++ b/xml/Pair_8cuh.xml @@ -1,5 +1,5 @@ - + Pair.cuh diff --git a/xml/PolysemousTraining_8h.xml b/xml/PolysemousTraining_8h.xml index 2a95661621..554f2d29fd 100644 --- a/xml/PolysemousTraining_8h.xml +++ b/xml/PolysemousTraining_8h.xml @@ -1,24 +1,10 @@ - + PolysemousTraining.h faiss/impl/ProductQuantizer.h faiss/IndexPQ.h - - - - - - - - - - - - - - @@ -27,8 +13,25 @@ - - + + + + + + + + + + + + + + + + + + + @@ -36,39 +39,41 @@ - - - - - - - - - + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - + + + + + + + @@ -102,52 +107,57 @@ + + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -156,6 +166,16 @@ + + + + + + + + + + @@ -174,42 +194,22 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + faiss::SimulatedAnnealingParameters faiss::PermutationObjective @@ -266,7 +266,7 @@ //defaultimplementationjustcomputesbothandcomputesthedifference virtualdoublecost_update(constint*perm,intiw,intjw)const; -virtual~PermutationObjective(){} +virtual~PermutationObjective(){} }; structReproduceDistancesObjective:PermutationObjective{ @@ -307,7 +307,7 @@ voidset_affine_target_dis(constdouble*source_dis_in); -~ReproduceDistancesObjective()override{} +~ReproduceDistancesObjective()override{} }; structRandomGenerator; @@ -333,7 +333,7 @@ //runtheoptimizationandreturnthebestresultinbest_perm doublerun_optimization(int*best_perm); -virtual~SimulatedAnnealingOptimizer(); +virtual~SimulatedAnnealingOptimizer(); }; ///optimizestheorderofindicesinaProductQuantizer diff --git a/xml/ProductAdditiveQuantizer_8h.xml b/xml/ProductAdditiveQuantizer_8h.xml index dd0303a9df..feea614d66 100644 --- a/xml/ProductAdditiveQuantizer_8h.xml +++ b/xml/ProductAdditiveQuantizer_8h.xml @@ -1,5 +1,5 @@ - + ProductAdditiveQuantizer.h cstdint @@ -13,24 +13,35 @@ faiss/IndexIVFAdditiveQuantizer.h faiss/IndexIVFAdditiveQuantizerFastScan.h - - - - + + + + - + + + + + - + - + - + + + - - + + + + + + + @@ -42,44 +53,33 @@ - - - - - - + + + + - - - + + + + + - + - - - - - - - - + + + - - - - - - - - - - - + + + + + @@ -101,39 +101,49 @@ + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - - - + + + + + + + @@ -157,6 +167,10 @@ + + + + @@ -167,83 +181,69 @@ - - - - + + + + - + - + - + - + + + - - + + - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - + + - - - - - + + + + + + + + + + + - - + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + @@ -253,6 +253,20 @@ + + + + + + + + + + + + + + @@ -265,20 +279,6 @@ - - - - - - - - - - - - - - faiss::ProductAdditiveQuantizer faiss::ProductLocalSearchQuantizer @@ -337,14 +337,14 @@ ProductAdditiveQuantizer(); -virtual~ProductAdditiveQuantizer(); +virtual~ProductAdditiveQuantizer(); voidinit( size_td, conststd::vector<AdditiveQuantizer*>&aqs, Search_type_tsearch_type); -AdditiveQuantizer*subquantizer(size_tm)const; +AdditiveQuantizer*subquantizer(size_tm)const; ///<Traintheproductadditivequantizer voidtrain(size_tn,constfloat*x)override; diff --git a/xml/ProductQuantizer-inl_8h.xml b/xml/ProductQuantizer-inl_8h.xml index 21dd86b23a..00a9a560d5 100644 --- a/xml/ProductQuantizer-inl_8h.xml +++ b/xml/ProductQuantizer-inl_8h.xml @@ -1,86 +1,86 @@ - + ProductQuantizer-inl.h faiss/impl/ProductQuantizer.h - + + + + + + + + + + + - + - + - + + + + + + + + + + + - + + + - - - - - - - - - - - - - - - + - - - - + + + + + + + + - - - - - - - + - + - - - - + + + + - - - - - - - - - - - + + + + + @@ -91,7 +91,7 @@ - + diff --git a/xml/ProductQuantizer_8h.xml b/xml/ProductQuantizer_8h.xml index 0af1ec6242..49b3d297ca 100644 --- a/xml/ProductQuantizer_8h.xml +++ b/xml/ProductQuantizer_8h.xml @@ -1,5 +1,5 @@ - + ProductQuantizer.h stdint.h @@ -9,26 +9,12 @@ faiss/impl/platform_macros.h faiss/utils/Heap.h faiss/impl/ProductQuantizer-inl.h - faiss/gpu/GpuIndexIVFPQ.h - faiss/impl/PolysemousTraining.h faiss/IndexIVFPQFastScan.h faiss/IndexPQ.h faiss/IndexPQFastScan.h + faiss/gpu/GpuIndexIVFPQ.h + faiss/impl/PolysemousTraining.h - - - - - - - - - - - - - - @@ -37,42 +23,61 @@ - - - - - - - - + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - + + + + + + + @@ -106,124 +111,119 @@ + + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + - + - + - + + + + + + + + + + + - + + + - - - - - - - - - + - - - - + + + + + + + + - - - - - - - + - + - - - - + + + + - - - - - - - - - - - - @@ -233,7 +233,7 @@ - + @@ -318,10 +318,10 @@ std::vector<float>centroids_sq_lengths; ///returnthecentroidsassociatedwithsubvectorm -float*get_centroids(size_tm,size_ti){ +float*get_centroids(size_tm,size_ti){ return&centroids[(m*ksub+i)*dsub]; } -constfloat*get_centroids(size_tm,size_ti)const{ +constfloat*get_centroids(size_tm,size_ti)const{ return&centroids[(m*ksub+i)*dsub]; } @@ -457,7 +457,7 @@ voidencode(uint64_tx); -~PQEncoderGeneric(); +~PQEncoderGeneric(); }; structPQEncoder8{ diff --git a/xml/PtxUtils_8cuh.xml b/xml/PtxUtils_8cuh.xml index 49d4d2c06f..35ea82da26 100644 --- a/xml/PtxUtils_8cuh.xml +++ b/xml/PtxUtils_8cuh.xml @@ -1,5 +1,5 @@ - + PtxUtils.cuh diff --git a/xml/Quantizer_8h.xml b/xml/Quantizer_8h.xml index 4ca7fd41f6..70b258b17a 100644 --- a/xml/Quantizer_8h.xml +++ b/xml/Quantizer_8h.xml @@ -1,5 +1,5 @@ - + Quantizer.h stdint.h @@ -7,164 +7,122 @@ faiss/impl/ProductQuantizer.h faiss/impl/ScalarQuantizer.h - - - + + + - - - - - - - + + + - + - + + + + + + + + + + + - - + + - + + + + + + + + + - + - + + + + + - + + + + + - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - + - + - + - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - - + + + - - - - - - - - + + - - - - - - - + + + - + - + + + + + + + @@ -173,30 +131,48 @@ - + - + + + + + + + + + + + + + - - - - - - - + + + + + - - - + + + + + + + + + + + @@ -207,14 +183,38 @@ - + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss::Quantizer @@ -266,7 +266,7 @@ */ virtualvoiddecode(constuint8_t*code,float*x,size_tn)const=0; -virtual~Quantizer(){} +virtual~Quantizer(){} }; }//namespacefaiss diff --git a/xml/ReductionOperators_8cuh.xml b/xml/ReductionOperators_8cuh.xml index d782c26ba3..f253782080 100644 --- a/xml/ReductionOperators_8cuh.xml +++ b/xml/ReductionOperators_8cuh.xml @@ -1,5 +1,5 @@ - + ReductionOperators.cuh diff --git a/xml/Reductions_8cuh.xml b/xml/Reductions_8cuh.xml index 7c59d625b6..602a2c84e9 100644 --- a/xml/Reductions_8cuh.xml +++ b/xml/Reductions_8cuh.xml @@ -1,5 +1,5 @@ - + Reductions.cuh diff --git a/xml/RemapIndices_8h.xml b/xml/RemapIndices_8h.xml index 401b0f4909..584add1cd7 100644 --- a/xml/RemapIndices_8h.xml +++ b/xml/RemapIndices_8h.xml @@ -1,10 +1,30 @@ - + RemapIndices.h faiss/Index.h vector + + + + + + + + + + + + + + + + + + + + @@ -24,41 +44,21 @@ + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - faiss faiss::gpu diff --git a/xml/ResidualQuantizer_8h.xml b/xml/ResidualQuantizer_8h.xml index e1a4d525d4..2d9071cea6 100644 --- a/xml/ResidualQuantizer_8h.xml +++ b/xml/ResidualQuantizer_8h.xml @@ -1,5 +1,5 @@ - + ResidualQuantizer.h cstdint @@ -7,20 +7,32 @@ faiss/Clustering.h faiss/impl/AdditiveQuantizer.h faiss/utils/approx_topk/mode.h - faiss/impl/ProductAdditiveQuantizer.h faiss/IndexAdditiveQuantizer.h faiss/IndexIVFAdditiveQuantizer.h + faiss/impl/ProductAdditiveQuantizer.h - - - + + + - - + + + + + + + + + + + + + + @@ -29,49 +41,37 @@ - - - - + + + + - + + + - - + + + + + - - - - + + + + + + - - - - - - - - - - - - - - + + + + + - - - - - - - - - - @@ -79,11 +79,11 @@ - - - - - + + + + + @@ -99,86 +99,86 @@ - - - - + + + + - - - - - - - - - - - - - - - - - - - - - + + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + - + - + - + + + + + + + + + + + + + + + + + - - - - - + - - - - - - - - - - - - faiss::ResidualQuantizer faiss @@ -217,7 +217,7 @@ ///initialization //Wasenumbutthatdoesnotworksowellwithbitmasks -usingtrain_type_t=int; +usingtrain_type_t=int; ///BinaryoroftheTrain_*flagsbelow train_type_ttrain_type=Train_progressive_dim; diff --git a/xml/ResultHandler_8h.xml b/xml/ResultHandler_8h.xml index 133629e1c7..f46766c54a 100644 --- a/xml/ResultHandler_8h.xml +++ b/xml/ResultHandler_8h.xml @@ -1,5 +1,5 @@ - + ResultHandler.h faiss/impl/AuxIndexStructures.h @@ -14,35 +14,12 @@ faiss/utils/distances_fused/distances_fused.h faiss/utils/distances_fused/simdlib_based.h - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - @@ -61,20 +38,17 @@ - - - - - - - - - - - - - - + + + + + + + + + + + @@ -86,24 +60,31 @@ - - - - + + + + - + - + + + + + + + + + - - - - - - - - + + + + + + + @@ -137,69 +118,72 @@ - - - - - - - - - - - - + + + + + + + - - + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - - + + + - - + - - - + + - - - + + - - - + + + + + + + + + + @@ -212,6 +196,22 @@ + + + + + + + + + + + + + + + + faiss::BlockResultHandler faiss::ResultHandler @@ -225,7 +225,7 @@ faiss::RangeSearchBlockResultHandler faiss::RangeSearchBlockResultHandler::SingleResultHandler faiss - + DISPATCH_C_SEL C @@ -262,7 +262,7 @@ - + @@ -330,7 +330,7 @@ //seriesofresultsforqueriesi0..i1isdone virtualvoidend_multiple(){} -virtual~BlockResultHandler(){} +virtual~BlockResultHandler(){} boolis_in_selection(idx_ti)const{ return!use_sel||sel->is_member(i); @@ -346,7 +346,7 @@ //returnwhetherthresholdwasupdated virtualbooladd_result(typenameC::Tdis,typenameC::TIidx)=0; -virtual~ResultHandler(){} +virtual~ResultHandler(){} }; /***************************************************************** @@ -357,10 +357,10 @@ template<classC,booluse_sel=false> structTop1BlockResultHandler:BlockResultHandler<C,use_sel>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingBlockResultHandler<C, use_sel>::i0; -usingBlockResultHandler<C, use_sel>::i1; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingBlockResultHandler<C,use_sel>::i0; +usingBlockResultHandler<C,use_sel>::i1; //containsexactlynqelements T*dis_tab; @@ -378,7 +378,7 @@ structSingleResultHandler:ResultHandler<C>{ Top1BlockResultHandler&hr; -usingResultHandler<C>::threshold; +usingResultHandler<C>::threshold; TImin_idx; size_tcurrent_idx=0; @@ -455,10 +455,10 @@ template<classC,booluse_sel=false> structHeapBlockResultHandler:BlockResultHandler<C,use_sel>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingBlockResultHandler<C, use_sel>::i0; -usingBlockResultHandler<C, use_sel>::i1; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingBlockResultHandler<C,use_sel>::i0; +usingBlockResultHandler<C,use_sel>::i1; T*heap_dis_tab; TI*heap_ids_tab; @@ -483,7 +483,7 @@ structSingleResultHandler:ResultHandler<C>{ HeapBlockResultHandler&hr; -usingResultHandler<C>::threshold; +usingResultHandler<C>::threshold; size_tk; T*heap_dis; @@ -568,9 +568,9 @@ ///Reservoirforasinglequery template<classC> structReservoirTopN:ResultHandler<C>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingResultHandler<C>::threshold; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingResultHandler<C>::threshold; T*vals; TI*ids; @@ -638,10 +638,10 @@ template<classC,booluse_sel=false> structReservoirBlockResultHandler:BlockResultHandler<C,use_sel>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingBlockResultHandler<C, use_sel>::i0; -usingBlockResultHandler<C, use_sel>::i1; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingBlockResultHandler<C,use_sel>::i0; +usingBlockResultHandler<C,use_sel>::i1; T*heap_dis_tab; TI*heap_ids_tab; @@ -752,10 +752,10 @@ template<classC,booluse_sel=false> structRangeSearchBlockResultHandler:BlockResultHandler<C,use_sel>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingBlockResultHandler<C, use_sel>::i0; -usingBlockResultHandler<C, use_sel>::i1; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingBlockResultHandler<C,use_sel>::i0; +usingBlockResultHandler<C,use_sel>::i1; RangeSearchResult*res; Tradius; @@ -775,7 +775,7 @@ structSingleResultHandler:ResultHandler<C>{ //almostthesameinterfaceasRangeSearchResultHandler -usingResultHandler<C>::threshold; +usingResultHandler<C>::threshold; RangeSearchPartialResultpres; RangeQueryResult*qr=nullptr; @@ -786,7 +786,7 @@ ///beginresultsforquery#i voidbegin(size_ti){ -qr=&pres.new_result(i); +qr=&pres.new_result(i); } ///addoneresultforqueryi @@ -800,14 +800,14 @@ ///seriesofresultsforqueryiisdone voidend(){} -~SingleResultHandler(){ +~SingleResultHandler(){ try{ //finalizethepartialresult pres.finalize(); }catch(constfaiss::FaissException&e){ //Donothingifallocationfailsinfinalizingpartialresults. #ifndefNDEBUG -std::cerr<<e.what()<<std::endl; +std::cerr<<e.what()<<std::endl; #endif } } @@ -852,7 +852,7 @@ for(size_ti=i0;i<i1;i++){ constfloat*ip_line=dis_tab+(i-i0)*(j1-j0); -RangeQueryResult&qres=pres->new_result(i); +RangeQueryResult&qres=pres->new_result(i); for(size_tj=j0;j<j1;j++){ floatdis=*ip_line++; @@ -863,7 +863,7 @@ } } -~RangeSearchBlockResultHandler(){ +~RangeSearchBlockResultHandler(){ try{ if(partial_results.size()>0){ RangeSearchPartialResult::merge(partial_results); @@ -871,7 +871,7 @@ }catch(constfaiss::FaissException&e){ //Donothingifallocationfailsinmerge. #ifndefNDEBUG -std::cerr<<e.what()<<std::endl; +std::cerr<<e.what()<<std::endl; #endif } } @@ -907,14 +907,14 @@ } if(is_similarity_metric(metric)){ -usingC=CMin<float,int64_t>; +usingC=CMin<float,int64_t>; if(sel){ DISPATCH_C_SEL(C,true); }else{ DISPATCH_C_SEL(C,false); } }else{ -usingC=CMax<float,int64_t>; +usingC=CMax<float,int64_t>; if(sel){ DISPATCH_C_SEL(C,true); }else{ @@ -937,14 +937,14 @@ returnconsumer.templatef<>(resb,args...); if(is_similarity_metric(metric)){ -usingC=CMin<float,int64_t>; +usingC=CMin<float,int64_t>; if(sel){ DISPATCH_C_SEL(C,true); }else{ DISPATCH_C_SEL(C,false); } }else{ -usingC=CMax<float,int64_t>; +usingC=CMax<float,int64_t>; if(sel){ DISPATCH_C_SEL(C,true); }else{ diff --git a/xml/SaDecodeKernels_8h.xml b/xml/SaDecodeKernels_8h.xml index 03c4d44be3..b100dcf45f 100644 --- a/xml/SaDecodeKernels_8h.xml +++ b/xml/SaDecodeKernels_8h.xml @@ -1,5 +1,5 @@ - + SaDecodeKernels.h faiss/cppcontrib/sa_decode/MinMax-inl.h @@ -19,11 +19,9 @@ - - - - - + + + @@ -39,14 +37,30 @@ - - - + + + + + - + + + + + - + + + + + + + + + + + @@ -57,9 +71,6 @@ - - - @@ -68,38 +79,27 @@ - - - - - + + + - + - - - - - + - - - - - - - - - - + + - - + + + + + diff --git a/xml/ScalarQuantizer_8h.xml b/xml/ScalarQuantizer_8h.xml index de6ef9016d..6e9880348c 100644 --- a/xml/ScalarQuantizer_8h.xml +++ b/xml/ScalarQuantizer_8h.xml @@ -1,26 +1,32 @@ - + ScalarQuantizer.h faiss/impl/AuxIndexStructures.h faiss/impl/DistanceComputer.h faiss/impl/Quantizer.h - faiss/gpu/GpuIndexIVFFlat.h faiss/IndexScalarQuantizer.h + faiss/gpu/GpuIndexIVFFlat.h - - - - + + + + + + + + + + - - - - - + + + + + @@ -40,32 +46,17 @@ - - - - - - - - - - - - - - - - - - - - + + + + + @@ -77,28 +68,19 @@ - - - - + + + + - - - - - - - - + + - - - - - + + @@ -106,47 +88,65 @@ - - + + + + + + + + + + + + + + + - - + - + + + - + - + + + + + - + - + - - - - - - - + + + - + - + - - - + + + + + + + faiss::ScalarQuantizer @@ -252,7 +252,7 @@ virtualvoidencode_vector(constfloat*x,uint8_t*code)const=0; virtualvoiddecode_vector(constuint8_t*code,float*x)const=0; -virtual~SQuantizer(){} +virtual~SQuantizer(){} }; SQuantizer*select_quantizer()const; diff --git a/xml/Select_8cuh.xml b/xml/Select_8cuh.xml index d7ce3e2863..6b00aa60b4 100644 --- a/xml/Select_8cuh.xml +++ b/xml/Select_8cuh.xml @@ -1,5 +1,5 @@ - + Select.cuh diff --git a/xml/StackDeviceMemory_8h.xml b/xml/StackDeviceMemory_8h.xml index 02e0d5d2e8..5a584481cd 100644 --- a/xml/StackDeviceMemory_8h.xml +++ b/xml/StackDeviceMemory_8h.xml @@ -1,5 +1,5 @@ - + StackDeviceMemory.h cuda_runtime.h @@ -10,15 +10,16 @@ unordered_map faiss/gpu/StandardGpuResources.h - - - - - - - + + + + - + + + + + @@ -41,8 +42,31 @@ - - + + + + + + + + + + + + + + + + + + + + + + + + + @@ -55,82 +79,58 @@ + + + + + + + + + - - - - - - - - - - - - - - - - - - + + - - + + + + + - - - - - - - - - - - - - - - - - - - - - - + + - - + + - - - - + + + + - - - - + + + + @@ -174,12 +174,12 @@ ///withoutownership StackDeviceMemory(intdevice,void*p,size_tsize,boolisOwner); -~StackDeviceMemory(); +~StackDeviceMemory(); intgetDevice()const; ///Allallocationsrequestedshouldbeamultipleof16bytes -void*allocMemory(cudaStream_tstream,size_tsize); +void*allocMemory(cudaStream_tstream,size_tsize); voiddeallocMemory(intdevice,cudaStream_t,size_tsize,void*p); size_tgetSizeAvailable()const; @@ -202,7 +202,7 @@ ///ConstructorthatallocatesmemoryviacudaMalloc Stack(GpuResources*res,intdevice,size_tsize); -~Stack(); +~Stack(); ///Returnshowmuchsizeisavailableforanallocationwithout ///callingcudaMalloc @@ -210,7 +210,7 @@ ///Obtainsanallocation;allallocationsareguaranteedtobe16 ///bytealigned -char*getAlloc(size_tsize,cudaStream_tstream); +char*getAlloc(size_tsize,cudaStream_tstream); ///Returnsanallocation voidreturnAlloc(char*p,size_tsize,cudaStream_tstream); diff --git a/xml/StandardGpuResources_8h.xml b/xml/StandardGpuResources_8h.xml index 3a3361566d..ffbce14c83 100644 --- a/xml/StandardGpuResources_8h.xml +++ b/xml/StandardGpuResources_8h.xml @@ -1,5 +1,5 @@ - + StandardGpuResources.h faiss/gpu/GpuResources.h @@ -11,21 +11,52 @@ vector faiss/gpu/perf/IndexWrapper.h - - - - - - - + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -42,11 +73,31 @@ - - + + + + + + + + + + + + + - - + + + + + + + + + + + @@ -59,111 +110,60 @@ - - - - - - - - - - - + + + + + + + + - - + + + + + + + + - - - - - - - - - - - - - - - - - - + + - - + + - - + + - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - faiss::gpu::StandardGpuResourcesImpl faiss::gpu::StandardGpuResources @@ -222,7 +222,7 @@ public: StandardGpuResourcesImpl(); -~StandardGpuResourcesImpl()override; +~StandardGpuResourcesImpl()override; ///DoesthegivenGPUsupportbfloat16? boolsupportsBFloat16(intdevice)override; @@ -281,10 +281,10 @@ cublasHandle_tgetBlasHandle(intdevice)override; -std::vector<cudaStream_t>getAlternateStreams(intdevice)override; +std::vector<cudaStream_t>getAlternateStreams(intdevice)override; ///Allocatenon-temporaryGPUmemory -void*allocMemory(constAllocRequest&req)override; +void*allocMemory(constAllocRequest&req)override; ///Returnsapreviousallocation voiddeallocMemory(intdevice,void*in)override; @@ -292,10 +292,10 @@ size_tgetTempMemoryAvailable(intdevice)constoverride; ///ExportadescriptionofmemoryusedforPython -std::map<int,std::map<std::string,std::pair<int,size_t>>>getMemoryInfo() +std::map<int,std::map<std::string,std::pair<int,size_t>>>getMemoryInfo() const; -std::pair<void*,size_t>getPinnedMemory()override; +std::pair<void*,size_t>getPinnedMemory()override; cudaStream_tgetAsyncCopyStream(intdevice)override; @@ -374,9 +374,9 @@ classStandardGpuResources:publicGpuResourcesProvider{ public: StandardGpuResources(); -~StandardGpuResources()override; +~StandardGpuResources()override; -std::shared_ptr<GpuResources>getResources()override; +std::shared_ptr<GpuResources>getResources()override; ///Whetherornotthegivendevicesupportsnativebfloat16arithmetic boolsupportsBFloat16(intdevice); @@ -415,7 +415,7 @@ voidsetDefaultNullStreamAllDevices(); ///ExportadescriptionofmemoryusedforPython -std::map<int,std::map<std::string,std::pair<int,size_t>>>getMemoryInfo() +std::map<int,std::map<std::string,std::pair<int,size_t>>>getMemoryInfo() const; ///Returnsthecurrentdefaultstream cudaStream_tgetDefaultStream(intdevice); diff --git a/xml/StaticUtils_8h.xml b/xml/StaticUtils_8h.xml index 4502f36f34..f2fb175bb4 100644 --- a/xml/StaticUtils_8h.xml +++ b/xml/StaticUtils_8h.xml @@ -1,5 +1,5 @@ - + StaticUtils.h cuda.h @@ -17,7 +17,7 @@ faiss faiss::gpu faiss::gpu::utils - + __host__ @@ -38,7 +38,7 @@ - + @@ -66,73 +66,73 @@ namespaceutils{ template<typenameU,typenameV> -constexpr__host____device__autodivDown(Ua,Vb)->decltype(a+b){ +constexpr__host____device__autodivDown(Ua,Vb)->decltype(a+b){ return(a/b); } template<typenameU,typenameV> -constexpr__host____device__autodivUp(Ua,Vb)->decltype(a+b){ +constexpr__host____device__autodivUp(Ua,Vb)->decltype(a+b){ return(a+b-1)/b; } template<typenameU,typenameV> -constexpr__host____device__autoroundDown(Ua,Vb)->decltype(a+b){ +constexpr__host____device__autoroundDown(Ua,Vb)->decltype(a+b){ returndivDown(a,b)*b; } template<typenameU,typenameV> -constexpr__host____device__autoroundUp(Ua,Vb)->decltype(a+b){ +constexpr__host____device__autoroundUp(Ua,Vb)->decltype(a+b){ returndivUp(a,b)*b; } template<classT> -constexpr__host____device__Tpow(Tn,Tpower){ +constexpr__host____device__Tpow(Tn,Tpower){ return(power>0?n*pow(n,power-1):1); } template<classT> -constexpr__host____device__Tpow2(Tn){ +constexpr__host____device__Tpow2(Tn){ returnpow(2,(T)n); } -static_assert(pow2(8)==256,"pow2"); +static_assert(pow2(8)==256,"pow2"); template<typenameT> -constexpr__host____device__intlog2(Tn,intp=0){ +constexpr__host____device__intlog2(Tn,intp=0){ return(n<=1)?p:log2(n/2,p+1); } -static_assert(log2(2)==1,"log2"); -static_assert(log2(3)==1,"log2"); -static_assert(log2(4)==2,"log2"); +static_assert(log2(2)==1,"log2"); +static_assert(log2(3)==1,"log2"); +static_assert(log2(4)==2,"log2"); template<typenameT> -constexpr__host____device__boolisPowerOf2(Tv){ +constexpr__host____device__boolisPowerOf2(Tv){ return(v&&!(v&(v-1))); } -static_assert(isPowerOf2(2048),"isPowerOf2"); -static_assert(!isPowerOf2(3333),"isPowerOf2"); +static_assert(isPowerOf2(2048),"isPowerOf2"); +static_assert(!isPowerOf2(3333),"isPowerOf2"); template<typenameT> -constexpr__host____device__TnextHighestPowerOf2(Tv){ +constexpr__host____device__TnextHighestPowerOf2(Tv){ return(isPowerOf2(v)?(T)2*v:((T)1<<(log2(v)+1))); } -static_assert(nextHighestPowerOf2(1)==2,"nextHighestPowerOf2"); -static_assert(nextHighestPowerOf2(2)==4,"nextHighestPowerOf2"); -static_assert(nextHighestPowerOf2(3)==4,"nextHighestPowerOf2"); -static_assert(nextHighestPowerOf2(4)==8,"nextHighestPowerOf2"); +static_assert(nextHighestPowerOf2(1)==2,"nextHighestPowerOf2"); +static_assert(nextHighestPowerOf2(2)==4,"nextHighestPowerOf2"); +static_assert(nextHighestPowerOf2(3)==4,"nextHighestPowerOf2"); +static_assert(nextHighestPowerOf2(4)==8,"nextHighestPowerOf2"); -static_assert(nextHighestPowerOf2(15)==16,"nextHighestPowerOf2"); -static_assert(nextHighestPowerOf2(16)==32,"nextHighestPowerOf2"); -static_assert(nextHighestPowerOf2(17)==32,"nextHighestPowerOf2"); +static_assert(nextHighestPowerOf2(15)==16,"nextHighestPowerOf2"); +static_assert(nextHighestPowerOf2(16)==32,"nextHighestPowerOf2"); +static_assert(nextHighestPowerOf2(17)==32,"nextHighestPowerOf2"); -static_assert( +static_assert( nextHighestPowerOf2(1536000000u)==2147483648u, "nextHighestPowerOf2"); -static_assert( -nextHighestPowerOf2((size_t)2147483648ULL)==(size_t)4294967296ULL, +static_assert( +nextHighestPowerOf2((size_t)2147483648ULL)==(size_t)4294967296ULL, "nextHighestPowerOf2"); }//namespaceutils diff --git a/xml/Tensor-inl_8cuh.xml b/xml/Tensor-inl_8cuh.xml index f8eea88c27..cfce2c5fe2 100644 --- a/xml/Tensor-inl_8cuh.xml +++ b/xml/Tensor-inl_8cuh.xml @@ -1,5 +1,5 @@ - + Tensor-inl.cuh diff --git a/xml/Tensor_8cuh.xml b/xml/Tensor_8cuh.xml index 4dfefbe270..e8cfa26b05 100644 --- a/xml/Tensor_8cuh.xml +++ b/xml/Tensor_8cuh.xml @@ -1,5 +1,5 @@ - + Tensor.cuh faiss/gpu/utils/CuvsUtils.h diff --git a/xml/TestUtils_8h.xml b/xml/TestUtils_8h.xml index 1dd4ce026c..5ca1163d41 100644 --- a/xml/TestUtils_8h.xml +++ b/xml/TestUtils_8h.xml @@ -1,5 +1,5 @@ - + TestUtils.h faiss/Index.h @@ -12,24 +12,24 @@ string vector - - - - + + + + - + - + - + - - - - - + - + + + + + @@ -54,8 +54,39 @@ - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -65,75 +96,44 @@ - - - - - - - - + + - - + + + + + + + + - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - + + - - + + - - + + faiss diff --git a/xml/ThreadedIndex-inl_8h.xml b/xml/ThreadedIndex-inl_8h.xml index c3921d999f..a6b5c7cae2 100644 --- a/xml/ThreadedIndex-inl_8h.xml +++ b/xml/ThreadedIndex-inl_8h.xml @@ -1,5 +1,5 @@ - + ThreadedIndex-inl.h faiss/impl/FaissAssert.h @@ -7,6 +7,20 @@ iostream faiss/impl/ThreadedIndex.h + + + + + + + + + + + + + + @@ -19,6 +33,16 @@ + + + + + + + + + + @@ -30,72 +54,62 @@ - - - - - - - - - - - - + + + - - - - - - - - - - - - - + + - - - - - + + + + + + + + + + + - + - - - + - + + + + + - + - - - + + + + + @@ -105,20 +119,6 @@ - - - - - - - - - - - - - - faiss @@ -270,7 +270,7 @@ } } -handleExceptions(exceptions); +handleExceptions(exceptions); } } @@ -312,7 +312,7 @@ } } -handleExceptions(exceptions); +handleExceptions(exceptions); } }//namespacefaiss diff --git a/xml/ThreadedIndex_8h.xml b/xml/ThreadedIndex_8h.xml index b974db0856..f9815c2aaf 100644 --- a/xml/ThreadedIndex_8h.xml +++ b/xml/ThreadedIndex_8h.xml @@ -1,5 +1,5 @@ - + ThreadedIndex.h faiss/Index.h @@ -11,76 +11,20 @@ faiss/IndexReplicas.h faiss/IndexShards.h - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - - @@ -95,34 +39,47 @@ - - - - - + + + + + - - - - + + + + + + - + - - - - - - + + + + + + + + + + - - + + + + + + + + + @@ -140,55 +97,106 @@ - - - - - - + + + + - + + + + + - + - - - - - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + + + + + - + - - - - @@ -197,14 +205,6 @@ - - - - - - - - faiss::ThreadedIndex faiss @@ -238,7 +238,7 @@ explicitThreadedIndex(boolthreaded); explicitThreadedIndex(intd,boolthreaded); -~ThreadedIndex()override; +~ThreadedIndex()override; ///overrideanindexthatismanagedbyourselves. ///WARNING:onceanindexisadded,itbecomesunsafetotouchitfromany @@ -267,12 +267,12 @@ } ///Returnsthei-thsub-index -IndexT*at(size_ti){ +IndexT*at(size_ti){ returnindices_[i].first; } ///Returnsthei-thsub-index(constversion) -constIndexT*at(size_ti)const{ +constIndexT*at(size_ti)const{ returnindices_[i].first; } diff --git a/xml/ThrustUtils_8cuh.xml b/xml/ThrustUtils_8cuh.xml index 3d0ea9056e..5adcd5c5dd 100644 --- a/xml/ThrustUtils_8cuh.xml +++ b/xml/ThrustUtils_8cuh.xml @@ -1,5 +1,5 @@ - + ThrustUtils.cuh diff --git a/xml/Timer_8h.xml b/xml/Timer_8h.xml index f4da7fccb7..2d0ea797b1 100644 --- a/xml/Timer_8h.xml +++ b/xml/Timer_8h.xml @@ -1,16 +1,10 @@ - + Timer.h cuda_runtime.h chrono - - - - - - @@ -19,6 +13,12 @@ + + + + + + faiss::gpu::KernelTimer faiss::gpu::CpuTimer diff --git a/xml/Transpose_8cuh.xml b/xml/Transpose_8cuh.xml index 8700f4ad14..46ce917eef 100644 --- a/xml/Transpose_8cuh.xml +++ b/xml/Transpose_8cuh.xml @@ -1,5 +1,5 @@ - + Transpose.cuh diff --git a/xml/UintReader_8h.xml b/xml/UintReader_8h.xml index 61ac96fdda..86886cf112 100644 --- a/xml/UintReader_8h.xml +++ b/xml/UintReader_8h.xml @@ -1,5 +1,5 @@ - + UintReader.h faiss/impl/platform_macros.h @@ -9,6 +9,14 @@ faiss/cppcontrib/sa_decode/PQ-avx2-inl.h faiss/cppcontrib/sa_decode/PQ-neon-inl.h + + + + + + + + @@ -23,24 +31,8 @@ - - - - - - - - - - - - - - - - @@ -57,6 +49,14 @@ + + + + + + + + @@ -90,14 +90,14 @@ template<intptr_tN_ELEMENTS,intptr_tCPOS> structUint8Reader{ -static_assert(CPOS<N_ELEMENTS,"CPOSshouldbelessthanN_ELEMENTS"); +static_assert(CPOS<N_ELEMENTS,"CPOSshouldbelessthanN_ELEMENTS"); staticintptr_tget(constuint8_t*const__restrictcodes){ //Readusing4-bytes,ifpossible. //Readingusing8-bytetakestoomanyregisterssomewhy. -constexprintptr_tELEMENT_TO_READ=CPOS/4; -constexprintptr_tSUB_ELEMENT=CPOS%4; +constexprintptr_tELEMENT_TO_READ=CPOS/4; +constexprintptr_tSUB_ELEMENT=CPOS%4; switch(SUB_ELEMENT){ case0:{ @@ -165,13 +165,13 @@ //3333333333 template<intptr_tN_ELEMENTS,intptr_tCPOS> structUint10Reader{ -static_assert(CPOS<N_ELEMENTS,"CPOSshouldbelessthanN_ELEMENTS"); +static_assert(CPOS<N_ELEMENTS,"CPOSshouldbelessthanN_ELEMENTS"); staticintptr_tget(constuint8_t*const__restrictcodes){ //Readusing4-bytesor2-bytes. -constexprintptr_tELEMENT_TO_READ=CPOS/4; -constexprintptr_tSUB_ELEMENT=CPOS%4; +constexprintptr_tELEMENT_TO_READ=CPOS/4; +constexprintptr_tSUB_ELEMENT=CPOS%4; switch(SUB_ELEMENT){ case0:{ @@ -246,13 +246,13 @@ //333333333333 template<intptr_tN_ELEMENTS,intptr_tCPOS> structUint12Reader{ -static_assert(CPOS<N_ELEMENTS,"CPOSshouldbelessthanN_ELEMENTS"); +static_assert(CPOS<N_ELEMENTS,"CPOSshouldbelessthanN_ELEMENTS"); staticintptr_tget(constuint8_t*const__restrictcodes){ //Readusing4-bytesor2-bytes. -constexprintptr_tELEMENT_TO_READ=CPOS/4; -constexprintptr_tSUB_ELEMENT=CPOS%4; +constexprintptr_tELEMENT_TO_READ=CPOS/4; +constexprintptr_tSUB_ELEMENT=CPOS%4; switch(SUB_ELEMENT){ case0:{ @@ -330,14 +330,14 @@ //reducesthenumberofreadoperationsfromRAM template<intptr_tN_ELEMENTS,intptr_tCPOS> structUint16Reader{ -static_assert(CPOS<N_ELEMENTS,"CPOSshouldbelessthanN_ELEMENTS"); +static_assert(CPOS<N_ELEMENTS,"CPOSshouldbelessthanN_ELEMENTS"); staticintptr_tget(constuint8_t*const__restrictcodes){ //Readusing4-bytesor2-bytes. //Readingusing8-bytetakestoomanyregisterssomewhy. -constexprintptr_tELEMENT_TO_READ=CPOS/2; -constexprintptr_tSUB_ELEMENT=CPOS%2; +constexprintptr_tELEMENT_TO_READ=CPOS/2; +constexprintptr_tSUB_ELEMENT=CPOS%2; switch(SUB_ELEMENT){ case0:{ @@ -388,34 +388,34 @@ template<intptr_tN_ELEMENTS,intptr_tCPOS> structUintReaderImplType<N_ELEMENTS,8,CPOS>{ -usingreader_type=Uint8Reader<N_ELEMENTS,CPOS>; +usingreader_type=Uint8Reader<N_ELEMENTS,CPOS>; }; template<intptr_tN_ELEMENTS,intptr_tCPOS> structUintReaderImplType<N_ELEMENTS,10,CPOS>{ -usingreader_type=Uint10Reader<N_ELEMENTS,CPOS>; +usingreader_type=Uint10Reader<N_ELEMENTS,CPOS>; }; template<intptr_tN_ELEMENTS,intptr_tCPOS> structUintReaderImplType<N_ELEMENTS,12,CPOS>{ -usingreader_type=Uint12Reader<N_ELEMENTS,CPOS>; +usingreader_type=Uint12Reader<N_ELEMENTS,CPOS>; }; template<intptr_tN_ELEMENTS,intptr_tCPOS> structUintReaderImplType<N_ELEMENTS,16,CPOS>{ -usingreader_type=Uint16Reader<N_ELEMENTS,CPOS>; +usingreader_type=Uint16Reader<N_ELEMENTS,CPOS>; }; }//namespace //reducesthenumberofreadoperationsfromRAM template<intptr_tDIM,intptr_tCODE_SIZE,intptr_tCODE_BITS,intptr_tCPOS> -usingUintReader= +usingUintReader= typenameUintReaderImplType<DIM/CODE_SIZE,CODE_BITS,CPOS>:: reader_type; template<intptr_tN_ELEMENTS,intptr_tCODE_BITS,intptr_tCPOS> -usingUintReaderRaw= +usingUintReaderRaw= typenameUintReaderImplType<N_ELEMENTS,CODE_BITS,CPOS>::reader_type; }//namespacedetail diff --git a/xml/VectorResidual_8cuh.xml b/xml/VectorResidual_8cuh.xml index 38da07c97a..1eb9538d2d 100644 --- a/xml/VectorResidual_8cuh.xml +++ b/xml/VectorResidual_8cuh.xml @@ -1,5 +1,5 @@ - + VectorResidual.cuh diff --git a/xml/VectorTransform_8h.xml b/xml/VectorTransform_8h.xml index 76fc835893..9155bda3bd 100644 --- a/xml/VectorTransform_8h.xml +++ b/xml/VectorTransform_8h.xml @@ -1,5 +1,5 @@ - + VectorTransform.h stdint.h @@ -9,13 +9,25 @@ faiss/IndexLSH.h faiss/IndexPreTransform.h - - - - + + + + + + + + + + + + + + + + @@ -27,9 +39,23 @@ + + + + + + + + + + + + + + @@ -39,37 +65,27 @@ - - - - - + + + + + - - - - - - - - - - - - + + + + - - - + + + - - @@ -80,26 +96,10 @@ - - - - - - - - - - - - - - - - faiss::VectorTransform faiss::LinearTransform @@ -165,7 +165,7 @@ *@paramxinputvectors,sizen*d_in *@returnoutputvectors,sizen*d_out */ -float*apply(idx_tn,constfloat*x)const; +float*apply(idx_tn,constfloat*x)const; /**applythetransformationandreturntheresultinaprovidedmatrix *@paramnnumberofvectorstotransform @@ -181,7 +181,7 @@ //checkthatthetwotransformsareidentical(tomergeindexes) virtualvoidcheck_identical(constVectorTransform&other)const=0; -virtual~VectorTransform(){} +virtual~VectorTransform(){} }; /**Genericlineartransformation,withbiastermappliedonoutput @@ -227,7 +227,7 @@ voidcheck_identical(constVectorTransform&other)constoverride; -~LinearTransform()override{} +~LinearTransform()override{} }; ///Randomlyrotateasetofvectors diff --git a/xml/WarpPackedBits_8cuh.xml b/xml/WarpPackedBits_8cuh.xml index 098e641117..29307a6055 100644 --- a/xml/WarpPackedBits_8cuh.xml +++ b/xml/WarpPackedBits_8cuh.xml @@ -1,5 +1,5 @@ - + WarpPackedBits.cuh diff --git a/xml/WarpSelectImpl_8cuh.xml b/xml/WarpSelectImpl_8cuh.xml index 3af216d4f6..8e260d5681 100644 --- a/xml/WarpSelectImpl_8cuh.xml +++ b/xml/WarpSelectImpl_8cuh.xml @@ -1,5 +1,5 @@ - + WarpSelectImpl.cuh diff --git a/xml/WarpSelectKernel_8cuh.xml b/xml/WarpSelectKernel_8cuh.xml index 71149014c4..84519163dd 100644 --- a/xml/WarpSelectKernel_8cuh.xml +++ b/xml/WarpSelectKernel_8cuh.xml @@ -1,5 +1,5 @@ - + WarpSelectKernel.cuh diff --git a/xml/WarpShuffles_8cuh.xml b/xml/WarpShuffles_8cuh.xml index dbdbfcd111..44c5599d54 100644 --- a/xml/WarpShuffles_8cuh.xml +++ b/xml/WarpShuffles_8cuh.xml @@ -1,5 +1,5 @@ - + WarpShuffles.cuh diff --git a/xml/WorkerThread_8h.xml b/xml/WorkerThread_8h.xml index b1aaa57270..536e78a20e 100644 --- a/xml/WorkerThread_8h.xml +++ b/xml/WorkerThread_8h.xml @@ -1,5 +1,5 @@ - + WorkerThread.h condition_variable @@ -9,15 +9,6 @@ thread faiss/impl/ThreadedIndex.h - - - - - - - - - @@ -32,40 +23,51 @@ + + + + + + + + + + + + + + + + + - + - + + + + + - + - - - - - - - - - - @@ -74,12 +76,10 @@ - - - - - - + + + + @@ -127,7 +127,7 @@ ///Futurestatusis`true`ifthelambdawasrunintheworker ///thread;`false`ifitwasnotrun,becausetheworkerthreadis ///exitingorhasexited. -std::future<bool>add(std::function<void()>f); +std::future<bool>add(std::function<void()>f); private: voidstartThread(); diff --git a/xml/approx__topk_2avx2-inl_8h.xml b/xml/approx__topk_2avx2-inl_8h.xml index 69ad5b8614..6d174bb62d 100644 --- a/xml/approx__topk_2avx2-inl_8h.xml +++ b/xml/approx__topk_2avx2-inl_8h.xml @@ -1,5 +1,5 @@ - + avx2-inl.h immintrin.h @@ -7,6 +7,20 @@ faiss/impl/FaissAssert.h faiss/utils/Heap.h + + + + + + + + + + + + + + @@ -19,9 +33,6 @@ - - - @@ -30,36 +41,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -82,16 +63,6 @@ - - - - - - - - - - @@ -104,28 +75,57 @@ - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + faiss::HeapWithBuckets @@ -161,8 +161,8 @@ template<uint32_tNBUCKETS,uint32_tN> structHeapWithBuckets<CMax<float,int>,NBUCKETS,N>{ -staticconstexpruint32_tNBUCKETS_8=NBUCKETS/8; -static_assert( +staticconstexpruint32_tNBUCKETS_8=NBUCKETS/8; +static_assert( (NBUCKETS)>0&&((NBUCKETS%8)==0), "Numberofbucketsneedstobe8,16,24,..."); @@ -207,7 +207,7 @@ //k, //beam_size*NBUCKETS*N); -usingC=CMax<float, int>; +usingC=CMax<float, int>; //mainloop for(uint32_tbeam_index=0;beam_index<beam_size;beam_index++){ diff --git a/xml/approx__topk_8h.xml b/xml/approx__topk_8h.xml index e22179f772..c5f8d6182f 100644 --- a/xml/approx__topk_8h.xml +++ b/xml/approx__topk_8h.xml @@ -1,11 +1,25 @@ - + approx_topk.h faiss/impl/platform_macros.h faiss/utils/approx_topk/mode.h faiss/utils/approx_topk/generic.h + + + + + + + + + + + + + + @@ -18,9 +32,6 @@ - - - @@ -29,35 +40,28 @@ - - - - - - - + + + + + + + + + + + + + + - - - + - - - - - - - - - - - - @@ -68,44 +72,24 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - + + + + + + + @@ -116,31 +100,47 @@ - - + + + + + - - + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + diff --git a/xml/approx__topk__hamming_8h.xml b/xml/approx__topk__hamming_8h.xml index 7fc5a76965..2c7de3f12a 100644 --- a/xml/approx__topk__hamming_8h.xml +++ b/xml/approx__topk__hamming_8h.xml @@ -1,5 +1,5 @@ - + approx_topk_hamming.h algorithm @@ -8,44 +8,6 @@ faiss/utils/Heap.h faiss/utils/simdlib.h - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -68,6 +30,20 @@ + + + + + + + + + + + + + + @@ -78,6 +54,12 @@ + + + + + + @@ -90,21 +72,39 @@ + + + + + + - - - - - + + - - + + + + + + + + + + + + + + + + + faiss::HeapWithBucketsForHamming32 faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT > @@ -147,8 +147,8 @@ NBUCKETS, N, HammingComputerT>{ -staticconstexpruint32_tNBUCKETS_8=NBUCKETS/8; -static_assert( +staticconstexpruint32_tNBUCKETS_8=NBUCKETS/8; +static_assert( (NBUCKETS)>0&&((NBUCKETS%8)==0), "Numberofbucketsneedstobe8,16,24,..."); @@ -186,7 +186,7 @@ //range int64_t*const__restrictbh_ids){ // -usingC=CMax<int, int64_t>; +usingC=CMax<int, int64_t>; //Hammingcodesize constsize_tcode_size=hc.get_code_size(); @@ -314,8 +314,8 @@ NBUCKETS, N, HammingComputerT>{ -staticconstexpruint32_tNBUCKETS_16=NBUCKETS/16; -static_assert( +staticconstexpruint32_tNBUCKETS_16=NBUCKETS/16; +static_assert( (NBUCKETS)>0&&((NBUCKETS%16)==0), "Numberofbucketsneedstobe16,32,48..."); @@ -353,7 +353,7 @@ //range int64_t*const__restrictbh_ids){ // -usingC=CMax<int, int64_t>; +usingC=CMax<int, int64_t>; //Hammingcodesize constsize_tcode_size=hc.get_code_size(); diff --git a/xml/avx512-inl_8h.xml b/xml/avx512-inl_8h.xml index 3dfa7fd64d..653530413b 100644 --- a/xml/avx512-inl_8h.xml +++ b/xml/avx512-inl_8h.xml @@ -1,5 +1,5 @@ - + avx512-inl.h cassert @@ -16,21 +16,6 @@ - - - - - - - - - - - - - - - @@ -45,6 +30,21 @@ + + + + + + + + + + + + + + + faiss::HammingComputer4 faiss::HammingComputer8 @@ -169,7 +169,7 @@ returnpopcount64(*(uint32_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return4; } }; @@ -192,7 +192,7 @@ returnpopcount64(*(uint64_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return8; } }; @@ -218,7 +218,7 @@ returnpopcount64(b[0]^a0)+popcount64(b[1]^a1); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return16; } }; @@ -249,7 +249,7 @@ popcount64(*(uint32_t*)(b+2)^a2); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return20; } }; @@ -278,7 +278,7 @@ popcount64(b[2]^a2)+popcount64(b[3]^a3); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return32; } }; @@ -322,7 +322,7 @@ #endif } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return64; } }; @@ -463,7 +463,7 @@ returngeneralized_hamming_64(*(uint64_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return8; } }; @@ -485,7 +485,7 @@ return16-popcount32(movemask); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return16; } }; @@ -505,7 +505,7 @@ return32-popcount32(movemask); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return32; } }; diff --git a/xml/avx512_8h.xml b/xml/avx512_8h.xml index 4c0dc5f9b9..8aa99d250f 100644 --- a/xml/avx512_8h.xml +++ b/xml/avx512_8h.xml @@ -1,49 +1,16 @@ - + avx512.h faiss/impl/ResultHandler.h faiss/impl/platform_macros.h faiss/utils/Heap.h - - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -63,20 +30,17 @@ - - - - - - - - - - - - - - + + + + + + + + + + + @@ -88,24 +52,31 @@ - - - - + + + + - + - + + + + + + + + + - - - - - - - - + + + + + + + @@ -129,6 +100,16 @@ + + + + + + + + + + @@ -139,51 +120,70 @@ - - - - - - - - - - - - + + + + + + + - - + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/xml/bf16_8h.xml b/xml/bf16_8h.xml index d31d3f6714..3819b32e06 100644 --- a/xml/bf16_8h.xml +++ b/xml/bf16_8h.xml @@ -1,21 +1,21 @@ - + bf16.h cstdint - - - + + + faiss - + uint32_t uint32_t as_u32 @@ -42,7 +42,7 @@ - + diff --git a/xml/classfaiss_1_1FaissException.xml b/xml/classfaiss_1_1FaissException.xml index b62aa74e17..d3fbde3f23 100644 --- a/xml/classfaiss_1_1FaissException.xml +++ b/xml/classfaiss_1_1FaissException.xml @@ -1,15 +1,16 @@ - + faiss::FaissException std::exception FaissException.h - + std::string std::string faiss::FaissException::msg msg + faiss::FaissException::msg @@ -18,13 +19,14 @@ - - + + faiss::FaissException::FaissException (const std::string &msg) FaissException + faiss::FaissException::FaissException const std::string & msg @@ -42,6 +44,7 @@ faiss::FaissException::FaissException (const std::string &msg, const char *funcName, const char *file, int line) FaissException + faiss::FaissException::FaissException const std::string & msg @@ -66,11 +69,12 @@ - + const char * - const char* faiss::FaissException::what + const char * faiss::FaissException::what () const noexcept override what + faiss::FaissException::what from std::exception @@ -80,7 +84,7 @@ - + Base class for Faiss exceptions. @@ -113,7 +117,7 @@ faiss::FaissExceptionFaissException faiss::FaissExceptionFaissException faiss::FaissExceptionmsg - faiss::FaissExceptionwhat + faiss::FaissExceptionwhat diff --git a/xml/classfaiss_1_1IndexReplicasTemplate.xml b/xml/classfaiss_1_1IndexReplicasTemplate.xml index 29eb928301..65b469971e 100644 --- a/xml/classfaiss_1_1IndexReplicasTemplate.xml +++ b/xml/classfaiss_1_1IndexReplicasTemplate.xml @@ -1,5 +1,5 @@ - + faiss::IndexReplicasTemplate faiss::ThreadedIndex< IndexT > @@ -9,12 +9,13 @@ typename IndexT - + typename IndexT::component_t using faiss::IndexReplicasTemplate< IndexT >::component_t = typename IndexT::component_t component_t + faiss::IndexReplicasTemplate::component_t @@ -28,6 +29,7 @@ using faiss::IndexReplicasTemplate< IndexT >::distance_t = typename IndexT::distance_t distance_t + faiss::IndexReplicasTemplate::distance_t @@ -36,13 +38,14 @@ - - + + faiss::IndexReplicasTemplate< IndexT >::IndexReplicasTemplate (bool threaded=true) IndexReplicasTemplate + faiss::IndexReplicasTemplate::IndexReplicasTemplate bool threaded @@ -71,6 +74,7 @@ faiss::IndexReplicasTemplate< IndexT >::IndexReplicasTemplate (idx_t d, bool threaded=true) IndexReplicasTemplate + faiss::IndexReplicasTemplate::IndexReplicasTemplate idx_t d @@ -111,6 +115,7 @@ faiss::IndexReplicasTemplate< IndexT >::IndexReplicasTemplate (int d, bool threaded=true) IndexReplicasTemplate + faiss::IndexReplicasTemplate::IndexReplicasTemplate int d @@ -134,6 +139,7 @@ void faiss::IndexReplicasTemplate< IndexT >::add_replica (IndexT *index) add_replica + faiss::IndexReplicasTemplate::add_replica IndexT * index @@ -152,6 +158,7 @@ void faiss::IndexReplicasTemplate< IndexT >::remove_replica (IndexT *index) remove_replica + faiss::IndexReplicasTemplate::remove_replica IndexT * index @@ -170,6 +177,7 @@ void faiss::IndexReplicasTemplate< IndexT >::train (idx_t n, const component_t *x) override train + faiss::IndexReplicasTemplate::train idx_t n @@ -192,6 +200,7 @@ void faiss::IndexReplicasTemplate< IndexT >::add (idx_t n, const component_t *x) override add + faiss::IndexReplicasTemplate::add idx_t n @@ -214,6 +223,7 @@ void faiss::IndexReplicasTemplate< IndexT >::search (idx_t n, const component_t *x, idx_t k, distance_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexReplicasTemplate::search idx_t n @@ -253,6 +263,7 @@ void faiss::IndexReplicasTemplate< IndexT >::reconstruct (idx_t, component_t *v) const override reconstruct + faiss::IndexReplicasTemplate::reconstruct idx_t @@ -274,6 +285,7 @@ void faiss::IndexReplicasTemplate< IndexT >::syncWithSubIndexes () syncWithSubIndexes + faiss::IndexReplicasTemplate::syncWithSubIndexes @@ -288,6 +300,7 @@ void faiss::ThreadedIndex< IndexT >::addIndex (IndexT *index) addIndex + faiss::ThreadedIndex::addIndex IndexT * index @@ -306,6 +319,7 @@ void faiss::ThreadedIndex< IndexT >::removeIndex (IndexT *index) removeIndex + faiss::ThreadedIndex::removeIndex IndexT * index @@ -324,6 +338,7 @@ void faiss::ThreadedIndex< IndexT >::runOnIndex (std::function< void(int, IndexT *)> f) runOnIndex + faiss::ThreadedIndex::runOnIndex std::function< void(int, IndexT *)> f @@ -342,6 +357,7 @@ void faiss::ThreadedIndex< IndexT >::runOnIndex (std::function< void(int, const IndexT *)> f) const runOnIndex + faiss::ThreadedIndex::runOnIndex std::function< void(int, const IndexT *)> f @@ -359,6 +375,7 @@ void faiss::ThreadedIndex< IndexT >::reset () override reset + faiss::ThreadedIndex::reset @@ -373,6 +390,7 @@ int faiss::ThreadedIndex< IndexT >::count () const count + faiss::ThreadedIndex::count Returns the number of sub-indices. @@ -382,11 +400,12 @@ - + IndexT * - IndexT* faiss::ThreadedIndex< IndexT >::at + IndexT * faiss::ThreadedIndex< IndexT >::at (size_t i) at + faiss::ThreadedIndex::at size_t i @@ -400,11 +419,12 @@ - + const IndexT * - const IndexT* faiss::ThreadedIndex< IndexT >::at + const IndexT * faiss::ThreadedIndex< IndexT >::at (size_t i) const at + faiss::ThreadedIndex::at size_t i @@ -418,13 +438,14 @@ - - + + void void faiss::IndexReplicasTemplate< IndexT >::onAfterAddIndex (IndexT *index) override onAfterAddIndex + faiss::IndexReplicasTemplate::onAfterAddIndex onAfterAddIndex IndexT * @@ -444,6 +465,7 @@ void faiss::IndexReplicasTemplate< IndexT >::onAfterRemoveIndex (IndexT *index) override onAfterRemoveIndex + faiss::IndexReplicasTemplate::onAfterRemoveIndex onAfterRemoveIndex IndexT * @@ -458,13 +480,14 @@ - - + + bool bool faiss::ThreadedIndex< IndexT >::own_indices own_indices + faiss::ThreadedIndex::own_indices = false Whether or not we are responsible for deleting our contained indices. @@ -475,13 +498,14 @@ - - + + std::vector< std::pair< IndexT *, std::unique_ptr< WorkerThread > > > std::vector<std::pair<IndexT*, std::unique_ptr<WorkerThread> > > faiss::ThreadedIndex< IndexT >::indices_ indices_ + faiss::ThreadedIndex::indices_ Collection of Index instances, with their managing worker thread if any. @@ -496,6 +520,7 @@ bool faiss::ThreadedIndex< IndexT >::isThreaded_ isThreaded_ + faiss::ThreadedIndex::isThreaded_ Is this index multi-threaded? @@ -505,15 +530,16 @@ - - - + + + void void faiss::ThreadedIndex< IndexT >::waitAndHandleFutures - (std::vector< std::future< bool >> &v) + (std::vector< std::future< bool > > &v) waitAndHandleFutures + faiss::ThreadedIndex::waitAndHandleFutures - std::vector< std::future< bool >> & + std::vector< std::future< bool > > & v @@ -524,19 +550,13 @@ - + Takes individual faiss::Index instances, and splits queries for sending to each Index instance, and joins the results together when done. Each index is managed by a separate CPU thread. - - - - - - @@ -546,14 +566,14 @@ - - + + @@ -563,14 +583,20 @@ + + + + + + faiss::IndexReplicasTemplateadd faiss::IndexReplicasTemplateadd_replica faiss::IndexReplicasTemplateaddIndex - faiss::IndexReplicasTemplateat - faiss::IndexReplicasTemplateat + faiss::IndexReplicasTemplateat + faiss::IndexReplicasTemplateat faiss::IndexReplicasTemplatecomponent_t faiss::IndexReplicasTemplatecount faiss::IndexReplicasTemplatedistance_t @@ -593,7 +619,7 @@ faiss::IndexReplicasTemplateThreadedIndex faiss::IndexReplicasTemplateThreadedIndex faiss::IndexReplicasTemplatetrain - faiss::IndexReplicasTemplatewaitAndHandleFutures + faiss::IndexReplicasTemplatewaitAndHandleFutures faiss::IndexReplicasTemplate~ThreadedIndex diff --git a/xml/classfaiss_1_1ThreadedIndex.xml b/xml/classfaiss_1_1ThreadedIndex.xml index a6250dadef..9133cfe545 100644 --- a/xml/classfaiss_1_1ThreadedIndex.xml +++ b/xml/classfaiss_1_1ThreadedIndex.xml @@ -1,5 +1,5 @@ - + faiss::ThreadedIndex IndexT @@ -11,12 +11,13 @@ typename IndexT - + bool bool faiss::ThreadedIndex< IndexT >::own_indices own_indices + faiss::ThreadedIndex::own_indices = false Whether or not we are responsible for deleting our contained indices. @@ -27,13 +28,14 @@ - - + + std::vector< std::pair< IndexT *, std::unique_ptr< WorkerThread > > > std::vector<std::pair<IndexT*, std::unique_ptr<WorkerThread> > > faiss::ThreadedIndex< IndexT >::indices_ indices_ + faiss::ThreadedIndex::indices_ Collection of Index instances, with their managing worker thread if any. @@ -48,6 +50,7 @@ bool faiss::ThreadedIndex< IndexT >::isThreaded_ isThreaded_ + faiss::ThreadedIndex::isThreaded_ Is this index multi-threaded? @@ -57,13 +60,14 @@ - - + + faiss::ThreadedIndex< IndexT >::ThreadedIndex (bool threaded) ThreadedIndex + faiss::ThreadedIndex::ThreadedIndex bool threaded @@ -81,6 +85,7 @@ faiss::ThreadedIndex< IndexT >::ThreadedIndex (int d, bool threaded) ThreadedIndex + faiss::ThreadedIndex::ThreadedIndex int d @@ -102,6 +107,7 @@ faiss::ThreadedIndex< IndexT >::~ThreadedIndex () override ~ThreadedIndex + faiss::ThreadedIndex::~ThreadedIndex @@ -115,6 +121,7 @@ void faiss::ThreadedIndex< IndexT >::addIndex (IndexT *index) addIndex + faiss::ThreadedIndex::addIndex IndexT * index @@ -133,6 +140,7 @@ void faiss::ThreadedIndex< IndexT >::removeIndex (IndexT *index) removeIndex + faiss::ThreadedIndex::removeIndex IndexT * index @@ -151,6 +159,7 @@ void faiss::ThreadedIndex< IndexT >::runOnIndex (std::function< void(int, IndexT *)> f) runOnIndex + faiss::ThreadedIndex::runOnIndex std::function< void(int, IndexT *)> f @@ -169,6 +178,7 @@ void faiss::ThreadedIndex< IndexT >::runOnIndex (std::function< void(int, const IndexT *)> f) const runOnIndex + faiss::ThreadedIndex::runOnIndex std::function< void(int, const IndexT *)> f @@ -186,6 +196,7 @@ void faiss::ThreadedIndex< IndexT >::reset () override reset + faiss::ThreadedIndex::reset @@ -200,6 +211,7 @@ int faiss::ThreadedIndex< IndexT >::count () const count + faiss::ThreadedIndex::count Returns the number of sub-indices. @@ -209,11 +221,12 @@ - + IndexT * - IndexT* faiss::ThreadedIndex< IndexT >::at + IndexT * faiss::ThreadedIndex< IndexT >::at (size_t i) at + faiss::ThreadedIndex::at size_t i @@ -227,11 +240,12 @@ - + const IndexT * - const IndexT* faiss::ThreadedIndex< IndexT >::at + const IndexT * faiss::ThreadedIndex< IndexT >::at (size_t i) const at + faiss::ThreadedIndex::at size_t i @@ -245,13 +259,14 @@ - - + + void void faiss::ThreadedIndex< IndexT >::onAfterAddIndex (IndexT *index) onAfterAddIndex + faiss::ThreadedIndex::onAfterAddIndex onAfterAddIndex onAfterAddIndex @@ -272,6 +287,7 @@ void faiss::ThreadedIndex< IndexT >::onAfterRemoveIndex (IndexT *index) onAfterRemoveIndex + faiss::ThreadedIndex::onAfterRemoveIndex onAfterRemoveIndex onAfterRemoveIndex @@ -287,15 +303,16 @@ - - - + + + void void faiss::ThreadedIndex< IndexT >::waitAndHandleFutures - (std::vector< std::future< bool >> &v) + (std::vector< std::future< bool > > &v) waitAndHandleFutures + faiss::ThreadedIndex::waitAndHandleFutures - std::vector< std::future< bool >> & + std::vector< std::future< bool > > & v @@ -306,16 +323,19 @@ - + A holder of indices in a collection of threads The interface to this class itself is not thread safe - - - + + + + + + @@ -325,38 +345,35 @@ + + + + + + + + - - - - - - - - - - - faiss::ThreadedIndexaddIndex - faiss::ThreadedIndexat - faiss::ThreadedIndexat + faiss::ThreadedIndexat + faiss::ThreadedIndexat faiss::ThreadedIndexcount faiss::ThreadedIndexindices_ faiss::ThreadedIndexisThreaded_ @@ -369,7 +386,7 @@ faiss::ThreadedIndexrunOnIndex faiss::ThreadedIndexThreadedIndex faiss::ThreadedIndexThreadedIndex - faiss::ThreadedIndexwaitAndHandleFutures + faiss::ThreadedIndexwaitAndHandleFutures faiss::ThreadedIndex~ThreadedIndex diff --git a/xml/classfaiss_1_1WorkerThread.xml b/xml/classfaiss_1_1WorkerThread.xml index 825e32e8ac..50a00065fe 100644 --- a/xml/classfaiss_1_1WorkerThread.xml +++ b/xml/classfaiss_1_1WorkerThread.xml @@ -1,13 +1,14 @@ - + faiss::WorkerThread - + std::thread std::thread faiss::WorkerThread::thread_ thread_ + faiss::WorkerThread::thread_ Thread that all queued lambdas are run on. @@ -22,6 +23,7 @@ std::mutex faiss::WorkerThread::mutex_ mutex_ + faiss::WorkerThread::mutex_ Mutex for the queue and exit status. @@ -36,6 +38,7 @@ std::condition_variable faiss::WorkerThread::monitor_ monitor_ + faiss::WorkerThread::monitor_ Monitor for the exit status and the queue. @@ -50,6 +53,7 @@ bool faiss::WorkerThread::wantStop_ wantStop_ + faiss::WorkerThread::wantStop_ Whether or not we want the thread to exit. @@ -64,6 +68,7 @@ std::deque<std::pair<std::function<void()>, std::promise<bool> > > faiss::WorkerThread::queue_ queue_ + faiss::WorkerThread::queue_ Queue of pending lambdas to call. @@ -73,13 +78,14 @@ - - + + faiss::WorkerThread::WorkerThread () WorkerThread + faiss::WorkerThread::WorkerThread @@ -93,6 +99,7 @@ faiss::WorkerThread::~WorkerThread () ~WorkerThread + faiss::WorkerThread::~WorkerThread @@ -107,6 +114,7 @@ void faiss::WorkerThread::stop () stop + faiss::WorkerThread::stop Request that the worker thread stop itself. @@ -121,6 +129,7 @@ void faiss::WorkerThread::waitForThreadExit () waitForThreadExit + faiss::WorkerThread::waitForThreadExit @@ -130,11 +139,12 @@ - + std::future< bool > - std::future<bool> faiss::WorkerThread::add + std::future< bool > faiss::WorkerThread::add (std::function< void()> f) add + faiss::WorkerThread::add std::function< void()> f @@ -148,13 +158,14 @@ - - + + void void faiss::WorkerThread::startThread () startThread + faiss::WorkerThread::startThread @@ -168,6 +179,7 @@ void faiss::WorkerThread::threadMain () threadMain + faiss::WorkerThread::threadMain @@ -181,6 +193,7 @@ void faiss::WorkerThread::threadLoop () threadLoop + faiss::WorkerThread::threadLoop @@ -189,14 +202,14 @@ - + - faiss::WorkerThreadadd + faiss::WorkerThreadadd faiss::WorkerThreadmonitor_ faiss::WorkerThreadmutex_ faiss::WorkerThreadqueue_ diff --git a/xml/classfaiss_1_1gpu_1_1CpuTimer.xml b/xml/classfaiss_1_1gpu_1_1CpuTimer.xml index 6c06b32ac7..c6a6bfc102 100644 --- a/xml/classfaiss_1_1gpu_1_1CpuTimer.xml +++ b/xml/classfaiss_1_1gpu_1_1CpuTimer.xml @@ -1,14 +1,15 @@ - + faiss::gpu::CpuTimer Timer.h - + std::chrono::time_point< std::chrono::steady_clock > std::chrono::time_point<std::chrono::steady_clock> faiss::gpu::CpuTimer::start_ start_ + faiss::gpu::CpuTimer::start_ @@ -17,13 +18,14 @@ - - + + faiss::gpu::CpuTimer::CpuTimer () CpuTimer + faiss::gpu::CpuTimer::CpuTimer Creates and starts a new timer. @@ -38,6 +40,7 @@ float faiss::gpu::CpuTimer::elapsedMilliseconds () elapsedMilliseconds + faiss::gpu::CpuTimer::elapsedMilliseconds Returns elapsed time in milliseconds. @@ -47,7 +50,7 @@ - + CPU wallclock elapsed timer. diff --git a/xml/classfaiss_1_1gpu_1_1CublasHandleScope.xml b/xml/classfaiss_1_1gpu_1_1CublasHandleScope.xml index bb980477bc..98bd1ae05f 100644 --- a/xml/classfaiss_1_1gpu_1_1CublasHandleScope.xml +++ b/xml/classfaiss_1_1gpu_1_1CublasHandleScope.xml @@ -1,14 +1,15 @@ - + faiss::gpu::CublasHandleScope DeviceUtils.h - + cublasHandle_t cublasHandle_t faiss::gpu::CublasHandleScope::blasHandle_ blasHandle_ + faiss::gpu::CublasHandleScope::blasHandle_ @@ -17,13 +18,14 @@ - - + + faiss::gpu::CublasHandleScope::CublasHandleScope () CublasHandleScope + faiss::gpu::CublasHandleScope::CublasHandleScope @@ -37,6 +39,7 @@ faiss::gpu::CublasHandleScope::~CublasHandleScope () ~CublasHandleScope + faiss::gpu::CublasHandleScope::~CublasHandleScope @@ -50,6 +53,7 @@ cublasHandle_t faiss::gpu::CublasHandleScope::get () get + faiss::gpu::CublasHandleScope::get @@ -58,7 +62,7 @@ - + RAII object to manage a cublasHandle_t. diff --git a/xml/classfaiss_1_1gpu_1_1CudaEvent.xml b/xml/classfaiss_1_1gpu_1_1CudaEvent.xml index c88ab0278d..770cd204d1 100644 --- a/xml/classfaiss_1_1gpu_1_1CudaEvent.xml +++ b/xml/classfaiss_1_1gpu_1_1CudaEvent.xml @@ -1,13 +1,14 @@ - + faiss::gpu::CudaEvent - + cudaEvent_t cudaEvent_t faiss::gpu::CudaEvent::event_ event_ + faiss::gpu::CudaEvent::event_ @@ -16,13 +17,14 @@ - - + + faiss::gpu::CudaEvent::CudaEvent (cudaStream_t stream, bool timer=false) CudaEvent + faiss::gpu::CudaEvent::CudaEvent cudaStream_t stream @@ -46,6 +48,7 @@ faiss::gpu::CudaEvent::CudaEvent (const CudaEvent &event)=delete CudaEvent + faiss::gpu::CudaEvent::CudaEvent const CudaEvent & event @@ -63,6 +66,7 @@ faiss::gpu::CudaEvent::CudaEvent (CudaEvent &&event) noexcept CudaEvent + faiss::gpu::CudaEvent::CudaEvent CudaEvent && event @@ -80,6 +84,7 @@ faiss::gpu::CudaEvent::~CudaEvent () ~CudaEvent + faiss::gpu::CudaEvent::~CudaEvent @@ -93,6 +98,7 @@ cudaEvent_t faiss::gpu::CudaEvent::get () get + faiss::gpu::CudaEvent::get @@ -106,6 +112,7 @@ void faiss::gpu::CudaEvent::streamWaitOnEvent (cudaStream_t stream) streamWaitOnEvent + faiss::gpu::CudaEvent::streamWaitOnEvent cudaStream_t stream @@ -124,6 +131,7 @@ void faiss::gpu::CudaEvent::cpuWaitOnEvent () cpuWaitOnEvent + faiss::gpu::CudaEvent::cpuWaitOnEvent Have the CPU wait for the completion of this event. @@ -133,11 +141,12 @@ - + CudaEvent & - CudaEvent& faiss::gpu::CudaEvent::operator= + CudaEvent & faiss::gpu::CudaEvent::operator= (CudaEvent &&event) noexcept operator= + faiss::gpu::CudaEvent::operator= CudaEvent && event @@ -150,11 +159,12 @@ - + CudaEvent & - CudaEvent& faiss::gpu::CudaEvent::operator= + CudaEvent & faiss::gpu::CudaEvent::operator= (CudaEvent &event)=delete operator= + faiss::gpu::CudaEvent::operator= CudaEvent & event @@ -167,7 +177,7 @@ - + @@ -180,8 +190,8 @@ faiss::gpu::CudaEventCudaEvent faiss::gpu::CudaEventevent_ faiss::gpu::CudaEventget - faiss::gpu::CudaEventoperator= - faiss::gpu::CudaEventoperator= + faiss::gpu::CudaEventoperator= + faiss::gpu::CudaEventoperator= faiss::gpu::CudaEventstreamWaitOnEvent faiss::gpu::CudaEvent~CudaEvent diff --git a/xml/classfaiss_1_1gpu_1_1DeviceScope.xml b/xml/classfaiss_1_1gpu_1_1DeviceScope.xml index b7cd16f346..0739ba7875 100644 --- a/xml/classfaiss_1_1gpu_1_1DeviceScope.xml +++ b/xml/classfaiss_1_1gpu_1_1DeviceScope.xml @@ -1,14 +1,15 @@ - + faiss::gpu::DeviceScope DeviceUtils.h - + int int faiss::gpu::DeviceScope::prevDevice_ prevDevice_ + faiss::gpu::DeviceScope::prevDevice_ @@ -17,13 +18,14 @@ - - + + faiss::gpu::DeviceScope::DeviceScope (int device) DeviceScope + faiss::gpu::DeviceScope::DeviceScope int device @@ -41,6 +43,7 @@ faiss::gpu::DeviceScope::~DeviceScope () ~DeviceScope + faiss::gpu::DeviceScope::~DeviceScope @@ -49,7 +52,7 @@ - + diff --git a/xml/classfaiss_1_1gpu_1_1GpuIcmEncoder.xml b/xml/classfaiss_1_1gpu_1_1GpuIcmEncoder.xml index b7568a1b2f..45d8dd26c8 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIcmEncoder.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIcmEncoder.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuIcmEncoder faiss::lsq::IcmEncoder GpuIcmEncoder.h - + std::unique_ptr< IcmEncoderShards > std::unique_ptr<IcmEncoderShards> faiss::gpu::GpuIcmEncoder::shards shards + faiss::gpu::GpuIcmEncoder::shards @@ -18,13 +19,14 @@ - - + + faiss::gpu::GpuIcmEncoder::GpuIcmEncoder (const LocalSearchQuantizer *lsq, const std::vector< GpuResourcesProvider * > &provs, const std::vector< int > &devices) GpuIcmEncoder + faiss::gpu::GpuIcmEncoder::GpuIcmEncoder const LocalSearchQuantizer * lsq @@ -50,6 +52,7 @@ faiss::gpu::GpuIcmEncoder::~GpuIcmEncoder () ~GpuIcmEncoder + faiss::gpu::GpuIcmEncoder::~GpuIcmEncoder @@ -63,6 +66,7 @@ faiss::gpu::GpuIcmEncoder::GpuIcmEncoder (const GpuIcmEncoder &)=delete GpuIcmEncoder + faiss::gpu::GpuIcmEncoder::GpuIcmEncoder const GpuIcmEncoder & @@ -74,11 +78,12 @@ - + GpuIcmEncoder & - GpuIcmEncoder& faiss::gpu::GpuIcmEncoder::operator= + GpuIcmEncoder & faiss::gpu::GpuIcmEncoder::operator= (const GpuIcmEncoder &)=delete operator= + faiss::gpu::GpuIcmEncoder::operator= const GpuIcmEncoder & @@ -95,6 +100,7 @@ void faiss::gpu::GpuIcmEncoder::set_binary_term () override set_binary_term + faiss::gpu::GpuIcmEncoder::set_binary_term set_binary_term @@ -109,6 +115,7 @@ void faiss::gpu::GpuIcmEncoder::encode (int32_t *codes, const float *x, std::mt19937 &gen, size_t n, size_t ils_iters) const override encode + faiss::gpu::GpuIcmEncoder::encode encode int32_t * @@ -181,13 +188,14 @@ - - + + std::vector< float > std::vector<float> faiss::lsq::IcmEncoder::binaries binaries + faiss::lsq::IcmEncoder::binaries @@ -201,6 +209,7 @@ bool faiss::lsq::IcmEncoder::verbose verbose + faiss::lsq::IcmEncoder::verbose @@ -214,6 +223,7 @@ const LocalSearchQuantizer* faiss::lsq::IcmEncoder::lsq lsq + faiss::lsq::IcmEncoder::lsq @@ -222,7 +232,7 @@ - + @@ -242,24 +252,18 @@ - - - - - - - - + + + + - - icm_encoder_factory + + qnorm - - - - - + + + @@ -273,33 +277,35 @@ + + + + + + - - - - - - - - + + + + - - qnorm + + icm_encoder_factory - - - - + + + + @@ -309,6 +315,10 @@ lsq + + + + @@ -318,7 +328,7 @@ faiss::gpu::GpuIcmEncoderGpuIcmEncoder faiss::gpu::GpuIcmEncoderIcmEncoder faiss::gpu::GpuIcmEncoderlsq - faiss::gpu::GpuIcmEncoderoperator= + faiss::gpu::GpuIcmEncoderoperator= faiss::gpu::GpuIcmEncoderset_binary_term faiss::gpu::GpuIcmEncodershards faiss::gpu::GpuIcmEncoderverbose diff --git a/xml/classfaiss_1_1gpu_1_1GpuIndex.xml b/xml/classfaiss_1_1gpu_1_1GpuIndex.xml index 756e3dd480..a5e629abd4 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIndex.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIndex.xml @@ -1,17 +1,18 @@ - + faiss::gpu::GpuIndex faiss::Index faiss::gpu::GpuIndexCagra faiss::gpu::GpuIndexFlat faiss::gpu::GpuIndexIVF - + std::shared_ptr< GpuResources > std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::resources_ resources_ + faiss::gpu::GpuIndex::resources_ Manages streams, cuBLAS handles and scratch memory for devices. @@ -26,6 +27,7 @@ const GpuIndexConfig faiss::gpu::GpuIndex::config_ config_ + faiss::gpu::GpuIndex::config_ Our configuration options. @@ -40,6 +42,7 @@ size_t faiss::gpu::GpuIndex::minPagedSize_ minPagedSize_ + faiss::gpu::GpuIndex::minPagedSize_ Size above which we page copies from the CPU to GPU. @@ -49,13 +52,14 @@ - - + + faiss::gpu::GpuIndex::GpuIndex (std::shared_ptr< GpuResources > resources, int dims, faiss::MetricType metric, float metricArg, GpuIndexConfig config) GpuIndex + faiss::gpu::GpuIndex::GpuIndex std::shared_ptr< GpuResources > resources @@ -89,6 +93,7 @@ int faiss::gpu::GpuIndex::getDevice () const getDevice + faiss::gpu::GpuIndex::getDevice Returns the device that this index is resident on. @@ -98,11 +103,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndex::getResources () getResources + faiss::gpu::GpuIndex::getResources @@ -117,6 +123,7 @@ void faiss::gpu::GpuIndex::setMinPagingSize (size_t size) setMinPagingSize + faiss::gpu::GpuIndex::setMinPagingSize size_t size @@ -135,6 +142,7 @@ size_t faiss::gpu::GpuIndex::getMinPagingSize () const getMinPagingSize + faiss::gpu::GpuIndex::getMinPagingSize Returns the current minimum data size for paged searches. @@ -149,6 +157,7 @@ void faiss::gpu::GpuIndex::add (idx_t, const float *x) override add + faiss::gpu::GpuIndex::add add add @@ -172,6 +181,7 @@ void faiss::gpu::GpuIndex::add_with_ids (idx_t n, const float *x, const idx_t *ids) override add_with_ids + faiss::gpu::GpuIndex::add_with_ids add_with_ids idx_t @@ -199,6 +209,7 @@ void faiss::gpu::GpuIndex::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const override assign + faiss::gpu::GpuIndex::assign assign idx_t @@ -231,6 +242,7 @@ void faiss::gpu::GpuIndex::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndex::search search idx_t @@ -271,6 +283,7 @@ void faiss::gpu::GpuIndex::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::gpu::GpuIndex::search_and_reconstruct search_and_reconstruct idx_t @@ -315,6 +328,7 @@ void faiss::gpu::GpuIndex::compute_residual (const float *x, float *residual, idx_t key) const override compute_residual + faiss::gpu::GpuIndex::compute_residual compute_residual compute_residual @@ -343,6 +357,7 @@ void faiss::gpu::GpuIndex::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const override compute_residual_n + faiss::gpu::GpuIndex::compute_residual_n compute_residual_n compute_residual_n @@ -375,6 +390,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -448,6 +464,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -526,6 +543,7 @@ virtual void faiss::Index::reset ()=0 reset + faiss::Index::reset reset reset reset @@ -561,6 +579,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -585,6 +604,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -638,6 +658,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -691,6 +712,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -743,15 +765,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -767,6 +790,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -788,8 +813,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -853,14 +880,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -925,6 +952,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -953,6 +981,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -975,6 +1004,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1016,13 +1046,14 @@ - - + + void void faiss::gpu::GpuIndex::copyFrom (const faiss::Index *index) copyFrom + faiss::gpu::GpuIndex::copyFrom const faiss::Index * index @@ -1041,6 +1072,7 @@ void faiss::gpu::GpuIndex::copyTo (faiss::Index *index) const copyTo + faiss::gpu::GpuIndex::copyTo faiss::Index * index @@ -1059,6 +1091,7 @@ virtual bool faiss::gpu::GpuIndex::addImplRequiresIDs_ () const =0 addImplRequiresIDs_ + faiss::gpu::GpuIndex::addImplRequiresIDs_ addImplRequiresIDs_ addImplRequiresIDs_ addImplRequiresIDs_ @@ -1076,6 +1109,7 @@ virtual void faiss::gpu::GpuIndex::addImpl_ (idx_t n, const float *x, const idx_t *ids)=0 addImpl_ + faiss::gpu::GpuIndex::addImpl_ addImpl_ addImpl_ addImpl_ @@ -1105,6 +1139,7 @@ virtual void faiss::gpu::GpuIndex::searchImpl_ (idx_t n, const float *x, int k, float *distances, idx_t *labels, const SearchParameters *params) const =0 searchImpl_ + faiss::gpu::GpuIndex::searchImpl_ searchImpl_ searchImpl_ searchImpl_ @@ -1141,13 +1176,14 @@ - - + + void void faiss::gpu::GpuIndex::addPaged_ (idx_t n, const float *x, const idx_t *ids) addPaged_ + faiss::gpu::GpuIndex::addPaged_ idx_t n @@ -1174,6 +1210,7 @@ void faiss::gpu::GpuIndex::addPage_ (idx_t n, const float *x, const idx_t *ids) addPage_ + faiss::gpu::GpuIndex::addPage_ idx_t n @@ -1200,6 +1237,7 @@ void faiss::gpu::GpuIndex::searchNonPaged_ (idx_t n, const float *x, int k, float *outDistancesData, idx_t *outIndicesData, const SearchParameters *params) const searchNonPaged_ + faiss::gpu::GpuIndex::searchNonPaged_ idx_t n @@ -1238,6 +1276,7 @@ void faiss::gpu::GpuIndex::searchFromCpuPaged_ (idx_t n, const float *x, int k, float *outDistancesData, idx_t *outIndicesData, const SearchParameters *params) const searchFromCpuPaged_ + faiss::gpu::GpuIndex::searchFromCpuPaged_ idx_t n @@ -1271,13 +1310,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1291,6 +1331,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1299,13 +1340,14 @@ - - + + int int faiss::Index::d d + faiss::Index::d vector dimension @@ -1320,6 +1362,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1334,6 +1377,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1348,6 +1392,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1362,6 +1407,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1376,6 +1422,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1385,23 +1432,15 @@ - + - - - - - - - - - - - + + + @@ -1415,28 +1454,12 @@ - - - - - - - - - - - - - - - - @@ -1449,8 +1472,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1464,10 +1515,6 @@ - - - - @@ -1488,10 +1535,10 @@ faiss::gpu::GpuIndexcopyTo faiss::gpu::GpuIndexd faiss::gpu::GpuIndexdistance_t - faiss::gpu::GpuIndexget_distance_computer + faiss::gpu::GpuIndexget_distance_computer faiss::gpu::GpuIndexgetDevice faiss::gpu::GpuIndexgetMinPagingSize - faiss::gpu::GpuIndexgetResources + faiss::gpu::GpuIndexgetResources faiss::gpu::GpuIndexGpuIndex faiss::gpu::GpuIndexIndex faiss::gpu::GpuIndexis_trained diff --git a/xml/classfaiss_1_1gpu_1_1GpuIndexBinaryFlat.xml b/xml/classfaiss_1_1gpu_1_1GpuIndexBinaryFlat.xml index b5c70f7d70..25927daaad 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIndexBinaryFlat.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIndexBinaryFlat.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuIndexBinaryFlat faiss::IndexBinary GpuIndexBinaryFlat.h - + std::shared_ptr< GpuResources > std::shared_ptr<GpuResources> faiss::gpu::GpuIndexBinaryFlat::resources_ resources_ + faiss::gpu::GpuIndexBinaryFlat::resources_ Manages streans, cuBLAS handles and scratch memory for devices. @@ -24,6 +25,7 @@ const GpuIndexBinaryFlatConfig faiss::gpu::GpuIndexBinaryFlat::binaryFlatConfig_ binaryFlatConfig_ + faiss::gpu::GpuIndexBinaryFlat::binaryFlatConfig_ Configuration options. @@ -38,6 +40,7 @@ std::unique_ptr<BinaryFlatIndex> faiss::gpu::GpuIndexBinaryFlat::data_ data_ + faiss::gpu::GpuIndexBinaryFlat::data_ Holds our GPU data containing the list of vectors. @@ -47,13 +50,14 @@ - - + + faiss::gpu::GpuIndexBinaryFlat::GpuIndexBinaryFlat (GpuResourcesProvider *resources, const faiss::IndexBinaryFlat *index, GpuIndexBinaryFlatConfig config=GpuIndexBinaryFlatConfig()) GpuIndexBinaryFlat + faiss::gpu::GpuIndexBinaryFlat::GpuIndexBinaryFlat GpuResourcesProvider * resources @@ -81,6 +85,7 @@ faiss::gpu::GpuIndexBinaryFlat::GpuIndexBinaryFlat (GpuResourcesProvider *resources, int dims, GpuIndexBinaryFlatConfig config=GpuIndexBinaryFlatConfig()) GpuIndexBinaryFlat + faiss::gpu::GpuIndexBinaryFlat::GpuIndexBinaryFlat GpuResourcesProvider * resources @@ -108,6 +113,7 @@ faiss::gpu::GpuIndexBinaryFlat::~GpuIndexBinaryFlat () override ~GpuIndexBinaryFlat + faiss::gpu::GpuIndexBinaryFlat::~GpuIndexBinaryFlat @@ -121,6 +127,7 @@ int faiss::gpu::GpuIndexBinaryFlat::getDevice () const getDevice + faiss::gpu::GpuIndexBinaryFlat::getDevice Returns the device that this index is resident on. @@ -130,11 +137,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndexBinaryFlat::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndexBinaryFlat::getResources () getResources + faiss::gpu::GpuIndexBinaryFlat::getResources @@ -149,6 +157,7 @@ void faiss::gpu::GpuIndexBinaryFlat::copyFrom (const faiss::IndexBinaryFlat *index) copyFrom + faiss::gpu::GpuIndexBinaryFlat::copyFrom const faiss::IndexBinaryFlat * index @@ -167,6 +176,7 @@ void faiss::gpu::GpuIndexBinaryFlat::copyTo (faiss::IndexBinaryFlat *index) const copyTo + faiss::gpu::GpuIndexBinaryFlat::copyTo faiss::IndexBinaryFlat * index @@ -185,6 +195,7 @@ void faiss::gpu::GpuIndexBinaryFlat::add (faiss::idx_t n, const uint8_t *x) override add + faiss::gpu::GpuIndexBinaryFlat::add add faiss::idx_t @@ -218,6 +229,7 @@ void faiss::gpu::GpuIndexBinaryFlat::reset () override reset + faiss::gpu::GpuIndexBinaryFlat::reset reset Removes all elements from the database. @@ -233,6 +245,7 @@ void faiss::gpu::GpuIndexBinaryFlat::search (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, faiss::idx_t *labels, const faiss::SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndexBinaryFlat::search search idx_t @@ -300,6 +313,7 @@ void faiss::gpu::GpuIndexBinaryFlat::reconstruct (faiss::idx_t key, uint8_t *recons) const override reconstruct + faiss::gpu::GpuIndexBinaryFlat::reconstruct reconstruct faiss::idx_t @@ -341,6 +355,7 @@ virtual void faiss::IndexBinary::train (idx_t n, const uint8_t *x) train + faiss::IndexBinary::train train train train @@ -384,6 +399,7 @@ virtual void faiss::IndexBinary::add_with_ids (idx_t n, const uint8_t *x, const idx_t *xids) add_with_ids + faiss::IndexBinary::add_with_ids add_with_ids add_with_ids @@ -423,6 +439,7 @@ virtual void faiss::IndexBinary::range_search (idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::IndexBinary::range_search range_search range_search range_search @@ -489,6 +506,7 @@ void faiss::IndexBinary::assign (idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1) const assign + faiss::IndexBinary::assign idx_t n @@ -538,6 +556,7 @@ virtual size_t faiss::IndexBinary::remove_ids (const IDSelector &sel) remove_ids + faiss::IndexBinary::remove_ids remove_ids remove_ids @@ -558,6 +577,7 @@ virtual void faiss::IndexBinary::reconstruct_n (idx_t i0, idx_t ni, uint8_t *recons) const reconstruct_n + faiss::IndexBinary::reconstruct_n reconstruct_n idx_t @@ -595,6 +615,7 @@ virtual void faiss::IndexBinary::search_and_reconstruct (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::IndexBinary::search_and_reconstruct search_and_reconstruct idx_t @@ -650,6 +671,7 @@ void faiss::IndexBinary::display () const display + faiss::IndexBinary::display @@ -664,6 +686,7 @@ virtual void faiss::IndexBinary::merge_from (IndexBinary &otherIndex, idx_t add_id=0) merge_from + faiss::IndexBinary::merge_from merge_from IndexBinary & @@ -688,6 +711,7 @@ virtual void faiss::IndexBinary::check_compatible_for_merge (const IndexBinary &otherIndex) const check_compatible_for_merge + faiss::IndexBinary::check_compatible_for_merge check_compatible_for_merge const IndexBinary & @@ -707,6 +731,7 @@ virtual size_t faiss::IndexBinary::sa_code_size () const sa_code_size + faiss::IndexBinary::sa_code_size @@ -721,6 +746,7 @@ virtual void faiss::IndexBinary::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::IndexBinary::add_sa_codes idx_t n @@ -742,13 +768,14 @@ - - + + void void faiss::gpu::GpuIndexBinaryFlat::searchFromCpuPaged_ (idx_t n, const uint8_t *x, int k, int32_t *outDistancesData, idx_t *outIndicesData) const searchFromCpuPaged_ + faiss::gpu::GpuIndexBinaryFlat::searchFromCpuPaged_ idx_t n @@ -783,6 +810,7 @@ void faiss::gpu::GpuIndexBinaryFlat::searchNonPaged_ (idx_t n, const uint8_t *x, int k, int32_t *outDistancesData, idx_t *outIndicesData) const searchNonPaged_ + faiss::gpu::GpuIndexBinaryFlat::searchNonPaged_ idx_t n @@ -811,13 +839,14 @@ - - + + uint8_t using faiss::IndexBinary::component_t = uint8_t component_t + faiss::IndexBinary::component_t @@ -831,6 +860,7 @@ using faiss::IndexBinary::distance_t = int32_t distance_t + faiss::IndexBinary::distance_t @@ -839,13 +869,14 @@ - - + + int int faiss::IndexBinary::d d + faiss::IndexBinary::d = 0 vector dimension @@ -861,6 +892,7 @@ int faiss::IndexBinary::code_size code_size + faiss::IndexBinary::code_size = 0 number of bytes per vector ( = d / 8 ) @@ -876,6 +908,7 @@ idx_t faiss::IndexBinary::ntotal ntotal + faiss::IndexBinary::ntotal = 0 total nb of indexed vectors @@ -891,6 +924,7 @@ bool faiss::IndexBinary::verbose verbose + faiss::IndexBinary::verbose = false verbosity level @@ -906,6 +940,7 @@ bool faiss::IndexBinary::is_trained is_trained + faiss::IndexBinary::is_trained = true @@ -921,6 +956,7 @@ MetricType faiss::IndexBinary::metric_type metric_type + faiss::IndexBinary::metric_type = METRIC_L2 type of metric this index uses for search @@ -931,25 +967,29 @@ - + A GPU version of IndexBinaryFlat for brute-force comparison of bit vectors via Hamming distance + + + + + + - - @@ -959,19 +999,15 @@ binaryFlatConfig_ - - - - - - - + + + @@ -991,7 +1027,7 @@ faiss::gpu::GpuIndexBinaryFlatdisplay faiss::gpu::GpuIndexBinaryFlatdistance_t faiss::gpu::GpuIndexBinaryFlatgetDevice - faiss::gpu::GpuIndexBinaryFlatgetResources + faiss::gpu::GpuIndexBinaryFlatgetResources faiss::gpu::GpuIndexBinaryFlatGpuIndexBinaryFlat faiss::gpu::GpuIndexBinaryFlatGpuIndexBinaryFlat faiss::gpu::GpuIndexBinaryFlatIndexBinary diff --git a/xml/classfaiss_1_1gpu_1_1GpuIndexFlat.xml b/xml/classfaiss_1_1gpu_1_1GpuIndexFlat.xml index 73270d09ea..521aad2b4f 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIndexFlat.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIndexFlat.xml @@ -1,17 +1,18 @@ - + faiss::gpu::GpuIndexFlat faiss::gpu::GpuIndex faiss::gpu::GpuIndexFlatIP faiss::gpu::GpuIndexFlatL2 GpuIndexFlat.h - + const GpuIndexFlatConfig const GpuIndexFlatConfig faiss::gpu::GpuIndexFlat::flatConfig_ flatConfig_ + faiss::gpu::GpuIndexFlat::flatConfig_ Our configuration options. @@ -26,6 +27,7 @@ std::unique_ptr<FlatIndex> faiss::gpu::GpuIndexFlat::data_ data_ + faiss::gpu::GpuIndexFlat::data_ Holds our GPU data containing the list of vectors. @@ -40,6 +42,7 @@ std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::resources_ resources_ + faiss::gpu::GpuIndex::resources_ Manages streams, cuBLAS handles and scratch memory for devices. @@ -54,6 +57,7 @@ const GpuIndexConfig faiss::gpu::GpuIndex::config_ config_ + faiss::gpu::GpuIndex::config_ Our configuration options. @@ -68,6 +72,7 @@ size_t faiss::gpu::GpuIndex::minPagedSize_ minPagedSize_ + faiss::gpu::GpuIndex::minPagedSize_ Size above which we page copies from the CPU to GPU. @@ -77,13 +82,14 @@ - - + + faiss::gpu::GpuIndexFlat::GpuIndexFlat (GpuResourcesProvider *provider, const faiss::IndexFlat *index, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlat + faiss::gpu::GpuIndexFlat::GpuIndexFlat GpuResourcesProvider * provider @@ -111,6 +117,7 @@ faiss::gpu::GpuIndexFlat::GpuIndexFlat (std::shared_ptr< GpuResources > resources, const faiss::IndexFlat *index, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlat + faiss::gpu::GpuIndexFlat::GpuIndexFlat std::shared_ptr< GpuResources > resources @@ -137,6 +144,7 @@ faiss::gpu::GpuIndexFlat::GpuIndexFlat (GpuResourcesProvider *provider, int dims, faiss::MetricType metric, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlat + faiss::gpu::GpuIndexFlat::GpuIndexFlat GpuResourcesProvider * provider @@ -168,6 +176,7 @@ faiss::gpu::GpuIndexFlat::GpuIndexFlat (std::shared_ptr< GpuResources > resources, int dims, faiss::MetricType metric, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlat + faiss::gpu::GpuIndexFlat::GpuIndexFlat std::shared_ptr< GpuResources > resources @@ -198,6 +207,7 @@ faiss::gpu::GpuIndexFlat::~GpuIndexFlat () override ~GpuIndexFlat + faiss::gpu::GpuIndexFlat::~GpuIndexFlat @@ -211,6 +221,7 @@ void faiss::gpu::GpuIndexFlat::copyFrom (const faiss::IndexFlat *index) copyFrom + faiss::gpu::GpuIndexFlat::copyFrom const faiss::IndexFlat * index @@ -229,6 +240,7 @@ void faiss::gpu::GpuIndexFlat::copyTo (faiss::IndexFlat *index) const copyTo + faiss::gpu::GpuIndexFlat::copyTo faiss::IndexFlat * index @@ -247,6 +259,7 @@ size_t faiss::gpu::GpuIndexFlat::getNumVecs () const getNumVecs + faiss::gpu::GpuIndexFlat::getNumVecs Returns the number of vectors we contain. @@ -261,6 +274,7 @@ void faiss::gpu::GpuIndexFlat::reset () override reset + faiss::gpu::GpuIndexFlat::reset reset Clears all vectors from this index. @@ -276,6 +290,7 @@ void faiss::gpu::GpuIndexFlat::train (idx_t n, const float *x) override train + faiss::gpu::GpuIndexFlat::train train idx_t @@ -299,6 +314,7 @@ void faiss::gpu::GpuIndexFlat::add (idx_t, const float *x) override add + faiss::gpu::GpuIndexFlat::add add idx_t @@ -321,6 +337,7 @@ void faiss::gpu::GpuIndexFlat::reconstruct (idx_t key, float *out) const override reconstruct + faiss::gpu::GpuIndexFlat::reconstruct reconstruct idx_t @@ -344,6 +361,7 @@ void faiss::gpu::GpuIndexFlat::reconstruct_n (idx_t i0, idx_t num, float *out) const override reconstruct_n + faiss::gpu::GpuIndexFlat::reconstruct_n reconstruct_n idx_t @@ -371,6 +389,7 @@ void faiss::gpu::GpuIndexFlat::reconstruct_batch (idx_t n, const idx_t *keys, float *out) const override reconstruct_batch + faiss::gpu::GpuIndexFlat::reconstruct_batch reconstruct_batch idx_t @@ -398,6 +417,7 @@ void faiss::gpu::GpuIndexFlat::compute_residual (const float *x, float *residual, idx_t key) const override compute_residual + faiss::gpu::GpuIndexFlat::compute_residual compute_residual const float * @@ -425,6 +445,7 @@ void faiss::gpu::GpuIndexFlat::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const override compute_residual_n + faiss::gpu::GpuIndexFlat::compute_residual_n compute_residual_n idx_t @@ -451,11 +472,12 @@ - + FlatIndex * - FlatIndex* faiss::gpu::GpuIndexFlat::getGpuData + FlatIndex * faiss::gpu::GpuIndexFlat::getGpuData () getGpuData + faiss::gpu::GpuIndexFlat::getGpuData For internal access. @@ -470,6 +492,7 @@ int faiss::gpu::GpuIndex::getDevice () const getDevice + faiss::gpu::GpuIndex::getDevice Returns the device that this index is resident on. @@ -479,11 +502,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndex::getResources () getResources + faiss::gpu::GpuIndex::getResources @@ -498,6 +522,7 @@ void faiss::gpu::GpuIndex::setMinPagingSize (size_t size) setMinPagingSize + faiss::gpu::GpuIndex::setMinPagingSize size_t size @@ -516,6 +541,7 @@ size_t faiss::gpu::GpuIndex::getMinPagingSize () const getMinPagingSize + faiss::gpu::GpuIndex::getMinPagingSize Returns the current minimum data size for paged searches. @@ -530,6 +556,7 @@ void faiss::gpu::GpuIndex::add_with_ids (idx_t n, const float *x, const idx_t *ids) override add_with_ids + faiss::gpu::GpuIndex::add_with_ids add_with_ids idx_t @@ -557,6 +584,7 @@ void faiss::gpu::GpuIndex::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const override assign + faiss::gpu::GpuIndex::assign assign idx_t @@ -589,6 +617,7 @@ void faiss::gpu::GpuIndex::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndex::search search idx_t @@ -629,6 +658,7 @@ void faiss::gpu::GpuIndex::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::gpu::GpuIndex::search_and_reconstruct search_and_reconstruct idx_t @@ -673,6 +703,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -751,6 +782,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -770,15 +802,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -794,6 +827,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -815,8 +850,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -880,14 +917,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -952,6 +989,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -980,6 +1018,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1002,6 +1041,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1043,13 +1083,14 @@ - - + + void void faiss::gpu::GpuIndexFlat::resetIndex_ (int dims) resetIndex_ + faiss::gpu::GpuIndexFlat::resetIndex_ int dims @@ -1067,6 +1108,7 @@ bool faiss::gpu::GpuIndexFlat::addImplRequiresIDs_ () const override addImplRequiresIDs_ + faiss::gpu::GpuIndexFlat::addImplRequiresIDs_ addImplRequiresIDs_ @@ -1082,6 +1124,7 @@ void faiss::gpu::GpuIndexFlat::addImpl_ (idx_t n, const float *x, const idx_t *ids) override addImpl_ + faiss::gpu::GpuIndexFlat::addImpl_ addImpl_ idx_t @@ -1109,6 +1152,7 @@ void faiss::gpu::GpuIndexFlat::searchImpl_ (idx_t n, const float *x, int k, float *distances, idx_t *labels, const SearchParameters *params) const override searchImpl_ + faiss::gpu::GpuIndexFlat::searchImpl_ searchImpl_ idx_t @@ -1148,6 +1192,7 @@ void faiss::gpu::GpuIndex::copyFrom (const faiss::Index *index) copyFrom + faiss::gpu::GpuIndex::copyFrom const faiss::Index * index @@ -1166,6 +1211,7 @@ void faiss::gpu::GpuIndex::copyTo (faiss::Index *index) const copyTo + faiss::gpu::GpuIndex::copyTo faiss::Index * index @@ -1179,13 +1225,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1199,6 +1246,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1207,13 +1255,14 @@ - - + + int int faiss::Index::d d + faiss::Index::d vector dimension @@ -1228,6 +1277,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1242,6 +1292,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1256,6 +1307,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1270,6 +1322,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1284,6 +1337,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1293,13 +1347,17 @@ - + Wrapper around the GPU implementation that looks like faiss::IndexFlat; copies over centroid data from a given faiss::IndexFlat + + + + @@ -1312,10 +1370,6 @@ - - - - @@ -1330,6 +1384,10 @@ + + + + @@ -1352,10 +1410,6 @@ flatConfig_ - - - - @@ -1384,12 +1438,12 @@ faiss::gpu::GpuIndexFlatdata_ faiss::gpu::GpuIndexFlatdistance_t faiss::gpu::GpuIndexFlatflatConfig_ - faiss::gpu::GpuIndexFlatget_distance_computer + faiss::gpu::GpuIndexFlatget_distance_computer faiss::gpu::GpuIndexFlatgetDevice - faiss::gpu::GpuIndexFlatgetGpuData + faiss::gpu::GpuIndexFlatgetGpuData faiss::gpu::GpuIndexFlatgetMinPagingSize faiss::gpu::GpuIndexFlatgetNumVecs - faiss::gpu::GpuIndexFlatgetResources + faiss::gpu::GpuIndexFlatgetResources faiss::gpu::GpuIndexFlatGpuIndex faiss::gpu::GpuIndexFlatGpuIndexFlat faiss::gpu::GpuIndexFlatGpuIndexFlat diff --git a/xml/classfaiss_1_1gpu_1_1GpuIndexFlatIP.xml b/xml/classfaiss_1_1gpu_1_1GpuIndexFlatIP.xml index 2adf9055a6..c727a9c403 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIndexFlatIP.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIndexFlatIP.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuIndexFlatIP faiss::gpu::GpuIndexFlat GpuIndexFlat.h - + faiss::gpu::GpuIndexFlatIP::GpuIndexFlatIP (GpuResourcesProvider *provider, faiss::IndexFlatIP *index, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlatIP + faiss::gpu::GpuIndexFlatIP::GpuIndexFlatIP GpuResourcesProvider * provider @@ -37,6 +38,7 @@ faiss::gpu::GpuIndexFlatIP::GpuIndexFlatIP (std::shared_ptr< GpuResources > resources, faiss::IndexFlatIP *index, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlatIP + faiss::gpu::GpuIndexFlatIP::GpuIndexFlatIP std::shared_ptr< GpuResources > resources @@ -63,6 +65,7 @@ faiss::gpu::GpuIndexFlatIP::GpuIndexFlatIP (GpuResourcesProvider *provider, int dims, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlatIP + faiss::gpu::GpuIndexFlatIP::GpuIndexFlatIP GpuResourcesProvider * provider @@ -90,6 +93,7 @@ faiss::gpu::GpuIndexFlatIP::GpuIndexFlatIP (std::shared_ptr< GpuResources > resources, int dims, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlatIP + faiss::gpu::GpuIndexFlatIP::GpuIndexFlatIP std::shared_ptr< GpuResources > resources @@ -116,6 +120,7 @@ void faiss::gpu::GpuIndexFlatIP::copyFrom (faiss::IndexFlat *index) copyFrom + faiss::gpu::GpuIndexFlatIP::copyFrom faiss::IndexFlat * index @@ -134,6 +139,7 @@ void faiss::gpu::GpuIndexFlatIP::copyTo (faiss::IndexFlat *index) copyTo + faiss::gpu::GpuIndexFlatIP::copyTo faiss::IndexFlat * index @@ -152,6 +158,7 @@ void faiss::gpu::GpuIndexFlat::copyFrom (const faiss::IndexFlat *index) copyFrom + faiss::gpu::GpuIndexFlat::copyFrom const faiss::IndexFlat * index @@ -170,6 +177,7 @@ void faiss::gpu::GpuIndexFlat::copyTo (faiss::IndexFlat *index) const copyTo + faiss::gpu::GpuIndexFlat::copyTo faiss::IndexFlat * index @@ -188,6 +196,7 @@ size_t faiss::gpu::GpuIndexFlat::getNumVecs () const getNumVecs + faiss::gpu::GpuIndexFlat::getNumVecs Returns the number of vectors we contain. @@ -202,6 +211,7 @@ void faiss::gpu::GpuIndexFlat::reset () override reset + faiss::gpu::GpuIndexFlat::reset reset Clears all vectors from this index. @@ -217,6 +227,7 @@ void faiss::gpu::GpuIndexFlat::train (idx_t n, const float *x) override train + faiss::gpu::GpuIndexFlat::train train idx_t @@ -240,6 +251,7 @@ void faiss::gpu::GpuIndexFlat::add (idx_t, const float *x) override add + faiss::gpu::GpuIndexFlat::add add idx_t @@ -262,6 +274,7 @@ void faiss::gpu::GpuIndexFlat::reconstruct (idx_t key, float *out) const override reconstruct + faiss::gpu::GpuIndexFlat::reconstruct reconstruct idx_t @@ -285,6 +298,7 @@ void faiss::gpu::GpuIndexFlat::reconstruct_n (idx_t i0, idx_t num, float *out) const override reconstruct_n + faiss::gpu::GpuIndexFlat::reconstruct_n reconstruct_n idx_t @@ -312,6 +326,7 @@ void faiss::gpu::GpuIndexFlat::reconstruct_batch (idx_t n, const idx_t *keys, float *out) const override reconstruct_batch + faiss::gpu::GpuIndexFlat::reconstruct_batch reconstruct_batch idx_t @@ -339,6 +354,7 @@ void faiss::gpu::GpuIndexFlat::compute_residual (const float *x, float *residual, idx_t key) const override compute_residual + faiss::gpu::GpuIndexFlat::compute_residual compute_residual const float * @@ -366,6 +382,7 @@ void faiss::gpu::GpuIndexFlat::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const override compute_residual_n + faiss::gpu::GpuIndexFlat::compute_residual_n compute_residual_n idx_t @@ -392,11 +409,12 @@ - + FlatIndex * - FlatIndex* faiss::gpu::GpuIndexFlat::getGpuData + FlatIndex * faiss::gpu::GpuIndexFlat::getGpuData () getGpuData + faiss::gpu::GpuIndexFlat::getGpuData For internal access. @@ -411,6 +429,7 @@ int faiss::gpu::GpuIndex::getDevice () const getDevice + faiss::gpu::GpuIndex::getDevice Returns the device that this index is resident on. @@ -420,11 +439,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndex::getResources () getResources + faiss::gpu::GpuIndex::getResources @@ -439,6 +459,7 @@ void faiss::gpu::GpuIndex::setMinPagingSize (size_t size) setMinPagingSize + faiss::gpu::GpuIndex::setMinPagingSize size_t size @@ -457,6 +478,7 @@ size_t faiss::gpu::GpuIndex::getMinPagingSize () const getMinPagingSize + faiss::gpu::GpuIndex::getMinPagingSize Returns the current minimum data size for paged searches. @@ -471,6 +493,7 @@ void faiss::gpu::GpuIndex::add_with_ids (idx_t n, const float *x, const idx_t *ids) override add_with_ids + faiss::gpu::GpuIndex::add_with_ids add_with_ids idx_t @@ -498,6 +521,7 @@ void faiss::gpu::GpuIndex::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const override assign + faiss::gpu::GpuIndex::assign assign idx_t @@ -530,6 +554,7 @@ void faiss::gpu::GpuIndex::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndex::search search idx_t @@ -570,6 +595,7 @@ void faiss::gpu::GpuIndex::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::gpu::GpuIndex::search_and_reconstruct search_and_reconstruct idx_t @@ -614,6 +640,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -692,6 +719,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -711,15 +739,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -735,6 +764,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -756,8 +787,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -821,14 +854,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -893,6 +926,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -921,6 +955,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -943,6 +978,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -984,13 +1020,14 @@ - - + + const GpuIndexFlatConfig const GpuIndexFlatConfig faiss::gpu::GpuIndexFlat::flatConfig_ flatConfig_ + faiss::gpu::GpuIndexFlat::flatConfig_ Our configuration options. @@ -1005,6 +1042,7 @@ std::unique_ptr<FlatIndex> faiss::gpu::GpuIndexFlat::data_ data_ + faiss::gpu::GpuIndexFlat::data_ Holds our GPU data containing the list of vectors. @@ -1019,6 +1057,7 @@ std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::resources_ resources_ + faiss::gpu::GpuIndex::resources_ Manages streams, cuBLAS handles and scratch memory for devices. @@ -1033,6 +1072,7 @@ const GpuIndexConfig faiss::gpu::GpuIndex::config_ config_ + faiss::gpu::GpuIndex::config_ Our configuration options. @@ -1047,6 +1087,7 @@ size_t faiss::gpu::GpuIndex::minPagedSize_ minPagedSize_ + faiss::gpu::GpuIndex::minPagedSize_ Size above which we page copies from the CPU to GPU. @@ -1056,13 +1097,14 @@ - - + + void void faiss::gpu::GpuIndex::copyFrom (const faiss::Index *index) copyFrom + faiss::gpu::GpuIndex::copyFrom const faiss::Index * index @@ -1081,6 +1123,7 @@ void faiss::gpu::GpuIndex::copyTo (faiss::Index *index) const copyTo + faiss::gpu::GpuIndex::copyTo faiss::Index * index @@ -1099,6 +1142,7 @@ void faiss::gpu::GpuIndexFlat::resetIndex_ (int dims) resetIndex_ + faiss::gpu::GpuIndexFlat::resetIndex_ int dims @@ -1116,6 +1160,7 @@ bool faiss::gpu::GpuIndexFlat::addImplRequiresIDs_ () const override addImplRequiresIDs_ + faiss::gpu::GpuIndexFlat::addImplRequiresIDs_ addImplRequiresIDs_ @@ -1131,6 +1176,7 @@ void faiss::gpu::GpuIndexFlat::addImpl_ (idx_t n, const float *x, const idx_t *ids) override addImpl_ + faiss::gpu::GpuIndexFlat::addImpl_ addImpl_ idx_t @@ -1158,6 +1204,7 @@ void faiss::gpu::GpuIndexFlat::searchImpl_ (idx_t n, const float *x, int k, float *distances, idx_t *labels, const SearchParameters *params) const override searchImpl_ + faiss::gpu::GpuIndexFlat::searchImpl_ searchImpl_ idx_t @@ -1192,13 +1239,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1212,6 +1260,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1220,13 +1269,14 @@ - - + + int int faiss::Index::d d + faiss::Index::d vector dimension @@ -1241,6 +1291,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1255,6 +1306,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1269,6 +1321,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1283,6 +1336,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1297,6 +1351,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1306,13 +1361,17 @@ - + Wrapper around the GPU implementation that looks like faiss::IndexFlatIP; copies over centroid data from a given faiss::IndexFlat + + + + @@ -1325,10 +1384,6 @@ - - - - @@ -1337,6 +1392,10 @@ + + + + @@ -1359,9 +1418,11 @@ flatConfig_ - - - + + + + + @@ -1369,12 +1430,6 @@ - - - - - - @@ -1399,12 +1454,12 @@ faiss::gpu::GpuIndexFlatIPdata_ faiss::gpu::GpuIndexFlatIPdistance_t faiss::gpu::GpuIndexFlatIPflatConfig_ - faiss::gpu::GpuIndexFlatIPget_distance_computer + faiss::gpu::GpuIndexFlatIPget_distance_computer faiss::gpu::GpuIndexFlatIPgetDevice - faiss::gpu::GpuIndexFlatIPgetGpuData + faiss::gpu::GpuIndexFlatIPgetGpuData faiss::gpu::GpuIndexFlatIPgetMinPagingSize faiss::gpu::GpuIndexFlatIPgetNumVecs - faiss::gpu::GpuIndexFlatIPgetResources + faiss::gpu::GpuIndexFlatIPgetResources faiss::gpu::GpuIndexFlatIPGpuIndex faiss::gpu::GpuIndexFlatIPGpuIndexFlat faiss::gpu::GpuIndexFlatIPGpuIndexFlat diff --git a/xml/classfaiss_1_1gpu_1_1GpuIndexFlatL2.xml b/xml/classfaiss_1_1gpu_1_1GpuIndexFlatL2.xml index 046660b662..93de644ac1 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIndexFlatL2.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIndexFlatL2.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuIndexFlatL2 faiss::gpu::GpuIndexFlat GpuIndexFlat.h - + faiss::gpu::GpuIndexFlatL2::GpuIndexFlatL2 (GpuResourcesProvider *provider, faiss::IndexFlatL2 *index, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlatL2 + faiss::gpu::GpuIndexFlatL2::GpuIndexFlatL2 GpuResourcesProvider * provider @@ -37,6 +38,7 @@ faiss::gpu::GpuIndexFlatL2::GpuIndexFlatL2 (std::shared_ptr< GpuResources > resources, faiss::IndexFlatL2 *index, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlatL2 + faiss::gpu::GpuIndexFlatL2::GpuIndexFlatL2 std::shared_ptr< GpuResources > resources @@ -63,6 +65,7 @@ faiss::gpu::GpuIndexFlatL2::GpuIndexFlatL2 (GpuResourcesProvider *provider, int dims, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlatL2 + faiss::gpu::GpuIndexFlatL2::GpuIndexFlatL2 GpuResourcesProvider * provider @@ -90,6 +93,7 @@ faiss::gpu::GpuIndexFlatL2::GpuIndexFlatL2 (std::shared_ptr< GpuResources > resources, int dims, GpuIndexFlatConfig config=GpuIndexFlatConfig()) GpuIndexFlatL2 + faiss::gpu::GpuIndexFlatL2::GpuIndexFlatL2 std::shared_ptr< GpuResources > resources @@ -116,6 +120,7 @@ void faiss::gpu::GpuIndexFlatL2::copyFrom (faiss::IndexFlat *index) copyFrom + faiss::gpu::GpuIndexFlatL2::copyFrom faiss::IndexFlat * index @@ -134,6 +139,7 @@ void faiss::gpu::GpuIndexFlatL2::copyTo (faiss::IndexFlat *index) copyTo + faiss::gpu::GpuIndexFlatL2::copyTo faiss::IndexFlat * index @@ -152,6 +158,7 @@ void faiss::gpu::GpuIndexFlat::copyFrom (const faiss::IndexFlat *index) copyFrom + faiss::gpu::GpuIndexFlat::copyFrom const faiss::IndexFlat * index @@ -170,6 +177,7 @@ void faiss::gpu::GpuIndexFlat::copyTo (faiss::IndexFlat *index) const copyTo + faiss::gpu::GpuIndexFlat::copyTo faiss::IndexFlat * index @@ -188,6 +196,7 @@ size_t faiss::gpu::GpuIndexFlat::getNumVecs () const getNumVecs + faiss::gpu::GpuIndexFlat::getNumVecs Returns the number of vectors we contain. @@ -202,6 +211,7 @@ void faiss::gpu::GpuIndexFlat::reset () override reset + faiss::gpu::GpuIndexFlat::reset reset Clears all vectors from this index. @@ -217,6 +227,7 @@ void faiss::gpu::GpuIndexFlat::train (idx_t n, const float *x) override train + faiss::gpu::GpuIndexFlat::train train idx_t @@ -240,6 +251,7 @@ void faiss::gpu::GpuIndexFlat::add (idx_t, const float *x) override add + faiss::gpu::GpuIndexFlat::add add idx_t @@ -262,6 +274,7 @@ void faiss::gpu::GpuIndexFlat::reconstruct (idx_t key, float *out) const override reconstruct + faiss::gpu::GpuIndexFlat::reconstruct reconstruct idx_t @@ -285,6 +298,7 @@ void faiss::gpu::GpuIndexFlat::reconstruct_n (idx_t i0, idx_t num, float *out) const override reconstruct_n + faiss::gpu::GpuIndexFlat::reconstruct_n reconstruct_n idx_t @@ -312,6 +326,7 @@ void faiss::gpu::GpuIndexFlat::reconstruct_batch (idx_t n, const idx_t *keys, float *out) const override reconstruct_batch + faiss::gpu::GpuIndexFlat::reconstruct_batch reconstruct_batch idx_t @@ -339,6 +354,7 @@ void faiss::gpu::GpuIndexFlat::compute_residual (const float *x, float *residual, idx_t key) const override compute_residual + faiss::gpu::GpuIndexFlat::compute_residual compute_residual const float * @@ -366,6 +382,7 @@ void faiss::gpu::GpuIndexFlat::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const override compute_residual_n + faiss::gpu::GpuIndexFlat::compute_residual_n compute_residual_n idx_t @@ -392,11 +409,12 @@ - + FlatIndex * - FlatIndex* faiss::gpu::GpuIndexFlat::getGpuData + FlatIndex * faiss::gpu::GpuIndexFlat::getGpuData () getGpuData + faiss::gpu::GpuIndexFlat::getGpuData For internal access. @@ -411,6 +429,7 @@ int faiss::gpu::GpuIndex::getDevice () const getDevice + faiss::gpu::GpuIndex::getDevice Returns the device that this index is resident on. @@ -420,11 +439,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndex::getResources () getResources + faiss::gpu::GpuIndex::getResources @@ -439,6 +459,7 @@ void faiss::gpu::GpuIndex::setMinPagingSize (size_t size) setMinPagingSize + faiss::gpu::GpuIndex::setMinPagingSize size_t size @@ -457,6 +478,7 @@ size_t faiss::gpu::GpuIndex::getMinPagingSize () const getMinPagingSize + faiss::gpu::GpuIndex::getMinPagingSize Returns the current minimum data size for paged searches. @@ -471,6 +493,7 @@ void faiss::gpu::GpuIndex::add_with_ids (idx_t n, const float *x, const idx_t *ids) override add_with_ids + faiss::gpu::GpuIndex::add_with_ids add_with_ids idx_t @@ -498,6 +521,7 @@ void faiss::gpu::GpuIndex::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const override assign + faiss::gpu::GpuIndex::assign assign idx_t @@ -530,6 +554,7 @@ void faiss::gpu::GpuIndex::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndex::search search idx_t @@ -570,6 +595,7 @@ void faiss::gpu::GpuIndex::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::gpu::GpuIndex::search_and_reconstruct search_and_reconstruct idx_t @@ -614,6 +640,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -692,6 +719,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -711,15 +739,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -735,6 +764,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -756,8 +787,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -821,14 +854,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -893,6 +926,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -921,6 +955,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -943,6 +978,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -984,13 +1020,14 @@ - - + + const GpuIndexFlatConfig const GpuIndexFlatConfig faiss::gpu::GpuIndexFlat::flatConfig_ flatConfig_ + faiss::gpu::GpuIndexFlat::flatConfig_ Our configuration options. @@ -1005,6 +1042,7 @@ std::unique_ptr<FlatIndex> faiss::gpu::GpuIndexFlat::data_ data_ + faiss::gpu::GpuIndexFlat::data_ Holds our GPU data containing the list of vectors. @@ -1019,6 +1057,7 @@ std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::resources_ resources_ + faiss::gpu::GpuIndex::resources_ Manages streams, cuBLAS handles and scratch memory for devices. @@ -1033,6 +1072,7 @@ const GpuIndexConfig faiss::gpu::GpuIndex::config_ config_ + faiss::gpu::GpuIndex::config_ Our configuration options. @@ -1047,6 +1087,7 @@ size_t faiss::gpu::GpuIndex::minPagedSize_ minPagedSize_ + faiss::gpu::GpuIndex::minPagedSize_ Size above which we page copies from the CPU to GPU. @@ -1056,13 +1097,14 @@ - - + + void void faiss::gpu::GpuIndex::copyFrom (const faiss::Index *index) copyFrom + faiss::gpu::GpuIndex::copyFrom const faiss::Index * index @@ -1081,6 +1123,7 @@ void faiss::gpu::GpuIndex::copyTo (faiss::Index *index) const copyTo + faiss::gpu::GpuIndex::copyTo faiss::Index * index @@ -1099,6 +1142,7 @@ void faiss::gpu::GpuIndexFlat::resetIndex_ (int dims) resetIndex_ + faiss::gpu::GpuIndexFlat::resetIndex_ int dims @@ -1116,6 +1160,7 @@ bool faiss::gpu::GpuIndexFlat::addImplRequiresIDs_ () const override addImplRequiresIDs_ + faiss::gpu::GpuIndexFlat::addImplRequiresIDs_ addImplRequiresIDs_ @@ -1131,6 +1176,7 @@ void faiss::gpu::GpuIndexFlat::addImpl_ (idx_t n, const float *x, const idx_t *ids) override addImpl_ + faiss::gpu::GpuIndexFlat::addImpl_ addImpl_ idx_t @@ -1158,6 +1204,7 @@ void faiss::gpu::GpuIndexFlat::searchImpl_ (idx_t n, const float *x, int k, float *distances, idx_t *labels, const SearchParameters *params) const override searchImpl_ + faiss::gpu::GpuIndexFlat::searchImpl_ searchImpl_ idx_t @@ -1192,13 +1239,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1212,6 +1260,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1220,13 +1269,14 @@ - - + + int int faiss::Index::d d + faiss::Index::d vector dimension @@ -1241,6 +1291,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1255,6 +1306,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1269,6 +1321,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1283,6 +1336,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1297,6 +1351,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1306,13 +1361,17 @@ - + Wrapper around the GPU implementation that looks like faiss::IndexFlatL2; copies over centroid data from a given faiss::IndexFlat + + + + @@ -1325,10 +1384,6 @@ - - - - @@ -1337,6 +1392,10 @@ + + + + @@ -1359,10 +1418,6 @@ flatConfig_ - - - - @@ -1399,12 +1454,12 @@ faiss::gpu::GpuIndexFlatL2data_ faiss::gpu::GpuIndexFlatL2distance_t faiss::gpu::GpuIndexFlatL2flatConfig_ - faiss::gpu::GpuIndexFlatL2get_distance_computer + faiss::gpu::GpuIndexFlatL2get_distance_computer faiss::gpu::GpuIndexFlatL2getDevice - faiss::gpu::GpuIndexFlatL2getGpuData + faiss::gpu::GpuIndexFlatL2getGpuData faiss::gpu::GpuIndexFlatL2getMinPagingSize faiss::gpu::GpuIndexFlatL2getNumVecs - faiss::gpu::GpuIndexFlatL2getResources + faiss::gpu::GpuIndexFlatL2getResources faiss::gpu::GpuIndexFlatL2GpuIndex faiss::gpu::GpuIndexFlatL2GpuIndexFlat faiss::gpu::GpuIndexFlatL2GpuIndexFlat diff --git a/xml/classfaiss_1_1gpu_1_1GpuIndexIVF.xml b/xml/classfaiss_1_1gpu_1_1GpuIndexIVF.xml index 102a14208d..c6febaddee 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIndexIVF.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIndexIVF.xml @@ -1,5 +1,5 @@ - + faiss::gpu::GpuIndexIVF faiss::gpu::GpuIndex @@ -8,12 +8,13 @@ faiss::gpu::GpuIndexIVFPQ faiss::gpu::GpuIndexIVFScalarQuantizer GpuIndexIVF.h - + const GpuIndexIVFConfig const GpuIndexIVFConfig faiss::gpu::GpuIndexIVF::ivfConfig_ ivfConfig_ + faiss::gpu::GpuIndexIVF::ivfConfig_ Our configuration options. @@ -28,6 +29,7 @@ std::shared_ptr<IVFBase> faiss::gpu::GpuIndexIVF::baseIndex_ baseIndex_ + faiss::gpu::GpuIndexIVF::baseIndex_ For a trained/initialized index, this is a reference to the base class. @@ -42,6 +44,7 @@ std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::resources_ resources_ + faiss::gpu::GpuIndex::resources_ Manages streams, cuBLAS handles and scratch memory for devices. @@ -56,6 +59,7 @@ const GpuIndexConfig faiss::gpu::GpuIndex::config_ config_ + faiss::gpu::GpuIndex::config_ Our configuration options. @@ -70,6 +74,7 @@ size_t faiss::gpu::GpuIndex::minPagedSize_ minPagedSize_ + faiss::gpu::GpuIndex::minPagedSize_ Size above which we page copies from the CPU to GPU. @@ -79,13 +84,14 @@ - - + + faiss::gpu::GpuIndexIVF::GpuIndexIVF (GpuResourcesProvider *provider, int dims, faiss::MetricType metric, float metricArg, idx_t nlist, GpuIndexIVFConfig config=GpuIndexIVFConfig()) GpuIndexIVF + faiss::gpu::GpuIndexIVF::GpuIndexIVF GpuResourcesProvider * provider @@ -125,6 +131,7 @@ faiss::gpu::GpuIndexIVF::GpuIndexIVF (GpuResourcesProvider *provider, Index *coarseQuantizer, int dims, faiss::MetricType metric, float metricArg, idx_t nlist, GpuIndexIVFConfig config=GpuIndexIVFConfig()) GpuIndexIVF + faiss::gpu::GpuIndexIVF::GpuIndexIVF GpuResourcesProvider * provider @@ -168,6 +175,7 @@ faiss::gpu::GpuIndexIVF::~GpuIndexIVF () override ~GpuIndexIVF + faiss::gpu::GpuIndexIVF::~GpuIndexIVF @@ -181,6 +189,7 @@ void faiss::gpu::GpuIndexIVF::copyFrom (const faiss::IndexIVF *index) copyFrom + faiss::gpu::GpuIndexIVF::copyFrom const faiss::IndexIVF * index @@ -199,6 +208,7 @@ void faiss::gpu::GpuIndexIVF::copyTo (faiss::IndexIVF *index) const copyTo + faiss::gpu::GpuIndexIVF::copyTo faiss::IndexIVF * index @@ -217,6 +227,7 @@ virtual void faiss::gpu::GpuIndexIVF::updateQuantizer ()=0 updateQuantizer + faiss::gpu::GpuIndexIVF::updateQuantizer updateQuantizer updateQuantizer updateQuantizer @@ -234,6 +245,7 @@ virtual idx_t faiss::gpu::GpuIndexIVF::getNumLists () const getNumLists + faiss::gpu::GpuIndexIVF::getNumLists Returns the number of inverted lists we're managing. @@ -248,6 +260,7 @@ virtual idx_t faiss::gpu::GpuIndexIVF::getListLength (idx_t listId) const getListLength + faiss::gpu::GpuIndexIVF::getListLength idx_t listId @@ -261,11 +274,12 @@ - + std::vector< uint8_t > - virtual std::vector<uint8_t> faiss::gpu::GpuIndexIVF::getListVectorData + virtual std::vector< uint8_t > faiss::gpu::GpuIndexIVF::getListVectorData (idx_t listId, bool gpuFormat=false) const getListVectorData + faiss::gpu::GpuIndexIVF::getListVectorData idx_t listId @@ -284,11 +298,12 @@ - + std::vector< idx_t > - virtual std::vector<idx_t> faiss::gpu::GpuIndexIVF::getListIndices + virtual std::vector< idx_t > faiss::gpu::GpuIndexIVF::getListIndices (idx_t listId) const getListIndices + faiss::gpu::GpuIndexIVF::getListIndices idx_t listId @@ -307,6 +322,7 @@ void faiss::gpu::GpuIndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const SearchParametersIVF *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::gpu::GpuIndexIVF::search_preassigned search_preassigned idx_t @@ -438,6 +454,7 @@ void faiss::gpu::GpuIndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::gpu::GpuIndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -558,6 +575,7 @@ int faiss::gpu::GpuIndex::getDevice () const getDevice + faiss::gpu::GpuIndex::getDevice Returns the device that this index is resident on. @@ -567,11 +585,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndex::getResources () getResources + faiss::gpu::GpuIndex::getResources @@ -586,6 +605,7 @@ void faiss::gpu::GpuIndex::setMinPagingSize (size_t size) setMinPagingSize + faiss::gpu::GpuIndex::setMinPagingSize size_t size @@ -604,6 +624,7 @@ size_t faiss::gpu::GpuIndex::getMinPagingSize () const getMinPagingSize + faiss::gpu::GpuIndex::getMinPagingSize Returns the current minimum data size for paged searches. @@ -618,6 +639,7 @@ void faiss::gpu::GpuIndex::add (idx_t, const float *x) override add + faiss::gpu::GpuIndex::add add add @@ -641,6 +663,7 @@ void faiss::gpu::GpuIndex::add_with_ids (idx_t n, const float *x, const idx_t *ids) override add_with_ids + faiss::gpu::GpuIndex::add_with_ids add_with_ids idx_t @@ -668,6 +691,7 @@ void faiss::gpu::GpuIndex::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const override assign + faiss::gpu::GpuIndex::assign assign idx_t @@ -700,6 +724,7 @@ void faiss::gpu::GpuIndex::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndex::search search idx_t @@ -740,6 +765,7 @@ void faiss::gpu::GpuIndex::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::gpu::GpuIndex::search_and_reconstruct search_and_reconstruct idx_t @@ -784,6 +810,7 @@ void faiss::gpu::GpuIndex::compute_residual (const float *x, float *residual, idx_t key) const override compute_residual + faiss::gpu::GpuIndex::compute_residual compute_residual compute_residual @@ -812,6 +839,7 @@ void faiss::gpu::GpuIndex::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const override compute_residual_n + faiss::gpu::GpuIndex::compute_residual_n compute_residual_n compute_residual_n @@ -844,6 +872,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -917,6 +946,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -995,6 +1025,7 @@ virtual void faiss::Index::reset ()=0 reset + faiss::Index::reset reset reset reset @@ -1030,6 +1061,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -1054,6 +1086,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -1107,6 +1140,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1160,6 +1194,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1212,15 +1247,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1236,6 +1272,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1257,8 +1295,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1322,14 +1362,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1394,6 +1434,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1422,6 +1463,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1444,6 +1486,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1490,6 +1533,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -1520,6 +1564,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -1534,6 +1579,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -1555,6 +1601,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -1567,13 +1614,14 @@ - - + + void void faiss::gpu::GpuIndexIVF::init_ () init_ + faiss::gpu::GpuIndexIVF::init_ Shared initialization functions. @@ -1583,13 +1631,14 @@ - - + + int int faiss::gpu::GpuIndexIVF::getCurrentNProbe_ (const SearchParameters *params) const getCurrentNProbe_ + faiss::gpu::GpuIndexIVF::getCurrentNProbe_ const SearchParameters * params @@ -1608,6 +1657,7 @@ void faiss::gpu::GpuIndexIVF::verifyIVFSettings_ () const verifyIVFSettings_ + faiss::gpu::GpuIndexIVF::verifyIVFSettings_ @@ -1621,6 +1671,7 @@ bool faiss::gpu::GpuIndexIVF::addImplRequiresIDs_ () const override addImplRequiresIDs_ + faiss::gpu::GpuIndexIVF::addImplRequiresIDs_ addImplRequiresIDs_ @@ -1636,6 +1687,7 @@ virtual void faiss::gpu::GpuIndexIVF::trainQuantizer_ (idx_t n, const float *x) trainQuantizer_ + faiss::gpu::GpuIndexIVF::trainQuantizer_ idx_t n @@ -1657,6 +1709,7 @@ void faiss::gpu::GpuIndexIVF::addImpl_ (idx_t n, const float *x, const idx_t *ids) override addImpl_ + faiss::gpu::GpuIndexIVF::addImpl_ addImpl_ idx_t @@ -1684,6 +1737,7 @@ void faiss::gpu::GpuIndexIVF::searchImpl_ (idx_t n, const float *x, int k, float *distances, idx_t *labels, const SearchParameters *params) const override searchImpl_ + faiss::gpu::GpuIndexIVF::searchImpl_ searchImpl_ idx_t @@ -1723,6 +1777,7 @@ void faiss::gpu::GpuIndex::copyFrom (const faiss::Index *index) copyFrom + faiss::gpu::GpuIndex::copyFrom const faiss::Index * index @@ -1741,6 +1796,7 @@ void faiss::gpu::GpuIndex::copyTo (faiss::Index *index) const copyTo + faiss::gpu::GpuIndex::copyTo faiss::Index * index @@ -1754,13 +1810,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1774,6 +1831,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1782,13 +1840,14 @@ - - + + int int faiss::Index::d d + faiss::Index::d vector dimension @@ -1803,6 +1862,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1817,6 +1877,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1831,6 +1892,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1845,6 +1907,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1859,6 +1922,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1873,6 +1937,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -1888,6 +1953,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -1903,6 +1969,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -1918,6 +1985,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -1933,6 +2001,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -1948,6 +2017,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -1963,6 +2033,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -1977,6 +2048,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -1987,34 +2059,46 @@ - + Base class of all GPU IVF index types. This (for now) deliberately does not inherit from IndexIVF, as many of the public data members and functionality in IndexIVF is not supported in the same manner on the GPU. - - - - - + + + - - - - + + + + + + + + - - - + + + + + + + + + + + + + @@ -2022,26 +2106,39 @@ - - - - - - + + + + + + + + + + - + - + + + + + + + + clustering_index + quantizer + + + cp - - @@ -2051,33 +2148,15 @@ config_ - - - - - cp - - - clustering_index - quantizer - - - - - - - - - + + + - - flatConfig - @@ -2090,20 +2169,13 @@ ivfConfig_ - - - - - - - + + + - - - - - + + flatConfig @@ -2132,15 +2204,15 @@ faiss::gpu::GpuIndexIVFdecode_listno faiss::gpu::GpuIndexIVFdistance_t faiss::gpu::GpuIndexIVFencode_listno - faiss::gpu::GpuIndexIVFget_distance_computer + faiss::gpu::GpuIndexIVFget_distance_computer faiss::gpu::GpuIndexIVFgetCurrentNProbe_ faiss::gpu::GpuIndexIVFgetDevice - faiss::gpu::GpuIndexIVFgetListIndices + faiss::gpu::GpuIndexIVFgetListIndices faiss::gpu::GpuIndexIVFgetListLength - faiss::gpu::GpuIndexIVFgetListVectorData + faiss::gpu::GpuIndexIVFgetListVectorData faiss::gpu::GpuIndexIVFgetMinPagingSize faiss::gpu::GpuIndexIVFgetNumLists - faiss::gpu::GpuIndexIVFgetResources + faiss::gpu::GpuIndexIVFgetResources faiss::gpu::GpuIndexIVFGpuIndex faiss::gpu::GpuIndexIVFGpuIndexIVF faiss::gpu::GpuIndexIVFGpuIndexIVF diff --git a/xml/classfaiss_1_1gpu_1_1GpuIndexIVFFlat.xml b/xml/classfaiss_1_1gpu_1_1GpuIndexIVFFlat.xml index 655378eb41..6f277a163a 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIndexIVFFlat.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIndexIVFFlat.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuIndexIVFFlat faiss::gpu::GpuIndexIVF GpuIndexIVFFlat.h - + const GpuIndexIVFFlatConfig const GpuIndexIVFFlatConfig faiss::gpu::GpuIndexIVFFlat::ivfFlatConfig_ ivfFlatConfig_ + faiss::gpu::GpuIndexIVFFlat::ivfFlatConfig_ Our configuration options. @@ -24,6 +25,7 @@ size_t faiss::gpu::GpuIndexIVFFlat::reserveMemoryVecs_ reserveMemoryVecs_ + faiss::gpu::GpuIndexIVFFlat::reserveMemoryVecs_ Desired inverted list memory reservation. @@ -38,6 +40,7 @@ std::shared_ptr<IVFFlat> faiss::gpu::GpuIndexIVFFlat::index_ index_ + faiss::gpu::GpuIndexIVFFlat::index_ Instance that we own; contains the inverted lists. @@ -52,6 +55,7 @@ const GpuIndexIVFConfig faiss::gpu::GpuIndexIVF::ivfConfig_ ivfConfig_ + faiss::gpu::GpuIndexIVF::ivfConfig_ Our configuration options. @@ -66,6 +70,7 @@ std::shared_ptr<IVFBase> faiss::gpu::GpuIndexIVF::baseIndex_ baseIndex_ + faiss::gpu::GpuIndexIVF::baseIndex_ For a trained/initialized index, this is a reference to the base class. @@ -80,6 +85,7 @@ std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::resources_ resources_ + faiss::gpu::GpuIndex::resources_ Manages streams, cuBLAS handles and scratch memory for devices. @@ -94,6 +100,7 @@ const GpuIndexConfig faiss::gpu::GpuIndex::config_ config_ + faiss::gpu::GpuIndex::config_ Our configuration options. @@ -108,6 +115,7 @@ size_t faiss::gpu::GpuIndex::minPagedSize_ minPagedSize_ + faiss::gpu::GpuIndex::minPagedSize_ Size above which we page copies from the CPU to GPU. @@ -117,13 +125,14 @@ - - + + faiss::gpu::GpuIndexIVFFlat::GpuIndexIVFFlat (GpuResourcesProvider *provider, const faiss::IndexIVFFlat *index, GpuIndexIVFFlatConfig config=GpuIndexIVFFlatConfig()) GpuIndexIVFFlat + faiss::gpu::GpuIndexIVFFlat::GpuIndexIVFFlat GpuResourcesProvider * provider @@ -151,6 +160,7 @@ faiss::gpu::GpuIndexIVFFlat::GpuIndexIVFFlat (GpuResourcesProvider *provider, int dims, idx_t nlist, faiss::MetricType metric=faiss::METRIC_L2, GpuIndexIVFFlatConfig config=GpuIndexIVFFlatConfig()) GpuIndexIVFFlat + faiss::gpu::GpuIndexIVFFlat::GpuIndexIVFFlat GpuResourcesProvider * provider @@ -187,6 +197,7 @@ faiss::gpu::GpuIndexIVFFlat::GpuIndexIVFFlat (GpuResourcesProvider *provider, Index *coarseQuantizer, int dims, idx_t nlist, faiss::MetricType metric=faiss::METRIC_L2, GpuIndexIVFFlatConfig config=GpuIndexIVFFlatConfig()) GpuIndexIVFFlat + faiss::gpu::GpuIndexIVFFlat::GpuIndexIVFFlat GpuResourcesProvider * provider @@ -227,6 +238,7 @@ faiss::gpu::GpuIndexIVFFlat::~GpuIndexIVFFlat () override ~GpuIndexIVFFlat + faiss::gpu::GpuIndexIVFFlat::~GpuIndexIVFFlat @@ -240,6 +252,7 @@ void faiss::gpu::GpuIndexIVFFlat::reserveMemory (size_t numVecs) reserveMemory + faiss::gpu::GpuIndexIVFFlat::reserveMemory size_t numVecs @@ -258,6 +271,7 @@ void faiss::gpu::GpuIndexIVFFlat::copyFrom (const faiss::IndexIVFFlat *index) copyFrom + faiss::gpu::GpuIndexIVFFlat::copyFrom const faiss::IndexIVFFlat * index @@ -276,6 +290,7 @@ void faiss::gpu::GpuIndexIVFFlat::copyTo (faiss::IndexIVFFlat *index) const copyTo + faiss::gpu::GpuIndexIVFFlat::copyTo faiss::IndexIVFFlat * index @@ -294,6 +309,7 @@ size_t faiss::gpu::GpuIndexIVFFlat::reclaimMemory () reclaimMemory + faiss::gpu::GpuIndexIVFFlat::reclaimMemory @@ -308,6 +324,7 @@ void faiss::gpu::GpuIndexIVFFlat::reset () override reset + faiss::gpu::GpuIndexIVFFlat::reset reset @@ -323,6 +340,7 @@ void faiss::gpu::GpuIndexIVFFlat::updateQuantizer () override updateQuantizer + faiss::gpu::GpuIndexIVFFlat::updateQuantizer updateQuantizer @@ -338,6 +356,7 @@ void faiss::gpu::GpuIndexIVFFlat::train (idx_t n, const float *x) override train + faiss::gpu::GpuIndexIVFFlat::train train idx_t @@ -361,6 +380,7 @@ void faiss::gpu::GpuIndexIVFFlat::reconstruct_n (idx_t i0, idx_t n, float *out) const override reconstruct_n + faiss::gpu::GpuIndexIVFFlat::reconstruct_n reconstruct_n idx_t @@ -414,6 +434,7 @@ void faiss::gpu::GpuIndexIVF::copyFrom (const faiss::IndexIVF *index) copyFrom + faiss::gpu::GpuIndexIVF::copyFrom const faiss::IndexIVF * index @@ -432,6 +453,7 @@ void faiss::gpu::GpuIndexIVF::copyTo (faiss::IndexIVF *index) const copyTo + faiss::gpu::GpuIndexIVF::copyTo faiss::IndexIVF * index @@ -450,6 +472,7 @@ virtual idx_t faiss::gpu::GpuIndexIVF::getNumLists () const getNumLists + faiss::gpu::GpuIndexIVF::getNumLists Returns the number of inverted lists we're managing. @@ -464,6 +487,7 @@ virtual idx_t faiss::gpu::GpuIndexIVF::getListLength (idx_t listId) const getListLength + faiss::gpu::GpuIndexIVF::getListLength idx_t listId @@ -477,11 +501,12 @@ - + std::vector< uint8_t > - virtual std::vector<uint8_t> faiss::gpu::GpuIndexIVF::getListVectorData + virtual std::vector< uint8_t > faiss::gpu::GpuIndexIVF::getListVectorData (idx_t listId, bool gpuFormat=false) const getListVectorData + faiss::gpu::GpuIndexIVF::getListVectorData idx_t listId @@ -500,11 +525,12 @@ - + std::vector< idx_t > - virtual std::vector<idx_t> faiss::gpu::GpuIndexIVF::getListIndices + virtual std::vector< idx_t > faiss::gpu::GpuIndexIVF::getListIndices (idx_t listId) const getListIndices + faiss::gpu::GpuIndexIVF::getListIndices idx_t listId @@ -523,6 +549,7 @@ void faiss::gpu::GpuIndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const SearchParametersIVF *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::gpu::GpuIndexIVF::search_preassigned search_preassigned idx_t @@ -654,6 +681,7 @@ void faiss::gpu::GpuIndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::gpu::GpuIndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -774,6 +802,7 @@ int faiss::gpu::GpuIndex::getDevice () const getDevice + faiss::gpu::GpuIndex::getDevice Returns the device that this index is resident on. @@ -783,11 +812,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndex::getResources () getResources + faiss::gpu::GpuIndex::getResources @@ -802,6 +832,7 @@ void faiss::gpu::GpuIndex::setMinPagingSize (size_t size) setMinPagingSize + faiss::gpu::GpuIndex::setMinPagingSize size_t size @@ -820,6 +851,7 @@ size_t faiss::gpu::GpuIndex::getMinPagingSize () const getMinPagingSize + faiss::gpu::GpuIndex::getMinPagingSize Returns the current minimum data size for paged searches. @@ -834,6 +866,7 @@ void faiss::gpu::GpuIndex::add (idx_t, const float *x) override add + faiss::gpu::GpuIndex::add add add @@ -857,6 +890,7 @@ void faiss::gpu::GpuIndex::add_with_ids (idx_t n, const float *x, const idx_t *ids) override add_with_ids + faiss::gpu::GpuIndex::add_with_ids add_with_ids idx_t @@ -884,6 +918,7 @@ void faiss::gpu::GpuIndex::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const override assign + faiss::gpu::GpuIndex::assign assign idx_t @@ -916,6 +951,7 @@ void faiss::gpu::GpuIndex::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndex::search search idx_t @@ -956,6 +992,7 @@ void faiss::gpu::GpuIndex::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::gpu::GpuIndex::search_and_reconstruct search_and_reconstruct idx_t @@ -1000,6 +1037,7 @@ void faiss::gpu::GpuIndex::compute_residual (const float *x, float *residual, idx_t key) const override compute_residual + faiss::gpu::GpuIndex::compute_residual compute_residual compute_residual @@ -1028,6 +1066,7 @@ void faiss::gpu::GpuIndex::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const override compute_residual_n + faiss::gpu::GpuIndex::compute_residual_n compute_residual_n compute_residual_n @@ -1060,6 +1099,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1138,6 +1178,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -1162,6 +1203,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -1215,6 +1257,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1263,15 +1306,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1287,6 +1331,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1308,8 +1354,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1373,14 +1421,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1445,6 +1493,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1473,6 +1522,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1495,6 +1545,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1541,6 +1592,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -1571,6 +1623,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -1585,6 +1638,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -1606,6 +1660,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -1618,13 +1673,14 @@ - - + + void void faiss::gpu::GpuIndexIVFFlat::setIndex_ (GpuResources *resources, int dim, int nlist, faiss::MetricType metric, float metricArg, bool useResidual, faiss::ScalarQuantizer *scalarQ, bool interleavedLayout, IndicesOptions indicesOptions, MemorySpace space) setIndex_ + faiss::gpu::GpuIndexIVFFlat::setIndex_ GpuResources * resources @@ -1681,6 +1737,7 @@ void faiss::gpu::GpuIndex::copyFrom (const faiss::Index *index) copyFrom + faiss::gpu::GpuIndex::copyFrom const faiss::Index * index @@ -1699,6 +1756,7 @@ void faiss::gpu::GpuIndex::copyTo (faiss::Index *index) const copyTo + faiss::gpu::GpuIndex::copyTo faiss::Index * index @@ -1717,6 +1775,7 @@ int faiss::gpu::GpuIndexIVF::getCurrentNProbe_ (const SearchParameters *params) const getCurrentNProbe_ + faiss::gpu::GpuIndexIVF::getCurrentNProbe_ const SearchParameters * params @@ -1735,6 +1794,7 @@ void faiss::gpu::GpuIndexIVF::verifyIVFSettings_ () const verifyIVFSettings_ + faiss::gpu::GpuIndexIVF::verifyIVFSettings_ @@ -1748,6 +1808,7 @@ bool faiss::gpu::GpuIndexIVF::addImplRequiresIDs_ () const override addImplRequiresIDs_ + faiss::gpu::GpuIndexIVF::addImplRequiresIDs_ addImplRequiresIDs_ @@ -1763,6 +1824,7 @@ virtual void faiss::gpu::GpuIndexIVF::trainQuantizer_ (idx_t n, const float *x) trainQuantizer_ + faiss::gpu::GpuIndexIVF::trainQuantizer_ idx_t n @@ -1784,6 +1846,7 @@ void faiss::gpu::GpuIndexIVF::addImpl_ (idx_t n, const float *x, const idx_t *ids) override addImpl_ + faiss::gpu::GpuIndexIVF::addImpl_ addImpl_ idx_t @@ -1811,6 +1874,7 @@ void faiss::gpu::GpuIndexIVF::searchImpl_ (idx_t n, const float *x, int k, float *distances, idx_t *labels, const SearchParameters *params) const override searchImpl_ + faiss::gpu::GpuIndexIVF::searchImpl_ searchImpl_ idx_t @@ -1845,13 +1909,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1865,6 +1930,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1873,13 +1939,14 @@ - - + + int int faiss::Index::d d + faiss::Index::d vector dimension @@ -1894,6 +1961,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1908,6 +1976,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1922,6 +1991,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1936,6 +2006,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1950,6 +2021,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1964,6 +2036,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -1979,6 +2052,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -1994,6 +2068,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -2009,6 +2084,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -2024,6 +2100,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -2039,6 +2116,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -2054,6 +2132,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -2068,6 +2147,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -2078,29 +2158,33 @@ - + Wrapper around the GPU implementation that looks like faiss::IndexIVFFlat - - - - + + + + + + + + + + + + - - - - @@ -2109,25 +2193,37 @@ + + + + + + + + + + + + - + - + - - - - - - + + + + + clustering_index + quantizer - - ivfFlatConfig_ + + cp @@ -2139,33 +2235,15 @@ config_ - - - - - cp - - - clustering_index - quantizer - - - - - - - - - + + + - - flatConfig - @@ -2178,9 +2256,23 @@ ivfConfig_ - - - + + + + + + + flatConfig + + + + + + + + + ivfFlatConfig_ + @@ -2188,18 +2280,6 @@ - - - - - - - - - - - - @@ -2228,15 +2308,15 @@ faiss::gpu::GpuIndexIVFFlatdecode_listno faiss::gpu::GpuIndexIVFFlatdistance_t faiss::gpu::GpuIndexIVFFlatencode_listno - faiss::gpu::GpuIndexIVFFlatget_distance_computer + faiss::gpu::GpuIndexIVFFlatget_distance_computer faiss::gpu::GpuIndexIVFFlatgetCurrentNProbe_ faiss::gpu::GpuIndexIVFFlatgetDevice - faiss::gpu::GpuIndexIVFFlatgetListIndices + faiss::gpu::GpuIndexIVFFlatgetListIndices faiss::gpu::GpuIndexIVFFlatgetListLength - faiss::gpu::GpuIndexIVFFlatgetListVectorData + faiss::gpu::GpuIndexIVFFlatgetListVectorData faiss::gpu::GpuIndexIVFFlatgetMinPagingSize faiss::gpu::GpuIndexIVFFlatgetNumLists - faiss::gpu::GpuIndexIVFFlatgetResources + faiss::gpu::GpuIndexIVFFlatgetResources faiss::gpu::GpuIndexIVFFlatGpuIndex faiss::gpu::GpuIndexIVFFlatGpuIndexIVF faiss::gpu::GpuIndexIVFFlatGpuIndexIVF diff --git a/xml/classfaiss_1_1gpu_1_1GpuIndexIVFPQ.xml b/xml/classfaiss_1_1gpu_1_1GpuIndexIVFPQ.xml index 4ee0112426..2a2a0dea57 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIndexIVFPQ.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIndexIVFPQ.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuIndexIVFPQ faiss::gpu::GpuIndexIVF GpuIndexIVFPQ.h - + ProductQuantizer ProductQuantizer faiss::gpu::GpuIndexIVFPQ::pq pq + faiss::gpu::GpuIndexIVFPQ::pq @@ -24,6 +25,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -38,6 +40,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -52,6 +55,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -66,6 +70,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -80,6 +85,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -94,6 +100,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -108,6 +115,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -123,6 +131,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -138,6 +147,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -153,6 +163,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -168,6 +179,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -183,6 +195,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -198,6 +211,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -212,6 +226,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -222,13 +237,14 @@ - - + + const GpuIndexIVFPQConfig const GpuIndexIVFPQConfig faiss::gpu::GpuIndexIVFPQ::ivfpqConfig_ ivfpqConfig_ + faiss::gpu::GpuIndexIVFPQ::ivfpqConfig_ Our configuration options that we were initialized with. @@ -243,6 +259,7 @@ bool faiss::gpu::GpuIndexIVFPQ::usePrecomputedTables_ usePrecomputedTables_ + faiss::gpu::GpuIndexIVFPQ::usePrecomputedTables_ Runtime override: whether or not we use precomputed tables. @@ -257,6 +274,7 @@ int faiss::gpu::GpuIndexIVFPQ::subQuantizers_ subQuantizers_ + faiss::gpu::GpuIndexIVFPQ::subQuantizers_ Number of sub-quantizers per encoded vector. @@ -271,6 +289,7 @@ int faiss::gpu::GpuIndexIVFPQ::bitsPerCode_ bitsPerCode_ + faiss::gpu::GpuIndexIVFPQ::bitsPerCode_ Bits per sub-quantizer code. @@ -285,6 +304,7 @@ size_t faiss::gpu::GpuIndexIVFPQ::reserveMemoryVecs_ reserveMemoryVecs_ + faiss::gpu::GpuIndexIVFPQ::reserveMemoryVecs_ Desired inverted list memory reservation. @@ -299,6 +319,7 @@ std::shared_ptr<IVFPQ> faiss::gpu::GpuIndexIVFPQ::index_ index_ + faiss::gpu::GpuIndexIVFPQ::index_ @@ -313,6 +334,7 @@ const GpuIndexIVFConfig faiss::gpu::GpuIndexIVF::ivfConfig_ ivfConfig_ + faiss::gpu::GpuIndexIVF::ivfConfig_ Our configuration options. @@ -327,6 +349,7 @@ std::shared_ptr<IVFBase> faiss::gpu::GpuIndexIVF::baseIndex_ baseIndex_ + faiss::gpu::GpuIndexIVF::baseIndex_ For a trained/initialized index, this is a reference to the base class. @@ -341,6 +364,7 @@ std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::resources_ resources_ + faiss::gpu::GpuIndex::resources_ Manages streams, cuBLAS handles and scratch memory for devices. @@ -355,6 +379,7 @@ const GpuIndexConfig faiss::gpu::GpuIndex::config_ config_ + faiss::gpu::GpuIndex::config_ Our configuration options. @@ -369,6 +394,7 @@ size_t faiss::gpu::GpuIndex::minPagedSize_ minPagedSize_ + faiss::gpu::GpuIndex::minPagedSize_ Size above which we page copies from the CPU to GPU. @@ -378,13 +404,14 @@ - - + + faiss::gpu::GpuIndexIVFPQ::GpuIndexIVFPQ (GpuResourcesProvider *provider, const faiss::IndexIVFPQ *index, GpuIndexIVFPQConfig config=GpuIndexIVFPQConfig()) GpuIndexIVFPQ + faiss::gpu::GpuIndexIVFPQ::GpuIndexIVFPQ GpuResourcesProvider * provider @@ -412,6 +439,7 @@ faiss::gpu::GpuIndexIVFPQ::GpuIndexIVFPQ (GpuResourcesProvider *provider, int dims, idx_t nlist, idx_t subQuantizers, idx_t bitsPerCode, faiss::MetricType metric=faiss::METRIC_L2, GpuIndexIVFPQConfig config=GpuIndexIVFPQConfig()) GpuIndexIVFPQ + faiss::gpu::GpuIndexIVFPQ::GpuIndexIVFPQ GpuResourcesProvider * provider @@ -456,6 +484,7 @@ faiss::gpu::GpuIndexIVFPQ::GpuIndexIVFPQ (GpuResourcesProvider *provider, Index *coarseQuantizer, int dims, idx_t nlist, idx_t subQuantizers, idx_t bitsPerCode, faiss::MetricType metric=faiss::METRIC_L2, GpuIndexIVFPQConfig config=GpuIndexIVFPQConfig()) GpuIndexIVFPQ + faiss::gpu::GpuIndexIVFPQ::GpuIndexIVFPQ GpuResourcesProvider * provider @@ -504,6 +533,7 @@ faiss::gpu::GpuIndexIVFPQ::~GpuIndexIVFPQ () override ~GpuIndexIVFPQ + faiss::gpu::GpuIndexIVFPQ::~GpuIndexIVFPQ @@ -517,6 +547,7 @@ void faiss::gpu::GpuIndexIVFPQ::copyFrom (const faiss::IndexIVFPQ *index) copyFrom + faiss::gpu::GpuIndexIVFPQ::copyFrom const faiss::IndexIVFPQ * index @@ -535,6 +566,7 @@ void faiss::gpu::GpuIndexIVFPQ::copyTo (faiss::IndexIVFPQ *index) const copyTo + faiss::gpu::GpuIndexIVFPQ::copyTo faiss::IndexIVFPQ * index @@ -553,6 +585,7 @@ void faiss::gpu::GpuIndexIVFPQ::reserveMemory (size_t numVecs) reserveMemory + faiss::gpu::GpuIndexIVFPQ::reserveMemory size_t numVecs @@ -571,6 +604,7 @@ void faiss::gpu::GpuIndexIVFPQ::setPrecomputedCodes (bool enable) setPrecomputedCodes + faiss::gpu::GpuIndexIVFPQ::setPrecomputedCodes bool enable @@ -589,6 +623,7 @@ bool faiss::gpu::GpuIndexIVFPQ::getPrecomputedCodes () const getPrecomputedCodes + faiss::gpu::GpuIndexIVFPQ::getPrecomputedCodes Are pre-computed codes enabled? @@ -603,6 +638,7 @@ int faiss::gpu::GpuIndexIVFPQ::getNumSubQuantizers () const getNumSubQuantizers + faiss::gpu::GpuIndexIVFPQ::getNumSubQuantizers Return the number of sub-quantizers we are using. @@ -617,6 +653,7 @@ int faiss::gpu::GpuIndexIVFPQ::getBitsPerCode () const getBitsPerCode + faiss::gpu::GpuIndexIVFPQ::getBitsPerCode Return the number of bits per PQ code. @@ -631,6 +668,7 @@ int faiss::gpu::GpuIndexIVFPQ::getCentroidsPerSubQuantizer () const getCentroidsPerSubQuantizer + faiss::gpu::GpuIndexIVFPQ::getCentroidsPerSubQuantizer Return the number of centroids per PQ code (2^bits per code) @@ -645,6 +683,7 @@ size_t faiss::gpu::GpuIndexIVFPQ::reclaimMemory () reclaimMemory + faiss::gpu::GpuIndexIVFPQ::reclaimMemory @@ -659,6 +698,7 @@ void faiss::gpu::GpuIndexIVFPQ::reset () override reset + faiss::gpu::GpuIndexIVFPQ::reset reset @@ -674,6 +714,7 @@ void faiss::gpu::GpuIndexIVFPQ::updateQuantizer () override updateQuantizer + faiss::gpu::GpuIndexIVFPQ::updateQuantizer updateQuantizer @@ -689,6 +730,7 @@ void faiss::gpu::GpuIndexIVFPQ::train (idx_t n, const float *x) override train + faiss::gpu::GpuIndexIVFPQ::train train idx_t @@ -712,6 +754,7 @@ void faiss::gpu::GpuIndexIVF::copyFrom (const faiss::IndexIVF *index) copyFrom + faiss::gpu::GpuIndexIVF::copyFrom const faiss::IndexIVF * index @@ -730,6 +773,7 @@ void faiss::gpu::GpuIndexIVF::copyTo (faiss::IndexIVF *index) const copyTo + faiss::gpu::GpuIndexIVF::copyTo faiss::IndexIVF * index @@ -748,6 +792,7 @@ virtual idx_t faiss::gpu::GpuIndexIVF::getNumLists () const getNumLists + faiss::gpu::GpuIndexIVF::getNumLists Returns the number of inverted lists we're managing. @@ -762,6 +807,7 @@ virtual idx_t faiss::gpu::GpuIndexIVF::getListLength (idx_t listId) const getListLength + faiss::gpu::GpuIndexIVF::getListLength idx_t listId @@ -775,11 +821,12 @@ - + std::vector< uint8_t > - virtual std::vector<uint8_t> faiss::gpu::GpuIndexIVF::getListVectorData + virtual std::vector< uint8_t > faiss::gpu::GpuIndexIVF::getListVectorData (idx_t listId, bool gpuFormat=false) const getListVectorData + faiss::gpu::GpuIndexIVF::getListVectorData idx_t listId @@ -798,11 +845,12 @@ - + std::vector< idx_t > - virtual std::vector<idx_t> faiss::gpu::GpuIndexIVF::getListIndices + virtual std::vector< idx_t > faiss::gpu::GpuIndexIVF::getListIndices (idx_t listId) const getListIndices + faiss::gpu::GpuIndexIVF::getListIndices idx_t listId @@ -821,6 +869,7 @@ void faiss::gpu::GpuIndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const SearchParametersIVF *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::gpu::GpuIndexIVF::search_preassigned search_preassigned idx_t @@ -952,6 +1001,7 @@ void faiss::gpu::GpuIndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::gpu::GpuIndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1072,6 +1122,7 @@ int faiss::gpu::GpuIndex::getDevice () const getDevice + faiss::gpu::GpuIndex::getDevice Returns the device that this index is resident on. @@ -1081,11 +1132,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndex::getResources () getResources + faiss::gpu::GpuIndex::getResources @@ -1100,6 +1152,7 @@ void faiss::gpu::GpuIndex::setMinPagingSize (size_t size) setMinPagingSize + faiss::gpu::GpuIndex::setMinPagingSize size_t size @@ -1118,6 +1171,7 @@ size_t faiss::gpu::GpuIndex::getMinPagingSize () const getMinPagingSize + faiss::gpu::GpuIndex::getMinPagingSize Returns the current minimum data size for paged searches. @@ -1132,6 +1186,7 @@ void faiss::gpu::GpuIndex::add (idx_t, const float *x) override add + faiss::gpu::GpuIndex::add add add @@ -1155,6 +1210,7 @@ void faiss::gpu::GpuIndex::add_with_ids (idx_t n, const float *x, const idx_t *ids) override add_with_ids + faiss::gpu::GpuIndex::add_with_ids add_with_ids idx_t @@ -1182,6 +1238,7 @@ void faiss::gpu::GpuIndex::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const override assign + faiss::gpu::GpuIndex::assign assign idx_t @@ -1214,6 +1271,7 @@ void faiss::gpu::GpuIndex::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndex::search search idx_t @@ -1254,6 +1312,7 @@ void faiss::gpu::GpuIndex::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::gpu::GpuIndex::search_and_reconstruct search_and_reconstruct idx_t @@ -1298,6 +1357,7 @@ void faiss::gpu::GpuIndex::compute_residual (const float *x, float *residual, idx_t key) const override compute_residual + faiss::gpu::GpuIndex::compute_residual compute_residual compute_residual @@ -1326,6 +1386,7 @@ void faiss::gpu::GpuIndex::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const override compute_residual_n + faiss::gpu::GpuIndex::compute_residual_n compute_residual_n compute_residual_n @@ -1358,6 +1419,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1436,6 +1498,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -1460,6 +1523,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -1513,6 +1577,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1566,6 +1631,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1618,15 +1684,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1642,6 +1709,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1663,8 +1732,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1728,14 +1799,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1800,6 +1871,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1828,6 +1900,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1850,6 +1923,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1896,6 +1970,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -1926,6 +2001,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -1940,6 +2016,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -1961,6 +2038,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -1973,13 +2051,14 @@ - - + + void void faiss::gpu::GpuIndexIVFPQ::setIndex_ (GpuResources *resources, int dim, idx_t nlist, faiss::MetricType metric, float metricArg, int numSubQuantizers, int bitsPerSubQuantizer, bool useFloat16LookupTables, bool useMMCodeDistance, bool interleavedLayout, float *pqCentroidData, IndicesOptions indicesOptions, MemorySpace space) setIndex_ + faiss::gpu::GpuIndexIVFPQ::setIndex_ GpuResources * resources @@ -2046,6 +2125,7 @@ void faiss::gpu::GpuIndexIVFPQ::verifyPQSettings_ () const verifyPQSettings_ + faiss::gpu::GpuIndexIVFPQ::verifyPQSettings_ Throws errors if configuration settings are improper. @@ -2060,6 +2140,7 @@ void faiss::gpu::GpuIndexIVFPQ::trainResidualQuantizer_ (idx_t n, const float *x) trainResidualQuantizer_ + faiss::gpu::GpuIndexIVFPQ::trainResidualQuantizer_ idx_t n @@ -2082,6 +2163,7 @@ void faiss::gpu::GpuIndex::copyFrom (const faiss::Index *index) copyFrom + faiss::gpu::GpuIndex::copyFrom const faiss::Index * index @@ -2100,6 +2182,7 @@ void faiss::gpu::GpuIndex::copyTo (faiss::Index *index) const copyTo + faiss::gpu::GpuIndex::copyTo faiss::Index * index @@ -2118,6 +2201,7 @@ int faiss::gpu::GpuIndexIVF::getCurrentNProbe_ (const SearchParameters *params) const getCurrentNProbe_ + faiss::gpu::GpuIndexIVF::getCurrentNProbe_ const SearchParameters * params @@ -2136,6 +2220,7 @@ void faiss::gpu::GpuIndexIVF::verifyIVFSettings_ () const verifyIVFSettings_ + faiss::gpu::GpuIndexIVF::verifyIVFSettings_ @@ -2149,6 +2234,7 @@ bool faiss::gpu::GpuIndexIVF::addImplRequiresIDs_ () const override addImplRequiresIDs_ + faiss::gpu::GpuIndexIVF::addImplRequiresIDs_ addImplRequiresIDs_ @@ -2164,6 +2250,7 @@ virtual void faiss::gpu::GpuIndexIVF::trainQuantizer_ (idx_t n, const float *x) trainQuantizer_ + faiss::gpu::GpuIndexIVF::trainQuantizer_ idx_t n @@ -2185,6 +2272,7 @@ void faiss::gpu::GpuIndexIVF::addImpl_ (idx_t n, const float *x, const idx_t *ids) override addImpl_ + faiss::gpu::GpuIndexIVF::addImpl_ addImpl_ idx_t @@ -2212,6 +2300,7 @@ void faiss::gpu::GpuIndexIVF::searchImpl_ (idx_t n, const float *x, int k, float *distances, idx_t *labels, const SearchParameters *params) const override searchImpl_ + faiss::gpu::GpuIndexIVF::searchImpl_ searchImpl_ idx_t @@ -2246,13 +2335,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2266,6 +2356,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2274,27 +2365,31 @@ - + IVFPQ index for the GPU. - - - - + + + + + + + + - - - - + + + + @@ -2305,24 +2400,55 @@ + + + + + + + + + + + + - + - + + + + + + + + clustering_index + quantizer + + + cp - - - - - + + + + + + cp + + + assign_index + + + + @@ -2332,45 +2458,15 @@ config_ - - - - - cp - - - clustering_index - quantizer - - - - - - - - - ivfpqConfig_ - - - pq - - - - - - - - - + + + - - flatConfig - @@ -2383,36 +2479,31 @@ ivfConfig_ - - - - - - - - - - - + + + - - - - - + + flatConfig - - - - + + + + - - assign_index + + pq - - cp + + ivfpqConfig_ + + + + + + @@ -2444,19 +2535,19 @@ faiss::gpu::GpuIndexIVFPQdecode_listno faiss::gpu::GpuIndexIVFPQdistance_t faiss::gpu::GpuIndexIVFPQencode_listno - faiss::gpu::GpuIndexIVFPQget_distance_computer + faiss::gpu::GpuIndexIVFPQget_distance_computer faiss::gpu::GpuIndexIVFPQgetBitsPerCode faiss::gpu::GpuIndexIVFPQgetCentroidsPerSubQuantizer faiss::gpu::GpuIndexIVFPQgetCurrentNProbe_ faiss::gpu::GpuIndexIVFPQgetDevice - faiss::gpu::GpuIndexIVFPQgetListIndices + faiss::gpu::GpuIndexIVFPQgetListIndices faiss::gpu::GpuIndexIVFPQgetListLength - faiss::gpu::GpuIndexIVFPQgetListVectorData + faiss::gpu::GpuIndexIVFPQgetListVectorData faiss::gpu::GpuIndexIVFPQgetMinPagingSize faiss::gpu::GpuIndexIVFPQgetNumLists faiss::gpu::GpuIndexIVFPQgetNumSubQuantizers faiss::gpu::GpuIndexIVFPQgetPrecomputedCodes - faiss::gpu::GpuIndexIVFPQgetResources + faiss::gpu::GpuIndexIVFPQgetResources faiss::gpu::GpuIndexIVFPQGpuIndex faiss::gpu::GpuIndexIVFPQGpuIndexIVF faiss::gpu::GpuIndexIVFPQGpuIndexIVF diff --git a/xml/classfaiss_1_1gpu_1_1GpuIndexIVFScalarQuantizer.xml b/xml/classfaiss_1_1gpu_1_1GpuIndexIVFScalarQuantizer.xml index 9ecdee0de5..7b9cd95367 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuIndexIVFScalarQuantizer.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuIndexIVFScalarQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuIndexIVFScalarQuantizer faiss::gpu::GpuIndexIVF GpuIndexIVFScalarQuantizer.h - + faiss::ScalarQuantizer faiss::ScalarQuantizer faiss::gpu::GpuIndexIVFScalarQuantizer::sq sq + faiss::gpu::GpuIndexIVFScalarQuantizer::sq Exposed like the CPU version. @@ -24,6 +25,7 @@ bool faiss::gpu::GpuIndexIVFScalarQuantizer::by_residual by_residual + faiss::gpu::GpuIndexIVFScalarQuantizer::by_residual Exposed like the CPU version. @@ -38,6 +40,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -52,6 +55,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -66,6 +70,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -80,6 +85,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -94,6 +100,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -108,6 +115,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -122,6 +130,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -137,6 +146,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -152,6 +162,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -167,6 +178,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -182,6 +194,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -197,6 +210,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -212,6 +226,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -226,6 +241,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -236,13 +252,14 @@ - - + + const GpuIndexIVFScalarQuantizerConfig const GpuIndexIVFScalarQuantizerConfig faiss::gpu::GpuIndexIVFScalarQuantizer::ivfSQConfig_ ivfSQConfig_ + faiss::gpu::GpuIndexIVFScalarQuantizer::ivfSQConfig_ Our configuration options. @@ -257,6 +274,7 @@ size_t faiss::gpu::GpuIndexIVFScalarQuantizer::reserveMemoryVecs_ reserveMemoryVecs_ + faiss::gpu::GpuIndexIVFScalarQuantizer::reserveMemoryVecs_ Desired inverted list memory reservation. @@ -271,6 +289,7 @@ std::shared_ptr<IVFFlat> faiss::gpu::GpuIndexIVFScalarQuantizer::index_ index_ + faiss::gpu::GpuIndexIVFScalarQuantizer::index_ Instance that we own; contains the inverted list. @@ -285,6 +304,7 @@ const GpuIndexIVFConfig faiss::gpu::GpuIndexIVF::ivfConfig_ ivfConfig_ + faiss::gpu::GpuIndexIVF::ivfConfig_ Our configuration options. @@ -299,6 +319,7 @@ std::shared_ptr<IVFBase> faiss::gpu::GpuIndexIVF::baseIndex_ baseIndex_ + faiss::gpu::GpuIndexIVF::baseIndex_ For a trained/initialized index, this is a reference to the base class. @@ -313,6 +334,7 @@ std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::resources_ resources_ + faiss::gpu::GpuIndex::resources_ Manages streams, cuBLAS handles and scratch memory for devices. @@ -327,6 +349,7 @@ const GpuIndexConfig faiss::gpu::GpuIndex::config_ config_ + faiss::gpu::GpuIndex::config_ Our configuration options. @@ -341,6 +364,7 @@ size_t faiss::gpu::GpuIndex::minPagedSize_ minPagedSize_ + faiss::gpu::GpuIndex::minPagedSize_ Size above which we page copies from the CPU to GPU. @@ -350,13 +374,14 @@ - - + + faiss::gpu::GpuIndexIVFScalarQuantizer::GpuIndexIVFScalarQuantizer (GpuResourcesProvider *provider, const faiss::IndexIVFScalarQuantizer *index, GpuIndexIVFScalarQuantizerConfig config=GpuIndexIVFScalarQuantizerConfig()) GpuIndexIVFScalarQuantizer + faiss::gpu::GpuIndexIVFScalarQuantizer::GpuIndexIVFScalarQuantizer GpuResourcesProvider * provider @@ -384,6 +409,7 @@ faiss::gpu::GpuIndexIVFScalarQuantizer::GpuIndexIVFScalarQuantizer (GpuResourcesProvider *provider, int dims, idx_t nlist, faiss::ScalarQuantizer::QuantizerType qtype, faiss::MetricType metric=MetricType::METRIC_L2, bool encodeResidual=true, GpuIndexIVFScalarQuantizerConfig config=GpuIndexIVFScalarQuantizerConfig()) GpuIndexIVFScalarQuantizer + faiss::gpu::GpuIndexIVFScalarQuantizer::GpuIndexIVFScalarQuantizer GpuResourcesProvider * provider @@ -403,7 +429,7 @@ faiss::MetricType metric - MetricType::METRIC_L2 + MetricType::METRIC_L2 bool @@ -429,6 +455,7 @@ faiss::gpu::GpuIndexIVFScalarQuantizer::GpuIndexIVFScalarQuantizer (GpuResourcesProvider *provider, Index *coarseQuantizer, int dims, idx_t nlist, faiss::ScalarQuantizer::QuantizerType qtype, faiss::MetricType metric=MetricType::METRIC_L2, bool encodeResidual=true, GpuIndexIVFScalarQuantizerConfig config=GpuIndexIVFScalarQuantizerConfig()) GpuIndexIVFScalarQuantizer + faiss::gpu::GpuIndexIVFScalarQuantizer::GpuIndexIVFScalarQuantizer GpuResourcesProvider * provider @@ -452,7 +479,7 @@ faiss::MetricType metric - MetricType::METRIC_L2 + MetricType::METRIC_L2 bool @@ -478,6 +505,7 @@ faiss::gpu::GpuIndexIVFScalarQuantizer::~GpuIndexIVFScalarQuantizer () override ~GpuIndexIVFScalarQuantizer + faiss::gpu::GpuIndexIVFScalarQuantizer::~GpuIndexIVFScalarQuantizer @@ -491,6 +519,7 @@ void faiss::gpu::GpuIndexIVFScalarQuantizer::reserveMemory (size_t numVecs) reserveMemory + faiss::gpu::GpuIndexIVFScalarQuantizer::reserveMemory size_t numVecs @@ -509,6 +538,7 @@ void faiss::gpu::GpuIndexIVFScalarQuantizer::copyFrom (const faiss::IndexIVFScalarQuantizer *index) copyFrom + faiss::gpu::GpuIndexIVFScalarQuantizer::copyFrom const faiss::IndexIVFScalarQuantizer * index @@ -527,6 +557,7 @@ void faiss::gpu::GpuIndexIVFScalarQuantizer::copyTo (faiss::IndexIVFScalarQuantizer *index) const copyTo + faiss::gpu::GpuIndexIVFScalarQuantizer::copyTo faiss::IndexIVFScalarQuantizer * index @@ -545,6 +576,7 @@ size_t faiss::gpu::GpuIndexIVFScalarQuantizer::reclaimMemory () reclaimMemory + faiss::gpu::GpuIndexIVFScalarQuantizer::reclaimMemory @@ -559,6 +591,7 @@ void faiss::gpu::GpuIndexIVFScalarQuantizer::reset () override reset + faiss::gpu::GpuIndexIVFScalarQuantizer::reset reset @@ -574,6 +607,7 @@ void faiss::gpu::GpuIndexIVFScalarQuantizer::updateQuantizer () override updateQuantizer + faiss::gpu::GpuIndexIVFScalarQuantizer::updateQuantizer updateQuantizer @@ -589,6 +623,7 @@ void faiss::gpu::GpuIndexIVFScalarQuantizer::train (idx_t n, const float *x) override train + faiss::gpu::GpuIndexIVFScalarQuantizer::train train idx_t @@ -612,6 +647,7 @@ void faiss::gpu::GpuIndexIVF::copyFrom (const faiss::IndexIVF *index) copyFrom + faiss::gpu::GpuIndexIVF::copyFrom const faiss::IndexIVF * index @@ -630,6 +666,7 @@ void faiss::gpu::GpuIndexIVF::copyTo (faiss::IndexIVF *index) const copyTo + faiss::gpu::GpuIndexIVF::copyTo faiss::IndexIVF * index @@ -648,6 +685,7 @@ virtual idx_t faiss::gpu::GpuIndexIVF::getNumLists () const getNumLists + faiss::gpu::GpuIndexIVF::getNumLists Returns the number of inverted lists we're managing. @@ -662,6 +700,7 @@ virtual idx_t faiss::gpu::GpuIndexIVF::getListLength (idx_t listId) const getListLength + faiss::gpu::GpuIndexIVF::getListLength idx_t listId @@ -675,11 +714,12 @@ - + std::vector< uint8_t > - virtual std::vector<uint8_t> faiss::gpu::GpuIndexIVF::getListVectorData + virtual std::vector< uint8_t > faiss::gpu::GpuIndexIVF::getListVectorData (idx_t listId, bool gpuFormat=false) const getListVectorData + faiss::gpu::GpuIndexIVF::getListVectorData idx_t listId @@ -698,11 +738,12 @@ - + std::vector< idx_t > - virtual std::vector<idx_t> faiss::gpu::GpuIndexIVF::getListIndices + virtual std::vector< idx_t > faiss::gpu::GpuIndexIVF::getListIndices (idx_t listId) const getListIndices + faiss::gpu::GpuIndexIVF::getListIndices idx_t listId @@ -721,6 +762,7 @@ void faiss::gpu::GpuIndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const SearchParametersIVF *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::gpu::GpuIndexIVF::search_preassigned search_preassigned idx_t @@ -852,6 +894,7 @@ void faiss::gpu::GpuIndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::gpu::GpuIndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -972,6 +1015,7 @@ int faiss::gpu::GpuIndex::getDevice () const getDevice + faiss::gpu::GpuIndex::getDevice Returns the device that this index is resident on. @@ -981,11 +1025,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndex::getResources () getResources + faiss::gpu::GpuIndex::getResources @@ -1000,6 +1045,7 @@ void faiss::gpu::GpuIndex::setMinPagingSize (size_t size) setMinPagingSize + faiss::gpu::GpuIndex::setMinPagingSize size_t size @@ -1018,6 +1064,7 @@ size_t faiss::gpu::GpuIndex::getMinPagingSize () const getMinPagingSize + faiss::gpu::GpuIndex::getMinPagingSize Returns the current minimum data size for paged searches. @@ -1032,6 +1079,7 @@ void faiss::gpu::GpuIndex::add (idx_t, const float *x) override add + faiss::gpu::GpuIndex::add add add @@ -1055,6 +1103,7 @@ void faiss::gpu::GpuIndex::add_with_ids (idx_t n, const float *x, const idx_t *ids) override add_with_ids + faiss::gpu::GpuIndex::add_with_ids add_with_ids idx_t @@ -1082,6 +1131,7 @@ void faiss::gpu::GpuIndex::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const override assign + faiss::gpu::GpuIndex::assign assign idx_t @@ -1114,6 +1164,7 @@ void faiss::gpu::GpuIndex::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndex::search search idx_t @@ -1154,6 +1205,7 @@ void faiss::gpu::GpuIndex::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::gpu::GpuIndex::search_and_reconstruct search_and_reconstruct idx_t @@ -1198,6 +1250,7 @@ void faiss::gpu::GpuIndex::compute_residual (const float *x, float *residual, idx_t key) const override compute_residual + faiss::gpu::GpuIndex::compute_residual compute_residual compute_residual @@ -1226,6 +1279,7 @@ void faiss::gpu::GpuIndex::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const override compute_residual_n + faiss::gpu::GpuIndex::compute_residual_n compute_residual_n compute_residual_n @@ -1258,6 +1312,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1336,6 +1391,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -1360,6 +1416,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -1413,6 +1470,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1466,6 +1524,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1518,15 +1577,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1542,6 +1602,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1563,8 +1625,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1628,14 +1692,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1700,6 +1764,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1728,6 +1793,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1750,6 +1816,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1796,6 +1863,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -1826,6 +1894,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -1840,6 +1909,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -1861,6 +1931,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -1873,13 +1944,14 @@ - - + + void void faiss::gpu::GpuIndexIVFScalarQuantizer::verifySQSettings_ () const verifySQSettings_ + faiss::gpu::GpuIndexIVFScalarQuantizer::verifySQSettings_ Validates index SQ parameters. @@ -1894,6 +1966,7 @@ void faiss::gpu::GpuIndexIVFScalarQuantizer::trainResiduals_ (idx_t n, const float *x) trainResiduals_ + faiss::gpu::GpuIndexIVFScalarQuantizer::trainResiduals_ idx_t n @@ -1916,6 +1989,7 @@ void faiss::gpu::GpuIndex::copyFrom (const faiss::Index *index) copyFrom + faiss::gpu::GpuIndex::copyFrom const faiss::Index * index @@ -1934,6 +2008,7 @@ void faiss::gpu::GpuIndex::copyTo (faiss::Index *index) const copyTo + faiss::gpu::GpuIndex::copyTo faiss::Index * index @@ -1952,6 +2027,7 @@ int faiss::gpu::GpuIndexIVF::getCurrentNProbe_ (const SearchParameters *params) const getCurrentNProbe_ + faiss::gpu::GpuIndexIVF::getCurrentNProbe_ const SearchParameters * params @@ -1970,6 +2046,7 @@ void faiss::gpu::GpuIndexIVF::verifyIVFSettings_ () const verifyIVFSettings_ + faiss::gpu::GpuIndexIVF::verifyIVFSettings_ @@ -1983,6 +2060,7 @@ bool faiss::gpu::GpuIndexIVF::addImplRequiresIDs_ () const override addImplRequiresIDs_ + faiss::gpu::GpuIndexIVF::addImplRequiresIDs_ addImplRequiresIDs_ @@ -1998,6 +2076,7 @@ virtual void faiss::gpu::GpuIndexIVF::trainQuantizer_ (idx_t n, const float *x) trainQuantizer_ + faiss::gpu::GpuIndexIVF::trainQuantizer_ idx_t n @@ -2019,6 +2098,7 @@ void faiss::gpu::GpuIndexIVF::addImpl_ (idx_t n, const float *x, const idx_t *ids) override addImpl_ + faiss::gpu::GpuIndexIVF::addImpl_ addImpl_ idx_t @@ -2046,6 +2126,7 @@ void faiss::gpu::GpuIndexIVF::searchImpl_ (idx_t n, const float *x, int k, float *distances, idx_t *labels, const SearchParameters *params) const override searchImpl_ + faiss::gpu::GpuIndexIVF::searchImpl_ searchImpl_ idx_t @@ -2080,13 +2161,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2100,6 +2182,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2108,29 +2191,33 @@ - + Wrapper around the GPU implementation that looks like faiss::IndexIVFScalarQuantizer - - - - + + + + + + + + + + + + - - - - @@ -2139,38 +2226,42 @@ + + + + + + + + + + + + - + - + - - - - - - - - - sq + + + + + clustering_index + quantizer - - ivfSQConfig_ + + cp - - - - - - - config_ - + + + @@ -2178,33 +2269,24 @@ - - - - - cp + + + + - - clustering_index - quantizer + + config_ - - - - - - - + + + - - flatConfig - @@ -2217,24 +2299,25 @@ ivfConfig_ - - - - - - - - - - - + + + + + flatConfig + - - - - + + + + + + + sq + + + ivfSQConfig_ @@ -2272,15 +2355,15 @@ faiss::gpu::GpuIndexIVFScalarQuantizerdecode_listno faiss::gpu::GpuIndexIVFScalarQuantizerdistance_t faiss::gpu::GpuIndexIVFScalarQuantizerencode_listno - faiss::gpu::GpuIndexIVFScalarQuantizerget_distance_computer + faiss::gpu::GpuIndexIVFScalarQuantizerget_distance_computer faiss::gpu::GpuIndexIVFScalarQuantizergetCurrentNProbe_ faiss::gpu::GpuIndexIVFScalarQuantizergetDevice - faiss::gpu::GpuIndexIVFScalarQuantizergetListIndices + faiss::gpu::GpuIndexIVFScalarQuantizergetListIndices faiss::gpu::GpuIndexIVFScalarQuantizergetListLength - faiss::gpu::GpuIndexIVFScalarQuantizergetListVectorData + faiss::gpu::GpuIndexIVFScalarQuantizergetListVectorData faiss::gpu::GpuIndexIVFScalarQuantizergetMinPagingSize faiss::gpu::GpuIndexIVFScalarQuantizergetNumLists - faiss::gpu::GpuIndexIVFScalarQuantizergetResources + faiss::gpu::GpuIndexIVFScalarQuantizergetResources faiss::gpu::GpuIndexIVFScalarQuantizerGpuIndex faiss::gpu::GpuIndexIVFScalarQuantizerGpuIndexIVF faiss::gpu::GpuIndexIVFScalarQuantizerGpuIndexIVF diff --git a/xml/classfaiss_1_1gpu_1_1GpuResources.xml b/xml/classfaiss_1_1gpu_1_1GpuResources.xml index 25b1df88a2..cd0931a81d 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuResources.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuResources.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuResources faiss::gpu::StandardGpuResourcesImpl GpuResources.h - + virtual faiss::gpu::GpuResources::~GpuResources () ~GpuResources + faiss::gpu::GpuResources::~GpuResources @@ -23,6 +24,7 @@ virtual void faiss::gpu::GpuResources::initializeForDevice (int device)=0 initializeForDevice + faiss::gpu::GpuResources::initializeForDevice initializeForDevice int @@ -42,6 +44,7 @@ virtual bool faiss::gpu::GpuResources::supportsBFloat16 (int device)=0 supportsBFloat16 + faiss::gpu::GpuResources::supportsBFloat16 supportsBFloat16 int @@ -61,6 +64,7 @@ virtual cublasHandle_t faiss::gpu::GpuResources::getBlasHandle (int device)=0 getBlasHandle + faiss::gpu::GpuResources::getBlasHandle getBlasHandle int @@ -80,6 +84,7 @@ virtual cudaStream_t faiss::gpu::GpuResources::getDefaultStream (int device)=0 getDefaultStream + faiss::gpu::GpuResources::getDefaultStream getDefaultStream int @@ -99,6 +104,7 @@ virtual void faiss::gpu::GpuResources::setDefaultStream (int device, cudaStream_t stream)=0 setDefaultStream + faiss::gpu::GpuResources::setDefaultStream setDefaultStream int @@ -117,12 +123,13 @@ - + std::vector< cudaStream_t > - virtual std::vector<cudaStream_t> faiss::gpu::GpuResources::getAlternateStreams + virtual std::vector< cudaStream_t > faiss::gpu::GpuResources::getAlternateStreams (int device)=0 getAlternateStreams - getAlternateStreams + faiss::gpu::GpuResources::getAlternateStreams + getAlternateStreams int device @@ -136,12 +143,13 @@ - + void * - virtual void* faiss::gpu::GpuResources::allocMemory + virtual void * faiss::gpu::GpuResources::allocMemory (const AllocRequest &req)=0 allocMemory - allocMemory + faiss::gpu::GpuResources::allocMemory + allocMemory const AllocRequest & req @@ -160,6 +168,7 @@ virtual void faiss::gpu::GpuResources::deallocMemory (int device, void *in)=0 deallocMemory + faiss::gpu::GpuResources::deallocMemory deallocMemory int @@ -183,6 +192,7 @@ virtual size_t faiss::gpu::GpuResources::getTempMemoryAvailable (int device) const =0 getTempMemoryAvailable + faiss::gpu::GpuResources::getTempMemoryAvailable getTempMemoryAvailable int @@ -197,12 +207,13 @@ - + std::pair< void *, size_t > - virtual std::pair<void*, size_t> faiss::gpu::GpuResources::getPinnedMemory + virtual std::pair< void *, size_t > faiss::gpu::GpuResources::getPinnedMemory ()=0 getPinnedMemory - getPinnedMemory + faiss::gpu::GpuResources::getPinnedMemory + getPinnedMemory Returns the available CPU pinned memory buffer. @@ -217,6 +228,7 @@ virtual cudaStream_t faiss::gpu::GpuResources::getAsyncCopyStream (int device)=0 getAsyncCopyStream + faiss::gpu::GpuResources::getAsyncCopyStream getAsyncCopyStream int @@ -236,6 +248,7 @@ bool faiss::gpu::GpuResources::supportsBFloat16CurrentDevice () supportsBFloat16CurrentDevice + faiss::gpu::GpuResources::supportsBFloat16CurrentDevice Does the current GPU support bfloat16? @@ -251,6 +264,7 @@ cublasHandle_t faiss::gpu::GpuResources::getBlasHandleCurrentDevice () getBlasHandleCurrentDevice + faiss::gpu::GpuResources::getBlasHandleCurrentDevice Calls getBlasHandle with the current device. @@ -265,6 +279,7 @@ cudaStream_t faiss::gpu::GpuResources::getDefaultStreamCurrentDevice () getDefaultStreamCurrentDevice + faiss::gpu::GpuResources::getDefaultStreamCurrentDevice Calls getDefaultStream with the current device. @@ -279,6 +294,7 @@ size_t faiss::gpu::GpuResources::getTempMemoryAvailableCurrentDevice () const getTempMemoryAvailableCurrentDevice + faiss::gpu::GpuResources::getTempMemoryAvailableCurrentDevice Calls getTempMemoryAvailable with the current device. @@ -293,6 +309,7 @@ GpuMemoryReservation faiss::gpu::GpuResources::allocMemoryHandle (const AllocRequest &req) allocMemoryHandle + faiss::gpu::GpuResources::allocMemoryHandle const AllocRequest & req @@ -311,6 +328,7 @@ void faiss::gpu::GpuResources::syncDefaultStream (int device) syncDefaultStream + faiss::gpu::GpuResources::syncDefaultStream int device @@ -329,6 +347,7 @@ void faiss::gpu::GpuResources::syncDefaultStreamCurrentDevice () syncDefaultStreamCurrentDevice + faiss::gpu::GpuResources::syncDefaultStreamCurrentDevice Calls syncDefaultStream for the current device. @@ -338,11 +357,12 @@ - + std::vector< cudaStream_t > - std::vector<cudaStream_t> faiss::gpu::GpuResources::getAlternateStreamsCurrentDevice + std::vector< cudaStream_t > faiss::gpu::GpuResources::getAlternateStreamsCurrentDevice () getAlternateStreamsCurrentDevice + faiss::gpu::GpuResources::getAlternateStreamsCurrentDevice Calls getAlternateStreams for the current device. @@ -357,6 +377,7 @@ cudaStream_t faiss::gpu::GpuResources::getAsyncCopyStreamCurrentDevice () getAsyncCopyStreamCurrentDevice + faiss::gpu::GpuResources::getAsyncCopyStreamCurrentDevice Calls getAsyncCopyStream for the current device. @@ -366,38 +387,38 @@ - + Base class of GPU-side resource provider; hides provision of cuBLAS handles, CUDA streams and all device memory allocation performed + + + + - - - - - faiss::gpu::GpuResourcesallocMemory + faiss::gpu::GpuResourcesallocMemory faiss::gpu::GpuResourcesallocMemoryHandle faiss::gpu::GpuResourcesdeallocMemory - faiss::gpu::GpuResourcesgetAlternateStreams - faiss::gpu::GpuResourcesgetAlternateStreamsCurrentDevice + faiss::gpu::GpuResourcesgetAlternateStreams + faiss::gpu::GpuResourcesgetAlternateStreamsCurrentDevice faiss::gpu::GpuResourcesgetAsyncCopyStream faiss::gpu::GpuResourcesgetAsyncCopyStreamCurrentDevice faiss::gpu::GpuResourcesgetBlasHandle faiss::gpu::GpuResourcesgetBlasHandleCurrentDevice faiss::gpu::GpuResourcesgetDefaultStream faiss::gpu::GpuResourcesgetDefaultStreamCurrentDevice - faiss::gpu::GpuResourcesgetPinnedMemory + faiss::gpu::GpuResourcesgetPinnedMemory faiss::gpu::GpuResourcesgetTempMemoryAvailable faiss::gpu::GpuResourcesgetTempMemoryAvailableCurrentDevice faiss::gpu::GpuResourcesinitializeForDevice diff --git a/xml/classfaiss_1_1gpu_1_1GpuResourcesProvider.xml b/xml/classfaiss_1_1gpu_1_1GpuResourcesProvider.xml index a725ee71dc..c7fe9985f6 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuResourcesProvider.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuResourcesProvider.xml @@ -1,16 +1,17 @@ - + faiss::gpu::GpuResourcesProvider faiss::gpu::GpuResourcesProviderFromInstance faiss::gpu::StandardGpuResources GpuResources.h - + virtual faiss::gpu::GpuResourcesProvider::~GpuResourcesProvider () ~GpuResourcesProvider + faiss::gpu::GpuResourcesProvider::~GpuResourcesProvider @@ -19,13 +20,14 @@ - + std::shared_ptr< GpuResources > - virtual std::shared_ptr<GpuResources> faiss::gpu::GpuResourcesProvider::getResources + virtual std::shared_ptr< GpuResources > faiss::gpu::GpuResourcesProvider::getResources ()=0 getResources - getResources - getResources + faiss::gpu::GpuResourcesProvider::getResources + getResources + getResources Returns the shared resources object. @@ -35,19 +37,13 @@ - + Interface for a provider of a shared resources object. This is to avoid interfacing std::shared_ptr to Python - - - - - - @@ -58,10 +54,16 @@ + + + + + + - faiss::gpu::GpuResourcesProvidergetResources + faiss::gpu::GpuResourcesProvidergetResources faiss::gpu::GpuResourcesProvider~GpuResourcesProvider diff --git a/xml/classfaiss_1_1gpu_1_1GpuResourcesProviderFromInstance.xml b/xml/classfaiss_1_1gpu_1_1GpuResourcesProviderFromInstance.xml index 93dde0263a..e5d1817ce9 100644 --- a/xml/classfaiss_1_1gpu_1_1GpuResourcesProviderFromInstance.xml +++ b/xml/classfaiss_1_1gpu_1_1GpuResourcesProviderFromInstance.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuResourcesProviderFromInstance faiss::gpu::GpuResourcesProvider GpuResources.h - + std::shared_ptr< GpuResources > std::shared_ptr<GpuResources> faiss::gpu::GpuResourcesProviderFromInstance::res_ res_ + faiss::gpu::GpuResourcesProviderFromInstance::res_ @@ -18,13 +19,14 @@ - - + + faiss::gpu::GpuResourcesProviderFromInstance::GpuResourcesProviderFromInstance (std::shared_ptr< GpuResources > p) GpuResourcesProviderFromInstance + faiss::gpu::GpuResourcesProviderFromInstance::GpuResourcesProviderFromInstance std::shared_ptr< GpuResources > p @@ -42,6 +44,7 @@ faiss::gpu::GpuResourcesProviderFromInstance::~GpuResourcesProviderFromInstance () override ~GpuResourcesProviderFromInstance + faiss::gpu::GpuResourcesProviderFromInstance::~GpuResourcesProviderFromInstance @@ -50,12 +53,13 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuResourcesProviderFromInstance::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuResourcesProviderFromInstance::getResources () override getResources - getResources + faiss::gpu::GpuResourcesProviderFromInstance::getResources + getResources Returns the shared resources object. @@ -65,7 +69,7 @@ - + @@ -97,7 +101,7 @@ - faiss::gpu::GpuResourcesProviderFromInstancegetResources + faiss::gpu::GpuResourcesProviderFromInstancegetResources faiss::gpu::GpuResourcesProviderFromInstanceGpuResourcesProviderFromInstance faiss::gpu::GpuResourcesProviderFromInstanceres_ faiss::gpu::GpuResourcesProviderFromInstance~GpuResourcesProvider diff --git a/xml/classfaiss_1_1gpu_1_1KernelTimer.xml b/xml/classfaiss_1_1gpu_1_1KernelTimer.xml index b788bdef17..b659cbeb94 100644 --- a/xml/classfaiss_1_1gpu_1_1KernelTimer.xml +++ b/xml/classfaiss_1_1gpu_1_1KernelTimer.xml @@ -1,14 +1,15 @@ - + faiss::gpu::KernelTimer Timer.h - + cudaEvent_t cudaEvent_t faiss::gpu::KernelTimer::startEvent_ startEvent_ + faiss::gpu::KernelTimer::startEvent_ @@ -22,6 +23,7 @@ cudaEvent_t faiss::gpu::KernelTimer::stopEvent_ stopEvent_ + faiss::gpu::KernelTimer::stopEvent_ @@ -35,6 +37,7 @@ cudaStream_t faiss::gpu::KernelTimer::stream_ stream_ + faiss::gpu::KernelTimer::stream_ @@ -48,6 +51,7 @@ bool faiss::gpu::KernelTimer::valid_ valid_ + faiss::gpu::KernelTimer::valid_ @@ -56,13 +60,14 @@ - - + + faiss::gpu::KernelTimer::KernelTimer (cudaStream_t stream=nullptr) KernelTimer + faiss::gpu::KernelTimer::KernelTimer cudaStream_t stream @@ -82,6 +87,7 @@ faiss::gpu::KernelTimer::~KernelTimer () ~KernelTimer + faiss::gpu::KernelTimer::~KernelTimer Destructor releases event resources. @@ -96,6 +102,7 @@ float faiss::gpu::KernelTimer::elapsedMilliseconds () elapsedMilliseconds + faiss::gpu::KernelTimer::elapsedMilliseconds @@ -105,7 +112,7 @@ - + Utility class for timing execution of a kernel. diff --git a/xml/classfaiss_1_1gpu_1_1StackDeviceMemory.xml b/xml/classfaiss_1_1gpu_1_1StackDeviceMemory.xml index 0d6a1d8a7a..480de7a401 100644 --- a/xml/classfaiss_1_1gpu_1_1StackDeviceMemory.xml +++ b/xml/classfaiss_1_1gpu_1_1StackDeviceMemory.xml @@ -1,16 +1,17 @@ - + faiss::gpu::StackDeviceMemory StackDeviceMemory.h faiss::gpu::StackDeviceMemory::Range faiss::gpu::StackDeviceMemory::Stack - + int int faiss::gpu::StackDeviceMemory::device_ device_ + faiss::gpu::StackDeviceMemory::device_ Our device. @@ -25,6 +26,7 @@ Stack faiss::gpu::StackDeviceMemory::stack_ stack_ + faiss::gpu::StackDeviceMemory::stack_ Memory stack. @@ -34,13 +36,14 @@ - - + + faiss::gpu::StackDeviceMemory::StackDeviceMemory (GpuResources *res, int device, size_t allocPerDevice) StackDeviceMemory + faiss::gpu::StackDeviceMemory::StackDeviceMemory GpuResources * res @@ -67,6 +70,7 @@ faiss::gpu::StackDeviceMemory::StackDeviceMemory (int device, void *p, size_t size, bool isOwner) StackDeviceMemory + faiss::gpu::StackDeviceMemory::StackDeviceMemory int device @@ -97,6 +101,7 @@ faiss::gpu::StackDeviceMemory::~StackDeviceMemory () ~StackDeviceMemory + faiss::gpu::StackDeviceMemory::~StackDeviceMemory @@ -110,6 +115,7 @@ int faiss::gpu::StackDeviceMemory::getDevice () const getDevice + faiss::gpu::StackDeviceMemory::getDevice @@ -118,11 +124,12 @@ - + void * - void* faiss::gpu::StackDeviceMemory::allocMemory + void * faiss::gpu::StackDeviceMemory::allocMemory (cudaStream_t stream, size_t size) allocMemory + faiss::gpu::StackDeviceMemory::allocMemory cudaStream_t stream @@ -145,6 +152,7 @@ void faiss::gpu::StackDeviceMemory::deallocMemory (int device, cudaStream_t, size_t size, void *p) deallocMemory + faiss::gpu::StackDeviceMemory::deallocMemory int device @@ -173,6 +181,7 @@ size_t faiss::gpu::StackDeviceMemory::getSizeAvailable () const getSizeAvailable + faiss::gpu::StackDeviceMemory::getSizeAvailable @@ -186,6 +195,7 @@ std::string faiss::gpu::StackDeviceMemory::toString () const toString + faiss::gpu::StackDeviceMemory::toString @@ -194,7 +204,7 @@ - + @@ -205,13 +215,6 @@ - - - - - res_ - - @@ -219,10 +222,17 @@ stack_ + + + + + res_ + + - faiss::gpu::StackDeviceMemoryallocMemory + faiss::gpu::StackDeviceMemoryallocMemory faiss::gpu::StackDeviceMemorydeallocMemory faiss::gpu::StackDeviceMemorydevice_ faiss::gpu::StackDeviceMemorygetDevice diff --git a/xml/classfaiss_1_1gpu_1_1StandardGpuResources.xml b/xml/classfaiss_1_1gpu_1_1StandardGpuResources.xml index d3dc5124ac..b97e47648a 100644 --- a/xml/classfaiss_1_1gpu_1_1StandardGpuResources.xml +++ b/xml/classfaiss_1_1gpu_1_1StandardGpuResources.xml @@ -1,15 +1,16 @@ - + faiss::gpu::StandardGpuResources faiss::gpu::GpuResourcesProvider StandardGpuResources.h - + std::shared_ptr< StandardGpuResourcesImpl > std::shared_ptr<StandardGpuResourcesImpl> faiss::gpu::StandardGpuResources::res_ res_ + faiss::gpu::StandardGpuResources::res_ @@ -18,13 +19,14 @@ - - + + faiss::gpu::StandardGpuResources::StandardGpuResources () StandardGpuResources + faiss::gpu::StandardGpuResources::StandardGpuResources @@ -38,6 +40,7 @@ faiss::gpu::StandardGpuResources::~StandardGpuResources () override ~StandardGpuResources + faiss::gpu::StandardGpuResources::~StandardGpuResources @@ -46,12 +49,13 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::StandardGpuResources::getResources + std::shared_ptr< GpuResources > faiss::gpu::StandardGpuResources::getResources () override getResources - getResources + faiss::gpu::StandardGpuResources::getResources + getResources Returns the shared resources object. @@ -66,6 +70,7 @@ bool faiss::gpu::StandardGpuResources::supportsBFloat16 (int device) supportsBFloat16 + faiss::gpu::StandardGpuResources::supportsBFloat16 int device @@ -84,6 +89,7 @@ bool faiss::gpu::StandardGpuResources::supportsBFloat16CurrentDevice () supportsBFloat16CurrentDevice + faiss::gpu::StandardGpuResources::supportsBFloat16CurrentDevice Whether or not the current device supports native bfloat16 arithmetic. @@ -98,6 +104,7 @@ void faiss::gpu::StandardGpuResources::noTempMemory () noTempMemory + faiss::gpu::StandardGpuResources::noTempMemory @@ -112,6 +119,7 @@ void faiss::gpu::StandardGpuResources::setTempMemory (size_t size) setTempMemory + faiss::gpu::StandardGpuResources::setTempMemory size_t size @@ -130,6 +138,7 @@ void faiss::gpu::StandardGpuResources::setPinnedMemory (size_t size) setPinnedMemory + faiss::gpu::StandardGpuResources::setPinnedMemory size_t size @@ -148,6 +157,7 @@ void faiss::gpu::StandardGpuResources::setDefaultStream (int device, cudaStream_t stream) setDefaultStream + faiss::gpu::StandardGpuResources::setDefaultStream int device @@ -170,6 +180,7 @@ void faiss::gpu::StandardGpuResources::revertDefaultStream (int device) revertDefaultStream + faiss::gpu::StandardGpuResources::revertDefaultStream int device @@ -188,6 +199,7 @@ void faiss::gpu::StandardGpuResources::setDefaultNullStreamAllDevices () setDefaultNullStreamAllDevices + faiss::gpu::StandardGpuResources::setDefaultNullStreamAllDevices @@ -197,11 +209,12 @@ - + std::map< int, std::map< std::string, std::pair< int, size_t > > > - std::map<int, std::map<std::string, std::pair<int, size_t> > > faiss::gpu::StandardGpuResources::getMemoryInfo + std::map< int, std::map< std::string, std::pair< int, size_t > > > faiss::gpu::StandardGpuResources::getMemoryInfo () const getMemoryInfo + faiss::gpu::StandardGpuResources::getMemoryInfo Export a description of memory used for Python. @@ -216,6 +229,7 @@ cudaStream_t faiss::gpu::StandardGpuResources::getDefaultStream (int device) getDefaultStream + faiss::gpu::StandardGpuResources::getDefaultStream int device @@ -234,6 +248,7 @@ size_t faiss::gpu::StandardGpuResources::getTempMemoryAvailable (int device) const getTempMemoryAvailable + faiss::gpu::StandardGpuResources::getTempMemoryAvailable int device @@ -252,6 +267,7 @@ void faiss::gpu::StandardGpuResources::syncDefaultStreamCurrentDevice () syncDefaultStreamCurrentDevice + faiss::gpu::StandardGpuResources::syncDefaultStreamCurrentDevice Synchronize our default stream with the CPU. @@ -266,6 +282,7 @@ void faiss::gpu::StandardGpuResources::setLogMemoryAllocations (bool enable) setLogMemoryAllocations + faiss::gpu::StandardGpuResources::setLogMemoryAllocations bool enable @@ -279,41 +296,41 @@ - + Default implementation of GpuResources that allocates a cuBLAS stream and 2 streams for use, as well as temporary memory. Internally, the Faiss GPU code uses the instance managed by getResources, but this is the user-facing object that is internally reference counted. + + + + + + - - - - - - faiss::gpu::StandardGpuResourcesgetDefaultStream - faiss::gpu::StandardGpuResourcesgetMemoryInfo - faiss::gpu::StandardGpuResourcesgetResources + faiss::gpu::StandardGpuResourcesgetMemoryInfo + faiss::gpu::StandardGpuResourcesgetResources faiss::gpu::StandardGpuResourcesgetTempMemoryAvailable faiss::gpu::StandardGpuResourcesnoTempMemory faiss::gpu::StandardGpuResourcesres_ diff --git a/xml/classfaiss_1_1gpu_1_1StandardGpuResourcesImpl.xml b/xml/classfaiss_1_1gpu_1_1StandardGpuResourcesImpl.xml index df9323c3a2..c7ea7c1c44 100644 --- a/xml/classfaiss_1_1gpu_1_1StandardGpuResourcesImpl.xml +++ b/xml/classfaiss_1_1gpu_1_1StandardGpuResourcesImpl.xml @@ -1,15 +1,16 @@ - + faiss::gpu::StandardGpuResourcesImpl faiss::gpu::GpuResources StandardGpuResources.h - + std::unordered_map< int, std::unordered_map< void *, AllocRequest > > std::unordered_map<int, std::unordered_map<void*, AllocRequest> > faiss::gpu::StandardGpuResourcesImpl::allocs_ allocs_ + faiss::gpu::StandardGpuResourcesImpl::allocs_ @@ -24,6 +25,7 @@ std::unordered_map<int, std::unique_ptr<StackDeviceMemory> > faiss::gpu::StandardGpuResourcesImpl::tempMemory_ tempMemory_ + faiss::gpu::StandardGpuResourcesImpl::tempMemory_ Temporary memory provider, per each device. @@ -38,6 +40,7 @@ std::unordered_map<int, cudaStream_t> faiss::gpu::StandardGpuResourcesImpl::defaultStreams_ defaultStreams_ + faiss::gpu::StandardGpuResourcesImpl::defaultStreams_ Our default stream that work is ordered on, one per each device. @@ -52,6 +55,7 @@ std::unordered_map<int, cudaStream_t> faiss::gpu::StandardGpuResourcesImpl::userDefaultStreams_ userDefaultStreams_ + faiss::gpu::StandardGpuResourcesImpl::userDefaultStreams_ @@ -66,6 +70,7 @@ std::unordered_map<int, std::vector<cudaStream_t> > faiss::gpu::StandardGpuResourcesImpl::alternateStreams_ alternateStreams_ + faiss::gpu::StandardGpuResourcesImpl::alternateStreams_ Other streams we can use, per each device. @@ -80,6 +85,7 @@ std::unordered_map<int, cudaStream_t> faiss::gpu::StandardGpuResourcesImpl::asyncCopyStreams_ asyncCopyStreams_ + faiss::gpu::StandardGpuResourcesImpl::asyncCopyStreams_ Async copy stream to use for GPU <-> CPU pinned memory copies. @@ -94,6 +100,7 @@ std::unordered_map<int, cublasHandle_t> faiss::gpu::StandardGpuResourcesImpl::blasHandles_ blasHandles_ + faiss::gpu::StandardGpuResourcesImpl::blasHandles_ cuBLAS handle for each device @@ -108,6 +115,7 @@ void* faiss::gpu::StandardGpuResourcesImpl::pinnedMemAlloc_ pinnedMemAlloc_ + faiss::gpu::StandardGpuResourcesImpl::pinnedMemAlloc_ Pinned memory allocation for use with this GPU. @@ -122,6 +130,7 @@ size_t faiss::gpu::StandardGpuResourcesImpl::pinnedMemAllocSize_ pinnedMemAllocSize_ + faiss::gpu::StandardGpuResourcesImpl::pinnedMemAllocSize_ @@ -135,6 +144,7 @@ size_t faiss::gpu::StandardGpuResourcesImpl::tempMemSize_ tempMemSize_ + faiss::gpu::StandardGpuResourcesImpl::tempMemSize_ @@ -149,6 +159,7 @@ size_t faiss::gpu::StandardGpuResourcesImpl::pinnedMemSize_ pinnedMemSize_ + faiss::gpu::StandardGpuResourcesImpl::pinnedMemSize_ Amount of pinned memory we should allocate. @@ -163,6 +174,7 @@ bool faiss::gpu::StandardGpuResourcesImpl::allocLogging_ allocLogging_ + faiss::gpu::StandardGpuResourcesImpl::allocLogging_ Whether or not we log every GPU memory allocation and deallocation. @@ -172,13 +184,14 @@ - - + + faiss::gpu::StandardGpuResourcesImpl::StandardGpuResourcesImpl () StandardGpuResourcesImpl + faiss::gpu::StandardGpuResourcesImpl::StandardGpuResourcesImpl @@ -192,6 +205,7 @@ faiss::gpu::StandardGpuResourcesImpl::~StandardGpuResourcesImpl () override ~StandardGpuResourcesImpl + faiss::gpu::StandardGpuResourcesImpl::~StandardGpuResourcesImpl @@ -205,6 +219,7 @@ bool faiss::gpu::StandardGpuResourcesImpl::supportsBFloat16 (int device) override supportsBFloat16 + faiss::gpu::StandardGpuResourcesImpl::supportsBFloat16 supportsBFloat16 int @@ -224,6 +239,7 @@ void faiss::gpu::StandardGpuResourcesImpl::noTempMemory () noTempMemory + faiss::gpu::StandardGpuResourcesImpl::noTempMemory @@ -238,6 +254,7 @@ void faiss::gpu::StandardGpuResourcesImpl::setTempMemory (size_t size) setTempMemory + faiss::gpu::StandardGpuResourcesImpl::setTempMemory size_t size @@ -256,6 +273,7 @@ void faiss::gpu::StandardGpuResourcesImpl::setPinnedMemory (size_t size) setPinnedMemory + faiss::gpu::StandardGpuResourcesImpl::setPinnedMemory size_t size @@ -274,6 +292,7 @@ void faiss::gpu::StandardGpuResourcesImpl::setDefaultStream (int device, cudaStream_t stream) override setDefaultStream + faiss::gpu::StandardGpuResourcesImpl::setDefaultStream setDefaultStream int @@ -297,6 +316,7 @@ void faiss::gpu::StandardGpuResourcesImpl::revertDefaultStream (int device) revertDefaultStream + faiss::gpu::StandardGpuResourcesImpl::revertDefaultStream int device @@ -315,6 +335,7 @@ cudaStream_t faiss::gpu::StandardGpuResourcesImpl::getDefaultStream (int device) override getDefaultStream + faiss::gpu::StandardGpuResourcesImpl::getDefaultStream getDefaultStream int @@ -334,6 +355,7 @@ void faiss::gpu::StandardGpuResourcesImpl::setDefaultNullStreamAllDevices () setDefaultNullStreamAllDevices + faiss::gpu::StandardGpuResourcesImpl::setDefaultNullStreamAllDevices @@ -348,6 +370,7 @@ void faiss::gpu::StandardGpuResourcesImpl::setLogMemoryAllocations (bool enable) setLogMemoryAllocations + faiss::gpu::StandardGpuResourcesImpl::setLogMemoryAllocations bool enable @@ -366,6 +389,7 @@ void faiss::gpu::StandardGpuResourcesImpl::initializeForDevice (int device) override initializeForDevice + faiss::gpu::StandardGpuResourcesImpl::initializeForDevice initializeForDevice int @@ -386,6 +410,7 @@ cublasHandle_t faiss::gpu::StandardGpuResourcesImpl::getBlasHandle (int device) override getBlasHandle + faiss::gpu::StandardGpuResourcesImpl::getBlasHandle getBlasHandle int @@ -400,12 +425,13 @@ - + std::vector< cudaStream_t > - std::vector<cudaStream_t> faiss::gpu::StandardGpuResourcesImpl::getAlternateStreams + std::vector< cudaStream_t > faiss::gpu::StandardGpuResourcesImpl::getAlternateStreams (int device) override getAlternateStreams - getAlternateStreams + faiss::gpu::StandardGpuResourcesImpl::getAlternateStreams + getAlternateStreams int device @@ -419,12 +445,13 @@ - + void * - void* faiss::gpu::StandardGpuResourcesImpl::allocMemory + void * faiss::gpu::StandardGpuResourcesImpl::allocMemory (const AllocRequest &req) override allocMemory - allocMemory + faiss::gpu::StandardGpuResourcesImpl::allocMemory + allocMemory const AllocRequest & req @@ -443,6 +470,7 @@ void faiss::gpu::StandardGpuResourcesImpl::deallocMemory (int device, void *in) override deallocMemory + faiss::gpu::StandardGpuResourcesImpl::deallocMemory deallocMemory int @@ -466,6 +494,7 @@ size_t faiss::gpu::StandardGpuResourcesImpl::getTempMemoryAvailable (int device) const override getTempMemoryAvailable + faiss::gpu::StandardGpuResourcesImpl::getTempMemoryAvailable getTempMemoryAvailable int @@ -480,11 +509,12 @@ - + std::map< int, std::map< std::string, std::pair< int, size_t > > > - std::map<int, std::map<std::string, std::pair<int, size_t> > > faiss::gpu::StandardGpuResourcesImpl::getMemoryInfo + std::map< int, std::map< std::string, std::pair< int, size_t > > > faiss::gpu::StandardGpuResourcesImpl::getMemoryInfo () const getMemoryInfo + faiss::gpu::StandardGpuResourcesImpl::getMemoryInfo Export a description of memory used for Python. @@ -494,12 +524,13 @@ - + std::pair< void *, size_t > - std::pair<void*, size_t> faiss::gpu::StandardGpuResourcesImpl::getPinnedMemory + std::pair< void *, size_t > faiss::gpu::StandardGpuResourcesImpl::getPinnedMemory () override getPinnedMemory - getPinnedMemory + faiss::gpu::StandardGpuResourcesImpl::getPinnedMemory + getPinnedMemory Returns the available CPU pinned memory buffer. @@ -514,6 +545,7 @@ cudaStream_t faiss::gpu::StandardGpuResourcesImpl::getAsyncCopyStream (int device) override getAsyncCopyStream + faiss::gpu::StandardGpuResourcesImpl::getAsyncCopyStream getAsyncCopyStream int @@ -533,6 +565,7 @@ bool faiss::gpu::GpuResources::supportsBFloat16CurrentDevice () supportsBFloat16CurrentDevice + faiss::gpu::GpuResources::supportsBFloat16CurrentDevice Does the current GPU support bfloat16? @@ -548,6 +581,7 @@ cublasHandle_t faiss::gpu::GpuResources::getBlasHandleCurrentDevice () getBlasHandleCurrentDevice + faiss::gpu::GpuResources::getBlasHandleCurrentDevice Calls getBlasHandle with the current device. @@ -562,6 +596,7 @@ cudaStream_t faiss::gpu::GpuResources::getDefaultStreamCurrentDevice () getDefaultStreamCurrentDevice + faiss::gpu::GpuResources::getDefaultStreamCurrentDevice Calls getDefaultStream with the current device. @@ -576,6 +611,7 @@ size_t faiss::gpu::GpuResources::getTempMemoryAvailableCurrentDevice () const getTempMemoryAvailableCurrentDevice + faiss::gpu::GpuResources::getTempMemoryAvailableCurrentDevice Calls getTempMemoryAvailable with the current device. @@ -590,6 +626,7 @@ GpuMemoryReservation faiss::gpu::GpuResources::allocMemoryHandle (const AllocRequest &req) allocMemoryHandle + faiss::gpu::GpuResources::allocMemoryHandle const AllocRequest & req @@ -608,6 +645,7 @@ void faiss::gpu::GpuResources::syncDefaultStream (int device) syncDefaultStream + faiss::gpu::GpuResources::syncDefaultStream int device @@ -626,6 +664,7 @@ void faiss::gpu::GpuResources::syncDefaultStreamCurrentDevice () syncDefaultStreamCurrentDevice + faiss::gpu::GpuResources::syncDefaultStreamCurrentDevice Calls syncDefaultStream for the current device. @@ -635,11 +674,12 @@ - + std::vector< cudaStream_t > - std::vector<cudaStream_t> faiss::gpu::GpuResources::getAlternateStreamsCurrentDevice + std::vector< cudaStream_t > faiss::gpu::GpuResources::getAlternateStreamsCurrentDevice () getAlternateStreamsCurrentDevice + faiss::gpu::GpuResources::getAlternateStreamsCurrentDevice Calls getAlternateStreams for the current device. @@ -654,6 +694,7 @@ cudaStream_t faiss::gpu::GpuResources::getAsyncCopyStreamCurrentDevice () getAsyncCopyStreamCurrentDevice + faiss::gpu::GpuResources::getAsyncCopyStreamCurrentDevice Calls getAsyncCopyStream for the current device. @@ -663,13 +704,14 @@ - - + + bool bool faiss::gpu::StandardGpuResourcesImpl::isInitialized (int device) const isInitialized + faiss::gpu::StandardGpuResourcesImpl::isInitialized int device @@ -683,13 +725,14 @@ - - + + size_t static size_t faiss::gpu::StandardGpuResourcesImpl::getDefaultTempMemForGPU (int device, size_t requested) getDefaultTempMemForGPU + faiss::gpu::StandardGpuResourcesImpl::getDefaultTempMemForGPU int device @@ -707,40 +750,40 @@ - + Standard implementation of the GpuResources object that provides for a temporary memory manager + + + + + + - - - - - - faiss::gpu::StandardGpuResourcesImplallocLogging_ - faiss::gpu::StandardGpuResourcesImplallocMemory + faiss::gpu::StandardGpuResourcesImplallocMemory faiss::gpu::StandardGpuResourcesImplallocMemoryHandle faiss::gpu::StandardGpuResourcesImplallocs_ faiss::gpu::StandardGpuResourcesImplalternateStreams_ @@ -748,8 +791,8 @@ faiss::gpu::StandardGpuResourcesImplblasHandles_ faiss::gpu::StandardGpuResourcesImpldeallocMemory faiss::gpu::StandardGpuResourcesImpldefaultStreams_ - faiss::gpu::StandardGpuResourcesImplgetAlternateStreams - faiss::gpu::StandardGpuResourcesImplgetAlternateStreamsCurrentDevice + faiss::gpu::StandardGpuResourcesImplgetAlternateStreams + faiss::gpu::StandardGpuResourcesImplgetAlternateStreamsCurrentDevice faiss::gpu::StandardGpuResourcesImplgetAsyncCopyStream faiss::gpu::StandardGpuResourcesImplgetAsyncCopyStreamCurrentDevice faiss::gpu::StandardGpuResourcesImplgetBlasHandle @@ -757,8 +800,8 @@ faiss::gpu::StandardGpuResourcesImplgetDefaultStream faiss::gpu::StandardGpuResourcesImplgetDefaultStreamCurrentDevice faiss::gpu::StandardGpuResourcesImplgetDefaultTempMemForGPU - faiss::gpu::StandardGpuResourcesImplgetMemoryInfo - faiss::gpu::StandardGpuResourcesImplgetPinnedMemory + faiss::gpu::StandardGpuResourcesImplgetMemoryInfo + faiss::gpu::StandardGpuResourcesImplgetPinnedMemory faiss::gpu::StandardGpuResourcesImplgetTempMemoryAvailable faiss::gpu::StandardGpuResourcesImplgetTempMemoryAvailableCurrentDevice faiss::gpu::StandardGpuResourcesImplinitializeForDevice diff --git a/xml/clone__index_8h.xml b/xml/clone__index_8h.xml index 3742a057de..9d117caa9e 100644 --- a/xml/clone__index_8h.xml +++ b/xml/clone__index_8h.xml @@ -1,5 +1,5 @@ - + clone_index.h faiss/gpu/GpuCloner.h @@ -53,7 +53,7 @@ virtualVectorTransform*clone_VectorTransform(constVectorTransform*); virtualIndex*clone_Index(constIndex*); virtualIndexIVF*clone_IndexIVF(constIndexIVF*); -virtual~Cloner(){} +virtual~Cloner(){} }; Quantizer*clone_Quantizer(constQuantizer*quant); diff --git a/xml/code__distance-avx2_8h.xml b/xml/code__distance-avx2_8h.xml index df0b1bea1e..7d3d837bcb 100644 --- a/xml/code__distance-avx2_8h.xml +++ b/xml/code__distance-avx2_8h.xml @@ -1,5 +1,5 @@ - + code_distance-avx2.h @@ -55,7 +55,7 @@ floatresult=0; constfloat*tab=sim_table; -constexprsize_tksub=1<<8; +constexprsize_tksub=1<<8; const__m128ivksub=_mm_set1_epi32(ksub); __m128ioffsets_0=_mm_setr_epi32(0,1,2,3); @@ -95,7 +95,7 @@ floatresult=0; constfloat*tab=sim_table; -constexprsize_tksub=1<<8; +constexprsize_tksub=1<<8; const__m256ivksub=_mm256_set1_epi32(ksub); __m256ioffsets_0=_mm256_setr_epi32(0,1,2,3,4,5,6,7); @@ -141,10 +141,10 @@ float&result1, float&result2, float&result3){ -constexprintptr_tN=4; +constexprintptr_tN=4; constfloat*tab=sim_table; -constexprsize_tksub=1<<8; +constexprsize_tksub=1<<8; //process8values const__m128ivksub=_mm_set1_epi32(ksub); @@ -198,10 +198,10 @@ float&result1, float&result2, float&result3){ -constexprintptr_tN=4; +constexprintptr_tN=4; constfloat*tab=sim_table; -constexprsize_tksub=1<<8; +constexprsize_tksub=1<<8; //process8values const__m256ivksub=_mm256_set1_epi32(ksub); @@ -277,7 +277,7 @@ } floatresult=0; -constexprsize_tksub=1<<8; +constexprsize_tksub=1<<8; size_tm=0; constsize_tpqM16=M/16; @@ -440,12 +440,12 @@ result1=0; result2=0; result3=0; -constexprsize_tksub=1<<8; +constexprsize_tksub=1<<8; size_tm=0; constsize_tpqM16=M/16; -constexprintptr_tN=4; +constexprintptr_tN=4; constfloat*tab=sim_table; diff --git a/xml/code__distance-avx512_8h.xml b/xml/code__distance-avx512_8h.xml index 83cc2a5ead..04e505534d 100644 --- a/xml/code__distance-avx512_8h.xml +++ b/xml/code__distance-avx512_8h.xml @@ -1,5 +1,5 @@ - + code_distance-avx512.h @@ -58,12 +58,12 @@ constfloat*sim_table, constuint8_t*code0){ floatresult0=0; -constexprsize_tksub=1<<8; +constexprsize_tksub=1<<8; size_tm=0; constsize_tpqM16=M/16; -constexprintptr_tN=1; +constexprintptr_tN=1; constfloat*tab=sim_table; @@ -179,12 +179,12 @@ result1=0; result2=0; result3=0; -constexprsize_tksub=1<<8; +constexprsize_tksub=1<<8; size_tm=0; constsize_tpqM16=M/16; -constexprintptr_tN=4; +constexprintptr_tN=4; constfloat*tab=sim_table; diff --git a/xml/code__distance-generic_8h.xml b/xml/code__distance-generic_8h.xml index 5425f578ae..93b03f0948 100644 --- a/xml/code__distance-generic_8h.xml +++ b/xml/code__distance-generic_8h.xml @@ -1,17 +1,11 @@ - + code_distance-generic.h cstddef cstdint faiss/impl/code_distance/code_distance.h - - - - - - @@ -20,18 +14,24 @@ - - - - + + + + + + + + + + faiss diff --git a/xml/code__distance-sve_8h.xml b/xml/code__distance-sve_8h.xml index fa0737fee0..222ab4a1fa 100644 --- a/xml/code__distance-sve_8h.xml +++ b/xml/code__distance-sve_8h.xml @@ -1,5 +1,5 @@ - + code_distance-sve.h @@ -64,7 +64,7 @@ constfloat*sim_table, //codes constuint8_t*__restrictcode){ -constexprsize_tnbits=8u; +constexprsize_tnbits=8u; constsize_tksub=1<<nbits; @@ -220,7 +220,7 @@ float&result1, float&result2, float&result3){ -constexprsize_tnbits=8u; +constexprsize_tnbits=8u; constsize_tksub=1<<nbits; diff --git a/xml/code__distance_8h.xml b/xml/code__distance_8h.xml index 295f020f4b..2ebb16f337 100644 --- a/xml/code__distance_8h.xml +++ b/xml/code__distance_8h.xml @@ -1,24 +1,18 @@ - + code_distance.h faiss/impl/platform_macros.h faiss/impl/code_distance/code_distance-generic.h - - - - + + + + - + - - - - - - @@ -27,16 +21,22 @@ + + + + + + + + - - - - - - - + + + + + faiss diff --git a/xml/common_8h.xml b/xml/common_8h.xml index bc4b6aac17..b22d665d3b 100644 --- a/xml/common_8h.xml +++ b/xml/common_8h.xml @@ -1,5 +1,5 @@ - + common.h cstdint @@ -14,12 +14,6 @@ - - - - - - @@ -28,14 +22,14 @@ - - - - - - + + + + + + @@ -46,9 +40,15 @@ + + + + + + faiss - + int32_t using hamdis_t = int32_t @@ -62,7 +62,7 @@ - + @@ -83,7 +83,7 @@ #include<faiss/impl/platform_macros.h> /*TheHammingdistancetype*/ -usinghamdis_t=int32_t; +usinghamdis_t=int32_t; namespacefaiss{ @@ -101,7 +101,7 @@ //otherwiseitwascausingcompilationerrorswhiletryingto //compileswigmodulesonWindows. //todoforC++17:switchto'inlineconstexpr' -staticconstexpruint8_thamdis_tab_ham_bytes[256]={ +staticconstexpruint8_thamdis_tab_ham_bytes[256]={ 0,1,1,2,1,2,2,3,1,2,2,3,2,3,3,4,1,2,2,3,2,3,3,4, 2,3,3,4,3,4,4,5,1,2,2,3,2,3,3,4,2,3,3,4,3,4,4,5, 2,3,3,4,3,4,4,5,3,4,4,5,4,5,5,6,1,2,2,3,2,3,3,4, diff --git a/xml/compound.xsd b/xml/compound.xsd index 6a8a834638..e3cf2e5590 100644 --- a/xml/compound.xsd +++ b/xml/compound.xsd @@ -24,17 +24,23 @@ + + + + + + @@ -97,12 +103,26 @@ - + + + + + + + + + + + + + + + @@ -124,11 +144,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + - + + @@ -140,13 +187,16 @@ + + + @@ -160,6 +210,7 @@ + @@ -218,7 +269,7 @@ - + @@ -424,6 +475,7 @@ + @@ -433,9 +485,9 @@ - - - + + + @@ -697,13 +749,300 @@ + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -712,14 +1051,15 @@ - - - + + + + @@ -757,12 +1097,15 @@ + + + @@ -833,6 +1176,7 @@ + @@ -851,6 +1195,34 @@ + + + + + + + + + + + + + The mentioned file will be located in the directory as specified by XML_OUTPUT + + + + + + + + + + + + + + + @@ -920,6 +1292,13 @@ + + + + + + + @@ -1033,6 +1412,8 @@ + + @@ -1063,6 +1444,8 @@ + + @@ -1116,6 +1499,7 @@ + @@ -1158,6 +1542,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1211,5 +1621,15 @@ + + + + + + + + + + diff --git a/xml/dir_17d03c0b48df2002720ab53d8fded289.xml b/xml/dir_17d03c0b48df2002720ab53d8fded289.xml index c49c129896..ba6d29b3fa 100644 --- a/xml/dir_17d03c0b48df2002720ab53d8fded289.xml +++ b/xml/dir_17d03c0b48df2002720ab53d8fded289.xml @@ -1,5 +1,5 @@ - + faiss/python python_callbacks.h diff --git a/xml/dir_221463c854b1b8cd5e47ba008a62b54d.xml b/xml/dir_221463c854b1b8cd5e47ba008a62b54d.xml index 8b49bfae94..401190ed13 100644 --- a/xml/dir_221463c854b1b8cd5e47ba008a62b54d.xml +++ b/xml/dir_221463c854b1b8cd5e47ba008a62b54d.xml @@ -1,5 +1,5 @@ - + faiss/gpu/test TestUtils.h diff --git a/xml/dir_223b9c703ffee17e94e6e39e310b329b.xml b/xml/dir_223b9c703ffee17e94e6e39e310b329b.xml index 745c2db42d..36d7d4999d 100644 --- a/xml/dir_223b9c703ffee17e94e6e39e310b329b.xml +++ b/xml/dir_223b9c703ffee17e94e6e39e310b329b.xml @@ -1,5 +1,5 @@ - + faiss/cppcontrib/sa_decode Level2-avx2-inl.h diff --git a/xml/dir_283b6f110a5e88358299b04e4fc2c7ec.xml b/xml/dir_283b6f110a5e88358299b04e4fc2c7ec.xml index 4848f03860..6b26ab6e1c 100644 --- a/xml/dir_283b6f110a5e88358299b04e4fc2c7ec.xml +++ b/xml/dir_283b6f110a5e88358299b04e4fc2c7ec.xml @@ -1,5 +1,5 @@ - + faiss faiss/cppcontrib diff --git a/xml/dir_42f4926097fe2768058790a30a036468.xml b/xml/dir_42f4926097fe2768058790a30a036468.xml index 92145431d6..71d7fbf18e 100644 --- a/xml/dir_42f4926097fe2768058790a30a036468.xml +++ b/xml/dir_42f4926097fe2768058790a30a036468.xml @@ -1,5 +1,5 @@ - + faiss/gpu/utils faiss/gpu/utils/blockselect diff --git a/xml/dir_6db856fab8a406bb2751df9e12e5655b.xml b/xml/dir_6db856fab8a406bb2751df9e12e5655b.xml index 5c8bc6d8b1..2b2dbfddfc 100644 --- a/xml/dir_6db856fab8a406bb2751df9e12e5655b.xml +++ b/xml/dir_6db856fab8a406bb2751df9e12e5655b.xml @@ -1,5 +1,5 @@ - + faiss/utils/transpose transpose-avx2-inl.h diff --git a/xml/dir_71a5f2b83da87e7fb52bb1a9a3fef9ad.xml b/xml/dir_71a5f2b83da87e7fb52bb1a9a3fef9ad.xml index f58ae67068..e0703dd474 100644 --- a/xml/dir_71a5f2b83da87e7fb52bb1a9a3fef9ad.xml +++ b/xml/dir_71a5f2b83da87e7fb52bb1a9a3fef9ad.xml @@ -1,5 +1,5 @@ - + faiss/invlists BlockInvertedLists.h diff --git a/xml/dir_7d0d39c4b531e697805e66643e473925.xml b/xml/dir_7d0d39c4b531e697805e66643e473925.xml index 86ae485c1e..236475ccfd 100644 --- a/xml/dir_7d0d39c4b531e697805e66643e473925.xml +++ b/xml/dir_7d0d39c4b531e697805e66643e473925.xml @@ -1,5 +1,5 @@ - + faiss/gpu/impl/scan IVFInterleavedImpl.cuh diff --git a/xml/dir_8024a5c5304a6089dbde2bf6560405dc.xml b/xml/dir_8024a5c5304a6089dbde2bf6560405dc.xml index 77f7154d16..af34b819c3 100644 --- a/xml/dir_8024a5c5304a6089dbde2bf6560405dc.xml +++ b/xml/dir_8024a5c5304a6089dbde2bf6560405dc.xml @@ -1,5 +1,5 @@ - + faiss/utils/distances_fused avx512.h diff --git a/xml/dir_8904d4d25cfd37481067280c4d4c9f97.xml b/xml/dir_8904d4d25cfd37481067280c4d4c9f97.xml index 7bcf5506eb..77034aee85 100644 --- a/xml/dir_8904d4d25cfd37481067280c4d4c9f97.xml +++ b/xml/dir_8904d4d25cfd37481067280c4d4c9f97.xml @@ -1,5 +1,5 @@ - + faiss/gpu faiss/gpu/impl diff --git a/xml/dir_8ad259f5ae9600a74caf331497f5b251.xml b/xml/dir_8ad259f5ae9600a74caf331497f5b251.xml index 7bd720cc86..428ad96767 100644 --- a/xml/dir_8ad259f5ae9600a74caf331497f5b251.xml +++ b/xml/dir_8ad259f5ae9600a74caf331497f5b251.xml @@ -1,5 +1,5 @@ - + faiss/utils faiss/utils/approx_topk diff --git a/xml/dir_8b616007acf4b97b5964ac00bedb17ee.xml b/xml/dir_8b616007acf4b97b5964ac00bedb17ee.xml index f072bc02b0..6cf20ad392 100644 --- a/xml/dir_8b616007acf4b97b5964ac00bedb17ee.xml +++ b/xml/dir_8b616007acf4b97b5964ac00bedb17ee.xml @@ -1,5 +1,5 @@ - + faiss/cppcontrib/detail CoarseBitType.h diff --git a/xml/dir_a183f389f7fdb8e3b256673548812ad2.xml b/xml/dir_a183f389f7fdb8e3b256673548812ad2.xml index 1121387083..ca82fee365 100644 --- a/xml/dir_a183f389f7fdb8e3b256673548812ad2.xml +++ b/xml/dir_a183f389f7fdb8e3b256673548812ad2.xml @@ -1,5 +1,5 @@ - + faiss/gpu/perf IndexWrapper-inl.h diff --git a/xml/dir_a72cdb8482385b533c81985f0af53313.xml b/xml/dir_a72cdb8482385b533c81985f0af53313.xml index 2183171165..c2bb0f2056 100644 --- a/xml/dir_a72cdb8482385b533c81985f0af53313.xml +++ b/xml/dir_a72cdb8482385b533c81985f0af53313.xml @@ -1,5 +1,5 @@ - + faiss/cppcontrib faiss/cppcontrib/detail diff --git a/xml/dir_a990053ab0ed2a0e35fd7924fe582c4e.xml b/xml/dir_a990053ab0ed2a0e35fd7924fe582c4e.xml index 10e5947c66..92b7c5c9e8 100644 --- a/xml/dir_a990053ab0ed2a0e35fd7924fe582c4e.xml +++ b/xml/dir_a990053ab0ed2a0e35fd7924fe582c4e.xml @@ -1,5 +1,5 @@ - + faiss/utils/hamming_distance avx2-inl.h diff --git a/xml/dir_ad53beca454033ad93eaf26a4bdf359c.xml b/xml/dir_ad53beca454033ad93eaf26a4bdf359c.xml index fda1ee7e0b..91345f010b 100644 --- a/xml/dir_ad53beca454033ad93eaf26a4bdf359c.xml +++ b/xml/dir_ad53beca454033ad93eaf26a4bdf359c.xml @@ -1,5 +1,5 @@ - + faiss/gpu/utils/warpselect WarpSelectImpl.cuh diff --git a/xml/dir_c2dc665bb85977007db19edac984ae84.xml b/xml/dir_c2dc665bb85977007db19edac984ae84.xml index c52c42a5b6..485b4d28cc 100644 --- a/xml/dir_c2dc665bb85977007db19edac984ae84.xml +++ b/xml/dir_c2dc665bb85977007db19edac984ae84.xml @@ -1,5 +1,5 @@ - + faiss/utils/approx_topk approx_topk.h diff --git a/xml/dir_c7562a8177f4c7fed0562155251b7d22.xml b/xml/dir_c7562a8177f4c7fed0562155251b7d22.xml index c0329b7674..cf42ce457a 100644 --- a/xml/dir_c7562a8177f4c7fed0562155251b7d22.xml +++ b/xml/dir_c7562a8177f4c7fed0562155251b7d22.xml @@ -1,5 +1,5 @@ - + faiss/gpu/impl faiss/gpu/impl/scan diff --git a/xml/dir_dd54f55b8e87373dfa8f730dca1dd7f8.xml b/xml/dir_dd54f55b8e87373dfa8f730dca1dd7f8.xml index 0800e5da09..5ea5fc9b64 100644 --- a/xml/dir_dd54f55b8e87373dfa8f730dca1dd7f8.xml +++ b/xml/dir_dd54f55b8e87373dfa8f730dca1dd7f8.xml @@ -1,5 +1,5 @@ - + faiss/impl faiss/impl/code_distance diff --git a/xml/dir_df06d869ac375e073b830f0b1d0f2164.xml b/xml/dir_df06d869ac375e073b830f0b1d0f2164.xml index 684a9bb917..7d6f5580bc 100644 --- a/xml/dir_df06d869ac375e073b830f0b1d0f2164.xml +++ b/xml/dir_df06d869ac375e073b830f0b1d0f2164.xml @@ -1,5 +1,5 @@ - + faiss/impl/code_distance code_distance-avx2.h diff --git a/xml/dir_e0bc4e8ba6e534e3fbf335254ee8d911.xml b/xml/dir_e0bc4e8ba6e534e3fbf335254ee8d911.xml index c367bcab36..db402420cc 100644 --- a/xml/dir_e0bc4e8ba6e534e3fbf335254ee8d911.xml +++ b/xml/dir_e0bc4e8ba6e534e3fbf335254ee8d911.xml @@ -1,5 +1,5 @@ - + faiss/gpu/utils/blockselect BlockSelectImpl.cuh diff --git a/xml/dir_e13a2bd573d2812b9a3a73eeae8e330e.xml b/xml/dir_e13a2bd573d2812b9a3a73eeae8e330e.xml index d9287ccfc7..1bd24e7e3a 100644 --- a/xml/dir_e13a2bd573d2812b9a3a73eeae8e330e.xml +++ b/xml/dir_e13a2bd573d2812b9a3a73eeae8e330e.xml @@ -1,5 +1,5 @@ - + faiss/utils/approx_topk_hamming approx_topk_hamming.h diff --git a/xml/distances_8h.xml b/xml/distances_8h.xml index 7e834e6b25..a6ef071d59 100644 --- a/xml/distances_8h.xml +++ b/xml/distances_8h.xml @@ -1,5 +1,5 @@ - + distances.h stdint.h @@ -7,19 +7,6 @@ faiss/utils/Heap.h faiss/utils/extra_distances-inl.h - - - - - - - - - - - - - @@ -28,24 +15,6 @@ - - - - - - - - - - - - - - - - - - @@ -68,6 +37,16 @@ + + + + + + + + + + @@ -78,12 +57,33 @@ + + + + + + + + + + + + + + + + + + + + + @@ -92,16 +92,16 @@ - - - - + + + + faiss diff --git a/xml/distances__fused_8h.xml b/xml/distances__fused_8h.xml index d95e48cf90..72bebf0e8f 100644 --- a/xml/distances__fused_8h.xml +++ b/xml/distances__fused_8h.xml @@ -1,39 +1,16 @@ - + distances_fused.h faiss/impl/ResultHandler.h faiss/utils/Heap.h - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - @@ -52,27 +29,16 @@ - - - - - - - - - - - - - - - - - - - + + + + - + + + + + @@ -85,24 +51,31 @@ - - - - + + + + - + - + + + + + + + + + - - - - - - - - + + + + + + + @@ -126,6 +99,14 @@ + + + + + + + + @@ -136,51 +117,70 @@ - - - - - - - - - - - - + + + + + + + - - + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss diff --git a/xml/doxyfile.xsd b/xml/doxyfile.xsd new file mode 100644 index 0000000000..fbfc2c13df --- /dev/null +++ b/xml/doxyfile.xsd @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/xml/extra__distances-inl_8h.xml b/xml/extra__distances-inl_8h.xml index efc2c533b3..a66e223691 100644 --- a/xml/extra__distances-inl_8h.xml +++ b/xml/extra__distances-inl_8h.xml @@ -1,5 +1,5 @@ - + extra_distances-inl.h faiss/MetricType.h @@ -9,14 +9,24 @@ type_traits faiss/utils/extra_distances.h - - - - + + + + + + + + + + - + + + + + @@ -31,9 +41,6 @@ - - - @@ -42,47 +49,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -105,6 +71,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -115,54 +105,64 @@ - - + + - - - - - + + - - + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + - - - - + + + + faiss::VectorDistance faiss - + DISPATCH_VD mt @@ -178,7 +178,7 @@ - + @@ -206,12 +206,12 @@ structVectorDistance{ size_td; floatmetric_arg; -staticconstexprboolis_similarity=is_similarity_metric(mt); +staticconstexprboolis_similarity=is_similarity_metric(mt); inlinefloatoperator()(constfloat*x,constfloat*y)const; //heaptemplatetouseforthistypeofmetric -usingC=typenamestd::conditional< +usingC=typenamestd::conditional< is_similarity_metric(mt), CMin<float, int64_t>, CMax<float, int64_t>>::type; diff --git a/xml/extra__distances_8h.xml b/xml/extra__distances_8h.xml index 2fd52d7d88..f38c11a649 100644 --- a/xml/extra__distances_8h.xml +++ b/xml/extra__distances_8h.xml @@ -1,5 +1,5 @@ - + extra_distances.h stdint.h @@ -7,14 +7,38 @@ faiss/utils/Heap.h faiss/utils/extra_distances-inl.h - - - - + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + @@ -29,21 +53,6 @@ - - - - - - - - - - - - - - - @@ -52,53 +61,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -121,6 +83,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -131,51 +129,53 @@ - - + + - - - - - - - - - - - - - + + - - - - - + + - - + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + faiss @@ -233,7 +233,7 @@ /**getaDistanceComputerthatreferstothistypeofdistanceand *indexesaflatarrayofsizenb*/ -FlatCodesDistanceComputer*get_extra_distance_computer( +FlatCodesDistanceComputer*get_extra_distance_computer( size_td, MetricTypemt, floatmetric_arg, diff --git a/xml/factory__tools_8h.xml b/xml/factory__tools_8h.xml index 4cf9b8e5f4..5654cae420 100644 --- a/xml/factory__tools_8h.xml +++ b/xml/factory__tools_8h.xml @@ -1,5 +1,5 @@ - + factory_tools.h faiss/IndexBinaryFlat.h @@ -14,92 +14,82 @@ faiss/IndexPreTransform.h faiss/IndexRefine.h - - - + + + + + - + + + + + - + - + - + + + - - - - + + + + + + - + - + - - - - - - - + + + + - + - + - + + + + + - + - + - - - - - - - - - - + + + - - - + - + - + - - - - - - - - - - - - - + + + - - - + @@ -110,89 +100,45 @@ - - - - - - + + + + - - - - - + - - - - - - - - - - + + + - - - - - - - - - - - - - + - + - - - - - + - - - + + + - - - - - - - - - - - - + - + - + - - - - @@ -220,147 +166,80 @@ - - - - + + + + - + - - - - - + - - - - - - - - - - - - - - - - - + + + + - + - - - - - - - + + + - + - - - + - + - - - - - - - - - - + + + + - - - - - - - - - - - - + - - - - - + - + - + - - - - + + + + - + - + - - - - - - - - - - - + + + + - + - + - + - + - - - - - - - - - - - + - - - - - - @@ -373,39 +252,18 @@ - - - - - - - - - - - - - - - - - - - - - + + + + - + - - - - - - - - + + + + @@ -422,110 +280,140 @@ - - - - - - + + + + - + + + + + - + - + - - - - - - - + + + + - + - + - + - + - - - - - + - + - + + + + + + + - - + + + + + + + + + + + + + + + + + - - + + + + + - - - - + + + + + + - + - - - - - - - - - + + + + - + + + + + - - - - + + + + - + - + - + - + - + - + - + - + - + + + + + - + + + - - - - + + + + + + + + @@ -544,10 +432,28 @@ - - - - + + + + + + + + + + + + + + + + + + + + + + @@ -558,34 +464,73 @@ - - - - - - + + + + + - + + + + + - + + + + + + + + + - - - - + + + + - + - + + + + + + + + + + + + + - - + + + - - + + + + + + + + + + + + + + + + + @@ -603,23 +548,78 @@ - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss diff --git a/xml/fp16-arm_8h.xml b/xml/fp16-arm_8h.xml index 23e672b05a..5ff92f03ba 100644 --- a/xml/fp16-arm_8h.xml +++ b/xml/fp16-arm_8h.xml @@ -1,16 +1,10 @@ - + fp16-arm.h arm_neon.h cstdint - - - - - - @@ -19,6 +13,12 @@ + + + + + + faiss diff --git a/xml/fp16-fp16c_8h.xml b/xml/fp16-fp16c_8h.xml index bcdbb6b9e1..952e730db9 100644 --- a/xml/fp16-fp16c_8h.xml +++ b/xml/fp16-fp16c_8h.xml @@ -1,16 +1,10 @@ - + fp16-fp16c.h immintrin.h cstdint - - - - - - @@ -19,6 +13,12 @@ + + + + + + faiss diff --git a/xml/fp16-inl_8h.xml b/xml/fp16-inl_8h.xml index 5a9e2ac2e4..8f1b921793 100644 --- a/xml/fp16-inl_8h.xml +++ b/xml/fp16-inl_8h.xml @@ -1,14 +1,11 @@ - + fp16-inl.h algorithm cstdint faiss/utils/fp16.h - - - @@ -20,16 +17,19 @@ + + + - - - - + + + + @@ -38,10 +38,10 @@ - - - - + + + + diff --git a/xml/fp16_8h.xml b/xml/fp16_8h.xml index f0860d8234..2575eadb0f 100644 --- a/xml/fp16_8h.xml +++ b/xml/fp16_8h.xml @@ -1,5 +1,5 @@ - + fp16.h cstdint @@ -7,16 +7,6 @@ faiss/utils/fp16-inl.h faiss/cppcontrib/sa_decode/MinMaxFP16-inl.h - - - - - - - - - - @@ -25,9 +15,6 @@ - - - @@ -36,30 +23,43 @@ - - + + + + + + + + + + + + + + + - - - - - - + + + + + + diff --git a/xml/generic-inl_8h.xml b/xml/generic-inl_8h.xml index 5178e4eea6..6de453ed12 100644 --- a/xml/generic-inl_8h.xml +++ b/xml/generic-inl_8h.xml @@ -1,5 +1,5 @@ - + generic-inl.h cassert @@ -16,12 +16,6 @@ - - - - - - @@ -34,19 +28,23 @@ - - + + + + + + + + - - - - - + + + @@ -54,9 +52,11 @@ - - - + + + + + faiss::HammingComputer4 @@ -175,7 +175,7 @@ returnpopcount64(*(uint32_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return4; } }; @@ -198,7 +198,7 @@ returnpopcount64(*(uint64_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return8; } }; @@ -224,7 +224,7 @@ returnpopcount64(b[0]^a0)+popcount64(b[1]^a1); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return16; } }; @@ -258,7 +258,7 @@ popcount64(*(uint32_t*)(b+2)^a2); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return20; } }; @@ -287,7 +287,7 @@ popcount64(b[2]^a2)+popcount64(b[3]^a3); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return32; } }; @@ -322,7 +322,7 @@ popcount64(b[6]^a6)+popcount64(b[7]^a7); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return64; } }; @@ -450,7 +450,7 @@ returngeneralized_hamming_64(*(uint64_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return8; } }; @@ -470,7 +470,7 @@ generalized_hamming_64(b[1]^a1); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return16; } }; @@ -495,7 +495,7 @@ generalized_hamming_64(b[3]^a3); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return32; } }; diff --git a/xml/generic_8h.xml b/xml/generic_8h.xml index 000f447d2a..59ebb49eb8 100644 --- a/xml/generic_8h.xml +++ b/xml/generic_8h.xml @@ -1,5 +1,5 @@ - + generic.h algorithm @@ -9,6 +9,20 @@ faiss/utils/Heap.h faiss/utils/approx_topk/approx_topk.h + + + + + + + + + + + + + + @@ -21,9 +35,6 @@ - - - @@ -32,47 +43,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -95,6 +65,20 @@ + + + + + + + + + + + + + + @@ -105,44 +89,60 @@ - - + + + + + - - + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + - - - - faiss::HeapWithBuckets faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N > @@ -221,7 +221,7 @@ //k, //beam_size*NBUCKETS*N); -usingC=CMax<float,int>; +usingC=CMax<float,int>; //mainloop for(uint32_tbeam_index=0;beam_index<beam_size;beam_index++){ diff --git a/xml/hamdis-inl_8h.xml b/xml/hamdis-inl_8h.xml index b4173cc9ea..82bd7c2630 100644 --- a/xml/hamdis-inl_8h.xml +++ b/xml/hamdis-inl_8h.xml @@ -1,5 +1,5 @@ - + hamdis-inl.h faiss/utils/hamming_distance/common.h @@ -14,18 +14,12 @@ - - - - - - - - - - + + + + - + @@ -40,36 +34,42 @@ - - + + + + + + + + + + - - - - - - - + + + + + + + + + - - - - faiss::HammingComputer faiss - + SPECIALIZED_HC CODE_SIZE @@ -84,7 +84,7 @@ - + DISPATCH_HC @@ -99,7 +99,7 @@ - + diff --git a/xml/hamming-inl_8h.xml b/xml/hamming-inl_8h.xml index 0d71a24c67..ba1c5cc998 100644 --- a/xml/hamming-inl_8h.xml +++ b/xml/hamming-inl_8h.xml @@ -1,5 +1,5 @@ - + hamming-inl.h faiss/utils/hamming.h diff --git a/xml/hamming_8h.xml b/xml/hamming_8h.xml index 602b807818..8f85b2cd0a 100644 --- a/xml/hamming_8h.xml +++ b/xml/hamming_8h.xml @@ -1,5 +1,5 @@ - + hamming.h stdint.h @@ -9,13 +9,6 @@ faiss/utils/approx_topk/mode.h faiss/utils/hamming-inl.h - - - - - - - @@ -24,38 +17,36 @@ - - - - - - - - - - - - - - - - + + + + - + + + + + - - - - - + - + - + + + + + + + + + + + @@ -72,36 +63,32 @@ - - - - - - - - - - - - - - - - - - + + + + - + + + + + - + - + - + - + + + + + + + @@ -114,22 +101,35 @@ - - + + + + + + + + + + + + + + - - - - - - - + + + + + + + + faiss::BitstringWriter diff --git a/xml/hamming__distance_2avx2-inl_8h.xml b/xml/hamming__distance_2avx2-inl_8h.xml index d4e323af4c..9ce939ad51 100644 --- a/xml/hamming__distance_2avx2-inl_8h.xml +++ b/xml/hamming__distance_2avx2-inl_8h.xml @@ -1,5 +1,5 @@ - + avx2-inl.h cassert @@ -8,6 +8,14 @@ faiss/impl/platform_macros.h immintrin.h + + + + + + + + @@ -22,28 +30,20 @@ - - - - - - - + + + + + - - - - - - - - + + faiss::HammingComputer4 @@ -164,7 +164,7 @@ returnpopcount64(*(uint32_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return4; } }; @@ -187,7 +187,7 @@ returnpopcount64(*(uint64_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return8; } }; @@ -213,7 +213,7 @@ returnpopcount64(b[0]^a0)+popcount64(b[1]^a1); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return16; } }; @@ -244,7 +244,7 @@ popcount64(*(uint32_t*)(b+2)^a2); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return20; } }; @@ -273,7 +273,7 @@ popcount64(b[2]^a2)+popcount64(b[3]^a3); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return32; } }; @@ -308,7 +308,7 @@ popcount64(b[6]^a6)+popcount64(b[7]^a7); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return64; } }; @@ -435,7 +435,7 @@ returngeneralized_hamming_64(*(uint64_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return8; } }; @@ -457,7 +457,7 @@ return16-popcount32(movemask); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return16; } }; @@ -477,7 +477,7 @@ return32-popcount32(movemask); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return32; } }; diff --git a/xml/index.xml b/xml/index.xml index 6df37231dc..59d559d96e 100644 --- a/xml/index.xml +++ b/xml/index.xml @@ -1,5 +1,5 @@ - + faiss::AdditiveCoarseQuantizer aq centroid_norms @@ -24,7 +24,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -99,11 +99,11 @@ clear size nbytes - get - get - data - data - operator[] + get + get + data + data + operator[] operator[] faiss::AlignedTableTightAlloc @@ -116,14 +116,14 @@ clear size nbytes - get - get - data - data - operator[] + get + get + data + data + operator[] operator[] ~AlignedTableTightAlloc - operator= + operator= AlignedTableTightAlloc faiss::gpu::AllocInfo @@ -154,8 +154,8 @@ use_iterator ArrayInvertedLists list_size - get_codes - get_ids + get_codes + get_ids add_entries update_entries resize @@ -165,9 +165,9 @@ release_codes release_ids get_single_id - get_single_code + get_single_code prefetch_lists - get_iterator + get_iterator add_entry update_entry reset @@ -237,8 +237,8 @@ BlockInvertedLists BlockInvertedLists list_size - get_codes - get_ids + get_codes + get_ids remove_ids add_entries update_entries @@ -247,10 +247,10 @@ release_codes release_ids get_single_id - get_single_code + get_single_code prefetch_lists is_empty - get_iterator + get_iterator add_entry update_entry reset @@ -270,14 +270,14 @@ faiss::BlockInvertedListsIOHook BlockInvertedListsIOHook write - read - read_ArrayInvertedLists + read + read_ArrayInvertedLists key classname add_callback print_callbacks - lookup - lookup_classname + lookup + lookup_classname faiss::BlockResultHandler nq @@ -341,12 +341,12 @@ apply_noalloc reverse_transform check_identical - apply + apply faiss::Cloner - clone_VectorTransform - clone_Index - clone_IndexIVF + clone_VectorTransform + clone_Index + clone_IndexIVF ~Cloner faiss::Clustering @@ -553,8 +553,8 @@ get streamWaitOnEvent cpuWaitOnEvent - operator= - operator= + operator= + operator= faiss::gpu::DeviceScope prevDevice_ @@ -620,8 +620,8 @@ weight Embedding operator() - data - data + data + data faiss::EnumeratedVectors nv @@ -638,7 +638,7 @@ msg FaissException FaissException - what + what faiss::FastScanStats t0 @@ -789,7 +789,7 @@ GpuIcmEncoder ~GpuIcmEncoder GpuIcmEncoder - operator= + operator= set_binary_term encode binaries @@ -800,7 +800,7 @@ provs devices GpuIcmEncoderFactory - get + get faiss::gpu::GpuIndex resources_ @@ -808,7 +808,7 @@ minPagedSize_ GpuIndex getDevice - getResources + getResources setMinPagingSize getMinPagingSize add @@ -825,7 +825,7 @@ reconstruct reconstruct_batch reconstruct_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -858,7 +858,7 @@ GpuIndexBinaryFlat ~GpuIndexBinaryFlat getDevice - getResources + getResources copyFrom copyTo add @@ -904,9 +904,9 @@ copyFrom copyTo reset - get_knngraph + get_knngraph getDevice - getResources + getResources setMinPagingSize getMinPagingSize add @@ -921,7 +921,7 @@ reconstruct reconstruct_batch reconstruct_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -982,9 +982,9 @@ reconstruct_batch compute_residual compute_residual_n - getGpuData + getGpuData getDevice - getResources + getResources setMinPagingSize getMinPagingSize add_with_ids @@ -993,7 +993,7 @@ search_and_reconstruct range_search remove_ids - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -1040,9 +1040,9 @@ reconstruct_batch compute_residual compute_residual_n - getGpuData + getGpuData getDevice - getResources + getResources setMinPagingSize getMinPagingSize add_with_ids @@ -1051,7 +1051,7 @@ search_and_reconstruct range_search remove_ids - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -1096,9 +1096,9 @@ reconstruct_batch compute_residual compute_residual_n - getGpuData + getGpuData getDevice - getResources + getResources setMinPagingSize getMinPagingSize add_with_ids @@ -1107,7 +1107,7 @@ search_and_reconstruct range_search remove_ids - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -1148,12 +1148,12 @@ updateQuantizer getNumLists getListLength - getListVectorData - getListIndices + getListVectorData + getListIndices search_preassigned range_search_preassigned getDevice - getResources + getResources setMinPagingSize getMinPagingSize add @@ -1170,7 +1170,7 @@ reconstruct reconstruct_batch reconstruct_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -1240,12 +1240,12 @@ copyTo getNumLists getListLength - getListVectorData - getListIndices + getListVectorData + getListIndices search_preassigned range_search_preassigned getDevice - getResources + getResources setMinPagingSize getMinPagingSize add @@ -1259,7 +1259,7 @@ remove_ids reconstruct reconstruct_batch - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -1352,12 +1352,12 @@ copyTo getNumLists getListLength - getListVectorData - getListIndices + getListVectorData + getListIndices search_preassigned range_search_preassigned getDevice - getResources + getResources setMinPagingSize getMinPagingSize add @@ -1372,7 +1372,7 @@ reconstruct reconstruct_batch reconstruct_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -1449,12 +1449,12 @@ copyTo getNumLists getListLength - getListVectorData - getListIndices + getListVectorData + getListIndices search_preassigned range_search_preassigned getDevice - getResources + getResources setMinPagingSize getMinPagingSize add @@ -1469,7 +1469,7 @@ reconstruct reconstruct_batch reconstruct_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -1512,8 +1512,8 @@ GpuMemoryReservation GpuMemoryReservation ~GpuMemoryReservation - operator= - get + operator= + get release faiss::gpu::GpuMultipleClonerOptions @@ -1537,7 +1537,7 @@ combination_ge combination_name display - add_range + add_range set_index_parameters set_index_parameters update_bounds @@ -1555,7 +1555,7 @@ devices ncall GpuProgressiveDimIndexFactory - operator() + operator() ~GpuProgressiveDimIndexFactory faiss::gpu::GpuResources @@ -1565,11 +1565,11 @@ getBlasHandle getDefaultStream setDefaultStream - getAlternateStreams - allocMemory + getAlternateStreams + allocMemory deallocMemory getTempMemoryAvailable - getPinnedMemory + getPinnedMemory getAsyncCopyStream supportsBFloat16CurrentDevice getBlasHandleCurrentDevice @@ -1578,18 +1578,18 @@ allocMemoryHandle syncDefaultStream syncDefaultStreamCurrentDevice - getAlternateStreamsCurrentDevice + getAlternateStreamsCurrentDevice getAsyncCopyStreamCurrentDevice faiss::gpu::GpuResourcesProvider ~GpuResourcesProvider - getResources + getResources faiss::gpu::GpuResourcesProviderFromInstance res_ GpuResourcesProviderFromInstance ~GpuResourcesProviderFromInstance - getResources + getResources faiss::nsg::Graph data @@ -1601,7 +1601,7 @@ Graph ~Graph at - at + at get_neighbors faiss::HammingComputer @@ -1779,8 +1779,8 @@ k ids val - get_val - get_ids + get_val + get_ids heapify addn addn_with_ids @@ -1909,18 +1909,18 @@ use_iterator HStackInvertedLists list_size - get_codes - get_ids + get_codes + get_ids prefetch_lists release_codes release_ids get_single_id - get_single_code + get_single_code add_entries update_entries resize is_empty - get_iterator + get_iterator add_entry update_entry reset @@ -1947,7 +1947,7 @@ encode faiss::lsq::IcmEncoderFactory - get + get ~IcmEncoderFactory faiss::IDSelector @@ -2050,7 +2050,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -2076,7 +2076,7 @@ ~Index2Layer train search - get_distance_computer + get_distance_computer transfer_to_IVFPQ sa_encode sa_decode @@ -2086,9 +2086,9 @@ reconstruct sa_code_size remove_ids - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -2147,16 +2147,16 @@ search sa_encode sa_decode - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer add reset reconstruct_n reconstruct sa_code_size remove_ids - get_distance_computer + get_distance_computer range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -2216,9 +2216,11 @@ search_implem_14 reconstruct remove_ids - get_CodePacker + get_CodePacker merge_from check_compatible_for_merge + sa_code_size + sa_encode add_with_ids range_search assign @@ -2227,9 +2229,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer - sa_code_size - sa_encode + get_distance_computer add_sa_codes faiss::IndexBinary @@ -2381,7 +2381,7 @@ IndexBinaryHNSW IndexBinaryHNSW ~IndexBinaryHNSW - get_distance_computer + get_distance_computer add train search @@ -2427,7 +2427,7 @@ add_with_ids add_core search_preassigned - get_InvertedListScanner + get_InvertedListScanner search range_search range_search_preassigned @@ -2519,9 +2519,11 @@ search_implem_14 reconstruct remove_ids - get_CodePacker + get_CodePacker merge_from check_compatible_for_merge + sa_code_size + sa_encode train add_with_ids range_search @@ -2531,9 +2533,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer - sa_code_size - sa_encode + get_distance_computer sa_decode add_sa_codes component_t @@ -2545,10 +2545,10 @@ range_search reconstruct compute_distance_subset - get_xb - get_xb + get_xb + get_xb IndexFlat - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer sa_encode sa_decode add @@ -2556,8 +2556,8 @@ reconstruct_n sa_code_size remove_ids - get_distance_computer - get_CodePacker + get_distance_computer + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -2597,21 +2597,21 @@ add reset search - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer sync_l2norms clear_l2norms range_search reconstruct compute_distance_subset - get_xb - get_xb + get_xb + get_xb sa_encode sa_decode reconstruct_n sa_code_size remove_ids - get_distance_computer - get_CodePacker + get_distance_computer + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -2643,11 +2643,11 @@ reconstruct sa_code_size remove_ids - get_FlatCodesDistanceComputer - get_distance_computer + get_FlatCodesDistanceComputer + get_distance_computer search range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -2671,9 +2671,9 @@ range_search reconstruct compute_distance_subset - get_xb - get_xb - get_FlatCodesDistanceComputer + get_xb + get_xb + get_FlatCodesDistanceComputer sa_encode sa_decode add @@ -2681,8 +2681,8 @@ reconstruct_n sa_code_size remove_ids - get_distance_computer - get_CodePacker + get_distance_computer + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -2717,15 +2717,15 @@ metric_arg IndexFlatL2 IndexFlatL2 - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer sync_l2norms clear_l2norms search range_search reconstruct compute_distance_subset - get_xb - get_xb + get_xb + get_xb sa_encode sa_decode add @@ -2733,8 +2733,8 @@ reconstruct_n sa_code_size remove_ids - get_distance_computer - get_CodePacker + get_distance_computer + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -2780,7 +2780,7 @@ reorder_links link_singletons permute_entries - get_distance_computer + get_distance_computer add_with_ids assign remove_ids @@ -2813,7 +2813,7 @@ reorder_links link_singletons permute_entries - get_distance_computer + get_distance_computer add_with_ids assign remove_ids @@ -2872,7 +2872,7 @@ reorder_links link_singletons permute_entries - get_distance_computer + get_distance_computer add_with_ids assign remove_ids @@ -2907,7 +2907,7 @@ reorder_links link_singletons permute_entries - get_distance_computer + get_distance_computer add_with_ids assign remove_ids @@ -2953,7 +2953,7 @@ reorder_links link_singletons permute_entries - get_distance_computer + get_distance_computer add_with_ids assign remove_ids @@ -2999,7 +2999,7 @@ reorder_links link_singletons permute_entries - get_distance_computer + get_distance_computer add_with_ids assign remove_ids @@ -3111,7 +3111,7 @@ range_search_preassigned search range_search - get_InvertedListScanner + get_InvertedListScanner reconstruct update_vectors reconstruct_n @@ -3121,7 +3121,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to ~IndexIVF get_list_size @@ -3136,7 +3136,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_decode train_q1 coarse_code_size @@ -3177,7 +3177,7 @@ train_encoder train_encoder_num_vectors encode_vectors - get_InvertedListScanner + get_InvertedListScanner sa_decode reconstruct_from_offset ~IndexIVFAdditiveQuantizer @@ -3199,7 +3199,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -3212,7 +3212,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -3235,6 +3235,7 @@ skip qbs qbs2 + fine_quantizer orig_invlists invlists own_invlists @@ -3269,8 +3270,7 @@ search lookup_table_is_3d compute_LUT - sa_decode - init_fastscan + init_fastscan init_code_packer add_with_ids compute_LUT_uint8 @@ -3284,15 +3284,16 @@ search_implem_12 search_implem_14 reconstruct_from_offset - get_CodePacker + get_CodePacker reconstruct_orig_invlists + sa_decode reset train add add_core add_sa_codes range_search_preassigned - get_InvertedListScanner + get_InvertedListScanner reconstruct update_vectors reconstruct_n @@ -3313,7 +3314,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -3329,6 +3330,7 @@ skip qbs qbs2 + fine_quantizer orig_invlists invlists own_invlists @@ -3353,7 +3355,7 @@ clustering_index IndexIVFFastScan IndexIVFFastScan - init_fastscan + init_fastscan init_code_packer ~IndexIVFFastScan add_with_ids @@ -3371,8 +3373,9 @@ search_implem_12 search_implem_14 reconstruct_from_offset - get_CodePacker + get_CodePacker reconstruct_orig_invlists + sa_decode reset train add @@ -3382,7 +3385,7 @@ train_encoder train_encoder_num_vectors range_search_preassigned - get_InvertedListScanner + get_InvertedListScanner reconstruct update_vectors reconstruct_n @@ -3403,8 +3406,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer - sa_decode + get_distance_computer train_q1 coarse_code_size encode_listno @@ -3416,7 +3418,7 @@ IndexIVFFlat add_core encode_vectors - get_InvertedListScanner + get_InvertedListScanner reconstruct_from_offset sa_decode IndexIVFFlat @@ -3439,7 +3441,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -3452,7 +3454,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -3515,7 +3517,7 @@ IndexIVFFlatDedup add_core encode_vectors - get_InvertedListScanner + get_InvertedListScanner sa_decode reset add @@ -3530,7 +3532,7 @@ search_and_return_codes check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -3543,7 +3545,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -3579,7 +3581,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -3638,7 +3640,7 @@ train_encoder train_encoder_num_vectors encode_vectors - get_InvertedListScanner + get_InvertedListScanner sa_decode reconstruct_from_offset reset @@ -3659,7 +3661,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -3672,7 +3674,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -3696,6 +3698,7 @@ skip qbs qbs2 + fine_quantizer orig_invlists invlists own_invlists @@ -3728,8 +3731,7 @@ search lookup_table_is_3d compute_LUT - sa_decode - init_fastscan + init_fastscan init_code_packer add_with_ids compute_LUT_uint8 @@ -3743,15 +3745,16 @@ search_implem_12 search_implem_14 reconstruct_from_offset - get_CodePacker + get_CodePacker reconstruct_orig_invlists + sa_decode reset train add add_core add_sa_codes range_search_preassigned - get_InvertedListScanner + get_InvertedListScanner reconstruct update_vectors reconstruct_n @@ -3772,7 +3775,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -3822,7 +3825,7 @@ encode encode_multiple decode_multiple - get_InvertedListScanner + get_InvertedListScanner precompute_table IndexIVFPQ reset @@ -3842,7 +3845,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -3855,7 +3858,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -3876,6 +3879,7 @@ skip qbs qbs2 + fine_quantizer orig_invlists invlists own_invlists @@ -3907,8 +3911,7 @@ encode_vectors lookup_table_is_3d compute_LUT - sa_decode - init_fastscan + init_fastscan init_code_packer add_with_ids compute_LUT_uint8 @@ -3923,15 +3926,16 @@ search_implem_12 search_implem_14 reconstruct_from_offset - get_CodePacker + get_CodePacker reconstruct_orig_invlists + sa_decode reset train add add_core add_sa_codes range_search_preassigned - get_InvertedListScanner + get_InvertedListScanner reconstruct update_vectors reconstruct_n @@ -3952,7 +3956,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -4010,7 +4014,7 @@ encode encode_multiple decode_multiple - get_InvertedListScanner + get_InvertedListScanner precompute_table train add @@ -4024,7 +4028,7 @@ search_and_reconstruct search_and_return_codes check_compatible_for_merge - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -4037,7 +4041,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -4084,7 +4088,7 @@ train_encoder train_encoder_num_vectors encode_vectors - get_InvertedListScanner + get_InvertedListScanner sa_decode reconstruct_from_offset reset @@ -4105,7 +4109,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -4118,7 +4122,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -4142,6 +4146,7 @@ skip qbs qbs2 + fine_quantizer orig_invlists invlists own_invlists @@ -4174,8 +4179,7 @@ search lookup_table_is_3d compute_LUT - sa_decode - init_fastscan + init_fastscan init_code_packer add_with_ids compute_LUT_uint8 @@ -4189,15 +4193,16 @@ search_implem_12 search_implem_14 reconstruct_from_offset - get_CodePacker + get_CodePacker reconstruct_orig_invlists + sa_decode reset train add add_core add_sa_codes range_search_preassigned - get_InvertedListScanner + get_InvertedListScanner reconstruct update_vectors reconstruct_n @@ -4218,7 +4223,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -4258,7 +4263,7 @@ train_encoder train_encoder_num_vectors encode_vectors - get_InvertedListScanner + get_InvertedListScanner sa_decode reconstruct_from_offset reset @@ -4279,7 +4284,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -4292,7 +4297,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -4316,6 +4321,7 @@ skip qbs qbs2 + fine_quantizer orig_invlists invlists own_invlists @@ -4348,8 +4354,7 @@ search lookup_table_is_3d compute_LUT - sa_decode - init_fastscan + init_fastscan init_code_packer add_with_ids compute_LUT_uint8 @@ -4363,15 +4368,16 @@ search_implem_12 search_implem_14 reconstruct_from_offset - get_CodePacker + get_CodePacker reconstruct_orig_invlists + sa_decode reset train add add_core add_sa_codes range_search_preassigned - get_InvertedListScanner + get_InvertedListScanner reconstruct update_vectors reconstruct_n @@ -4392,7 +4398,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -4433,7 +4439,7 @@ train_encoder train_encoder_num_vectors encode_vectors - get_InvertedListScanner + get_InvertedListScanner sa_decode reconstruct_from_offset reset @@ -4454,7 +4460,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -4467,7 +4473,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -4491,6 +4497,7 @@ skip qbs qbs2 + fine_quantizer orig_invlists invlists own_invlists @@ -4523,8 +4530,7 @@ search lookup_table_is_3d compute_LUT - sa_decode - init_fastscan + init_fastscan init_code_packer add_with_ids compute_LUT_uint8 @@ -4538,15 +4544,16 @@ search_implem_12 search_implem_14 reconstruct_from_offset - get_CodePacker + get_CodePacker reconstruct_orig_invlists + sa_decode reset train add add_core add_sa_codes range_search_preassigned - get_InvertedListScanner + get_InvertedListScanner reconstruct update_vectors reconstruct_n @@ -4567,7 +4574,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -4605,7 +4612,7 @@ train_encoder_num_vectors encode_vectors add_core - get_InvertedListScanner + get_InvertedListScanner reconstruct_from_offset sa_decode reset @@ -4625,7 +4632,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -4638,7 +4645,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer train_q1 coarse_code_size encode_listno @@ -4684,7 +4691,7 @@ IndexIVFSpectralHash train_encoder encode_vectors - get_InvertedListScanner + get_InvertedListScanner replace_vt replace_vt ~IndexIVFSpectralHash @@ -4708,7 +4715,7 @@ remove_ids check_compatible_for_merge merge_from - get_CodePacker + get_CodePacker copy_subset_to get_list_size check_ids_sorted @@ -4721,7 +4728,7 @@ reconstruct_batch compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_decode train_q1 coarse_code_size @@ -4764,11 +4771,11 @@ reconstruct_n reconstruct remove_ids - get_FlatCodesDistanceComputer - get_distance_computer + get_FlatCodesDistanceComputer + get_distance_computer search range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -4799,16 +4806,16 @@ search sa_encode sa_decode - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer add reset reconstruct_n reconstruct sa_code_size remove_ids - get_distance_computer + get_distance_computer range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -4866,9 +4873,11 @@ search_implem_14 reconstruct remove_ids - get_CodePacker + get_CodePacker merge_from check_compatible_for_merge + sa_code_size + sa_encode add_with_ids range_search assign @@ -4877,9 +4886,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer - sa_code_size - sa_encode + get_distance_computer add_sa_codes Search_type_t component_t @@ -4900,7 +4907,7 @@ metric_type metric_arg IndexLSH - apply_preprocess + apply_preprocess train search transfer_thresholds @@ -4914,10 +4921,10 @@ reconstruct sa_code_size remove_ids - get_FlatCodesDistanceComputer - get_distance_computer + get_FlatCodesDistanceComputer + get_distance_computer range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -4984,11 +4991,11 @@ reconstruct sa_code_size remove_ids - get_FlatCodesDistanceComputer - get_distance_computer + get_FlatCodesDistanceComputer + get_distance_computer search range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -5032,7 +5039,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -5057,7 +5064,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -5113,7 +5120,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -5142,7 +5149,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -5187,7 +5194,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -5232,7 +5239,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -5288,7 +5295,7 @@ search sa_encode sa_decode - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer search_core_polysemous hamming_distance_histogram hamming_distance_table @@ -5298,9 +5305,9 @@ reconstruct sa_code_size remove_ids - get_distance_computer + get_distance_computer range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -5374,9 +5381,11 @@ search_implem_14 reconstruct remove_ids - get_CodePacker + get_CodePacker merge_from check_compatible_for_merge + sa_code_size + sa_encode add_with_ids range_search assign @@ -5385,9 +5394,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer - sa_code_size - sa_encode + get_distance_computer add_sa_codes component_t distance_t @@ -5423,9 +5430,9 @@ reconstruct reconstruct_n search_and_reconstruct - apply_chain + apply_chain reverse_chain - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -5457,16 +5464,16 @@ search sa_encode sa_decode - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer add reset reconstruct_n reconstruct sa_code_size remove_ids - get_distance_computer + get_distance_computer range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -5524,9 +5531,11 @@ search_implem_14 reconstruct remove_ids - get_CodePacker + get_CodePacker merge_from check_compatible_for_merge + sa_code_size + sa_encode add_with_ids range_search assign @@ -5535,9 +5544,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer - sa_code_size - sa_encode + get_distance_computer add_sa_codes Search_type_t component_t @@ -5560,16 +5567,16 @@ search sa_encode sa_decode - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer add reset reconstruct_n reconstruct sa_code_size remove_ids - get_distance_computer + get_distance_computer range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -5627,9 +5634,11 @@ search_implem_14 reconstruct remove_ids - get_CodePacker + get_CodePacker merge_from check_compatible_for_merge + sa_code_size + sa_encode add_with_ids range_search assign @@ -5638,9 +5647,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer - sa_code_size - sa_encode + get_distance_computer add_sa_codes Search_type_t component_t @@ -5670,11 +5677,11 @@ reconstruct sa_code_size remove_ids - get_FlatCodesDistanceComputer - get_distance_computer + get_FlatCodesDistanceComputer + get_distance_computer search range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -5712,7 +5719,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -5754,7 +5761,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer merge_from check_compatible_for_merge add_sa_codes @@ -5782,7 +5789,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer merge_from check_compatible_for_merge add_sa_codes @@ -5825,14 +5832,14 @@ runOnIndex reset count - at - at + at + at onAfterAddIndex onAfterRemoveIndex own_indices indices_ isThreaded_ - waitAndHandleFutures + waitAndHandleFutures faiss::IndexResidualQuantizer rq @@ -5852,16 +5859,16 @@ search sa_encode sa_decode - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer add reset reconstruct_n reconstruct sa_code_size remove_ids - get_distance_computer + get_distance_computer range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -5919,9 +5926,11 @@ search_implem_14 reconstruct remove_ids - get_CodePacker + get_CodePacker merge_from check_compatible_for_merge + sa_code_size + sa_encode add_with_ids range_search assign @@ -5930,9 +5939,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer - sa_code_size - sa_encode + get_distance_computer add_sa_codes Search_type_t component_t @@ -5959,7 +5966,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer merge_from check_compatible_for_merge add_sa_codes @@ -6001,7 +6008,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -6032,7 +6039,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer merge_from check_compatible_for_merge add_sa_codes @@ -6061,7 +6068,7 @@ IndexScalarQuantizer train search - get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer sa_encode sa_decode add @@ -6070,9 +6077,9 @@ reconstruct sa_code_size remove_ids - get_distance_computer + get_distance_computer range_search - get_CodePacker + get_CodePacker check_compatible_for_merge merge_from add_sa_codes @@ -6102,8 +6109,8 @@ runOnIndex reset count - at - at + at + at train_q1 coarse_code_size encode_listno @@ -6122,7 +6129,7 @@ onAfterRemoveIndex indices_ isThreaded_ - waitAndHandleFutures + waitAndHandleFutures faiss::IndexShardsTemplate component_t @@ -6145,13 +6152,13 @@ runOnIndex reset count - at - at + at + at onAfterAddIndex onAfterRemoveIndex indices_ isThreaded_ - waitAndHandleFutures + waitAndHandleFutures faiss::IndexSplitVectors own_fields @@ -6182,7 +6189,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -6242,15 +6249,15 @@ InvertedLists ~InvertedLists list_size - get_codes - get_ids + get_codes + get_ids release_codes release_ids get_single_id - get_single_code + get_single_code prefetch_lists is_empty - get_iterator + get_iterator add_entry add_entries update_entry @@ -6284,19 +6291,19 @@ classname InvertedListsIOHook write - read - read_ArrayInvertedLists + read + read_ArrayInvertedLists ~InvertedListsIOHook add_callback print_callbacks - lookup - lookup_classname + lookup + lookup_classname faiss::InvertedListsIterator ~InvertedListsIterator is_available next - get_id_and_codes + get_id_and_codes faiss::IOReader name @@ -6332,7 +6339,7 @@ set_is_orthonormal print_if_verbose check_identical - apply + apply faiss::ITQTransform mean @@ -6347,7 +6354,7 @@ train apply_noalloc check_identical - apply + apply reverse_transform faiss::IVFFastScanStats @@ -6442,7 +6449,7 @@ check_identical ~LinearTransform train - apply + apply faiss::LocalSearchCoarseQuantizer lsq @@ -6470,7 +6477,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -6579,18 +6586,18 @@ use_iterator MaskedInvertedLists list_size - get_codes - get_ids + get_codes + get_ids release_codes release_ids get_single_id - get_single_code + get_single_code prefetch_lists add_entries update_entries resize is_empty - get_iterator + get_iterator add_entry update_entry reset @@ -6663,7 +6670,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -6699,7 +6706,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -6744,7 +6751,7 @@ rnn_new Nhood Nhood - operator= + operator= Nhood insert join @@ -6773,8 +6780,8 @@ nndescent join update - generate_eval_set - eval_recall + generate_eval_set + eval_recall faiss::HNSW::NodeDistCloser d @@ -6799,7 +6806,7 @@ reverse_transform check_identical train - apply + apply faiss::NormTableScaler nscale @@ -6864,8 +6871,8 @@ use_iterator OnDiskInvertedLists list_size - get_codes - get_ids + get_codes + get_ids add_entries update_entries resize @@ -6884,9 +6891,9 @@ release_codes release_ids get_single_id - get_single_code + get_single_code is_empty - get_iterator + get_iterator add_entry update_entry reset @@ -6900,14 +6907,14 @@ faiss::OnDiskInvertedListsIOHook OnDiskInvertedListsIOHook write - read - read_ArrayInvertedLists + read + read_ArrayInvertedLists key classname add_callback print_callbacks - lookup - lookup_classname + lookup + lookup_classname faiss::OnDiskOneList size @@ -6968,7 +6975,7 @@ set_is_orthonormal print_if_verbose check_identical - apply + apply faiss::ParameterRange name @@ -6986,7 +6993,7 @@ combination_ge combination_name display - add_range + add_range initialize set_index_parameters set_index_parameters @@ -7062,7 +7069,7 @@ set_is_orthonormal print_if_verbose check_identical - apply + apply faiss::MatrixStats::PerDimStats n @@ -7176,7 +7183,7 @@ ProductAdditiveQuantizer ~ProductAdditiveQuantizer init - subquantizer + subquantizer train compute_codes_add_centroids compute_unpacked_codes @@ -7212,7 +7219,7 @@ ProductLocalSearchQuantizer ProductLocalSearchQuantizer init - subquantizer + subquantizer train compute_codes_add_centroids compute_unpacked_codes @@ -7287,8 +7294,8 @@ sdc_table d code_size - get_centroids - get_centroids + get_centroids + get_centroids train ProductQuantizer ProductQuantizer @@ -7315,7 +7322,7 @@ ProductResidualQuantizer ProductResidualQuantizer init - subquantizer + subquantizer train compute_codes_add_centroids compute_unpacked_codes @@ -7413,7 +7420,7 @@ ProgressiveDimClusteringParameters faiss::ProgressiveDimIndexFactory - operator() + operator() ~ProgressiveDimIndexFactory PyCallbackIDSelector @@ -7449,7 +7456,7 @@ d M QINCo - get_step + get_step decode encode ~QINCo @@ -7463,7 +7470,7 @@ MLPconcat residual_blocks QINCoStep - get_residual_block + get_residual_block encode decode @@ -7496,7 +7503,7 @@ set_is_orthonormal print_if_verbose check_identical - apply + apply have_bias is_orthonormal A @@ -7577,7 +7584,7 @@ buffers wp RangeSearchPartialResult - new_result + new_result finalize set_lims copy_result @@ -7602,15 +7609,15 @@ update_entries resize list_size - get_codes - get_ids + get_codes + get_ids release_codes release_ids get_single_id - get_single_code + get_single_code prefetch_lists is_empty - get_iterator + get_iterator add_entry update_entry reset @@ -7655,7 +7662,7 @@ RemapDimensionsTransform check_identical train - apply + apply faiss::Repeat val @@ -7785,7 +7792,7 @@ search_and_reconstruct compute_residual compute_residual_n - get_distance_computer + get_distance_computer sa_code_size sa_encode sa_decode @@ -7926,9 +7933,9 @@ train compute_codes decode - select_quantizer - get_distance_computer - select_InvertedListScanner + select_quantizer + get_distance_computer + select_InvertedListScanner faiss::InvertedLists::ScopedCodes il @@ -7936,7 +7943,7 @@ list_no ScopedCodes ScopedCodes - get + get ~ScopedCodes faiss::InvertedLists::ScopedIds @@ -7944,7 +7951,7 @@ ids list_no ScopedIds - get + get operator[] ~ScopedIds @@ -8006,13 +8013,13 @@ data i f - @1 + u8 u16 u32 f32 - @5 - @7 + + simd16uint16 simd16uint16 simd16uint16 @@ -8154,13 +8161,13 @@ faiss::simd256bit i f - @1 + u8 u16 u32 f32 - @5 - @7 + + simd256bit simd256bit simd256bit @@ -8228,19 +8235,19 @@ bin i f - @3 + faiss::simd32uint8 data i f - @1 + u8 u16 u32 f32 - @5 - @7 + + simd32uint8 simd32uint8 simd32uint8 @@ -8322,7 +8329,7 @@ faiss::simd512bit i f - @3 + simd512bit simd512bit simd512bit @@ -8364,19 +8371,19 @@ bin i f - @3 + faiss::simd8float32 data i f - @1 + u8 u16 u32 f32 - @5 - @7 + + simd8float32 simd8float32 simd8float32 @@ -8386,7 +8393,7 @@ operator* operator+ operator- - operator+= + operator+= operator== operator!= tostring @@ -8399,7 +8406,7 @@ operator* operator+ operator- - operator+= + operator+= operator== operator!= tostring @@ -8418,7 +8425,7 @@ operator* operator+ operator- - operator+= + operator+= operator== operator!= is_same_as @@ -8432,7 +8439,7 @@ operator* operator+ operator- - operator+= + operator+= operator== operator!= tostring @@ -8447,13 +8454,13 @@ data i f - @1 + u8 u16 u32 f32 - @5 - @7 + + simd8uint32 simd8uint32 simd8uint32 @@ -8462,7 +8469,7 @@ simd8uint32 operator+ operator- - operator+= + operator+= operator== operator!= elements_to_string @@ -8477,7 +8484,7 @@ simd8uint32 operator+ operator- - operator+= + operator+= operator== operator!= elements_to_string @@ -8493,7 +8500,7 @@ simd8uint32 operator+ operator- - operator+= + operator+= operator== operator~ operator!= @@ -8516,7 +8523,7 @@ simd8uint32 operator+ operator- - operator+= + operator+= operator== operator!= elements_to_string @@ -8674,18 +8681,18 @@ use_iterator SliceInvertedLists list_size - get_codes - get_ids + get_codes + get_ids release_codes release_ids get_single_id - get_single_code + get_single_code prefetch_lists add_entries update_entries resize is_empty - get_iterator + get_iterator add_entry update_entry reset @@ -8757,7 +8764,7 @@ Stack ~Stack getSizeAvailable - getAlloc + getAlloc returnAlloc toString @@ -8768,7 +8775,7 @@ StackDeviceMemory ~StackDeviceMemory getDevice - allocMemory + allocMemory deallocMemory getSizeAvailable toString @@ -8777,7 +8784,7 @@ res_ StandardGpuResources ~StandardGpuResources - getResources + getResources supportsBFloat16 supportsBFloat16CurrentDevice noTempMemory @@ -8786,7 +8793,7 @@ setDefaultStream revertDefaultStream setDefaultNullStreamAllDevices - getMemoryInfo + getMemoryInfo getDefaultStream getTempMemoryAvailable syncDefaultStreamCurrentDevice @@ -8818,12 +8825,12 @@ setLogMemoryAllocations initializeForDevice getBlasHandle - getAlternateStreams - allocMemory + getAlternateStreams + allocMemory deallocMemory getTempMemoryAvailable - getMemoryInfo - getPinnedMemory + getMemoryInfo + getPinnedMemory getAsyncCopyStream supportsBFloat16CurrentDevice getBlasHandleCurrentDevice @@ -8832,7 +8839,7 @@ allocMemoryHandle syncDefaultStream syncDefaultStreamCurrentDevice - getAlternateStreamsCurrentDevice + getAlternateStreamsCurrentDevice getAsyncCopyStreamCurrentDevice isInitialized getDefaultTempMemForGPU @@ -8845,18 +8852,18 @@ use_iterator StopWordsInvertedLists list_size - get_codes - get_ids + get_codes + get_ids release_codes release_ids get_single_id - get_single_code + get_single_code prefetch_lists add_entries update_entries resize is_empty - get_iterator + get_iterator add_entry update_entry reset @@ -8889,11 +8896,11 @@ shape v Tensor2DTemplate - operator+= + operator+= column numel - data - data + data + data faiss::ThreadedIndex own_indices @@ -8908,11 +8915,11 @@ runOnIndex reset count - at - at + at + at onAfterAddIndex onAfterRemoveIndex - waitAndHandleFutures + waitAndHandleFutures faiss::TimeoutCallback start @@ -8929,9 +8936,9 @@ faiss::gpu::ToCPUCloner merge_index - clone_Index - clone_VectorTransform - clone_IndexIVF + clone_Index + clone_VectorTransform + clone_IndexIVF faiss::gpu::ToGpuCloner provider @@ -8946,9 +8953,9 @@ use_cuvs allowCpuCoarseQuantizer ToGpuCloner - clone_Index - clone_VectorTransform - clone_IndexIVF + clone_Index + clone_VectorTransform + clone_IndexIVF faiss::gpu::ToGpuClonerMultiple sub_cloners @@ -8967,10 +8974,10 @@ ToGpuClonerMultiple ToGpuClonerMultiple copy_ivf_shard - clone_Index_to_shards - clone_Index - clone_VectorTransform - clone_IndexIVF + clone_Index_to_shards + clone_Index + clone_VectorTransform + clone_IndexIVF faiss::Top1BlockResultHandler T @@ -9043,7 +9050,7 @@ is_trained VectorTransform train - apply + apply apply_noalloc reverse_transform check_identical @@ -9065,18 +9072,18 @@ use_iterator VStackInvertedLists list_size - get_codes - get_ids + get_codes + get_ids release_codes release_ids get_single_id - get_single_code + get_single_code prefetch_lists add_entries update_entries resize is_empty - get_iterator + get_iterator add_entry update_entry reset @@ -9103,7 +9110,7 @@ ~WorkerThread stop waitForThreadExit - add + add startThread threadMain threadLoop @@ -9241,9 +9248,9 @@ hamdis_tab_ham_bytes partition_stats bucket_sort_verbose - clone_index - clone_Quantizer - clone_binary_index + clone_index + clone_Quantizer + clone_binary_index kmeans_clustering reverse_index_factory reverse_index_factory @@ -9251,17 +9258,17 @@ distance_four_codes_generic distance_single_code distance_four_codes - handleExceptions + handleExceptions demangle_cpp_symbol search_from_candidates greedy_update_nearest - search_from_candidate_unbounded + search_from_candidate_unbounded search_neighbors_to_add read_index_header read_direct_map - read_ivf_header + read_ivf_header read_InvertedLists - set_array_invlist + set_array_invlist read_ProductQuantizer read_ScalarQuantizer fourcc @@ -9287,30 +9294,30 @@ beam_search_encode_step_tab dispatch_knn_ResultHandler dispatch_range_ResultHandler - index_factory - index_binary_factory + index_factory + index_binary_factory write_index write_index write_index write_index_binary write_index_binary write_index_binary - read_index - read_index - read_index - read_index_binary - read_index_binary - read_index_binary + read_index + read_index + read_index + read_index_binary + read_index_binary + read_index_binary write_VectorTransform write_VectorTransform - read_VectorTransform - read_VectorTransform - read_ProductQuantizer - read_ProductQuantizer + read_VectorTransform + read_VectorTransform + read_ProductQuantizer + read_ProductQuantizer write_ProductQuantizer write_ProductQuantizer write_InvertedLists - read_InvertedLists + read_InvertedLists initialize_IVFPQ_precomputed_table lo_build lo_listno @@ -9354,11 +9361,11 @@ compute_PQ_dis_tables_dsub2 fvec_madd fvec_madd_and_argmin - exhaustive_L2sqr_fused_cmax + exhaustive_L2sqr_fused_cmax dispatch_VectorDistance pairwise_extra_distances knn_extra_metrics - get_extra_distance_computer + get_extra_distance_computer encode_fp16 decode_fp16 bitvec_print @@ -9386,8 +9393,14 @@ hamming< 128 > hamming< 256 > generalized_hamming_64 + hamming< 64 > + hamming< 128 > + hamming< 256 > popcount32 popcount64 + hamming< 64 > + hamming< 128 > + hamming< 256 > SPECIALIZED_HC SPECIALIZED_HC SPECIALIZED_HC @@ -9492,7 +9505,7 @@ ivec_checksum bvec_checksum bvecs_checksum - fvecs_maybe_subsample + fvecs_maybe_subsample binary_to_real real_to_binary hash_bytes @@ -9552,12 +9565,12 @@ bin bin bin - set1 + set1 elements_to_string - unary_func - unary_func - binary_func - binary_func + unary_func + unary_func + binary_func + binary_func vmovmask_u8 cmp_xe32 vshlq @@ -9603,18 +9616,18 @@ Temporary Device Unified - index_gpu_to_cpu - index_cpu_to_gpu - index_cpu_to_gpu_multiple - index_binary_gpu_to_cpu - index_binary_cpu_to_gpu - index_binary_cpu_to_gpu_multiple + index_gpu_to_cpu + index_cpu_to_gpu + index_cpu_to_gpu_multiple + index_binary_gpu_to_cpu + index_binary_cpu_to_gpu + index_binary_cpu_to_gpu_multiple should_use_cuvs bfKnn bfKnn_tiling bruteForceKnn should_use_cuvs - tryCastGpuIndex + tryCastGpuIndex isGpuIndex isGpuIndexImplemented allocTypeToString @@ -9625,20 +9638,20 @@ getMaxKSelection validateKSelect validateNProbe - unpackNonInterleaved - unpackInterleaved - packNonInterleaved - packInterleaved - ivfOffsetToUserIndex + unpackNonInterleaved + unpackInterleaved + packNonInterleaved + packInterleaved + ivfOffsetToUserIndex newTestSeed setTestSeed relativeError randVal randBool randSelect - randVecs - randBinaryVecs - roundToHalf + randVecs + randBinaryVecs + roundToHalf compareIndices compareIndices compareLists @@ -9652,8 +9665,8 @@ profilerStart profilerStop synchronizeAllDevices - getDeviceProperties - getCurrentDeviceProperties + getDeviceProperties + getCurrentDeviceProperties getMaxThreads getMaxThreadsCurrentDevice getMaxGrid @@ -9687,18 +9700,18 @@ faiss::ivflib check_compatible_for_merge - extract_index_ivf - extract_index_ivf - try_extract_index_ivf - try_extract_index_ivf + extract_index_ivf + extract_index_ivf + try_extract_index_ivf + try_extract_index_ivf merge_into search_centroid search_and_return_centroids - get_invlist_range + get_invlist_range set_invlist_range search_with_parameters range_search_with_parameters - ivf_residual_from_quantizer + ivf_residual_from_quantizer ivf_residual_add_from_flat_codes faiss::lsq @@ -9710,7 +9723,7 @@ faiss::nndescent faiss::nsg - storage_distance_computer + storage_distance_computer faiss::quantize_lut round_uint8_per_column @@ -10286,10 +10299,10 @@ faiss/utils/hamming_distance - faiss/impl - faiss/gpu/impl + faiss/impl + faiss/invlists faiss/gpu/perf @@ -10304,10 +10317,10 @@ faiss/utils/transpose - faiss/utils - faiss/gpu/utils + faiss/utils + faiss/gpu/utils/warpselect diff --git a/xml/index.xsd b/xml/index.xsd index edb1d347d9..6c847cc363 100644 --- a/xml/index.xsd +++ b/xml/index.xsd @@ -45,6 +45,8 @@ + + diff --git a/xml/index__factory_8h.xml b/xml/index__factory_8h.xml index f783e2faac..506601439d 100644 --- a/xml/index__factory_8h.xml +++ b/xml/index__factory_8h.xml @@ -1,36 +1,15 @@ - + index_factory.h faiss/Index.h faiss/IndexBinary.h - - - - - - + + + + - - - - - - - - - - - - - - - - - - - @@ -39,14 +18,10 @@ - - - - - - - + + + @@ -55,6 +30,8 @@ + + @@ -62,6 +39,14 @@ + + + + + + + + @@ -70,6 +55,21 @@ + + + + + + + + + + + + + + + faiss @@ -93,7 +93,7 @@ /**Buildandindexwiththesequenceofprocessingstepsdescribedin *thestring.*/ -Index*index_factory( +Index*index_factory( intd, constchar*description, MetricTypemetric=METRIC_L2); diff --git a/xml/index__io_8h.xml b/xml/index__io_8h.xml index 333f9f2e0e..1d2a9ced5d 100644 --- a/xml/index__io_8h.xml +++ b/xml/index__io_8h.xml @@ -1,5 +1,5 @@ - + index_io.h cstdio @@ -9,18 +9,6 @@ faiss/invlists/BlockInvertedLists.h faiss/invlists/OnDiskInvertedLists.h - - - - - - - - - - - - @@ -33,16 +21,20 @@ - - + + + - - + - - - + + + + + + + @@ -51,6 +43,14 @@ + + + + + + + + faiss diff --git a/xml/index__read__utils_8h.xml b/xml/index__read__utils_8h.xml index 10be3f03d1..a401c7b0b5 100644 --- a/xml/index__read__utils_8h.xml +++ b/xml/index__read__utils_8h.xml @@ -1,24 +1,10 @@ - + index_read_utils.h faiss/IndexIVF.h faiss/impl/io.h - - - - - - - - - - - - - - @@ -27,8 +13,19 @@ - - + + + + + + + + + + + + + @@ -56,26 +53,12 @@ - - - - - - + + + + - - - - - - - - - - - - @@ -86,12 +69,6 @@ - - - - - - @@ -100,14 +77,41 @@ - - + + + + + + + + + + + - - + + + + + + + - - + + + + + + + + + + + + + + + @@ -141,58 +145,54 @@ - - - - - - - - - - - - - - + + - - - - - - - - - - - - - + + - - - - - + + - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + faiss diff --git a/xml/io_8h.xml b/xml/io_8h.xml index ff17f8d48c..1358213967 100644 --- a/xml/io_8h.xml +++ b/xml/io_8h.xml @@ -1,5 +1,5 @@ - + io.h cstdio @@ -10,31 +10,25 @@ faiss/invlists/InvertedListsIOHook.h faiss/python/python_callbacks.h - - - - + + + + + + + + + + - - - - - - - - - - - - - - - - - + + + + + @@ -48,40 +42,38 @@ - - - - + + + + - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - - - - - - - @@ -104,6 +96,14 @@ + + + + + + + + faiss::IOReader faiss::IOWriter @@ -155,7 +155,7 @@ //returnafilenumberthatcanbememory-mapped virtualintfiledescriptor(); -virtual~IOReader(){} +virtual~IOReader(){} }; structIOWriter{ @@ -168,7 +168,7 @@ //returnafilenumberthatcanbememory-mapped virtualintfiledescriptor(); -virtual~IOWriter()noexcept(false){} +virtual~IOWriter()noexcept(false){} }; structVectorIOReader:IOReader{ @@ -190,7 +190,7 @@ FileIOReader(constchar*fname); -~FileIOReader()override; +~FileIOReader()override; size_toperator()(void*ptr,size_tsize,size_tnitems)override; @@ -205,7 +205,7 @@ FileIOWriter(constchar*fname); -~FileIOWriter()override; +~FileIOWriter()override; size_toperator()(constvoid*ptr,size_tsize,size_tnitems)override; @@ -251,7 +251,7 @@ size_toperator()(constvoid*ptr,size_tsize,size_tnitems)override; //flushes -~BufferedIOWriter()override; +~BufferedIOWriter()override; }; ///casta4-characterstringtoauint32_tthatcanbewrittenandreadeasily diff --git a/xml/io__macros_8h.xml b/xml/io__macros_8h.xml index 39cc067d51..b6649b4a35 100644 --- a/xml/io__macros_8h.xml +++ b/xml/io__macros_8h.xml @@ -1,8 +1,8 @@ - + io_macros.h - + READANDCHECK ptr @@ -23,7 +23,7 @@ - + READ1 @@ -50,7 +50,7 @@ - + READVECTOR @@ -68,7 +68,7 @@ - + WRITEANDCHECK @@ -90,7 +90,7 @@ - + WRITE1 @@ -118,7 +118,7 @@ - + WRITEXBVECTOR @@ -135,7 +135,7 @@ - + READXBVECTOR @@ -154,9 +154,9 @@ - + - + @@ -184,12 +184,12 @@ size_tret=(*f)(ptr,sizeof(*(ptr)),n);\ FAISS_THROW_IF_NOT_FMT(\ ret==(n),\ -"readerrorin%s:%zd!=%zd(%s)",\ -f->name.c_str(),\ -ret,\ -size_t(n),\ -strerror(errno));\ -} +"readerrorin%s:%zd!=%zd(%s)",\ +f->name.c_str(),\ +ret,\ +size_t(n),\ +strerror(errno));\ +} #defineREAD1(x)READANDCHECK(&(x),1) @@ -214,12 +214,12 @@ size_tret=(*f)(ptr,sizeof(*(ptr)),n);\ FAISS_THROW_IF_NOT_FMT(\ ret==(n),\ -"writeerrorin%s:%zd!=%zd(%s)",\ -f->name.c_str(),\ -ret,\ -size_t(n),\ -strerror(errno));\ -} +"writeerrorin%s:%zd!=%zd(%s)",\ +f->name.c_str(),\ +ret,\ +size_t(n),\ +strerror(errno));\ +} #defineWRITE1(x)WRITEANDCHECK(&(x),1) diff --git a/xml/kmeans1d_8h.xml b/xml/kmeans1d_8h.xml index b5120bb2c2..25278707fd 100644 --- a/xml/kmeans1d_8h.xml +++ b/xml/kmeans1d_8h.xml @@ -1,12 +1,37 @@ - + kmeans1d.h faiss/Index.h functional - - + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -19,45 +44,20 @@ - - - - - - - - - - - - - + + - - - - - - - - - - - - - + + - - - - - + + faiss diff --git a/xml/lattice__Zn_8h.xml b/xml/lattice__Zn_8h.xml index b617a700ba..7cc2bae96b 100644 --- a/xml/lattice__Zn_8h.xml +++ b/xml/lattice__Zn_8h.xml @@ -1,5 +1,5 @@ - + lattice_Zn.h stddef.h @@ -7,15 +7,6 @@ vector faiss/IndexLattice.h - - - - - - - - - @@ -26,6 +17,15 @@ + + + + + + + + + @@ -136,7 +136,7 @@ int64_t*idx, float*dis); -virtual~EnumeratedVectors(){} +virtual~EnumeratedVectors(){} }; structRepeat{ diff --git a/xml/mode_8h.xml b/xml/mode_8h.xml index 9973433550..11e2d4fb77 100644 --- a/xml/mode_8h.xml +++ b/xml/mode_8h.xml @@ -1,113 +1,113 @@ - + mode.h - faiss/impl/residual_quantizer_encode_steps.h - faiss/impl/ResidualQuantizer.h faiss/IndexBinaryFlat.h + faiss/impl/ResidualQuantizer.h + faiss/impl/residual_quantizer_encode_steps.h faiss/utils/approx_topk/approx_topk.h faiss/utils/hamming.h - + - + - - - - + + + + + + + + - + - + - + - + - + - - - - - - - + + + - - - + + + + + + + + + + + + + - - - - - - + + + + - + - + - - - - - + - - - + - + - - - - - + - - - + + + - - - + + + - - - - - - + + + + - + + + + + - - - + + + - + int ApproxTopK_mode_t @@ -164,7 +164,7 @@ - + diff --git a/xml/namespacefaiss.xml b/xml/namespacefaiss.xml index cd835bee3a..39f32d5d9a 100644 --- a/xml/namespacefaiss.xml +++ b/xml/namespacefaiss.xml @@ -1,172 +1,134 @@ - + faiss + faiss::AdditiveCoarseQuantizer + faiss::AdditiveQuantizer + faiss::AlignedTable + faiss::AlignedTableTightAlloc + faiss::ArrayInvertedLists faiss::AutoTuneCriterion - faiss::OneRecallAtRCriterion - faiss::IntersectionCriterion - faiss::OperatingPoint - faiss::OperatingPoints - faiss::ParameterRange - faiss::ParameterSpace + faiss::BinaryInvertedListScanner + faiss::BitstringReader + faiss::BitstringWriter + faiss::BlockInvertedLists + faiss::BlockInvertedListsIOHook + faiss::BlockResultHandler + faiss::BufferedIOReader + faiss::BufferedIOWriter + faiss::BufferList + faiss::CenteringTransform faiss::Cloner - faiss::ClusteringParameters - faiss::ClusteringIterationStats faiss::Clustering faiss::Clustering1D - faiss::ProgressiveDimClusteringParameters - faiss::ProgressiveDimIndexFactory - faiss::ProgressiveDimClustering - faiss::AdditiveQuantizer - faiss::RangeSearchResult - faiss::BufferList - faiss::RangeQueryResult - faiss::RangeSearchPartialResult - faiss::InterruptCallback - faiss::TimeoutCallback - faiss::VisitedTable + faiss::ClusteringIterationStats + faiss::ClusteringParameters + faiss::CMax + faiss::CMin faiss::CodePacker faiss::CodePackerFlat + faiss::CodePackerPQ4 + faiss::CodeSet + faiss::CombinerRangeKNN + faiss::DirectMap + faiss::DirectMapAdd faiss::DistanceComputer - faiss::NegativeDistanceComputer - faiss::FlatCodesDistanceComputer + faiss::DummyScaler + faiss::EnumeratedVectors faiss::FaissException - faiss::TransformedVectors - faiss::ResultHandler - faiss::SearchParametersHNSW + faiss::FastScanStats + faiss::FileIOReader + faiss::FileIOWriter + faiss::FlatCodesDistanceComputer + faiss::GenHammingComputer16 + faiss::GenHammingComputer32 + faiss::GenHammingComputer8 + faiss::GenHammingComputerM8 + faiss::HammingComputer + faiss::HammingComputer16 + faiss::HammingComputer20 + faiss::HammingComputer32 + faiss::HammingComputer4 + faiss::HammingComputer64 + faiss::HammingComputer8 + faiss::HammingComputerDefault + faiss::HCounterState + faiss::HeapArray + faiss::HeapBlockResultHandler + faiss::HeapWithBuckets + faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N > + faiss::HeapWithBucketsForHamming16 + faiss::HeapWithBucketsForHamming16< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT > + faiss::HeapWithBucketsForHamming32 + faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT > faiss::HNSW faiss::HNSWStats + faiss::HStackInvertedLists faiss::IDSelector - faiss::IDSelectorRange + faiss::IDSelectorAll + faiss::IDSelectorAnd faiss::IDSelectorArray faiss::IDSelectorBatch faiss::IDSelectorBitmap faiss::IDSelectorNot - faiss::IDSelectorAll - faiss::IDSelectorAnd faiss::IDSelectorOr + faiss::IDSelectorRange + faiss::IDSelectorTranslated faiss::IDSelectorXOr - faiss::IOReader - faiss::IOWriter - faiss::VectorIOReader - faiss::VectorIOWriter - faiss::FileIOReader - faiss::FileIOWriter - faiss::BufferedIOReader - faiss::BufferedIOWriter - faiss::ZnSphereSearch - faiss::EnumeratedVectors - faiss::Repeat - faiss::Repeats - faiss::ZnSphereCodec - faiss::ZnSphereCodecRec - faiss::ZnSphereCodecAlt - faiss::LocalSearchQuantizer - faiss::DummyScaler - faiss::NormTableScaler - faiss::NNDescent - faiss::NSG - faiss::SimulatedAnnealingParameters - faiss::PermutationObjective - faiss::ReproduceDistancesObjective - faiss::SimulatedAnnealingOptimizer - faiss::PolysemousTraining - faiss::CodePackerPQ4 - faiss::ProductAdditiveQuantizer - faiss::ProductLocalSearchQuantizer - faiss::ProductResidualQuantizer - faiss::ProductQuantizer - faiss::PQEncoderGeneric - faiss::PQEncoder8 - faiss::PQEncoder16 - faiss::PQDecoderGeneric - faiss::PQDecoder8 - faiss::PQDecoder16 - faiss::Quantizer - faiss::ResidualQuantizer - faiss::BlockResultHandler - faiss::Top1BlockResultHandler - faiss::HeapBlockResultHandler - faiss::ReservoirTopN - faiss::ReservoirBlockResultHandler - faiss::RangeSearchBlockResultHandler - faiss::ScalarQuantizer - faiss::SIMDResultHandler - faiss::SIMDResultHandlerToFloat - faiss::ThreadedIndex - faiss::SearchParameters faiss::Index faiss::Index2Layer faiss::IndexAdditiveQuantizer - faiss::IndexResidualQuantizer - faiss::IndexLocalSearchQuantizer - faiss::IndexProductResidualQuantizer - faiss::IndexProductLocalSearchQuantizer - faiss::AdditiveCoarseQuantizer - faiss::SearchParametersResidualCoarseQuantizer - faiss::ResidualCoarseQuantizer - faiss::LocalSearchCoarseQuantizer faiss::IndexAdditiveQuantizerFastScan - faiss::IndexResidualQuantizerFastScan - faiss::IndexLocalSearchQuantizerFastScan - faiss::IndexProductResidualQuantizerFastScan - faiss::IndexProductLocalSearchQuantizerFastScan faiss::IndexBinary faiss::IndexBinaryFlat faiss::IndexBinaryFromFloat faiss::IndexBinaryHash faiss::IndexBinaryHashStats - faiss::IndexBinaryMultiHash faiss::IndexBinaryHNSW faiss::IndexBinaryIVF - faiss::BinaryInvertedListScanner + faiss::IndexBinaryMultiHash faiss::IndexFastScan - faiss::FastScanStats faiss::IndexFlat - faiss::IndexFlatIP - faiss::IndexFlatL2 faiss::IndexFlat1D faiss::IndexFlatCodes + faiss::IndexFlatIP + faiss::IndexFlatL2 faiss::IndexHNSW + faiss::IndexHNSW2Level + faiss::IndexHNSWCagra faiss::IndexHNSWFlat faiss::IndexHNSWPQ faiss::IndexHNSWSQ - faiss::IndexHNSW2Level - faiss::IndexHNSWCagra - faiss::IndexIDMapTemplate faiss::IndexIDMap2Template - faiss::IDSelectorTranslated - faiss::Level1Quantizer - faiss::SearchParametersIVF - faiss::IndexIVFInterface + faiss::IndexIDMapTemplate faiss::IndexIVF - faiss::InvertedListScanner - faiss::IndexIVFStats faiss::IndexIVFAdditiveQuantizer - faiss::IndexIVFResidualQuantizer - faiss::IndexIVFLocalSearchQuantizer - faiss::IndexIVFProductResidualQuantizer - faiss::IndexIVFProductLocalSearchQuantizer faiss::IndexIVFAdditiveQuantizerFastScan - faiss::IndexIVFLocalSearchQuantizerFastScan - faiss::IndexIVFResidualQuantizerFastScan - faiss::IndexIVFProductLocalSearchQuantizerFastScan - faiss::IndexIVFProductResidualQuantizerFastScan faiss::IndexIVFFastScan - faiss::IVFFastScanStats faiss::IndexIVFFlat faiss::IndexIVFFlatDedup faiss::IndexIVFIndependentQuantizer - faiss::IVFPQSearchParameters + faiss::IndexIVFInterface + faiss::IndexIVFLocalSearchQuantizer + faiss::IndexIVFLocalSearchQuantizerFastScan faiss::IndexIVFPQ - faiss::IndexIVFPQStats faiss::IndexIVFPQFastScan faiss::IndexIVFPQR + faiss::IndexIVFPQStats + faiss::IndexIVFProductLocalSearchQuantizer + faiss::IndexIVFProductLocalSearchQuantizerFastScan + faiss::IndexIVFProductResidualQuantizer + faiss::IndexIVFProductResidualQuantizerFastScan + faiss::IndexIVFResidualQuantizer + faiss::IndexIVFResidualQuantizerFastScan + faiss::IndexIVFScalarQuantizer faiss::IndexIVFSpectralHash + faiss::IndexIVFStats faiss::IndexLattice + faiss::IndexLocalSearchQuantizer + faiss::IndexLocalSearchQuantizerFastScan faiss::IndexLSH faiss::IndexNeuralNetCodec - faiss::IndexQINCo faiss::IndexNNDescent faiss::IndexNNDescentFlat faiss::IndexNSG @@ -174,98 +136,136 @@ faiss::IndexNSGPQ faiss::IndexNSGSQ faiss::IndexPQ - faiss::SearchParametersPQ - faiss::IndexPQStats - faiss::MultiIndexQuantizer - faiss::MultiIndexQuantizer2 faiss::IndexPQFastScan - faiss::SearchParametersPreTransform + faiss::IndexPQStats faiss::IndexPreTransform - faiss::IndexRefineSearchParameters + faiss::IndexProductLocalSearchQuantizer + faiss::IndexProductLocalSearchQuantizerFastScan + faiss::IndexProductResidualQuantizer + faiss::IndexProductResidualQuantizerFastScan + faiss::IndexQINCo + faiss::IndexRandom faiss::IndexRefine faiss::IndexRefineFlat + faiss::IndexRefineSearchParameters faiss::IndexReplicasTemplate + faiss::IndexResidualQuantizer + faiss::IndexResidualQuantizerFastScan + faiss::IndexRowwiseMinMax faiss::IndexRowwiseMinMaxBase faiss::IndexRowwiseMinMaxFP16 - faiss::IndexRowwiseMinMax faiss::IndexScalarQuantizer - faiss::IndexIVFScalarQuantizer - faiss::IndexShardsTemplate faiss::IndexShardsIVF - faiss::BlockInvertedLists - faiss::BlockInvertedListsIOHook - faiss::DirectMap - faiss::DirectMapAdd - faiss::InvertedListsIterator + faiss::IndexShardsTemplate + faiss::IndexSplitVectors + faiss::InterruptCallback + faiss::IntersectionCriterion faiss::InvertedLists - faiss::ArrayInvertedLists - faiss::ReadOnlyInvertedLists - faiss::HStackInvertedLists - faiss::SliceInvertedLists - faiss::VStackInvertedLists - faiss::MaskedInvertedLists - faiss::StopWordsInvertedLists + faiss::InvertedListScanner faiss::InvertedListsIOHook - faiss::OnDiskOneList - faiss::OnDiskInvertedLists - faiss::OnDiskInvertedListsIOHook + faiss::InvertedListsIterator + faiss::IOReader + faiss::IOWriter + faiss::ITQMatrix + faiss::ITQTransform + faiss::IVFFastScanStats + faiss::IVFPQSearchParameters + faiss::Level1Quantizer + faiss::LinearTransform + faiss::LocalSearchCoarseQuantizer + faiss::LocalSearchQuantizer + faiss::MaskedInvertedLists faiss::MatrixStats - faiss::IndexSplitVectors - faiss::IndexRandom - faiss::AlignedTableTightAlloc - faiss::AlignedTable - faiss::HeapWithBuckets - faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N > - faiss::HeapWithBucketsForHamming32 - faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT > - faiss::HeapWithBucketsForHamming16 - faiss::HeapWithBucketsForHamming16< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT > - faiss::VectorDistance - faiss::HCounterState - faiss::BitstringWriter - faiss::BitstringReader - faiss::HammingComputer4 - faiss::HammingComputer8 - faiss::HammingComputer16 - faiss::HammingComputer20 - faiss::HammingComputer32 - faiss::HammingComputer64 - faiss::HammingComputerDefault - faiss::GenHammingComputer8 - faiss::GenHammingComputer16 - faiss::GenHammingComputer32 - faiss::GenHammingComputerM8 - faiss::HammingComputer - faiss::HeapArray - faiss::QINCoStep + faiss::MultiIndexQuantizer + faiss::MultiIndexQuantizer2 + faiss::NegativeDistanceComputer faiss::NeuralNetCodec - faiss::QINCo - faiss::CMax - faiss::CMin + faiss::NNDescent + faiss::NormalizationTransform + faiss::NormTableScaler + faiss::NSG + faiss::OnDiskInvertedLists + faiss::OnDiskInvertedListsIOHook + faiss::OnDiskOneList + faiss::OneRecallAtRCriterion + faiss::OperatingPoint + faiss::OperatingPoints + faiss::OPQMatrix + faiss::ParameterRange + faiss::ParameterSpace faiss::PartitionStats + faiss::PCAMatrix + faiss::PermutationObjective + faiss::PolysemousTraining + faiss::PQDecoder16 + faiss::PQDecoder8 + faiss::PQDecoderGeneric + faiss::PQEncoder16 + faiss::PQEncoder8 + faiss::PQEncoderGeneric + faiss::ProductAdditiveQuantizer + faiss::ProductLocalSearchQuantizer + faiss::ProductQuantizer + faiss::ProductResidualQuantizer + faiss::ProgressiveDimClustering + faiss::ProgressiveDimClusteringParameters + faiss::ProgressiveDimIndexFactory + faiss::QINCo + faiss::QINCoStep + faiss::Quantizer faiss::RandomGenerator - faiss::SplitMix64RandomGenerator - faiss::simd256bit + faiss::RandomRotationMatrix + faiss::RangeQueryResult + faiss::RangeSearchBlockResultHandler + faiss::RangeSearchPartialResult + faiss::RangeSearchResult + faiss::ReadOnlyInvertedLists + faiss::RemapDimensionsTransform + faiss::Repeat + faiss::Repeats + faiss::ReproduceDistancesObjective + faiss::ReservoirBlockResultHandler + faiss::ReservoirTopN + faiss::ResidualCoarseQuantizer + faiss::ResidualQuantizer + faiss::ResultHandler + faiss::ScalarQuantizer + faiss::SearchParameters + faiss::SearchParametersHNSW + faiss::SearchParametersIVF + faiss::SearchParametersPQ + faiss::SearchParametersPreTransform + faiss::SearchParametersResidualCoarseQuantizer faiss::simd16uint16 + faiss::simd256bit + faiss::simd32uint16 faiss::simd32uint8 - faiss::simd8uint32 - faiss::simd8float32 faiss::simd512bit - faiss::simd32uint16 faiss::simd64uint8 - faiss::CombinerRangeKNN - faiss::CodeSet - faiss::WorkerThread + faiss::simd8float32 + faiss::simd8uint32 + faiss::SIMDResultHandler + faiss::SIMDResultHandlerToFloat + faiss::SimulatedAnnealingOptimizer + faiss::SimulatedAnnealingParameters + faiss::SliceInvertedLists + faiss::SplitMix64RandomGenerator + faiss::StopWordsInvertedLists + faiss::ThreadedIndex + faiss::TimeoutCallback + faiss::Top1BlockResultHandler + faiss::TransformedVectors + faiss::VectorDistance + faiss::VectorIOReader + faiss::VectorIOWriter faiss::VectorTransform - faiss::LinearTransform - faiss::RandomRotationMatrix - faiss::PCAMatrix - faiss::ITQMatrix - faiss::ITQTransform - faiss::OPQMatrix - faiss::RemapDimensionsTransform - faiss::NormalizationTransform - faiss::CenteringTransform + faiss::VisitedTable + faiss::VStackInvertedLists + faiss::WorkerThread + faiss::ZnSphereCodec + faiss::ZnSphereCodecAlt + faiss::ZnSphereCodecRec + faiss::ZnSphereSearch faiss::cppcontrib faiss::detail faiss::gpu @@ -277,10 +277,11 @@ faiss::quantize_lut faiss::rq_encode_steps faiss::simd_result_handlers - + MetricType + faiss::MetricType METRIC_INNER_PRODUCT = 0 @@ -380,13 +381,14 @@ - - + + IndexIDMapTemplate< Index > using faiss::IndexIDMap = typedef IndexIDMapTemplate<Index> IndexIDMap + faiss::IndexIDMap @@ -400,6 +402,7 @@ using faiss::IndexBinaryIDMap = typedef IndexIDMapTemplate<IndexBinary> IndexBinaryIDMap + faiss::IndexBinaryIDMap @@ -413,6 +416,7 @@ using faiss::IndexIDMap2 = typedef IndexIDMap2Template<Index> IndexIDMap2 + faiss::IndexIDMap2 @@ -426,6 +430,7 @@ using faiss::IndexBinaryIDMap2 = typedef IndexIDMap2Template<IndexBinary> IndexBinaryIDMap2 + faiss::IndexBinaryIDMap2 @@ -439,6 +444,7 @@ using faiss::IVFSearchParameters = typedef SearchParametersIVF IVFSearchParameters + faiss::IVFSearchParameters @@ -452,6 +458,7 @@ using faiss::IndexReplicas = typedef IndexReplicasTemplate<Index> IndexReplicas + faiss::IndexReplicas @@ -465,6 +472,7 @@ using faiss::IndexBinaryReplicas = typedef IndexReplicasTemplate<IndexBinary> IndexBinaryReplicas + faiss::IndexBinaryReplicas @@ -478,6 +486,7 @@ using faiss::IndexShards = typedef IndexShardsTemplate<Index> IndexShards + faiss::IndexShards @@ -491,6 +500,7 @@ using faiss::IndexBinaryShards = typedef IndexShardsTemplate<IndexBinary> IndexBinaryShards + faiss::IndexBinaryShards @@ -504,6 +514,7 @@ using faiss::ConcatenatedInvertedLists = typedef HStackInvertedLists ConcatenatedInvertedLists + faiss::ConcatenatedInvertedLists @@ -517,6 +528,7 @@ using faiss::idx_t = typedef int64_t idx_t + faiss::idx_t all vector indices are this type @@ -531,6 +543,7 @@ typedef HeapArray<CMin<float, int64_t> > faiss::float_minheap_array_t float_minheap_array_t + faiss::float_minheap_array_t @@ -544,6 +557,7 @@ typedef HeapArray<CMin<int, int64_t> > faiss::int_minheap_array_t int_minheap_array_t + faiss::int_minheap_array_t @@ -557,6 +571,7 @@ typedef HeapArray<CMax<float, int64_t> > faiss::float_maxheap_array_t float_maxheap_array_t + faiss::float_maxheap_array_t @@ -570,6 +585,7 @@ typedef HeapArray<CMax<int, int64_t> > faiss::int_maxheap_array_t int_maxheap_array_t + faiss::int_maxheap_array_t @@ -578,13 +594,14 @@ - - - + + + FAISS_API HNSWStats FAISS_API HNSWStats faiss::hnsw_stats hnsw_stats + faiss::hnsw_stats @@ -593,11 +610,12 @@ - + FAISS_API int FAISS_API int faiss::product_quantizer_compute_codes_bs product_quantizer_compute_codes_bs + faiss::product_quantizer_compute_codes_bs @@ -606,11 +624,12 @@ - + FAISS_API int FAISS_API int faiss::distance_compute_min_k_reservoir distance_compute_min_k_reservoir + faiss::distance_compute_min_k_reservoir @@ -619,11 +638,12 @@ - + FAISS_API bool FAISS_API bool faiss::simd_result_handlers_accept_virtual simd_result_handlers_accept_virtual + faiss::simd_result_handlers_accept_virtual @@ -632,11 +652,12 @@ - + FAISS_API int FAISS_API int faiss::index2layer_sa_encode_bs index2layer_sa_encode_bs + faiss::index2layer_sa_encode_bs @@ -645,11 +666,12 @@ - + FAISS_API int FAISS_API int faiss::index_factory_verbose index_factory_verbose + faiss::index_factory_verbose set to > 0 to get more logs from index_factory @@ -664,6 +686,7 @@ const int faiss::IO_FLAG_SKIP_STORAGE IO_FLAG_SKIP_STORAGE + faiss::IO_FLAG_SKIP_STORAGE = 1 skip the storage for graph-based indexes @@ -679,6 +702,7 @@ const int faiss::IO_FLAG_READ_ONLY IO_FLAG_READ_ONLY + faiss::IO_FLAG_READ_ONLY = 2 @@ -693,6 +717,7 @@ const int faiss::IO_FLAG_ONDISK_SAME_DIR IO_FLAG_ONDISK_SAME_DIR + faiss::IO_FLAG_ONDISK_SAME_DIR = 4 @@ -707,6 +732,7 @@ const int faiss::IO_FLAG_SKIP_IVF_DATA IO_FLAG_SKIP_IVF_DATA + faiss::IO_FLAG_SKIP_IVF_DATA = 8 @@ -721,6 +747,7 @@ const int faiss::IO_FLAG_SKIP_PRECOMPUTE_TABLE IO_FLAG_SKIP_PRECOMPUTE_TABLE + faiss::IO_FLAG_SKIP_PRECOMPUTE_TABLE = 16 @@ -735,6 +762,7 @@ const int faiss::IO_FLAG_PQ_SKIP_SDC_TABLE IO_FLAG_PQ_SKIP_SDC_TABLE + faiss::IO_FLAG_PQ_SKIP_SDC_TABLE = 32 @@ -749,6 +777,7 @@ const int faiss::IO_FLAG_MMAP IO_FLAG_MMAP + faiss::IO_FLAG_MMAP = IO_FLAG_SKIP_IVF_DATA | 0x646f0000 @@ -758,11 +787,12 @@ - + FAISS_API IndexBinaryHashStats FAISS_API IndexBinaryHashStats faiss::indexBinaryHash_stats indexBinaryHash_stats + faiss::indexBinaryHash_stats @@ -771,24 +801,26 @@ - + FAISS_API FastScanStats FAISS_API FastScanStats faiss::FastScan_stats FastScan_stats + faiss::FastScan_stats - + - + FAISS_API bool FAISS_API bool faiss::check_compatible_for_merge_expensive_check check_compatible_for_merge_expensive_check + faiss::check_compatible_for_merge_expensive_check @@ -797,11 +829,12 @@ - + FAISS_API IndexIVFStats FAISS_API IndexIVFStats faiss::indexIVF_stats indexIVF_stats + faiss::indexIVF_stats @@ -810,24 +843,26 @@ - + FAISS_API IVFFastScanStats FAISS_API IVFFastScanStats faiss::IVFFastScan_stats IVFFastScan_stats + faiss::IVFFastScan_stats - + - + FAISS_API size_t FAISS_API size_t faiss::precomputed_table_max_bytes precomputed_table_max_bytes + faiss::precomputed_table_max_bytes @@ -836,11 +871,12 @@ - + FAISS_API int FAISS_API int faiss::index_ivfpq_add_core_o_bs index_ivfpq_add_core_o_bs + faiss::index_ivfpq_add_core_o_bs @@ -849,11 +885,12 @@ - + FAISS_API IndexIVFPQStats FAISS_API IndexIVFPQStats faiss::indexIVFPQ_stats indexIVFPQ_stats + faiss::indexIVFPQ_stats @@ -862,11 +899,12 @@ - + FAISS_API IndexPQStats FAISS_API IndexPQStats faiss::indexPQ_stats indexPQ_stats + faiss::indexPQ_stats @@ -875,11 +913,12 @@ - + FAISS_API int FAISS_API int faiss::multi_index_quantizer_search_bs multi_index_quantizer_search_bs + faiss::multi_index_quantizer_search_bs @@ -888,11 +927,12 @@ - + FAISS_API int FAISS_API int faiss::rowwise_minmax_sa_encode_bs rowwise_minmax_sa_encode_bs + faiss::rowwise_minmax_sa_encode_bs block size for performing sa_encode and sa_decode @@ -902,11 +942,12 @@ - + FAISS_API int FAISS_API int faiss::rowwise_minmax_sa_decode_bs rowwise_minmax_sa_decode_bs + faiss::rowwise_minmax_sa_decode_bs @@ -915,11 +956,12 @@ - + FAISS_API int FAISS_API int faiss::distance_compute_blas_threshold distance_compute_blas_threshold + faiss::distance_compute_blas_threshold @@ -928,11 +970,12 @@ - + FAISS_API int FAISS_API int faiss::distance_compute_blas_query_bs distance_compute_blas_query_bs + faiss::distance_compute_blas_query_bs @@ -941,11 +984,12 @@ - + FAISS_API int FAISS_API int faiss::distance_compute_blas_database_bs distance_compute_blas_database_bs + faiss::distance_compute_blas_database_bs @@ -954,11 +998,12 @@ - + FAISS_API size_t FAISS_API size_t faiss::hamming_batch_size hamming_batch_size + faiss::hamming_batch_size @@ -972,6 +1017,7 @@ constexpr uint8_t faiss::hamdis_tab_ham_bytes[256] [256] hamdis_tab_ham_bytes + faiss::hamdis_tab_ham_bytes = { 0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4, 1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5, 1, 2, 2, 3, 2, 3, 3, 4, 2, 3, 3, 4, 3, 4, 4, 5, @@ -990,13 +1036,14 @@ - + - + FAISS_API PartitionStats FAISS_API PartitionStats faiss::partition_stats partition_stats + faiss::partition_stats @@ -1005,11 +1052,12 @@ - + FAISS_API int FAISS_API int faiss::bucket_sort_verbose bucket_sort_verbose + faiss::bucket_sort_verbose increase verbosity of the bucket_sort functions @@ -1019,13 +1067,14 @@ - - - + + + Index * - Index* faiss::clone_index + Index * faiss::clone_index (const Index *) clone_index + faiss::clone_index const Index * @@ -1037,11 +1086,12 @@ - + Quantizer * - Quantizer* faiss::clone_Quantizer + Quantizer * faiss::clone_Quantizer (const Quantizer *quant) clone_Quantizer + faiss::clone_Quantizer const Quantizer * quant @@ -1054,11 +1104,12 @@ - + IndexBinary * - IndexBinary* faiss::clone_binary_index + IndexBinary * faiss::clone_binary_index (const IndexBinary *index) clone_binary_index + faiss::clone_binary_index const IndexBinary * index @@ -1076,6 +1127,7 @@ float faiss::kmeans_clustering (size_t d, size_t n, size_t k, const float *x, float *centroids) kmeans_clustering + faiss::kmeans_clustering size_t d @@ -1154,6 +1206,7 @@ std::string faiss::reverse_index_factory (const faiss::Index *index) reverse_index_factory + faiss::reverse_index_factory const faiss::Index * index @@ -1171,6 +1224,7 @@ std::string faiss::reverse_index_factory (const faiss::IndexBinary *index) reverse_index_factory + faiss::reverse_index_factory const faiss::IndexBinary * index @@ -1193,6 +1247,7 @@ float faiss::distance_single_code_generic (const size_t M, const size_t nbits, const float *sim_table, const uint8_t *code) distance_single_code_generic + faiss::distance_single_code_generic const size_t M @@ -1228,6 +1283,7 @@ void faiss::distance_four_codes_generic (const size_t M, const size_t nbits, const float *sim_table, const uint8_t *__restrict code0, const uint8_t *__restrict code1, const uint8_t *__restrict code2, const uint8_t *__restrict code3, float &result0, float &result1, float &result2, float &result3) distance_four_codes_generic + faiss::distance_four_codes_generic const size_t M @@ -1291,6 +1347,7 @@ float faiss::distance_single_code (const size_t M, const size_t nbits, const float *sim_table, const uint8_t *code) distance_single_code + faiss::distance_single_code const size_t M @@ -1325,6 +1382,7 @@ void faiss::distance_four_codes (const size_t M, const size_t nbits, const float *sim_table, const uint8_t *__restrict code0, const uint8_t *__restrict code1, const uint8_t *__restrict code2, const uint8_t *__restrict code3, float &result0, float &result1, float &result2, float &result3) distance_four_codes + faiss::distance_four_codes const size_t M @@ -1377,13 +1435,14 @@ - + void void faiss::handleExceptions - (std::vector< std::pair< int, std::exception_ptr >> &exceptions) + (std::vector< std::pair< int, std::exception_ptr > > &exceptions) handleExceptions + faiss::handleExceptions - std::vector< std::pair< int, std::exception_ptr >> & + std::vector< std::pair< int, std::exception_ptr > > & exceptions @@ -1400,6 +1459,7 @@ std::string faiss::demangle_cpp_symbol (const char *name) demangle_cpp_symbol + faiss::demangle_cpp_symbol const char * name @@ -1418,6 +1478,7 @@ int faiss::search_from_candidates (const HNSW &hnsw, DistanceComputer &qdis, ResultHandler< HNSW::C > &res, HNSW::MinimaxHeap &candidates, VisitedTable &vt, HNSWStats &stats, int level, int nres_in=0, const SearchParametersHNSW *params=nullptr) search_from_candidates + faiss::search_from_candidates const HNSW & hnsw @@ -1469,6 +1530,7 @@ HNSWStats faiss::greedy_update_nearest (const HNSW &hnsw, DistanceComputer &qdis, int level, HNSW::storage_idx_t &nearest, float &d_nearest) greedy_update_nearest + faiss::greedy_update_nearest const HNSW & hnsw @@ -1497,11 +1559,12 @@ - + std::priority_queue< HNSW::Node > - std::priority_queue<HNSW::Node> faiss::search_from_candidate_unbounded + std::priority_queue< HNSW::Node > faiss::search_from_candidate_unbounded (const HNSW &hnsw, const HNSW::Node &node, DistanceComputer &qdis, int ef, VisitedTable *vt, HNSWStats &stats) search_from_candidate_unbounded + faiss::search_from_candidate_unbounded const HNSW & hnsw @@ -1539,6 +1602,7 @@ void faiss::search_neighbors_to_add (HNSW &hnsw, DistanceComputer &qdis, std::priority_queue< HNSW::NodeDistCloser > &results, int entry_point, float d_entry_point, int level, VisitedTable &vt, bool reference_version=false) search_neighbors_to_add + faiss::search_neighbors_to_add HNSW & hnsw @@ -1585,6 +1649,7 @@ void faiss::read_index_header (Index *idx, IOReader *f) read_index_header + faiss::read_index_header Index * idx @@ -1606,6 +1671,7 @@ void faiss::read_direct_map (DirectMap *dm, IOReader *f) read_direct_map + faiss::read_direct_map DirectMap * dm @@ -1622,11 +1688,12 @@ - + void void faiss::read_ivf_header - (IndexIVF *ivf, IOReader *f, std::vector< std::vector< idx_t >> *ids=nullptr) + (IndexIVF *ivf, IOReader *f, std::vector< std::vector< idx_t > > *ids=nullptr) read_ivf_header + faiss::read_ivf_header IndexIVF * ivf @@ -1636,7 +1703,7 @@ f - std::vector< std::vector< idx_t >> * + std::vector< std::vector< idx_t > > * ids nullptr @@ -1653,6 +1720,7 @@ void faiss::read_InvertedLists (IndexIVF *ivf, IOReader *f, int io_flags) read_InvertedLists + faiss::read_InvertedLists IndexIVF * ivf @@ -1673,17 +1741,18 @@ - + ArrayInvertedLists * - ArrayInvertedLists* faiss::set_array_invlist - (IndexIVF *ivf, std::vector< std::vector< idx_t >> &ids) + ArrayInvertedLists * faiss::set_array_invlist + (IndexIVF *ivf, std::vector< std::vector< idx_t > > &ids) set_array_invlist + faiss::set_array_invlist IndexIVF * ivf - std::vector< std::vector< idx_t >> & + std::vector< std::vector< idx_t > > & ids @@ -1699,6 +1768,7 @@ void faiss::read_ProductQuantizer (ProductQuantizer *pq, IOReader *f) read_ProductQuantizer + faiss::read_ProductQuantizer ProductQuantizer * pq @@ -1720,6 +1790,7 @@ void faiss::read_ScalarQuantizer (ScalarQuantizer *ivsc, IOReader *f) read_ScalarQuantizer + faiss::read_ScalarQuantizer ScalarQuantizer * ivsc @@ -1741,6 +1812,7 @@ uint32_t faiss::fourcc (const char sx[4]) fourcc + faiss::fourcc const char sx @@ -1760,6 +1832,7 @@ uint32_t faiss::fourcc (const std::string &sx) fourcc + faiss::fourcc const std::string & sx @@ -1777,6 +1850,7 @@ void faiss::fourcc_inv (uint32_t x, char str[5]) fourcc_inv + faiss::fourcc_inv uint32_t x @@ -1799,6 +1873,7 @@ std::string faiss::fourcc_inv (uint32_t x) fourcc_inv + faiss::fourcc_inv uint32_t x @@ -1816,6 +1891,7 @@ std::string faiss::fourcc_inv_printable (uint32_t x) fourcc_inv_printable + faiss::fourcc_inv_printable uint32_t x @@ -1833,6 +1909,7 @@ void faiss::smawk (const idx_t nrows, const idx_t ncols, const float *x, idx_t *argmins) smawk + faiss::smawk const idx_t nrows @@ -1898,6 +1975,7 @@ double faiss::kmeans1d (const float *x, size_t n, size_t nclusters, float *centroids) kmeans1d + faiss::kmeans1d const float * x @@ -1967,6 +2045,7 @@ void faiss::pq4_pack_codes (const uint8_t *codes, size_t ntotal, size_t M, size_t nb, size_t bbs, size_t nsq, uint8_t *blocks) pq4_pack_codes + faiss::pq4_pack_codes const uint8_t * codes @@ -2059,6 +2138,7 @@ void faiss::pq4_pack_codes_range (const uint8_t *codes, size_t M, size_t i0, size_t i1, size_t bbs, size_t nsq, uint8_t *blocks) pq4_pack_codes_range + faiss::pq4_pack_codes_range const uint8_t * codes @@ -2135,6 +2215,7 @@ uint8_t faiss::pq4_get_packed_element (const uint8_t *data, size_t bbs, size_t nsq, size_t vector_id, size_t sq) pq4_get_packed_element + faiss::pq4_get_packed_element const uint8_t * data @@ -2187,6 +2268,7 @@ void faiss::pq4_set_packed_element (uint8_t *data, uint8_t code, size_t bbs, size_t nsq, size_t vector_id, size_t sq) pq4_set_packed_element + faiss::pq4_set_packed_element uint8_t * data @@ -2243,6 +2325,7 @@ void faiss::pq4_pack_LUT (int nq, int nsq, const uint8_t *src, uint8_t *dest) pq4_pack_LUT + faiss::pq4_pack_LUT int nq @@ -2307,6 +2390,7 @@ void faiss::pq4_accumulate_loop (int nq, size_t nb, int bbs, int nsq, const uint8_t *codes, const uint8_t *LUT, SIMDResultHandler &res, const NormTableScaler *scaler) pq4_accumulate_loop + faiss::pq4_accumulate_loop int nq @@ -2411,6 +2495,7 @@ int faiss::pq4_qbs_to_nq (int qbs) pq4_qbs_to_nq + faiss::pq4_qbs_to_nq int qbs @@ -2428,6 +2513,7 @@ int faiss::pq4_preferred_qbs (int nq) pq4_preferred_qbs + faiss::pq4_preferred_qbs int nq @@ -2446,6 +2532,7 @@ int faiss::pq4_pack_LUT_qbs (int fqbs, int nsq, const uint8_t *src, uint8_t *dest) pq4_pack_LUT_qbs + faiss::pq4_pack_LUT_qbs int fqbs @@ -2512,6 +2599,7 @@ int faiss::pq4_pack_LUT_qbs_q_map (int qbs, int nsq, const uint8_t *src, const int *q_map, uint8_t *dest) pq4_pack_LUT_qbs_q_map + faiss::pq4_pack_LUT_qbs_q_map int qbs @@ -2546,6 +2634,7 @@ void faiss::pq4_accumulate_loop_qbs (int qbs, size_t nb, int nsq, const uint8_t *codes, const uint8_t *LUT, SIMDResultHandler &res, const NormTableScaler *scaler=nullptr) pq4_accumulate_loop_qbs + faiss::pq4_accumulate_loop_qbs int qbs @@ -2647,6 +2736,7 @@ void faiss::accumulate_to_mem (int nq, size_t ntotal2, int nsq, const uint8_t *codes, const uint8_t *LUT, uint16_t *accu) accumulate_to_mem + faiss::accumulate_to_mem int nq @@ -2735,6 +2825,7 @@ void faiss::beam_search_encode_step (size_t d, size_t K, const float *cent, size_t n, size_t beam_size, const float *residuals, size_t m, const int32_t *codes, size_t new_beam_size, int32_t *new_codes, float *new_residuals, float *new_distances, Index *assign_index=nullptr, ApproxTopK_mode_t approx_topk=ApproxTopK_mode_t::EXACT_TOPK) beam_search_encode_step + faiss::beam_search_encode_step size_t d @@ -2898,6 +2989,7 @@ void faiss::beam_search_encode_step_tab (size_t K, size_t n, size_t beam_size, const float *codebook_cross_norms, size_t ldc, const uint64_t *codebook_offsets, const float *query_cp, size_t ldqc, const float *cent_norms_i, size_t m, const int32_t *codes, const float *distances, size_t new_beam_size, int32_t *new_codes, float *new_distances, ApproxTopK_mode_t approx_topk=ApproxTopK_mode_t::EXACT_TOPK) beam_search_encode_step_tab + faiss::beam_search_encode_step_tab size_t K @@ -3045,6 +3137,7 @@ Consumer::T faiss::dispatch_knn_ResultHandler (size_t nx, float *vals, int64_t *ids, size_t k, MetricType metric, const IDSelector *sel, Consumer &consumer, Types... args) dispatch_knn_ResultHandler + faiss::dispatch_knn_ResultHandler size_t nx @@ -3100,6 +3193,7 @@ Consumer::T faiss::dispatch_range_ResultHandler (RangeSearchResult *res, float radius, MetricType metric, const IDSelector *sel, Consumer &consumer, Types... args) dispatch_range_ResultHandler + faiss::dispatch_range_ResultHandler RangeSearchResult * res @@ -3132,11 +3226,12 @@ - + Index * - Index* faiss::index_factory + Index * faiss::index_factory (int d, const char *description, MetricType metric=METRIC_L2) index_factory + faiss::index_factory int d @@ -3159,11 +3254,12 @@ - + IndexBinary * - IndexBinary* faiss::index_binary_factory + IndexBinary * faiss::index_binary_factory (int d, const char *description) index_binary_factory + faiss::index_binary_factory int d @@ -3185,6 +3281,7 @@ void faiss::write_index (const Index *idx, const char *fname, int io_flags=0) write_index + faiss::write_index const Index * idx @@ -3211,6 +3308,7 @@ void faiss::write_index (const Index *idx, FILE *f, int io_flags=0) write_index + faiss::write_index const Index * idx @@ -3237,6 +3335,7 @@ void faiss::write_index (const Index *idx, IOWriter *writer, int io_flags=0) write_index + faiss::write_index const Index * idx @@ -3263,6 +3362,7 @@ void faiss::write_index_binary (const IndexBinary *idx, const char *fname) write_index_binary + faiss::write_index_binary const IndexBinary * idx @@ -3284,6 +3384,7 @@ void faiss::write_index_binary (const IndexBinary *idx, FILE *f) write_index_binary + faiss::write_index_binary const IndexBinary * idx @@ -3305,6 +3406,7 @@ void faiss::write_index_binary (const IndexBinary *idx, IOWriter *writer) write_index_binary + faiss::write_index_binary const IndexBinary * idx @@ -3321,11 +3423,12 @@ - + Index * - Index* faiss::read_index + Index * faiss::read_index (const char *fname, int io_flags=0) read_index + faiss::read_index const char * fname @@ -3343,11 +3446,12 @@ - + Index * - Index* faiss::read_index + Index * faiss::read_index (FILE *f, int io_flags=0) read_index + faiss::read_index FILE * f @@ -3365,11 +3469,12 @@ - + Index * - Index* faiss::read_index + Index * faiss::read_index (IOReader *reader, int io_flags=0) read_index + faiss::read_index IOReader * reader @@ -3387,11 +3492,12 @@ - + IndexBinary * - IndexBinary* faiss::read_index_binary + IndexBinary * faiss::read_index_binary (const char *fname, int io_flags=0) read_index_binary + faiss::read_index_binary const char * fname @@ -3409,11 +3515,12 @@ - + IndexBinary * - IndexBinary* faiss::read_index_binary + IndexBinary * faiss::read_index_binary (FILE *f, int io_flags=0) read_index_binary + faiss::read_index_binary FILE * f @@ -3431,11 +3538,12 @@ - + IndexBinary * - IndexBinary* faiss::read_index_binary + IndexBinary * faiss::read_index_binary (IOReader *reader, int io_flags=0) read_index_binary + faiss::read_index_binary IOReader * reader @@ -3458,6 +3566,7 @@ void faiss::write_VectorTransform (const VectorTransform *vt, const char *fname) write_VectorTransform + faiss::write_VectorTransform const VectorTransform * vt @@ -3479,6 +3588,7 @@ void faiss::write_VectorTransform (const VectorTransform *vt, IOWriter *f) write_VectorTransform + faiss::write_VectorTransform const VectorTransform * vt @@ -3495,11 +3605,12 @@ - + VectorTransform * - VectorTransform* faiss::read_VectorTransform + VectorTransform * faiss::read_VectorTransform (const char *fname) read_VectorTransform + faiss::read_VectorTransform const char * fname @@ -3512,11 +3623,12 @@ - + VectorTransform * - VectorTransform* faiss::read_VectorTransform + VectorTransform * faiss::read_VectorTransform (IOReader *f) read_VectorTransform + faiss::read_VectorTransform IOReader * f @@ -3529,11 +3641,12 @@ - + ProductQuantizer * - ProductQuantizer* faiss::read_ProductQuantizer + ProductQuantizer * faiss::read_ProductQuantizer (const char *fname) read_ProductQuantizer + faiss::read_ProductQuantizer const char * fname @@ -3546,11 +3659,12 @@ - + ProductQuantizer * - ProductQuantizer* faiss::read_ProductQuantizer + ProductQuantizer * faiss::read_ProductQuantizer (IOReader *reader) read_ProductQuantizer + faiss::read_ProductQuantizer IOReader * reader @@ -3568,6 +3682,7 @@ void faiss::write_ProductQuantizer (const ProductQuantizer *pq, const char *fname) write_ProductQuantizer + faiss::write_ProductQuantizer const ProductQuantizer * pq @@ -3589,6 +3704,7 @@ void faiss::write_ProductQuantizer (const ProductQuantizer *pq, IOWriter *f) write_ProductQuantizer + faiss::write_ProductQuantizer const ProductQuantizer * pq @@ -3610,6 +3726,7 @@ void faiss::write_InvertedLists (const InvertedLists *ils, IOWriter *f) write_InvertedLists + faiss::write_InvertedLists const InvertedLists * ils @@ -3626,11 +3743,12 @@ - + InvertedLists * - InvertedLists* faiss::read_InvertedLists + InvertedLists * faiss::read_InvertedLists (IOReader *reader, int io_flags=0) read_InvertedLists + faiss::read_InvertedLists IOReader * reader @@ -3653,6 +3771,7 @@ void faiss::initialize_IVFPQ_precomputed_table (int &use_precomputed_table, const Index *quantizer, const ProductQuantizer &pq, AlignedTable< float > &precomputed_table, bool by_residual, bool verbose) initialize_IVFPQ_precomputed_table + faiss::initialize_IVFPQ_precomputed_table int & use_precomputed_table @@ -3709,6 +3828,7 @@ uint64_t faiss::lo_build (uint64_t list_id, uint64_t offset) lo_build + faiss::lo_build uint64_t list_id @@ -3730,6 +3850,7 @@ uint64_t faiss::lo_listno (uint64_t lo) lo_listno + faiss::lo_listno uint64_t lo @@ -3747,6 +3868,7 @@ uint64_t faiss::lo_offset (uint64_t lo) lo_offset + faiss::lo_offset uint64_t lo @@ -3764,6 +3886,7 @@ constexpr bool faiss::is_similarity_metric (MetricType metric_type) is_similarity_metric + faiss::is_similarity_metric MetricType metric_type @@ -3790,6 +3913,7 @@ bool faiss::is_aligned_pointer (const void *x) is_aligned_pointer + faiss::is_aligned_pointer const void * x @@ -3807,6 +3931,7 @@ uint16_t faiss::encode_bf16 (const float f) encode_bf16 + faiss::encode_bf16 const float f @@ -3824,6 +3949,7 @@ float faiss::decode_bf16 (const uint16_t v) decode_bf16 + faiss::decode_bf16 const uint16_t v @@ -3841,6 +3967,7 @@ float faiss::fvec_L2sqr (const float *x, const float *y, size_t d) fvec_L2sqr + faiss::fvec_L2sqr const float * x @@ -3867,6 +3994,7 @@ float faiss::fvec_inner_product (const float *x, const float *y, size_t d) fvec_inner_product + faiss::fvec_inner_product const float * x @@ -3893,6 +4021,7 @@ float faiss::fvec_L1 (const float *x, const float *y, size_t d) fvec_L1 + faiss::fvec_L1 const float * x @@ -3919,6 +4048,7 @@ float faiss::fvec_Linf (const float *x, const float *y, size_t d) fvec_Linf + faiss::fvec_Linf const float * x @@ -3945,6 +4075,7 @@ void faiss::fvec_inner_product_batch_4 (const float *x, const float *y0, const float *y1, const float *y2, const float *y3, const size_t d, float &dis0, float &dis1, float &dis2, float &dis3) fvec_inner_product_batch_4 + faiss::fvec_inner_product_batch_4 const float * x @@ -3999,6 +4130,7 @@ void faiss::fvec_L2sqr_batch_4 (const float *x, const float *y0, const float *y1, const float *y2, const float *y3, const size_t d, float &dis0, float &dis1, float &dis2, float &dis3) fvec_L2sqr_batch_4 + faiss::fvec_L2sqr_batch_4 const float * x @@ -4053,6 +4185,7 @@ void faiss::pairwise_L2sqr (int64_t d, int64_t nq, const float *xq, int64_t nb, const float *xb, float *dis, int64_t ldq=-1, int64_t ldb=-1, int64_t ldd=-1) pairwise_L2sqr + faiss::pairwise_L2sqr int64_t d @@ -4166,6 +4299,7 @@ void faiss::fvec_inner_products_ny (float *ip, const float *x, const float *y, size_t d, size_t ny) fvec_inner_products_ny + faiss::fvec_inner_products_ny float * ip @@ -4199,6 +4333,7 @@ void faiss::fvec_L2sqr_ny (float *dis, const float *x, const float *y, size_t d, size_t ny) fvec_L2sqr_ny + faiss::fvec_L2sqr_ny float * dis @@ -4232,6 +4367,7 @@ void faiss::fvec_L2sqr_ny_transposed (float *dis, const float *x, const float *y, const float *y_sqlen, size_t d, size_t d_offset, size_t ny) fvec_L2sqr_ny_transposed + faiss::fvec_L2sqr_ny_transposed float * dis @@ -4273,6 +4409,7 @@ size_t faiss::fvec_L2sqr_ny_nearest (float *distances_tmp_buffer, const float *x, const float *y, size_t d, size_t ny) fvec_L2sqr_ny_nearest + faiss::fvec_L2sqr_ny_nearest float * distances_tmp_buffer @@ -4306,6 +4443,7 @@ size_t faiss::fvec_L2sqr_ny_nearest_y_transposed (float *distances_tmp_buffer, const float *x, const float *y, const float *y_sqlen, size_t d, size_t d_offset, size_t ny) fvec_L2sqr_ny_nearest_y_transposed + faiss::fvec_L2sqr_ny_nearest_y_transposed float * distances_tmp_buffer @@ -4347,6 +4485,7 @@ float faiss::fvec_norm_L2sqr (const float *x, size_t d) fvec_norm_L2sqr + faiss::fvec_norm_L2sqr const float * x @@ -4369,6 +4508,7 @@ void faiss::fvec_norms_L2 (float *norms, const float *x, size_t d, size_t nx) fvec_norms_L2 + faiss::fvec_norms_L2 float * norms @@ -4417,6 +4557,7 @@ void faiss::fvec_norms_L2sqr (float *norms, const float *x, size_t d, size_t nx) fvec_norms_L2sqr + faiss::fvec_norms_L2sqr float * norms @@ -4447,6 +4588,7 @@ void faiss::fvec_renorm_L2 (size_t d, size_t nx, float *x) fvec_renorm_L2 + faiss::fvec_renorm_L2 size_t d @@ -4472,6 +4614,7 @@ void faiss::inner_product_to_L2sqr (float *dis, const float *nr1, const float *nr2, size_t n1, size_t n2) inner_product_to_L2sqr + faiss::inner_product_to_L2sqr float * dis @@ -4505,6 +4648,7 @@ void faiss::fvec_add (size_t d, const float *a, const float *b, float *c) fvec_add + faiss::fvec_add size_t d @@ -4562,6 +4706,7 @@ void faiss::fvec_add (size_t d, const float *a, float b, float *c) fvec_add + faiss::fvec_add size_t d @@ -4611,6 +4756,7 @@ void faiss::fvec_sub (size_t d, const float *a, const float *b, float *c) fvec_sub + faiss::fvec_sub size_t d @@ -4668,6 +4814,7 @@ void faiss::fvec_inner_products_by_idx (float *ip, const float *x, const float *y, const int64_t *ids, size_t d, size_t nx, size_t ny) fvec_inner_products_by_idx + faiss::fvec_inner_products_by_idx float * ip @@ -4745,6 +4892,7 @@ void faiss::fvec_L2sqr_by_idx (float *dis, const float *x, const float *y, const int64_t *ids, size_t d, size_t nx, size_t ny) fvec_L2sqr_by_idx + faiss::fvec_L2sqr_by_idx float * dis @@ -4822,6 +4970,7 @@ void faiss::pairwise_indexed_L2sqr (size_t d, size_t n, const float *x, const int64_t *ix, const float *y, const int64_t *iy, float *dis) pairwise_indexed_L2sqr + faiss::pairwise_indexed_L2sqr size_t d @@ -4906,6 +5055,7 @@ void faiss::pairwise_indexed_inner_product (size_t d, size_t n, const float *x, const int64_t *ix, const float *y, const int64_t *iy, float *dis) pairwise_indexed_inner_product + faiss::pairwise_indexed_inner_product size_t d @@ -4990,6 +5140,7 @@ void faiss::knn_inner_product (const float *x, const float *y, size_t d, size_t nx, size_t ny, float_minheap_array_t *res, const IDSelector *sel=nullptr) knn_inner_product + faiss::knn_inner_product const float * x @@ -5059,6 +5210,7 @@ void faiss::knn_inner_product (const float *x, const float *y, size_t d, size_t nx, size_t ny, size_t k, float *distances, int64_t *indexes, const IDSelector *sel=nullptr) knn_inner_product + faiss::knn_inner_product const float * x @@ -5144,6 +5296,7 @@ void faiss::knn_L2sqr (const float *x, const float *y, size_t d, size_t nx, size_t ny, float_maxheap_array_t *res, const float *y_norm2=nullptr, const IDSelector *sel=nullptr) knn_L2sqr + faiss::knn_L2sqr const float * x @@ -5233,6 +5386,7 @@ void faiss::knn_L2sqr (const float *x, const float *y, size_t d, size_t nx, size_t ny, size_t k, float *distances, int64_t *indexes, const float *y_norm2=nullptr, const IDSelector *sel=nullptr) knn_L2sqr + faiss::knn_L2sqr const float * x @@ -5339,6 +5493,7 @@ void faiss::knn_inner_products_by_idx (const float *x, const float *y, const int64_t *subset, size_t d, size_t nx, size_t ny, size_t nsubset, size_t k, float *vals, int64_t *ids, int64_t ld_ids=-1) knn_inner_products_by_idx + faiss::knn_inner_products_by_idx const float * x @@ -5440,6 +5595,7 @@ void faiss::knn_L2sqr_by_idx (const float *x, const float *y, const int64_t *subset, size_t d, size_t nx, size_t ny, size_t nsubset, size_t k, float *vals, int64_t *ids, int64_t ld_subset=-1) knn_L2sqr_by_idx + faiss::knn_L2sqr_by_idx const float * x @@ -5541,6 +5697,7 @@ void faiss::range_search_L2sqr (const float *x, const float *y, size_t d, size_t nx, size_t ny, float radius, RangeSearchResult *result, const IDSelector *sel=nullptr) range_search_L2sqr + faiss::range_search_L2sqr const float * x @@ -5622,6 +5779,7 @@ void faiss::range_search_inner_product (const float *x, const float *y, size_t d, size_t nx, size_t ny, float radius, RangeSearchResult *result, const IDSelector *sel=nullptr) range_search_inner_product + faiss::range_search_inner_product const float * x @@ -5669,6 +5827,7 @@ void faiss::compute_PQ_dis_tables_dsub2 (size_t d, size_t ksub, const float *centroids, size_t nx, const float *x, bool is_inner_product, float *dis_tables) compute_PQ_dis_tables_dsub2 + faiss::compute_PQ_dis_tables_dsub2 size_t d @@ -5711,6 +5870,7 @@ void faiss::fvec_madd (size_t n, const float *a, float bf, const float *b, float *c) fvec_madd + faiss::fvec_madd size_t n @@ -5779,6 +5939,7 @@ int faiss::fvec_madd_and_argmin (size_t n, const float *a, float bf, const float *b, float *c) fvec_madd_and_argmin + faiss::fvec_madd_and_argmin size_t n @@ -5810,11 +5971,12 @@ - + bool bool faiss::exhaustive_L2sqr_fused_cmax - (const float *x, const float *y, size_t d, size_t nx, size_t ny, Top1BlockResultHandler< CMax< float, int64_t >> &res, const float *y_norms) + (const float *x, const float *y, size_t d, size_t nx, size_t ny, Top1BlockResultHandler< CMax< float, int64_t > > &res, const float *y_norms) exhaustive_L2sqr_fused_cmax + faiss::exhaustive_L2sqr_fused_cmax const float * x @@ -5836,7 +5998,7 @@ ny - Top1BlockResultHandler< CMax< float, int64_t >> & + Top1BlockResultHandler< CMax< float, int64_t > > & res @@ -5866,6 +6028,7 @@ Consumer::T faiss::dispatch_VectorDistance (size_t d, MetricType metric, float metric_arg, Consumer &consumer, Types... args) dispatch_VectorDistance + faiss::dispatch_VectorDistance size_t d @@ -5899,6 +6062,7 @@ void faiss::pairwise_extra_distances (int64_t d, int64_t nq, const float *xq, int64_t nb, const float *xb, MetricType mt, float metric_arg, float *dis, int64_t ldq=-1, int64_t ldb=-1, int64_t ldd=-1) pairwise_extra_distances + faiss::pairwise_extra_distances int64_t d @@ -5959,6 +6123,7 @@ void faiss::knn_extra_metrics (const float *x, const float *y, size_t d, size_t nx, size_t ny, MetricType mt, float metric_arg, size_t k, float *distances, int64_t *indexes) knn_extra_metrics + faiss::knn_extra_metrics const float * x @@ -6007,11 +6172,12 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::get_extra_distance_computer + FlatCodesDistanceComputer * faiss::get_extra_distance_computer (size_t d, MetricType mt, float metric_arg, size_t nb, const float *xb) get_extra_distance_computer + faiss::get_extra_distance_computer size_t d @@ -6046,6 +6212,7 @@ uint16_t faiss::encode_fp16 (float x) encode_fp16 + faiss::encode_fp16 float x @@ -6063,6 +6230,7 @@ float faiss::decode_fp16 (uint16_t x) decode_fp16 + faiss::decode_fp16 uint16_t x @@ -6080,6 +6248,7 @@ void faiss::bitvec_print (const uint8_t *b, size_t d) bitvec_print + faiss::bitvec_print const uint8_t * b @@ -6101,6 +6270,7 @@ void faiss::fvecs2bitvecs (const float *x, uint8_t *b, size_t d, size_t n) fvecs2bitvecs + faiss::fvecs2bitvecs const float * x @@ -6130,6 +6300,7 @@ void faiss::bitvecs2fvecs (const uint8_t *b, float *x, size_t d, size_t n) bitvecs2fvecs + faiss::bitvecs2fvecs const uint8_t * b @@ -6159,6 +6330,7 @@ void faiss::fvec2bitvec (const float *x, uint8_t *b, size_t d) fvec2bitvec + faiss::fvec2bitvec const float * x @@ -6184,6 +6356,7 @@ void faiss::bitvec_shuffle (size_t n, size_t da, size_t db, const int *order, const uint8_t *a, uint8_t *b) bitvec_shuffle + faiss::bitvec_shuffle size_t n @@ -6222,6 +6395,7 @@ void faiss::hammings (const uint8_t *a, const uint8_t *b, size_t na, size_t nb, size_t nbytespercode, hamdis_t *dis) hammings + faiss::hammings const uint8_t * a @@ -6294,6 +6468,7 @@ void faiss::hammings_knn_hc (int_maxheap_array_t *ha, const uint8_t *a, const uint8_t *b, size_t nb, size_t ncodes, int ordered, ApproxTopK_mode_t approx_topk_mode=ApproxTopK_mode_t::EXACT_TOPK) hammings_knn_hc + faiss::hammings_knn_hc int_maxheap_array_t * ha @@ -6386,6 +6561,7 @@ void faiss::hammings_knn (int_maxheap_array_t *ha, const uint8_t *a, const uint8_t *b, size_t nb, size_t ncodes, int ordered) hammings_knn + faiss::hammings_knn int_maxheap_array_t * ha @@ -6423,6 +6599,7 @@ void faiss::hammings_knn_mc (const uint8_t *a, const uint8_t *b, size_t na, size_t nb, size_t k, size_t ncodes, int32_t *distances, int64_t *labels) hammings_knn_mc + faiss::hammings_knn_mc const uint8_t * a @@ -6534,6 +6711,7 @@ void faiss::hamming_range_search (const uint8_t *a, const uint8_t *b, size_t na, size_t nb, int radius, size_t ncodes, RangeSearchResult *result) hamming_range_search + faiss::hamming_range_search const uint8_t * a @@ -6576,6 +6754,7 @@ void faiss::hamming_count_thres (const uint8_t *bs1, const uint8_t *bs2, size_t n1, size_t n2, hamdis_t ht, size_t ncodes, size_t *nptr) hamming_count_thres + faiss::hamming_count_thres const uint8_t * bs1 @@ -6617,6 +6796,7 @@ size_t faiss::match_hamming_thres (const uint8_t *bs1, const uint8_t *bs2, size_t n1, size_t n2, hamdis_t ht, size_t ncodes, int64_t *idx, hamdis_t *dis) match_hamming_thres + faiss::match_hamming_thres const uint8_t * bs1 @@ -6662,6 +6842,7 @@ void faiss::crosshamming_count_thres (const uint8_t *dbs, size_t n, hamdis_t ht, size_t ncodes, size_t *nptr) crosshamming_count_thres + faiss::crosshamming_count_thres const uint8_t * dbs @@ -6695,6 +6876,7 @@ hamdis_t faiss::hamming (const uint64_t *bs1, const uint64_t *bs2, size_t nwords) hamming + faiss::hamming const uint64_t * bs1 @@ -6720,6 +6902,7 @@ void faiss::generalized_hammings_knn_hc (int_maxheap_array_t *ha, const uint8_t *a, const uint8_t *b, size_t nb, size_t code_size, int ordered=true) generalized_hammings_knn_hc + faiss::generalized_hammings_knn_hc int_maxheap_array_t * ha @@ -6759,6 +6942,7 @@ void faiss::pack_bitstrings (size_t n, size_t M, int nbit, const int32_t *unpacked, uint8_t *packed, size_t code_size) pack_bitstrings + faiss::pack_bitstrings size_t n @@ -6847,6 +7031,7 @@ void faiss::pack_bitstrings (size_t n, size_t M, const int32_t *nbits, const int32_t *unpacked, uint8_t *packed, size_t code_size) pack_bitstrings + faiss::pack_bitstrings size_t n @@ -6895,6 +7080,7 @@ void faiss::unpack_bitstrings (size_t n, size_t M, int nbit, const uint8_t *packed, size_t code_size, int32_t *unpacked) unpack_bitstrings + faiss::unpack_bitstrings size_t n @@ -6983,6 +7169,7 @@ void faiss::unpack_bitstrings (size_t n, size_t M, const int32_t *nbits, const uint8_t *packed, size_t code_size, int32_t *unpacked) unpack_bitstrings + faiss::unpack_bitstrings size_t n @@ -7041,6 +7228,7 @@ T faiss::hamming (const uint8_t *bs1, const uint8_t *bs2) hamming + faiss::hamming const uint8_t * bs1 @@ -7069,6 +7257,7 @@ hamdis_t faiss::hamming (const uint64_t *bs1, const uint64_t *bs2) hamming + faiss::hamming const uint64_t * bs1 @@ -7092,6 +7281,7 @@ hamdis_t faiss::hamming< 64 > (const uint64_t *pa, const uint64_t *pb) hamming< 64 > + faiss::hamming< 64 > const uint64_t * pa @@ -7115,6 +7305,7 @@ hamdis_t faiss::hamming< 128 > (const uint64_t *pa, const uint64_t *pb) hamming< 128 > + faiss::hamming< 128 > const uint64_t * pa @@ -7138,6 +7329,7 @@ hamdis_t faiss::hamming< 256 > (const uint64_t *pa, const uint64_t *pb) hamming< 256 > + faiss::hamming< 256 > const uint64_t * pa @@ -7159,6 +7351,7 @@ int faiss::generalized_hamming_64 (uint64_t a) generalized_hamming_64 + faiss::generalized_hamming_64 uint64_t a @@ -7171,11 +7364,84 @@ + + + + hamdis_t + hamdis_t faiss::hamming< 64 > + (const uint64_t *pa, const uint64_t *pb) + hamming< 64 > + faiss::hamming< 64 > + + const uint64_t * + pa + + + const uint64_t * + pb + + + + + + + + + + + + + hamdis_t + hamdis_t faiss::hamming< 128 > + (const uint64_t *pa, const uint64_t *pb) + hamming< 128 > + faiss::hamming< 128 > + + const uint64_t * + pa + + + const uint64_t * + pb + + + + + + + + + + + + + hamdis_t + hamdis_t faiss::hamming< 256 > + (const uint64_t *pa, const uint64_t *pb) + hamming< 256 > + faiss::hamming< 256 > + + const uint64_t * + pa + + + const uint64_t * + pb + + + + + + + + + int int faiss::popcount32 (uint32_t x) popcount32 + faiss::popcount32 uint32_t x @@ -7193,6 +7459,7 @@ int faiss::popcount64 (uint64_t x) popcount64 + faiss::popcount64 uint64_t x @@ -7205,11 +7472,84 @@ + + + + hamdis_t + hamdis_t faiss::hamming< 64 > + (const uint64_t *pa, const uint64_t *pb) + hamming< 64 > + faiss::hamming< 64 > + + const uint64_t * + pa + + + const uint64_t * + pb + + + + + + + + + + + + + hamdis_t + hamdis_t faiss::hamming< 128 > + (const uint64_t *pa, const uint64_t *pb) + hamming< 128 > + faiss::hamming< 128 > + + const uint64_t * + pa + + + const uint64_t * + pb + + + + + + + + + + + + + hamdis_t + hamdis_t faiss::hamming< 256 > + (const uint64_t *pa, const uint64_t *pb) + hamming< 256 > + faiss::hamming< 256 > + + const uint64_t * + pa + + + const uint64_t * + pb + + + + + + + + + faiss::SPECIALIZED_HC (4) SPECIALIZED_HC + faiss::SPECIALIZED_HC 4 @@ -7226,6 +7566,7 @@ faiss::SPECIALIZED_HC (8) SPECIALIZED_HC + faiss::SPECIALIZED_HC 8 @@ -7242,6 +7583,7 @@ faiss::SPECIALIZED_HC (16) SPECIALIZED_HC + faiss::SPECIALIZED_HC 16 @@ -7258,6 +7600,7 @@ faiss::SPECIALIZED_HC (20) SPECIALIZED_HC + faiss::SPECIALIZED_HC 20 @@ -7274,6 +7617,7 @@ faiss::SPECIALIZED_HC (32) SPECIALIZED_HC + faiss::SPECIALIZED_HC 32 @@ -7290,6 +7634,7 @@ faiss::SPECIALIZED_HC (64) SPECIALIZED_HC + faiss::SPECIALIZED_HC 64 @@ -7316,6 +7661,7 @@ Consumer::T faiss::dispatch_HammingComputer (int code_size, Consumer &consumer, Types... args) dispatch_HammingComputer + faiss::dispatch_HammingComputer int code_size @@ -7346,6 +7692,7 @@ void faiss::heap_pop (size_t k, typename C::T *bh_val, typename C::TI *bh_ids) heap_pop + faiss::heap_pop size_t k @@ -7377,6 +7724,7 @@ void faiss::heap_push (size_t k, typename C::T *bh_val, typename C::TI *bh_ids, typename C::T val, typename C::TI id) heap_push + faiss::heap_push size_t k @@ -7416,6 +7764,7 @@ void faiss::heap_replace_top (size_t k, typename C::T *bh_val, typename C::TI *bh_ids, typename C::T val, typename C::TI id) heap_replace_top + faiss::heap_replace_top size_t k @@ -7455,6 +7804,7 @@ void faiss::minheap_pop (size_t k, T *bh_val, int64_t *bh_ids) minheap_pop + faiss::minheap_pop size_t k @@ -7485,6 +7835,7 @@ void faiss::minheap_push (size_t k, T *bh_val, int64_t *bh_ids, T val, int64_t ids) minheap_push + faiss::minheap_push size_t k @@ -7523,6 +7874,7 @@ void faiss::minheap_replace_top (size_t k, T *bh_val, int64_t *bh_ids, T val, int64_t ids) minheap_replace_top + faiss::minheap_replace_top size_t k @@ -7561,6 +7913,7 @@ void faiss::maxheap_pop (size_t k, T *bh_val, int64_t *bh_ids) maxheap_pop + faiss::maxheap_pop size_t k @@ -7591,6 +7944,7 @@ void faiss::maxheap_push (size_t k, T *bh_val, int64_t *bh_ids, T val, int64_t ids) maxheap_push + faiss::maxheap_push size_t k @@ -7629,6 +7983,7 @@ void faiss::maxheap_replace_top (size_t k, T *bh_val, int64_t *bh_ids, T val, int64_t ids) maxheap_replace_top + faiss::maxheap_replace_top size_t k @@ -7667,6 +8022,7 @@ void faiss::heap_pop (size_t k, std::pair< typename C::T, typename C::TI > *bh) heap_pop + faiss::heap_pop size_t k @@ -7694,6 +8050,7 @@ void faiss::heap_push (size_t k, std::pair< typename C::T, typename C::TI > *bh, typename C::T val, typename C::TI id) heap_push + faiss::heap_push size_t k @@ -7729,6 +8086,7 @@ void faiss::heap_replace_top (size_t k, std::pair< typename C::T, typename C::TI > *bh, typename C::T val, typename C::TI id) heap_replace_top + faiss::heap_replace_top size_t k @@ -7764,6 +8122,7 @@ void faiss::heap_heapify (size_t k, typename C::T *bh_val, typename C::TI *bh_ids, const typename C::T *x=nullptr, const typename C::TI *ids=nullptr, size_t k0=0) heap_heapify + faiss::heap_heapify size_t k @@ -7809,6 +8168,7 @@ void faiss::minheap_heapify (size_t k, T *bh_val, int64_t *bh_ids, const T *x=nullptr, const int64_t *ids=nullptr, size_t k0=0) minheap_heapify + faiss::minheap_heapify size_t k @@ -7854,6 +8214,7 @@ void faiss::maxheap_heapify (size_t k, T *bh_val, int64_t *bh_ids, const T *x=nullptr, const int64_t *ids=nullptr, size_t k0=0) maxheap_heapify + faiss::maxheap_heapify size_t k @@ -7899,6 +8260,7 @@ void faiss::heap_addn (size_t k, typename C::T *bh_val, typename C::TI *bh_ids, const typename C::T *x, const typename C::TI *ids, size_t n) heap_addn + faiss::heap_addn size_t k @@ -7941,6 +8303,7 @@ void faiss::minheap_addn (size_t k, T *bh_val, int64_t *bh_ids, const T *x, const int64_t *ids, size_t n) minheap_addn + faiss::minheap_addn size_t k @@ -7983,6 +8346,7 @@ void faiss::maxheap_addn (size_t k, T *bh_val, int64_t *bh_ids, const T *x, const int64_t *ids, size_t n) maxheap_addn + faiss::maxheap_addn size_t k @@ -8025,6 +8389,7 @@ size_t faiss::heap_reorder (size_t k, typename C::T *bh_val, typename C::TI *bh_ids) heap_reorder + faiss::heap_reorder size_t k @@ -8055,6 +8420,7 @@ size_t faiss::minheap_reorder (size_t k, T *bh_val, int64_t *bh_ids) minheap_reorder + faiss::minheap_reorder size_t k @@ -8085,6 +8451,7 @@ size_t faiss::maxheap_reorder (size_t k, T *bh_val, int64_t *bh_ids) maxheap_reorder + faiss::maxheap_reorder size_t k @@ -8115,6 +8482,7 @@ void faiss::indirect_heap_pop (size_t k, const typename C::T *bh_val, typename C::TI *bh_ids) indirect_heap_pop + faiss::indirect_heap_pop size_t k @@ -8145,6 +8513,7 @@ void faiss::indirect_heap_push (size_t k, const typename C::T *bh_val, typename C::TI *bh_ids, typename C::TI id) indirect_heap_push + faiss::indirect_heap_push size_t k @@ -8182,6 +8551,7 @@ void faiss::merge_knn_results (size_t n, size_t k, typename C::TI nshard, const typename C::T *all_distances, const idx_t *all_labels, typename C::T *distances, idx_t *labels) merge_knn_results + faiss::merge_knn_results size_t n @@ -8263,6 +8633,7 @@ T faiss::cmin_nextafter (T x) cmin_nextafter + faiss::cmin_nextafter T x @@ -8285,6 +8656,7 @@ T faiss::cmax_nextafter (T x) cmax_nextafter + faiss::cmax_nextafter T x @@ -8304,6 +8676,7 @@ float faiss::cmin_nextafter< float > (float x) cmin_nextafter< float > + faiss::cmin_nextafter< float > float x @@ -8323,6 +8696,7 @@ float faiss::cmax_nextafter< float > (float x) cmax_nextafter< float > + faiss::cmax_nextafter< float > float x @@ -8342,6 +8716,7 @@ uint16_t faiss::cmin_nextafter< uint16_t > (uint16_t x) cmin_nextafter< uint16_t > + faiss::cmin_nextafter< uint16_t > uint16_t x @@ -8361,6 +8736,7 @@ uint16_t faiss::cmax_nextafter< uint16_t > (uint16_t x) cmax_nextafter< uint16_t > + faiss::cmax_nextafter< uint16_t > uint16_t x @@ -8383,6 +8759,7 @@ C::T faiss::partition_fuzzy (typename C::T *vals, typename C::TI *ids, size_t n, size_t q_min, size_t q_max, size_t *q_out) partition_fuzzy + faiss::partition_fuzzy typename C::T * vals @@ -8427,6 +8804,7 @@ C::T faiss::partition (typename C::T *vals, typename C::TI *ids, size_t n, size_t q) partition + faiss::partition typename C::T * vals @@ -8457,6 +8835,7 @@ void faiss::simd_histogram_8 (const uint16_t *data, int n, uint16_t min, int shift, int *hist) simd_histogram_8 + faiss::simd_histogram_8 const uint16_t * data @@ -8491,6 +8870,7 @@ void faiss::simd_histogram_16 (const uint16_t *data, int n, uint16_t min, int shift, int *hist) simd_histogram_16 + faiss::simd_histogram_16 const uint16_t * data @@ -8525,6 +8905,7 @@ void faiss::float_rand (float *x, size_t n, int64_t seed) float_rand + faiss::float_rand float * x @@ -8550,6 +8931,7 @@ void faiss::float_randn (float *x, size_t n, int64_t seed) float_randn + faiss::float_randn float * x @@ -8575,6 +8957,7 @@ void faiss::int64_rand (int64_t *x, size_t n, int64_t seed) int64_rand + faiss::int64_rand int64_t * x @@ -8600,6 +8983,7 @@ void faiss::byte_rand (uint8_t *x, size_t n, int64_t seed) byte_rand + faiss::byte_rand uint8_t * x @@ -8625,6 +9009,7 @@ void faiss::int64_rand_max (int64_t *x, size_t n, uint64_t max, int64_t seed) int64_rand_max + faiss::int64_rand_max int64_t * x @@ -8654,6 +9039,7 @@ void faiss::rand_perm (int *perm, size_t n, int64_t seed) rand_perm + faiss::rand_perm int * perm @@ -8679,6 +9065,7 @@ void faiss::rand_perm_splitmix64 (int *perm, size_t n, int64_t seed) rand_perm_splitmix64 + faiss::rand_perm_splitmix64 int * perm @@ -8704,6 +9091,7 @@ void faiss::rand_smooth_vectors (size_t n, size_t d, float *x, int64_t seed) rand_smooth_vectors + faiss::rand_smooth_vectors size_t n @@ -8733,6 +9121,7 @@ simd16uint16 faiss::min (simd16uint16 a, simd16uint16 b) min + faiss::min simd16uint16 a @@ -8754,6 +9143,7 @@ simd16uint16 faiss::max (simd16uint16 a, simd16uint16 b) max + faiss::max simd16uint16 a @@ -8775,6 +9165,7 @@ simd16uint16 faiss::combine2x2 (simd16uint16 a, simd16uint16 b) combine2x2 + faiss::combine2x2 simd16uint16 a @@ -8796,6 +9187,7 @@ uint32_t faiss::cmp_ge32 (simd16uint16 d0, simd16uint16 d1, simd16uint16 thr) cmp_ge32 + faiss::cmp_ge32 simd16uint16 d0 @@ -8821,6 +9213,7 @@ uint32_t faiss::cmp_le32 (simd16uint16 d0, simd16uint16 d1, simd16uint16 thr) cmp_le32 + faiss::cmp_le32 simd16uint16 d0 @@ -8846,6 +9239,7 @@ simd16uint16 faiss::hadd (const simd16uint16 &a, const simd16uint16 &b) hadd + faiss::hadd const simd16uint16 & a @@ -8867,6 +9261,7 @@ void faiss::cmplt_min_max_fast (const simd16uint16 candidateValues, const simd16uint16 candidateIndices, const simd16uint16 currentValues, const simd16uint16 currentIndices, simd16uint16 &minValues, simd16uint16 &minIndices, simd16uint16 &maxValues, simd16uint16 &maxIndices) cmplt_min_max_fast + faiss::cmplt_min_max_fast const simd16uint16 candidateValues @@ -8912,6 +9307,7 @@ simd32uint8 faiss::uint16_to_uint8_saturate (simd16uint16 a, simd16uint16 b) uint16_to_uint8_saturate + faiss::uint16_to_uint8_saturate simd16uint16 a @@ -8933,6 +9329,7 @@ uint32_t faiss::get_MSBs (simd32uint8 a) get_MSBs + faiss::get_MSBs simd32uint8 a @@ -8951,6 +9348,7 @@ simd32uint8 faiss::blendv (simd32uint8 a, simd32uint8 b, simd32uint8 mask) blendv + faiss::blendv simd32uint8 a @@ -8977,6 +9375,7 @@ void faiss::cmplt_min_max_fast (const simd8uint32 candidateValues, const simd8uint32 candidateIndices, const simd8uint32 currentValues, const simd8uint32 currentIndices, simd8uint32 &minValues, simd8uint32 &minIndices, simd8uint32 &maxValues, simd8uint32 &maxIndices) cmplt_min_max_fast + faiss::cmplt_min_max_fast const simd8uint32 candidateValues @@ -9022,6 +9421,7 @@ simd8float32 faiss::hadd (simd8float32 a, simd8float32 b) hadd + faiss::hadd simd8float32 a @@ -9043,6 +9443,7 @@ simd8float32 faiss::unpacklo (simd8float32 a, simd8float32 b) unpacklo + faiss::unpacklo simd8float32 a @@ -9064,6 +9465,7 @@ simd8float32 faiss::unpackhi (simd8float32 a, simd8float32 b) unpackhi + faiss::unpackhi simd8float32 a @@ -9085,6 +9487,7 @@ simd8float32 faiss::fmadd (simd8float32 a, simd8float32 b, simd8float32 c) fmadd + faiss::fmadd simd8float32 a @@ -9110,6 +9513,7 @@ void faiss::cmplt_and_blend_inplace (const simd8float32 candidateValues, const simd8uint32 candidateIndices, simd8float32 &lowestValues, simd8uint32 &lowestIndices) cmplt_and_blend_inplace + faiss::cmplt_and_blend_inplace const simd8float32 candidateValues @@ -9139,6 +9543,7 @@ void faiss::cmplt_min_max_fast (const simd8float32 candidateValues, const simd8uint32 candidateIndices, const simd8float32 currentValues, const simd8uint32 currentIndices, simd8float32 &minValues, simd8uint32 &minIndices, simd8float32 &maxValues, simd8uint32 &maxIndices) cmplt_min_max_fast + faiss::cmplt_min_max_fast const simd8float32 candidateValues @@ -9184,6 +9589,7 @@ simd16uint16 faiss::combine4x2 (simd32uint16 a, simd32uint16 b) combine4x2 + faiss::combine4x2 simd32uint16 a @@ -9205,6 +9611,7 @@ simd16uint16 faiss::min (const simd16uint16 &av, const simd16uint16 &bv) min + faiss::min const simd16uint16 & av @@ -9226,6 +9633,7 @@ simd16uint16 faiss::max (const simd16uint16 &av, const simd16uint16 &bv) max + faiss::max const simd16uint16 & av @@ -9247,6 +9655,7 @@ simd16uint16 faiss::combine2x2 (const simd16uint16 &a, const simd16uint16 &b) combine2x2 + faiss::combine2x2 const simd16uint16 & a @@ -9268,6 +9677,7 @@ uint32_t faiss::cmp_ge32 (const simd16uint16 &d0, const simd16uint16 &d1, const simd16uint16 &thr) cmp_ge32 + faiss::cmp_ge32 const simd16uint16 & d0 @@ -9293,6 +9703,7 @@ uint32_t faiss::cmp_le32 (const simd16uint16 &d0, const simd16uint16 &d1, const simd16uint16 &thr) cmp_le32 + faiss::cmp_le32 const simd16uint16 & d0 @@ -9318,6 +9729,7 @@ simd32uint8 faiss::uint16_to_uint8_saturate (const simd16uint16 &a, const simd16uint16 &b) uint16_to_uint8_saturate + faiss::uint16_to_uint8_saturate const simd16uint16 & a @@ -9339,6 +9751,7 @@ uint32_t faiss::get_MSBs (const simd32uint8 &a) get_MSBs + faiss::get_MSBs const simd32uint8 & a @@ -9357,6 +9770,7 @@ simd32uint8 faiss::blendv (const simd32uint8 &a, const simd32uint8 &b, const simd32uint8 &mask) blendv + faiss::blendv const simd32uint8 & a @@ -9383,6 +9797,7 @@ simd8float32 faiss::hadd (const simd8float32 &a, const simd8float32 &b) hadd + faiss::hadd const simd8float32 & a @@ -9404,6 +9819,7 @@ simd8float32 faiss::unpacklo (const simd8float32 &a, const simd8float32 &b) unpacklo + faiss::unpacklo const simd8float32 & a @@ -9425,6 +9841,7 @@ simd8float32 faiss::unpackhi (const simd8float32 &a, const simd8float32 &b) unpackhi + faiss::unpackhi const simd8float32 & a @@ -9446,6 +9863,7 @@ simd8float32 faiss::fmadd (const simd8float32 &a, const simd8float32 &b, const simd8float32 &c) fmadd + faiss::fmadd const simd8float32 & a @@ -9471,6 +9889,7 @@ void faiss::fvec_argsort (size_t n, const float *vals, size_t *perm) fvec_argsort + faiss::fvec_argsort size_t n @@ -9523,6 +9942,7 @@ void faiss::fvec_argsort_parallel (size_t n, const float *vals, size_t *perm) fvec_argsort_parallel + faiss::fvec_argsort_parallel size_t n @@ -9549,6 +9969,7 @@ void faiss::bucket_sort (size_t nval, const uint64_t *vals, uint64_t nbucket, int64_t *lims, int64_t *perm, int nt=0) bucket_sort + faiss::bucket_sort size_t nval @@ -9622,6 +10043,7 @@ void faiss::matrix_bucket_sort_inplace (size_t nrow, size_t ncol, int32_t *vals, int32_t nbucket, int64_t *lims, int nt=0) matrix_bucket_sort_inplace + faiss::matrix_bucket_sort_inplace size_t nrow @@ -9687,6 +10109,7 @@ void faiss::matrix_bucket_sort_inplace (size_t nrow, size_t ncol, int64_t *vals, int64_t nbucket, int64_t *lims, int nt=0) matrix_bucket_sort_inplace + faiss::matrix_bucket_sort_inplace size_t nrow @@ -9726,6 +10149,7 @@ void faiss::hashtable_int64_to_int64_init (int log2_capacity, int64_t *tab) hashtable_int64_to_int64_init + faiss::hashtable_int64_to_int64_init int log2_capacity @@ -9750,6 +10174,7 @@ void faiss::hashtable_int64_to_int64_add (int log2_capacity, int64_t *tab, size_t n, const int64_t *keys, const int64_t *vals) hashtable_int64_to_int64_add + faiss::hashtable_int64_to_int64_add int log2_capacity @@ -9783,6 +10208,7 @@ void faiss::hashtable_int64_to_int64_lookup (int log2_capacity, const int64_t *tab, size_t n, const int64_t *keys, int64_t *vals) hashtable_int64_to_int64_lookup + faiss::hashtable_int64_to_int64_lookup int log2_capacity @@ -9816,6 +10242,7 @@ std::string faiss::get_compile_options () get_compile_options + faiss::get_compile_options get compile options @@ -9830,6 +10257,7 @@ std::string faiss::get_version () get_version + faiss::get_version @@ -9843,6 +10271,7 @@ double faiss::getmillisecs () getmillisecs + faiss::getmillisecs ms elapsed since some arbitrary epoch @@ -9857,6 +10286,7 @@ size_t faiss::get_mem_usage_kb () get_mem_usage_kb + faiss::get_mem_usage_kb get current RSS usage in kB @@ -9871,6 +10301,7 @@ uint64_t faiss::get_cycles () get_cycles + faiss::get_cycles @@ -9884,6 +10315,7 @@ void faiss::reflection (const float *u, float *x, size_t n, size_t d, size_t nu) reflection + faiss::reflection const float * u @@ -9917,6 +10349,7 @@ void faiss::matrix_qr (int m, int n, float *a) matrix_qr + faiss::matrix_qr int m @@ -9952,6 +10385,7 @@ void faiss::ranklist_handle_ties (int k, int64_t *idx, const float *dis) ranklist_handle_ties + faiss::ranklist_handle_ties int k @@ -9978,6 +10412,7 @@ size_t faiss::ranklist_intersection_size (size_t k1, const int64_t *v1, size_t k2, const int64_t *v2) ranklist_intersection_size + faiss::ranklist_intersection_size size_t k1 @@ -10008,6 +10443,7 @@ size_t faiss::merge_result_table_with (size_t n, size_t k, int64_t *I0, float *D0, const int64_t *I1, const float *D1, bool keep_min=true, int64_t translation=0) merge_result_table_with + faiss::merge_result_table_with size_t n @@ -10094,6 +10530,7 @@ double faiss::imbalance_factor (int n, int k, const int64_t *assign) imbalance_factor + faiss::imbalance_factor int n @@ -10120,6 +10557,7 @@ double faiss::imbalance_factor (int k, const int *hist) imbalance_factor + faiss::imbalance_factor int k @@ -10142,6 +10580,7 @@ int faiss::ivec_hist (size_t n, const int *v, int vmax, int *hist) ivec_hist + faiss::ivec_hist size_t n @@ -10172,6 +10611,7 @@ void faiss::bincode_hist (size_t n, size_t nbits, const uint8_t *codes, int *hist) bincode_hist + faiss::bincode_hist size_t n @@ -10220,6 +10660,7 @@ uint64_t faiss::ivec_checksum (size_t n, const int32_t *a) ivec_checksum + faiss::ivec_checksum size_t n @@ -10242,6 +10683,7 @@ uint64_t faiss::bvec_checksum (size_t n, const uint8_t *a) bvec_checksum + faiss::bvec_checksum size_t n @@ -10264,6 +10706,7 @@ void faiss::bvecs_checksum (size_t n, size_t d, const uint8_t *a, uint64_t *cs) bvecs_checksum + faiss::bvecs_checksum size_t n @@ -10323,11 +10766,12 @@ - + const float * - const float* faiss::fvecs_maybe_subsample + const float * faiss::fvecs_maybe_subsample (size_t d, size_t *n, size_t nmax, const float *x, bool verbose=false, int64_t seed=1234) fvecs_maybe_subsample + faiss::fvecs_maybe_subsample size_t d @@ -10412,6 +10856,7 @@ void faiss::binary_to_real (size_t d, const uint8_t *x_in, float *x_out) binary_to_real + faiss::binary_to_real size_t d @@ -10464,6 +10909,7 @@ void faiss::real_to_binary (size_t d, const float *x_in, uint8_t *x_out) real_to_binary + faiss::real_to_binary size_t d @@ -10516,6 +10962,7 @@ uint64_t faiss::hash_bytes (const uint8_t *bytes, int64_t n) hash_bytes + faiss::hash_bytes const uint8_t * bytes @@ -10538,6 +10985,7 @@ bool faiss::check_openmp () check_openmp + faiss::check_openmp @@ -10547,7 +10995,7 @@ - + diff --git a/xml/namespacefaiss_1_1_0d136.xml b/xml/namespacefaiss_1_1_0d136.xml index f37813617b..df27b4e677 100644 --- a/xml/namespacefaiss_1_1_0d136.xml +++ b/xml/namespacefaiss_1_1_0d136.xml @@ -1,7 +1,7 @@ - + - faiss::@136 + faiss diff --git a/xml/namespacefaiss_1_1_0d145.xml b/xml/namespacefaiss_1_1_0d145.xml index c6be149c8c..c9f29e5ae1 100644 --- a/xml/namespacefaiss_1_1_0d145.xml +++ b/xml/namespacefaiss_1_1_0d145.xml @@ -1,7 +1,7 @@ - + - faiss::@145 + faiss diff --git a/xml/namespacefaiss_1_1_0d163.xml b/xml/namespacefaiss_1_1_0d163.xml index 914f0827ba..945f0f198d 100644 --- a/xml/namespacefaiss_1_1_0d163.xml +++ b/xml/namespacefaiss_1_1_0d163.xml @@ -1,7 +1,7 @@ - + - faiss::@163 + faiss diff --git a/xml/namespacefaiss_1_1_0d165.xml b/xml/namespacefaiss_1_1_0d165.xml index 7c65fcb692..de67981140 100644 --- a/xml/namespacefaiss_1_1_0d165.xml +++ b/xml/namespacefaiss_1_1_0d165.xml @@ -1,7 +1,7 @@ - + - faiss::@165 + faiss diff --git a/xml/namespacefaiss_1_1_0d166.xml b/xml/namespacefaiss_1_1_0d166.xml index 4ce8679705..2d8e1ad388 100644 --- a/xml/namespacefaiss_1_1_0d166.xml +++ b/xml/namespacefaiss_1_1_0d166.xml @@ -1,7 +1,7 @@ - + - faiss::@166 + faiss diff --git a/xml/namespacefaiss_1_1_0d167.xml b/xml/namespacefaiss_1_1_0d167.xml index fdf071daf2..0d090d0eaa 100644 --- a/xml/namespacefaiss_1_1_0d167.xml +++ b/xml/namespacefaiss_1_1_0d167.xml @@ -1,7 +1,7 @@ - + - faiss::@167 + faiss diff --git a/xml/namespacefaiss_1_1cppcontrib.xml b/xml/namespacefaiss_1_1cppcontrib.xml index 4d39e14381..8dcf9c86db 100644 --- a/xml/namespacefaiss_1_1cppcontrib.xml +++ b/xml/namespacefaiss_1_1cppcontrib.xml @@ -1,5 +1,5 @@ - + faiss::cppcontrib faiss::cppcontrib::Index2LevelDecoder @@ -7,12 +7,13 @@ faiss::cppcontrib::IndexMinMaxFP16Decoder faiss::cppcontrib::IndexPQDecoder faiss::cppcontrib::detail - + bool bool faiss::cppcontrib::isBigEndian () isBigEndian + faiss::cppcontrib::isBigEndian @@ -21,7 +22,7 @@ - + diff --git a/xml/namespacefaiss_1_1cppcontrib_1_1_0d11.xml b/xml/namespacefaiss_1_1cppcontrib_1_1_0d11.xml index 2e473dd834..d1b11bdb16 100644 --- a/xml/namespacefaiss_1_1cppcontrib_1_1_0d11.xml +++ b/xml/namespacefaiss_1_1cppcontrib_1_1_0d11.xml @@ -1,7 +1,7 @@ - + - faiss::cppcontrib::@11 + faiss::cppcontrib IndexPQDecoder. diff --git a/xml/namespacefaiss_1_1cppcontrib_1_1_0d13.xml b/xml/namespacefaiss_1_1cppcontrib_1_1_0d13.xml index f07ca6e8d9..0ca1828bd2 100644 --- a/xml/namespacefaiss_1_1cppcontrib_1_1_0d13.xml +++ b/xml/namespacefaiss_1_1cppcontrib_1_1_0d13.xml @@ -1,7 +1,7 @@ - + - faiss::cppcontrib::@13 + faiss::cppcontrib IndexPQDecoder. diff --git a/xml/namespacefaiss_1_1cppcontrib_1_1_0d6.xml b/xml/namespacefaiss_1_1cppcontrib_1_1_0d6.xml index 12b4cd5667..8fb30705f2 100644 --- a/xml/namespacefaiss_1_1cppcontrib_1_1_0d6.xml +++ b/xml/namespacefaiss_1_1cppcontrib_1_1_0d6.xml @@ -1,7 +1,7 @@ - + - faiss::cppcontrib::@6 + faiss::cppcontrib Index2LevelDecoder. diff --git a/xml/namespacefaiss_1_1cppcontrib_1_1_0d8.xml b/xml/namespacefaiss_1_1cppcontrib_1_1_0d8.xml index 348fe77769..62139e9d1f 100644 --- a/xml/namespacefaiss_1_1cppcontrib_1_1_0d8.xml +++ b/xml/namespacefaiss_1_1cppcontrib_1_1_0d8.xml @@ -1,7 +1,7 @@ - + - faiss::cppcontrib::@8 + faiss::cppcontrib diff --git a/xml/namespacefaiss_1_1cppcontrib_1_1detail.xml b/xml/namespacefaiss_1_1cppcontrib_1_1detail.xml index 271e905bd1..c7a4f405e3 100644 --- a/xml/namespacefaiss_1_1cppcontrib_1_1detail.xml +++ b/xml/namespacefaiss_1_1cppcontrib_1_1detail.xml @@ -1,11 +1,11 @@ - + faiss::cppcontrib::detail faiss::cppcontrib::detail::CoarseBitType - faiss::cppcontrib::detail::CoarseBitType< 8 > faiss::cppcontrib::detail::CoarseBitType< 16 > - + faiss::cppcontrib::detail::CoarseBitType< 8 > + @@ -33,6 +33,7 @@ using faiss::cppcontrib::detail::UintReader = typedef typename UintReaderImplType<DIM / CODE_SIZE, CODE_BITS, CPOS>:: reader_type UintReader + faiss::cppcontrib::detail::UintReader @@ -63,6 +64,7 @@ using faiss::cppcontrib::detail::UintReaderRaw = typedef typename UintReaderImplType<N_ELEMENTS, CODE_BITS, CPOS>::reader_type UintReaderRaw + faiss::cppcontrib::detail::UintReaderRaw @@ -71,7 +73,7 @@ - + diff --git a/xml/namespacefaiss_1_1cppcontrib_1_1detail_1_1_0d4.xml b/xml/namespacefaiss_1_1cppcontrib_1_1detail_1_1_0d4.xml index e06c2bb621..1f93cd83c2 100644 --- a/xml/namespacefaiss_1_1cppcontrib_1_1detail_1_1_0d4.xml +++ b/xml/namespacefaiss_1_1cppcontrib_1_1detail_1_1_0d4.xml @@ -1,7 +1,7 @@ - + - faiss::cppcontrib::detail::@4 + faiss::cppcontrib::detail diff --git a/xml/namespacefaiss_1_1detail.xml b/xml/namespacefaiss_1_1detail.xml index 3ce72790ec..705ea9708a 100644 --- a/xml/namespacefaiss_1_1detail.xml +++ b/xml/namespacefaiss_1_1detail.xml @@ -1,5 +1,5 @@ - + faiss::detail faiss::detail::simdlib diff --git a/xml/namespacefaiss_1_1detail_1_1simdlib.xml b/xml/namespacefaiss_1_1detail_1_1simdlib.xml index 7ff78c121c..cef80e6161 100644 --- a/xml/namespacefaiss_1_1detail_1_1simdlib.xml +++ b/xml/namespacefaiss_1_1detail_1_1simdlib.xml @@ -1,12 +1,12 @@ - + faiss::detail::simdlib + faiss::detail::simdlib::binary_func_impl faiss::detail::simdlib::is_simd256bit faiss::detail::simdlib::set1_impl faiss::detail::simdlib::unary_func_impl - faiss::detail::simdlib::binary_func_impl - + @@ -17,6 +17,7 @@ using faiss::detail::simdlib::remove_cv_ref_t = typedef typename std::remove_reference<typename std::remove_cv<T>::type>::type remove_cv_ref_t + faiss::detail::simdlib::remove_cv_ref_t @@ -25,13 +26,14 @@ - - + + uint8x16x2_t static uint8x16x2_t faiss::detail::simdlib::reinterpret_u8 (const uint8x16x2_t &v) reinterpret_u8 + faiss::detail::simdlib::reinterpret_u8 const uint8x16x2_t & v @@ -49,6 +51,7 @@ static uint8x16x2_t faiss::detail::simdlib::reinterpret_u8 (const uint16x8x2_t &v) reinterpret_u8 + faiss::detail::simdlib::reinterpret_u8 const uint16x8x2_t & v @@ -66,6 +69,7 @@ static uint8x16x2_t faiss::detail::simdlib::reinterpret_u8 (const uint32x4x2_t &v) reinterpret_u8 + faiss::detail::simdlib::reinterpret_u8 const uint32x4x2_t & v @@ -83,6 +87,7 @@ static uint8x16x2_t faiss::detail::simdlib::reinterpret_u8 (const float32x4x2_t &v) reinterpret_u8 + faiss::detail::simdlib::reinterpret_u8 const float32x4x2_t & v @@ -100,6 +105,7 @@ static uint16x8x2_t faiss::detail::simdlib::reinterpret_u16 (const uint8x16x2_t &v) reinterpret_u16 + faiss::detail::simdlib::reinterpret_u16 const uint8x16x2_t & v @@ -117,6 +123,7 @@ static uint16x8x2_t faiss::detail::simdlib::reinterpret_u16 (const uint16x8x2_t &v) reinterpret_u16 + faiss::detail::simdlib::reinterpret_u16 const uint16x8x2_t & v @@ -134,6 +141,7 @@ static uint16x8x2_t faiss::detail::simdlib::reinterpret_u16 (const uint32x4x2_t &v) reinterpret_u16 + faiss::detail::simdlib::reinterpret_u16 const uint32x4x2_t & v @@ -151,6 +159,7 @@ static uint16x8x2_t faiss::detail::simdlib::reinterpret_u16 (const float32x4x2_t &v) reinterpret_u16 + faiss::detail::simdlib::reinterpret_u16 const float32x4x2_t & v @@ -168,6 +177,7 @@ static uint32x4x2_t faiss::detail::simdlib::reinterpret_u32 (const uint8x16x2_t &v) reinterpret_u32 + faiss::detail::simdlib::reinterpret_u32 const uint8x16x2_t & v @@ -185,6 +195,7 @@ static uint32x4x2_t faiss::detail::simdlib::reinterpret_u32 (const uint16x8x2_t &v) reinterpret_u32 + faiss::detail::simdlib::reinterpret_u32 const uint16x8x2_t & v @@ -202,6 +213,7 @@ static uint32x4x2_t faiss::detail::simdlib::reinterpret_u32 (const uint32x4x2_t &v) reinterpret_u32 + faiss::detail::simdlib::reinterpret_u32 const uint32x4x2_t & v @@ -219,6 +231,7 @@ static uint32x4x2_t faiss::detail::simdlib::reinterpret_u32 (const float32x4x2_t &v) reinterpret_u32 + faiss::detail::simdlib::reinterpret_u32 const float32x4x2_t & v @@ -236,6 +249,7 @@ static float32x4x2_t faiss::detail::simdlib::reinterpret_f32 (const uint8x16x2_t &v) reinterpret_f32 + faiss::detail::simdlib::reinterpret_f32 const uint8x16x2_t & v @@ -253,6 +267,7 @@ static float32x4x2_t faiss::detail::simdlib::reinterpret_f32 (const uint16x8x2_t &v) reinterpret_f32 + faiss::detail::simdlib::reinterpret_f32 const uint16x8x2_t & v @@ -270,6 +285,7 @@ static float32x4x2_t faiss::detail::simdlib::reinterpret_f32 (const uint32x4x2_t &v) reinterpret_f32 + faiss::detail::simdlib::reinterpret_f32 const uint32x4x2_t & v @@ -287,6 +303,7 @@ static float32x4x2_t faiss::detail::simdlib::reinterpret_f32 (const float32x4x2_t &v) reinterpret_f32 + faiss::detail::simdlib::reinterpret_f32 const float32x4x2_t & v @@ -304,6 +321,7 @@ static inline ::uint16x8_t faiss::detail::simdlib::vdupq_n_u16 (std::uint16_t v) vdupq_n_u16 + faiss::detail::simdlib::vdupq_n_u16 std::uint16_t v @@ -321,6 +339,7 @@ static inline ::uint8x16_t faiss::detail::simdlib::vdupq_n_u8 (std::uint8_t v) vdupq_n_u8 + faiss::detail::simdlib::vdupq_n_u8 std::uint8_t v @@ -338,6 +357,7 @@ static void faiss::detail::simdlib::bin (const char(&bytes)[32], char bits[257]) bin + faiss::detail::simdlib::bin const char(&) bytes @@ -374,6 +394,7 @@ static void faiss::detail::simdlib::bin (const S &simd, char bits[257]) bin + faiss::detail::simdlib::bin const S & simd @@ -401,6 +422,7 @@ static std::string faiss::detail::simdlib::bin (const S &simd) bin + faiss::detail::simdlib::bin const S & simd @@ -413,7 +435,7 @@ - + typename D @@ -423,9 +445,10 @@ set1_impl< remove_cv_ref_t< D >, T > - static set1_impl<remove_cv_ref_t<D>, T> faiss::detail::simdlib::set1 + static set1_impl< remove_cv_ref_t< D >, T > faiss::detail::simdlib::set1 (D &d, T t) set1 + faiss::detail::simdlib::set1 D & d @@ -460,6 +483,7 @@ static std::string faiss::detail::simdlib::elements_to_string (const char *fmt, const S &simd) elements_to_string + faiss::detail::simdlib::elements_to_string const char * fmt @@ -476,16 +500,17 @@ - + typename T unary_func_impl< remove_cv_ref_t< T >, remove_cv_ref_t< T > > - static unary_func_impl<remove_cv_ref_t<T>, remove_cv_ref_t<T> > faiss::detail::simdlib::unary_func + static unary_func_impl< remove_cv_ref_t< T >, remove_cv_ref_t< T > > faiss::detail::simdlib::unary_func (const T &a) unary_func + faiss::detail::simdlib::unary_func const T & a @@ -498,7 +523,7 @@ - + typename T @@ -508,9 +533,10 @@ unary_func_impl< remove_cv_ref_t< T >, remove_cv_ref_t< U > > - static unary_func_impl<remove_cv_ref_t<T>, remove_cv_ref_t<U> > faiss::detail::simdlib::unary_func + static unary_func_impl< remove_cv_ref_t< T >, remove_cv_ref_t< U > > faiss::detail::simdlib::unary_func (const U &a) unary_func + faiss::detail::simdlib::unary_func const U & a @@ -523,16 +549,17 @@ - + typename T binary_func_impl< remove_cv_ref_t< T >, remove_cv_ref_t< T > > - static binary_func_impl<remove_cv_ref_t<T>, remove_cv_ref_t<T> > faiss::detail::simdlib::binary_func + static binary_func_impl< remove_cv_ref_t< T >, remove_cv_ref_t< T > > faiss::detail::simdlib::binary_func (const T &a, const T &b) binary_func + faiss::detail::simdlib::binary_func const T & a @@ -549,7 +576,7 @@ - + typename T @@ -559,9 +586,10 @@ binary_func_impl< remove_cv_ref_t< T >, remove_cv_ref_t< U > > - static binary_func_impl<remove_cv_ref_t<T>, remove_cv_ref_t<U> > faiss::detail::simdlib::binary_func + static binary_func_impl< remove_cv_ref_t< T >, remove_cv_ref_t< U > > faiss::detail::simdlib::binary_func (const U &a, const U &b) binary_func + faiss::detail::simdlib::binary_func const U & a @@ -583,6 +611,7 @@ static uint16_t faiss::detail::simdlib::vmovmask_u8 (const uint8x16_t &v) vmovmask_u8 + faiss::detail::simdlib::vmovmask_u8 const uint8x16_t & v @@ -607,6 +636,7 @@ static uint32_t faiss::detail::simdlib::cmp_xe32 (const uint16x8x2_t &d0, const uint16x8x2_t &d1, const uint16x8x2_t &thr) cmp_xe32 + faiss::detail::simdlib::cmp_xe32 const uint16x8x2_t & d0 @@ -639,6 +669,7 @@ static uint16x8_t faiss::detail::simdlib::vshlq (uint16x8_t vec) vshlq + faiss::detail::simdlib::vshlq uint16x8_t vec @@ -663,6 +694,7 @@ static uint16x8_t faiss::detail::simdlib::vshrq (uint16x8_t vec) vshrq + faiss::detail::simdlib::vshrq uint16x8_t vec @@ -675,7 +707,7 @@ - + diff --git a/xml/namespacefaiss_1_1gpu.xml b/xml/namespacefaiss_1_1gpu.xml index f098dedc98..3a0d23d221 100644 --- a/xml/namespacefaiss_1_1gpu.xml +++ b/xml/namespacefaiss_1_1gpu.xml @@ -1,58 +1,59 @@ - + faiss::gpu - faiss::gpu::GpuParameterSpace - faiss::gpu::ToCPUCloner - faiss::gpu::ToGpuCloner - faiss::gpu::ToGpuClonerMultiple - faiss::gpu::GpuProgressiveDimIndexFactory + faiss::gpu::AllocInfo + faiss::gpu::AllocRequest + faiss::gpu::CpuTimer + faiss::gpu::CublasHandleScope + faiss::gpu::CudaEvent + faiss::gpu::DeviceScope faiss::gpu::GpuClonerOptions - faiss::gpu::GpuMultipleClonerOptions faiss::gpu::GpuDistanceParams faiss::gpu::GpuIcmEncoder faiss::gpu::GpuIcmEncoderFactory - faiss::gpu::GpuIndexConfig faiss::gpu::GpuIndex - faiss::gpu::GpuIndexBinaryFlatConfig faiss::gpu::GpuIndexBinaryFlat - faiss::gpu::IVFPQBuildCagraConfig - faiss::gpu::IVFPQSearchCagraConfig - faiss::gpu::GpuIndexCagraConfig - faiss::gpu::SearchParametersCagra + faiss::gpu::GpuIndexBinaryFlatConfig faiss::gpu::GpuIndexCagra - faiss::gpu::GpuIndexFlatConfig + faiss::gpu::GpuIndexCagraConfig + faiss::gpu::GpuIndexConfig faiss::gpu::GpuIndexFlat - faiss::gpu::GpuIndexFlatL2 + faiss::gpu::GpuIndexFlatConfig faiss::gpu::GpuIndexFlatIP - faiss::gpu::GpuIndexIVFConfig + faiss::gpu::GpuIndexFlatL2 faiss::gpu::GpuIndexIVF - faiss::gpu::GpuIndexIVFFlatConfig + faiss::gpu::GpuIndexIVFConfig faiss::gpu::GpuIndexIVFFlat - faiss::gpu::GpuIndexIVFPQConfig + faiss::gpu::GpuIndexIVFFlatConfig faiss::gpu::GpuIndexIVFPQ - faiss::gpu::GpuIndexIVFScalarQuantizerConfig + faiss::gpu::GpuIndexIVFPQConfig faiss::gpu::GpuIndexIVFScalarQuantizer - faiss::gpu::AllocInfo - faiss::gpu::AllocRequest + faiss::gpu::GpuIndexIVFScalarQuantizerConfig faiss::gpu::GpuMemoryReservation + faiss::gpu::GpuMultipleClonerOptions + faiss::gpu::GpuParameterSpace + faiss::gpu::GpuProgressiveDimIndexFactory faiss::gpu::GpuResources faiss::gpu::GpuResourcesProvider faiss::gpu::GpuResourcesProviderFromInstance faiss::gpu::IndexWrapper - faiss::gpu::StandardGpuResourcesImpl - faiss::gpu::StandardGpuResources - faiss::gpu::DeviceScope - faiss::gpu::CublasHandleScope - faiss::gpu::CudaEvent - faiss::gpu::StackDeviceMemory + faiss::gpu::IVFPQBuildCagraConfig + faiss::gpu::IVFPQSearchCagraConfig faiss::gpu::KernelTimer - faiss::gpu::CpuTimer + faiss::gpu::SearchParametersCagra + faiss::gpu::StackDeviceMemory + faiss::gpu::StandardGpuResources + faiss::gpu::StandardGpuResourcesImpl + faiss::gpu::ToCPUCloner + faiss::gpu::ToGpuCloner + faiss::gpu::ToGpuClonerMultiple faiss::gpu::utils - + DistanceDataType + faiss::gpu::DistanceDataType F32 = 1 @@ -86,6 +87,7 @@ IndicesDataType + faiss::gpu::IndicesDataType I64 = 1 @@ -112,6 +114,7 @@ graph_build_algo + faiss::gpu::graph_build_algo IVF_PQ @@ -139,6 +142,7 @@ codebook_gen + faiss::gpu::codebook_gen PER_SUBSPACE = 0 @@ -167,6 +171,7 @@ search_algo + faiss::gpu::search_algo SINGLE_CTA @@ -208,6 +213,7 @@ hash_mode + faiss::gpu::hash_mode HASH @@ -240,6 +246,7 @@ IndicesOptions + faiss::gpu::IndicesOptions INDICES_CPU = 0 @@ -288,6 +295,7 @@ AllocType + faiss::gpu::AllocType Other = 0 @@ -362,6 +370,7 @@ MemorySpace + faiss::gpu::MemorySpace Temporary = 0 @@ -398,13 +407,14 @@ - - - + + + faiss::Index * - faiss::Index* faiss::gpu::index_gpu_to_cpu + faiss::Index * faiss::gpu::index_gpu_to_cpu (const faiss::Index *gpu_index) index_gpu_to_cpu + faiss::gpu::index_gpu_to_cpu const faiss::Index * gpu_index @@ -418,11 +428,12 @@ - + faiss::Index * - faiss::Index* faiss::gpu::index_cpu_to_gpu + faiss::Index * faiss::gpu::index_cpu_to_gpu (GpuResourcesProvider *provider, int device, const faiss::Index *index, const GpuClonerOptions *options=nullptr) index_cpu_to_gpu + faiss::gpu::index_cpu_to_gpu GpuResourcesProvider * provider @@ -449,11 +460,12 @@ - + faiss::Index * - faiss::Index* faiss::gpu::index_cpu_to_gpu_multiple + faiss::Index * faiss::gpu::index_cpu_to_gpu_multiple (std::vector< GpuResourcesProvider * > &provider, std::vector< int > &devices, const faiss::Index *index, const GpuMultipleClonerOptions *options=nullptr) index_cpu_to_gpu_multiple + faiss::gpu::index_cpu_to_gpu_multiple std::vector< GpuResourcesProvider * > & provider @@ -479,11 +491,12 @@ - + faiss::IndexBinary * - faiss::IndexBinary* faiss::gpu::index_binary_gpu_to_cpu + faiss::IndexBinary * faiss::gpu::index_binary_gpu_to_cpu (const faiss::IndexBinary *gpu_index) index_binary_gpu_to_cpu + faiss::gpu::index_binary_gpu_to_cpu const faiss::IndexBinary * gpu_index @@ -496,11 +509,12 @@ - + faiss::IndexBinary * - faiss::IndexBinary* faiss::gpu::index_binary_cpu_to_gpu + faiss::IndexBinary * faiss::gpu::index_binary_cpu_to_gpu (GpuResourcesProvider *provider, int device, const faiss::IndexBinary *index, const GpuClonerOptions *options=nullptr) index_binary_cpu_to_gpu + faiss::gpu::index_binary_cpu_to_gpu GpuResourcesProvider * provider @@ -527,11 +541,12 @@ - + faiss::IndexBinary * - faiss::IndexBinary* faiss::gpu::index_binary_cpu_to_gpu_multiple + faiss::IndexBinary * faiss::gpu::index_binary_cpu_to_gpu_multiple (std::vector< GpuResourcesProvider * > &provider, std::vector< int > &devices, const faiss::IndexBinary *index, const GpuMultipleClonerOptions *options=nullptr) index_binary_cpu_to_gpu_multiple + faiss::gpu::index_binary_cpu_to_gpu_multiple std::vector< GpuResourcesProvider * > & provider @@ -562,6 +577,7 @@ bool faiss::gpu::should_use_cuvs (GpuDistanceParams args) should_use_cuvs + faiss::gpu::should_use_cuvs GpuDistanceParams args @@ -580,6 +596,7 @@ void faiss::gpu::bfKnn (GpuResourcesProvider *resources, const GpuDistanceParams &args) bfKnn + faiss::gpu::bfKnn GpuResourcesProvider * resources @@ -604,6 +621,7 @@ void faiss::gpu::bfKnn_tiling (GpuResourcesProvider *resources, const GpuDistanceParams &args, size_t vectorsMemoryLimit, size_t queriesMemoryLimit) bfKnn_tiling + faiss::gpu::bfKnn_tiling GpuResourcesProvider * resources @@ -633,6 +651,7 @@ void faiss::gpu::bruteForceKnn (GpuResourcesProvider *resources, faiss::MetricType metric, const float *vectors, bool vectorsRowMajor, idx_t numVectors, const float *queries, bool queriesRowMajor, idx_t numQueries, int dims, int k, float *outDistances, idx_t *outIndices) bruteForceKnn + faiss::gpu::bruteForceKnn GpuResourcesProvider * resources @@ -695,6 +714,7 @@ bool faiss::gpu::should_use_cuvs (GpuIndexConfig config_) should_use_cuvs + faiss::gpu::should_use_cuvs GpuIndexConfig config_ @@ -708,11 +728,12 @@ - + GpuIndex * - GpuIndex* faiss::gpu::tryCastGpuIndex + GpuIndex * faiss::gpu::tryCastGpuIndex (faiss::Index *index) tryCastGpuIndex + faiss::gpu::tryCastGpuIndex faiss::Index * index @@ -731,6 +752,7 @@ bool faiss::gpu::isGpuIndex (faiss::Index *index) isGpuIndex + faiss::gpu::isGpuIndex faiss::Index * index @@ -749,6 +771,7 @@ bool faiss::gpu::isGpuIndexImplemented (faiss::Index *index) isGpuIndexImplemented + faiss::gpu::isGpuIndexImplemented faiss::Index * index @@ -767,6 +790,7 @@ std::string faiss::gpu::allocTypeToString (AllocType t) allocTypeToString + faiss::gpu::allocTypeToString AllocType t @@ -785,6 +809,7 @@ std::string faiss::gpu::memorySpaceToString (MemorySpace s) memorySpaceToString + faiss::gpu::memorySpaceToString MemorySpace s @@ -803,6 +828,7 @@ AllocInfo faiss::gpu::makeDevAlloc (AllocType at, cudaStream_t st) makeDevAlloc + faiss::gpu::makeDevAlloc AllocType at @@ -825,6 +851,7 @@ AllocInfo faiss::gpu::makeTempAlloc (AllocType at, cudaStream_t st) makeTempAlloc + faiss::gpu::makeTempAlloc AllocType at @@ -847,6 +874,7 @@ AllocInfo faiss::gpu::makeSpaceAlloc (AllocType at, MemorySpace sp, cudaStream_t st) makeSpaceAlloc + faiss::gpu::makeSpaceAlloc AllocType at @@ -873,6 +901,7 @@ int faiss::gpu::getMaxKSelection () getMaxKSelection + faiss::gpu::getMaxKSelection A collection of various utility functions for index implementation. @@ -888,6 +917,7 @@ void faiss::gpu::validateKSelect (int k) validateKSelect + faiss::gpu::validateKSelect int k @@ -905,6 +935,7 @@ void faiss::gpu::validateNProbe (size_t nprobe) validateNProbe + faiss::gpu::validateNProbe size_t nprobe @@ -917,11 +948,12 @@ - + std::vector< uint8_t > - std::vector<uint8_t> faiss::gpu::unpackNonInterleaved + std::vector< uint8_t > faiss::gpu::unpackNonInterleaved (std::vector< uint8_t > data, int numVecs, int dims, int bitsPerCode) unpackNonInterleaved + faiss::gpu::unpackNonInterleaved std::vector< uint8_t > data @@ -946,11 +978,12 @@ - + std::vector< uint8_t > - std::vector<uint8_t> faiss::gpu::unpackInterleaved + std::vector< uint8_t > faiss::gpu::unpackInterleaved (std::vector< uint8_t > data, int numVecs, int dims, int bitsPerCode) unpackInterleaved + faiss::gpu::unpackInterleaved std::vector< uint8_t > data @@ -975,11 +1008,12 @@ - + std::vector< uint8_t > - std::vector<uint8_t> faiss::gpu::packNonInterleaved + std::vector< uint8_t > faiss::gpu::packNonInterleaved (std::vector< uint8_t > data, int numVecs, int dims, int bitsPerCode) packNonInterleaved + faiss::gpu::packNonInterleaved std::vector< uint8_t > data @@ -1004,11 +1038,12 @@ - + std::vector< uint8_t > - std::vector<uint8_t> faiss::gpu::packInterleaved + std::vector< uint8_t > faiss::gpu::packInterleaved (std::vector< uint8_t > data, int numVecs, int dims, int bitsPerCode) packInterleaved + faiss::gpu::packInterleaved std::vector< uint8_t > data @@ -1033,11 +1068,12 @@ - + void void faiss::gpu::ivfOffsetToUserIndex - (idx_t *indices, idx_t numLists, idx_t queries, int k, const std::vector< std::vector< idx_t >> &listOffsetToUserIndex) + (idx_t *indices, idx_t numLists, idx_t queries, int k, const std::vector< std::vector< idx_t > > &listOffsetToUserIndex) ivfOffsetToUserIndex + faiss::gpu::ivfOffsetToUserIndex idx_t * indices @@ -1055,7 +1091,7 @@ k - const std::vector< std::vector< idx_t >> & + const std::vector< std::vector< idx_t > > & listOffsetToUserIndex @@ -1072,6 +1108,7 @@ void faiss::gpu::newTestSeed () newTestSeed + faiss::gpu::newTestSeed Generates and displays a new seed for the test. @@ -1086,6 +1123,7 @@ void faiss::gpu::setTestSeed (long seed) setTestSeed + faiss::gpu::setTestSeed long seed @@ -1104,6 +1142,7 @@ float faiss::gpu::relativeError (float a, float b) relativeError + faiss::gpu::relativeError float a @@ -1126,6 +1165,7 @@ int faiss::gpu::randVal (int a, int b) randVal + faiss::gpu::randVal int a @@ -1148,6 +1188,7 @@ bool faiss::gpu::randBool () randBool + faiss::gpu::randBool Generates a random bool. @@ -1167,6 +1208,7 @@ T faiss::gpu::randSelect (std::initializer_list< T > vals) randSelect + faiss::gpu::randSelect std::initializer_list< T > vals @@ -1180,11 +1222,12 @@ - + std::vector< float > - std::vector<float> faiss::gpu::randVecs + std::vector< float > faiss::gpu::randVecs (size_t num, size_t dim) randVecs + faiss::gpu::randVecs size_t num @@ -1202,11 +1245,12 @@ - + std::vector< unsigned char > - std::vector<unsigned char> faiss::gpu::randBinaryVecs + std::vector< unsigned char > faiss::gpu::randBinaryVecs (size_t num, size_t dim) randBinaryVecs + faiss::gpu::randBinaryVecs size_t num @@ -1224,11 +1268,12 @@ - + std::vector< float > - std::vector<float> faiss::gpu::roundToHalf + std::vector< float > faiss::gpu::roundToHalf (const std::vector< float > &v) roundToHalf + faiss::gpu::roundToHalf const std::vector< float > & v @@ -1246,6 +1291,7 @@ void faiss::gpu::compareIndices (const std::vector< float > &queryVecs, faiss::Index &refIndex, faiss::Index &testIndex, int numQuery, int dim, int k, const std::string &configMsg, float maxRelativeError=6e-5f, float pctMaxDiff1=0.1f, float pctMaxDiffN=0.005f) compareIndices + faiss::gpu::compareIndices const std::vector< float > & queryVecs @@ -1303,6 +1349,7 @@ void faiss::gpu::compareIndices (faiss::Index &refIndex, faiss::Index &testIndex, int numQuery, int dim, int k, const std::string &configMsg, float maxRelativeError=6e-5f, float pctMaxDiff1=0.1f, float pctMaxDiffN=0.005f) compareIndices + faiss::gpu::compareIndices faiss::Index & refIndex @@ -1356,6 +1403,7 @@ void faiss::gpu::compareLists (const float *refDist, const faiss::idx_t *refInd, const float *testDist, const faiss::idx_t *testInd, int dim1, int dim2, const std::string &configMsg, bool printBasicStats, bool printDiffs, bool assertOnErr, float maxRelativeError=6e-5f, float pctMaxDiff1=0.1f, float pctMaxDiffN=0.005f) compareLists + faiss::gpu::compareLists const float * refDist @@ -1433,6 +1481,7 @@ void faiss::gpu::testIVFEquality (A &cpuIndex, B &gpuIndex) testIVFEquality + faiss::gpu::testIVFEquality A & cpuIndex @@ -1455,6 +1504,7 @@ cuvsDistanceType faiss::gpu::metricFaissToCuvs (MetricType metric, bool exactDistance) metricFaissToCuvs + faiss::gpu::metricFaissToCuvs MetricType metric @@ -1476,6 +1526,7 @@ void faiss::gpu::validRowIndices (GpuResources *res, Tensor< float, 2, true > &vecs, bool *validRows) validRowIndices + faiss::gpu::validRowIndices GpuResources * res @@ -1502,6 +1553,7 @@ idx_t faiss::gpu::inplaceGatherFilteredRows (GpuResources *res, Tensor< float, 2, true > &vecs, Tensor< idx_t, 1, true > &indices) inplaceGatherFilteredRows + faiss::gpu::inplaceGatherFilteredRows GpuResources * res @@ -1528,6 +1580,7 @@ int faiss::gpu::getCurrentDevice () getCurrentDevice + faiss::gpu::getCurrentDevice Returns the current thread-local GPU device. @@ -1542,6 +1595,7 @@ void faiss::gpu::setCurrentDevice (int device) setCurrentDevice + faiss::gpu::setCurrentDevice int device @@ -1560,6 +1614,7 @@ int faiss::gpu::getNumDevices () getNumDevices + faiss::gpu::getNumDevices Returns the number of available GPU devices. @@ -1574,6 +1629,7 @@ void faiss::gpu::profilerStart () profilerStart + faiss::gpu::profilerStart Starts the CUDA profiler (exposed via SWIG) @@ -1588,6 +1644,7 @@ void faiss::gpu::profilerStop () profilerStop + faiss::gpu::profilerStop Stops the CUDA profiler (exposed via SWIG) @@ -1602,6 +1659,7 @@ void faiss::gpu::synchronizeAllDevices () synchronizeAllDevices + faiss::gpu::synchronizeAllDevices @@ -1611,11 +1669,12 @@ - + const cudaDeviceProp & - const cudaDeviceProp& faiss::gpu::getDeviceProperties + const cudaDeviceProp & faiss::gpu::getDeviceProperties (int device) getDeviceProperties + faiss::gpu::getDeviceProperties int device @@ -1629,11 +1688,12 @@ - + const cudaDeviceProp & - const cudaDeviceProp& faiss::gpu::getCurrentDeviceProperties + const cudaDeviceProp & faiss::gpu::getCurrentDeviceProperties () getCurrentDeviceProperties + faiss::gpu::getCurrentDeviceProperties Returns the cached cudaDeviceProp for the current device. @@ -1648,6 +1708,7 @@ int faiss::gpu::getMaxThreads (int device) getMaxThreads + faiss::gpu::getMaxThreads int device @@ -1666,6 +1727,7 @@ int faiss::gpu::getMaxThreadsCurrentDevice () getMaxThreadsCurrentDevice + faiss::gpu::getMaxThreadsCurrentDevice Equivalent to getMaxThreads(getCurrentDevice()) @@ -1680,6 +1742,7 @@ dim3 faiss::gpu::getMaxGrid (int device) getMaxGrid + faiss::gpu::getMaxGrid int device @@ -1698,6 +1761,7 @@ dim3 faiss::gpu::getMaxGridCurrentDevice () getMaxGridCurrentDevice + faiss::gpu::getMaxGridCurrentDevice Equivalent to getMaxGrid(getCurrentDevice()) @@ -1712,6 +1776,7 @@ size_t faiss::gpu::getMaxSharedMemPerBlock (int device) getMaxSharedMemPerBlock + faiss::gpu::getMaxSharedMemPerBlock int device @@ -1730,6 +1795,7 @@ size_t faiss::gpu::getMaxSharedMemPerBlockCurrentDevice () getMaxSharedMemPerBlockCurrentDevice + faiss::gpu::getMaxSharedMemPerBlockCurrentDevice Equivalent to getMaxSharedMemPerBlock(getCurrentDevice()) @@ -1744,6 +1810,7 @@ int faiss::gpu::getDeviceForAddress (const void *p) getDeviceForAddress + faiss::gpu::getDeviceForAddress const void * p @@ -1762,6 +1829,7 @@ bool faiss::gpu::getFullUnifiedMemSupport (int device) getFullUnifiedMemSupport + faiss::gpu::getFullUnifiedMemSupport int device @@ -1780,6 +1848,7 @@ bool faiss::gpu::getFullUnifiedMemSupportCurrentDevice () getFullUnifiedMemSupportCurrentDevice + faiss::gpu::getFullUnifiedMemSupportCurrentDevice Equivalent to getFullUnifiedMemSupport(getCurrentDevice()) @@ -1794,6 +1863,7 @@ bool faiss::gpu::getTensorCoreSupport (int device) getTensorCoreSupport + faiss::gpu::getTensorCoreSupport int device @@ -1812,6 +1882,7 @@ bool faiss::gpu::getTensorCoreSupportCurrentDevice () getTensorCoreSupportCurrentDevice + faiss::gpu::getTensorCoreSupportCurrentDevice Equivalent to getTensorCoreSupport(getCurrentDevice()) @@ -1826,6 +1897,7 @@ int faiss::gpu::getWarpSize (int device) getWarpSize + faiss::gpu::getWarpSize int device @@ -1844,6 +1916,7 @@ int faiss::gpu::getWarpSizeCurrentDevice () getWarpSizeCurrentDevice + faiss::gpu::getWarpSizeCurrentDevice Equivalent to getWarpSize(getCurrentDevice()) @@ -1858,6 +1931,7 @@ size_t faiss::gpu::getFreeMemory (int device) getFreeMemory + faiss::gpu::getFreeMemory int device @@ -1876,6 +1950,7 @@ size_t faiss::gpu::getFreeMemoryCurrentDevice () getFreeMemoryCurrentDevice + faiss::gpu::getFreeMemoryCurrentDevice Equivalent to getFreeMemory(getCurrentDevice()) @@ -1898,6 +1973,7 @@ void faiss::gpu::streamWaitBase (const L1 &listWaiting, const L2 &listWaitOn) streamWaitBase + faiss::gpu::streamWaitBase const L1 & listWaiting @@ -1925,6 +2001,7 @@ void faiss::gpu::streamWait (const L1 &a, const std::initializer_list< cudaStream_t > &b) streamWait + faiss::gpu::streamWait const L1 & a @@ -1952,6 +2029,7 @@ void faiss::gpu::streamWait (const std::initializer_list< cudaStream_t > &a, const L2 &b) streamWait + faiss::gpu::streamWait const std::initializer_list< cudaStream_t > & a @@ -1973,6 +2051,7 @@ void faiss::gpu::streamWait (const std::initializer_list< cudaStream_t > &a, const std::initializer_list< cudaStream_t > &b) streamWait + faiss::gpu::streamWait const std::initializer_list< cudaStream_t > & a @@ -1989,7 +2068,7 @@ - + diff --git a/xml/namespacefaiss_1_1gpu_1_1utils.xml b/xml/namespacefaiss_1_1gpu_1_1utils.xml index 2b1fde863a..1fdce0a228 100644 --- a/xml/namespacefaiss_1_1gpu_1_1utils.xml +++ b/xml/namespacefaiss_1_1gpu_1_1utils.xml @@ -1,8 +1,8 @@ - + faiss::gpu::utils - + @@ -16,6 +16,7 @@ constexpr __host__ __device__ auto faiss::gpu::utils::divDown (U a, V b) -> decltype(a+b) divDown + faiss::gpu::utils::divDown U a @@ -45,6 +46,7 @@ constexpr __host__ __device__ auto faiss::gpu::utils::divUp (U a, V b) -> decltype(a+b) divUp + faiss::gpu::utils::divUp U a @@ -74,6 +76,7 @@ constexpr __host__ __device__ auto faiss::gpu::utils::roundDown (U a, V b) -> decltype(a+b) roundDown + faiss::gpu::utils::roundDown U a @@ -103,6 +106,7 @@ constexpr __host__ __device__ auto faiss::gpu::utils::roundUp (U a, V b) -> decltype(a+b) roundUp + faiss::gpu::utils::roundUp U a @@ -129,6 +133,7 @@ constexpr __host__ __device__ T faiss::gpu::utils::pow (T n, T power) pow + faiss::gpu::utils::pow T n @@ -155,6 +160,7 @@ constexpr __host__ __device__ T faiss::gpu::utils::pow2 (T n) pow2 + faiss::gpu::utils::pow2 T n @@ -177,6 +183,7 @@ constexpr __host__ __device__ int faiss::gpu::utils::log2 (T n, int p=0) log2 + faiss::gpu::utils::log2 T n @@ -204,6 +211,7 @@ constexpr __host__ __device__ bool faiss::gpu::utils::isPowerOf2 (T v) isPowerOf2 + faiss::gpu::utils::isPowerOf2 T v @@ -226,6 +234,7 @@ constexpr __host__ __device__ T faiss::gpu::utils::nextHighestPowerOf2 (T v) nextHighestPowerOf2 + faiss::gpu::utils::nextHighestPowerOf2 T v @@ -238,7 +247,7 @@ - + diff --git a/xml/namespacefaiss_1_1ivflib.xml b/xml/namespacefaiss_1_1ivflib.xml index d31ddcca77..a3099dd69f 100644 --- a/xml/namespacefaiss_1_1ivflib.xml +++ b/xml/namespacefaiss_1_1ivflib.xml @@ -1,14 +1,15 @@ - + faiss::ivflib faiss::ivflib::SlidingIndexWindow - + void void faiss::ivflib::check_compatible_for_merge (const Index *index1, const Index *index2) check_compatible_for_merge + faiss::ivflib::check_compatible_for_merge const Index * index1 @@ -26,11 +27,12 @@ - + const IndexIVF * - const IndexIVF* faiss::ivflib::extract_index_ivf + const IndexIVF * faiss::ivflib::extract_index_ivf (const Index *index) extract_index_ivf + faiss::ivflib::extract_index_ivf const Index * index @@ -45,11 +47,12 @@ - + IndexIVF * - IndexIVF* faiss::ivflib::extract_index_ivf + IndexIVF * faiss::ivflib::extract_index_ivf (Index *index) extract_index_ivf + faiss::ivflib::extract_index_ivf Index * index @@ -62,11 +65,12 @@ - + const IndexIVF * - const IndexIVF* faiss::ivflib::try_extract_index_ivf + const IndexIVF * faiss::ivflib::try_extract_index_ivf (const Index *index) try_extract_index_ivf + faiss::ivflib::try_extract_index_ivf const Index * index @@ -80,11 +84,12 @@ - + IndexIVF * - IndexIVF* faiss::ivflib::try_extract_index_ivf + IndexIVF * faiss::ivflib::try_extract_index_ivf (Index *index) try_extract_index_ivf + faiss::ivflib::try_extract_index_ivf Index * index @@ -102,6 +107,7 @@ void faiss::ivflib::merge_into (Index *index0, Index *index1, bool shift_ids) merge_into + faiss::ivflib::merge_into Index * index0 @@ -138,6 +144,7 @@ void faiss::ivflib::search_centroid (Index *index, const float *x, int n, idx_t *centroid_ids) search_centroid + faiss::ivflib::search_centroid Index * index @@ -167,6 +174,7 @@ void faiss::ivflib::search_and_return_centroids (Index *index, size_t n, const float *xin, long k, float *distances, idx_t *labels, idx_t *query_centroid_ids, idx_t *result_centroid_ids) search_and_return_centroids + faiss::ivflib::search_and_return_centroids Index * index @@ -207,11 +215,12 @@ - + ArrayInvertedLists * - ArrayInvertedLists* faiss::ivflib::get_invlist_range + ArrayInvertedLists * faiss::ivflib::get_invlist_range (const Index *index, long i0, long i1) get_invlist_range + faiss::ivflib::get_invlist_range const Index * index @@ -238,6 +247,7 @@ void faiss::ivflib::set_invlist_range (Index *index, long i0, long i1, ArrayInvertedLists *src) set_invlist_range + faiss::ivflib::set_invlist_range Index * index @@ -268,6 +278,7 @@ void faiss::ivflib::search_with_parameters (const Index *index, idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const IVFSearchParameters *params, size_t *nb_dis=nullptr, double *ms_per_stage=nullptr) search_with_parameters + faiss::ivflib::search_with_parameters const Index * index @@ -325,6 +336,7 @@ void faiss::ivflib::range_search_with_parameters (const Index *index, idx_t n, const float *x, float radius, RangeSearchResult *result, const IVFSearchParameters *params, size_t *nb_dis=nullptr, double *ms_per_stage=nullptr) range_search_with_parameters + faiss::ivflib::range_search_with_parameters const Index * index @@ -368,11 +380,12 @@ - + IndexIVFResidualQuantizer * - IndexIVFResidualQuantizer* faiss::ivflib::ivf_residual_from_quantizer + IndexIVFResidualQuantizer * faiss::ivflib::ivf_residual_from_quantizer (const ResidualQuantizer &, int nlevel) ivf_residual_from_quantizer + faiss::ivflib::ivf_residual_from_quantizer const ResidualQuantizer & @@ -394,6 +407,7 @@ void faiss::ivflib::ivf_residual_add_from_flat_codes (IndexIVFResidualQuantizer *ivfrq, size_t ncode, const uint8_t *codes, int64_t code_size=-1) ivf_residual_add_from_flat_codes + faiss::ivflib::ivf_residual_add_from_flat_codes IndexIVFResidualQuantizer * ivfrq @@ -446,7 +460,7 @@ - + diff --git a/xml/namespacefaiss_1_1lsq.xml b/xml/namespacefaiss_1_1lsq.xml index a6f1c2e869..85f51b7184 100644 --- a/xml/namespacefaiss_1_1lsq.xml +++ b/xml/namespacefaiss_1_1lsq.xml @@ -1,5 +1,5 @@ - + faiss::lsq faiss::lsq::IcmEncoder diff --git a/xml/namespacefaiss_1_1nn.xml b/xml/namespacefaiss_1_1nn.xml index 85b29c8d1f..177436779e 100644 --- a/xml/namespacefaiss_1_1nn.xml +++ b/xml/namespacefaiss_1_1nn.xml @@ -1,17 +1,18 @@ - + faiss::nn - faiss::nn::Tensor2DTemplate - faiss::nn::Linear faiss::nn::Embedding faiss::nn::FFN - + faiss::nn::Linear + faiss::nn::Tensor2DTemplate + Tensor2DTemplate< float > using faiss::nn::Tensor2D = typedef Tensor2DTemplate<float> Tensor2D + faiss::nn::Tensor2D @@ -25,6 +26,7 @@ using faiss::nn::Int32Tensor2D = typedef Tensor2DTemplate<int32_t> Int32Tensor2D + faiss::nn::Int32Tensor2D @@ -33,7 +35,7 @@ - + diff --git a/xml/namespacefaiss_1_1nndescent.xml b/xml/namespacefaiss_1_1nndescent.xml index b8791c1a46..e80613f42e 100644 --- a/xml/namespacefaiss_1_1nndescent.xml +++ b/xml/namespacefaiss_1_1nndescent.xml @@ -1,5 +1,5 @@ - + faiss::nndescent faiss::nndescent::Neighbor diff --git a/xml/namespacefaiss_1_1nsg.xml b/xml/namespacefaiss_1_1nsg.xml index faae20c7d8..ff1026e6b6 100644 --- a/xml/namespacefaiss_1_1nsg.xml +++ b/xml/namespacefaiss_1_1nsg.xml @@ -1,14 +1,15 @@ - + faiss::nsg faiss::nsg::Graph - - + + DistanceComputer * - DistanceComputer* faiss::nsg::storage_distance_computer + DistanceComputer * faiss::nsg::storage_distance_computer (const Index *storage) storage_distance_computer + faiss::nsg::storage_distance_computer const Index * storage @@ -21,7 +22,7 @@ - + diff --git a/xml/namespacefaiss_1_1quantize__lut.xml b/xml/namespacefaiss_1_1quantize__lut.xml index 1bce8a04b3..632facb996 100644 --- a/xml/namespacefaiss_1_1quantize__lut.xml +++ b/xml/namespacefaiss_1_1quantize__lut.xml @@ -1,13 +1,14 @@ - + faiss::quantize_lut - + void void faiss::quantize_lut::round_uint8_per_column (float *tab, size_t n, size_t d, float *a_out=nullptr, float *b_out=nullptr) round_uint8_per_column + faiss::quantize_lut::round_uint8_per_column float * tab @@ -43,6 +44,7 @@ void faiss::quantize_lut::round_uint8_per_column_multi (float *tab, size_t m, size_t n, size_t d, float *a_out=nullptr, float *b_out=nullptr) round_uint8_per_column_multi + faiss::quantize_lut::round_uint8_per_column_multi float * tab @@ -82,6 +84,7 @@ void faiss::quantize_lut::quantize_LUT_and_bias (size_t nprobe, size_t M, size_t ksub, bool lut_is_3d, const float *LUT, const float *bias, uint8_t *LUTq, size_t M2, uint16_t *biasq, float *a_out=nullptr, float *b_out=nullptr) quantize_LUT_and_bias + faiss::quantize_lut::quantize_LUT_and_bias size_t nprobe @@ -153,6 +156,7 @@ void faiss::quantize_lut::aq_quantize_LUT_and_bias (size_t nprobe, size_t M, size_t ksub, const float *LUT, const float *bias, size_t M_norm, int norm_scale, uint8_t *LUTq, size_t M2, uint16_t *biasq, float *a_out, float *b_out) aq_quantize_LUT_and_bias + faiss::quantize_lut::aq_quantize_LUT_and_bias size_t nprobe @@ -214,6 +218,7 @@ float faiss::quantize_lut::aq_estimate_norm_scale (size_t M, size_t ksub, size_t M_norm, const float *LUT) aq_estimate_norm_scale + faiss::quantize_lut::aq_estimate_norm_scale size_t M @@ -238,7 +243,7 @@ - + diff --git a/xml/namespacefaiss_1_1rq__encode__steps.xml b/xml/namespacefaiss_1_1rq__encode__steps.xml index 1170d8a34a..8b37aebbd2 100644 --- a/xml/namespacefaiss_1_1rq__encode__steps.xml +++ b/xml/namespacefaiss_1_1rq__encode__steps.xml @@ -1,17 +1,18 @@ - + faiss::rq_encode_steps - faiss::rq_encode_steps::RefineBeamMemoryPool - faiss::rq_encode_steps::RefineBeamLUTMemoryPool faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool - + faiss::rq_encode_steps::RefineBeamLUTMemoryPool + faiss::rq_encode_steps::RefineBeamMemoryPool + void void faiss::rq_encode_steps::refine_beam_mp (const ResidualQuantizer &rq, size_t n, size_t beam_size, const float *x, int out_beam_size, int32_t *out_codes, float *out_residuals, float *out_distances, RefineBeamMemoryPool &pool) refine_beam_mp + faiss::rq_encode_steps::refine_beam_mp const ResidualQuantizer & rq @@ -61,6 +62,7 @@ void faiss::rq_encode_steps::refine_beam_LUT_mp (const ResidualQuantizer &rq, size_t n, const float *query_norms, const float *query_cp, int out_beam_size, int32_t *out_codes, float *out_distances, RefineBeamLUTMemoryPool &pool) refine_beam_LUT_mp + faiss::rq_encode_steps::refine_beam_LUT_mp const ResidualQuantizer & rq @@ -106,6 +108,7 @@ void faiss::rq_encode_steps::compute_codes_add_centroids_mp_lut0 (const ResidualQuantizer &rq, const float *x, uint8_t *codes_out, size_t n, const float *centroids, ComputeCodesAddCentroidsLUT0MemoryPool &pool) compute_codes_add_centroids_mp_lut0 + faiss::rq_encode_steps::compute_codes_add_centroids_mp_lut0 const ResidualQuantizer & rq @@ -143,6 +146,7 @@ void faiss::rq_encode_steps::compute_codes_add_centroids_mp_lut1 (const ResidualQuantizer &rq, const float *x, uint8_t *codes_out, size_t n, const float *centroids, ComputeCodesAddCentroidsLUT1MemoryPool &pool) compute_codes_add_centroids_mp_lut1 + faiss::rq_encode_steps::compute_codes_add_centroids_mp_lut1 const ResidualQuantizer & rq @@ -175,7 +179,7 @@ - + diff --git a/xml/namespacefaiss_1_1simd__result__handlers.xml b/xml/namespacefaiss_1_1simd__result__handlers.xml index 6740814b4e..dda8d8b2d8 100644 --- a/xml/namespacefaiss_1_1simd__result__handlers.xml +++ b/xml/namespacefaiss_1_1simd__result__handlers.xml @@ -1,17 +1,17 @@ - + faiss::simd_result_handlers faiss::simd_result_handlers::DummyResultHandler - faiss::simd_result_handlers::StoreResultHandler faiss::simd_result_handlers::FixedStorageHandler - faiss::simd_result_handlers::ResultHandlerCompare - faiss::simd_result_handlers::SingleResultHandler faiss::simd_result_handlers::HeapHandler - faiss::simd_result_handlers::ReservoirHandler - faiss::simd_result_handlers::RangeHandler faiss::simd_result_handlers::PartialRangeHandler - + faiss::simd_result_handlers::RangeHandler + faiss::simd_result_handlers::ReservoirHandler + faiss::simd_result_handlers::ResultHandlerCompare + faiss::simd_result_handlers::SingleResultHandler + faiss::simd_result_handlers::StoreResultHandler + @@ -35,6 +35,7 @@ void faiss::simd_result_handlers::dispatch_SIMDResultHandler_fixedCW (SIMDResultHandler &res, Consumer &consumer, Types... args) dispatch_SIMDResultHandler_fixedCW + faiss::simd_result_handlers::dispatch_SIMDResultHandler_fixedCW SIMDResultHandler & res @@ -73,6 +74,7 @@ void faiss::simd_result_handlers::dispatch_SIMDResultHandler_fixedC (SIMDResultHandler &res, Consumer &consumer, Types... args) dispatch_SIMDResultHandler_fixedC + faiss::simd_result_handlers::dispatch_SIMDResultHandler_fixedC SIMDResultHandler & res @@ -108,6 +110,7 @@ void faiss::simd_result_handlers::dispatch_SIMDResultHandler (SIMDResultHandler &res, Consumer &consumer, Types... args) dispatch_SIMDResultHandler + faiss::simd_result_handlers::dispatch_SIMDResultHandler SIMDResultHandler & res @@ -128,7 +131,7 @@ - + diff --git a/xml/namespacestd.xml b/xml/namespacestd.xml index b4131049a8..52ff2fb5bb 100644 --- a/xml/namespacestd.xml +++ b/xml/namespacestd.xml @@ -1,5 +1,5 @@ - + std diff --git a/xml/neon-inl_8h.xml b/xml/neon-inl_8h.xml index 07c34a2c07..2431ad46c5 100644 --- a/xml/neon-inl_8h.xml +++ b/xml/neon-inl_8h.xml @@ -1,5 +1,5 @@ - + neon-inl.h @@ -49,9 +49,9 @@ /*Hammingdistancesformultiplesof64bits*/ template<size_tnbits> inlinehamdis_thamming(constuint64_t*pa,constuint64_t*pb){ -constexprsize_tnwords256=nbits/256; -constexprsize_tnwords128=(nbits-nwords256*256)/128; -constexprsize_tnwords64= +constexprsize_tnwords256=nbits/256; +constexprsize_tnwords128=(nbits-nwords256*256)/128; +constexprsize_tnwords64= (nbits-nwords256*256-nwords128*128)/64; hamdis_th=0; @@ -159,7 +159,7 @@ returnpopcount64(*(uint32_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return4; } }; @@ -182,7 +182,7 @@ returnpopcount64(*(uint64_t*)b^a0); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return8; } }; @@ -210,7 +210,7 @@ returndis; } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return16; } }; @@ -247,7 +247,7 @@ returndis+popcount64(b[4]^a2); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return20; } }; @@ -281,7 +281,7 @@ returndis; } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return32; } }; @@ -305,7 +305,7 @@ returnhc0.hamming(b8)+hc1.hamming(b8+32); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return64; } }; @@ -442,7 +442,7 @@ return8-vaddv_u8(c0)/8; } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return8; } }; @@ -462,7 +462,7 @@ return16-vaddvq_u8(c0)/8; } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return16; } }; @@ -479,7 +479,7 @@ returna0.hamming(b8)+a1.hamming(b8+16); } -inlinestaticconstexprintget_code_size(){ +inlinestaticconstexprintget_code_size(){ return32; } }; diff --git a/xml/ordered__key__value_8h.xml b/xml/ordered__key__value_8h.xml index c01c6f89f2..764ae316c4 100644 --- a/xml/ordered__key__value_8h.xml +++ b/xml/ordered__key__value_8h.xml @@ -1,5 +1,5 @@ - + ordered_key_value.h climits @@ -7,12 +7,6 @@ limits faiss/utils/Heap.h - - - - - - @@ -26,264 +20,326 @@ + + + + + + - - - - - - - - - - - - - + + + - - - + + + - + - + - - - - - - - + + + + + + + - + + + + + + + + + - - - - + + + + - + + + + + - + - - - - - - - - - + - - - - - - - - - + - + + + + + - + - + - - - - - + - - - - - + + + + + - - - - + + + + - - - - + + + + + + + + - + - + + + + + + + + + + + + + + + - + + + + + - + + + + + + + + + + + + + - + + + + + + + + + - + - + - + - + - + + + + + - + + + + + - + - + - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + - - - - + + + + - - - + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - - - - - - + - + - - - - - + + + - - - - + + + + + + + + + + - + - - - - - - - - - - - - - + + + - - - + + + - + - + - + - + - + - + - + - + @@ -293,11 +349,11 @@ - + - + - + @@ -306,132 +362,76 @@ - - - - - - - - - - - + + + - - - - - - - - - - - - - - - - - - - - + + + + - - - + + + - - - - + + + + - - - - - - - + + + - - - + + + - - - + + + - - - + + + + + - - - + + + - - - - - - - - - - - - - + + + - - - - - - - - - - + + + + - - - + - + - + - + - - - - - - - - - + - - - - faiss::CMin faiss::CMax diff --git a/xml/partitioning_8h.xml b/xml/partitioning_8h.xml index 3f94a220f2..136185d498 100644 --- a/xml/partitioning_8h.xml +++ b/xml/partitioning_8h.xml @@ -1,5 +1,5 @@ - + partitioning.h stdint.h @@ -16,12 +16,6 @@ - - - - - - @@ -32,30 +26,48 @@ + + + + + + - - - + + + + + + + + + + + - - - + + + + + + + @@ -64,18 +76,6 @@ - - - - - - - - - - - - faiss::PartitionStats faiss diff --git a/xml/platform__macros_8h.xml b/xml/platform__macros_8h.xml index fe90611dd3..e5315a58d8 100644 --- a/xml/platform__macros_8h.xml +++ b/xml/platform__macros_8h.xml @@ -1,19 +1,9 @@ - + platform_macros.h cstdint cstdio - faiss/cppcontrib/detail/UintReader.h - faiss/cppcontrib/sa_decode/Level2-inl.h - faiss/impl/AuxIndexStructures.h - faiss/impl/code_distance/code_distance.h - faiss/impl/FaissAssert.h - faiss/impl/HNSW.h - faiss/impl/LocalSearchQuantizer.h - faiss/impl/NNDescent.h - faiss/impl/ProductQuantizer.h - faiss/impl/simd_result_handlers.h faiss/Index2Layer.h faiss/IndexAdditiveQuantizer.h faiss/IndexBinaryHash.h @@ -23,6 +13,16 @@ faiss/IndexPQ.h faiss/IndexRowwiseMinMax.h faiss/MetricType.h + faiss/cppcontrib/detail/UintReader.h + faiss/cppcontrib/sa_decode/Level2-inl.h + faiss/impl/AuxIndexStructures.h + faiss/impl/FaissAssert.h + faiss/impl/HNSW.h + faiss/impl/LocalSearchQuantizer.h + faiss/impl/NNDescent.h + faiss/impl/ProductQuantizer.h + faiss/impl/code_distance/code_distance.h + faiss/impl/simd_result_handlers.h faiss/utils/AlignedTable.h faiss/utils/approx_topk/approx_topk.h faiss/utils/distances.h @@ -56,1104 +56,1104 @@ - - - - - - - - - - - - + + + + - - - - - - - - - - - - + + + + - - - - - - - - - + - + - + - + - - - - - - - - - - - - - + - - - - - - - - - + + + - - - - + + + + - + - + - + - + - + - + - + - + - - - - - - - - - + - + - - - - - + - - - - - + - - - - - + - + - + - + - + - + - + - - - - - - - - - - - - - + - + - + - + - - - - - + - + - - - - - + - + - + - + - + - + - + + + + + + + + + - + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + + + + + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - + + + - - - - - - - - + + + + - - - + + + - - - - + + + + - + + + + + - + - + + + + + - + - - - - - + - - - - - + - - - - - - + + + + - + - + - + - + - - - - - + - - - - - + - - - - - + - - - - + + + + - - - - - - + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - + + + + - + + + + + + + + + - + - + + + + + - + + + + + + + + + - + - - - - - - - - + + + + - - - + + + - - - - + + + + + + + + - - - + + + - - - - + + + + - - - + + + - - - - + + + + + + + + + + + + + + + + - - - - + + + + - + + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + - - - + + + - + - - - - + + + + - - - - - + - + - + - + + + + + - - - + + + + + + + + + - - - + + + - - - - + + + + + + + + + + - - - + + + - - - + + + - - - + + + + + - - - - + + + + + + + + - - - + + + - - - + + + - + + + + + + + + + - - - + + + - - - - + + + + + + + + - + - + - + - + - - - - - - - - - - - + + + - - - + + + - - - - + + + + - - - - - - - - + + + + - + - + - - - - - + + + - - - - + + + + - - - - - - - + + + - - - - - - + + + + - + - + - - - - - - - - - + - + - - - - - - - + + + + + - - - + + + - - - - - - + + - - - - + + + + - - - + + + - - - + + + - - - - - + + + - - - + + + + + - - - + + + + + - - - - + + + + - + + + - - - - - + - - - - - + + + - - - - + + + + - + - + - - - - - - - + + + + + - - - - + + + + - + - + + + + + - + + + - + - + - + - + - + - - - - - + - - - - - + - - - - - - - - - + - + - - - - - - - - - - - - + + + + + + - + + + + + + + + + + + - - - - - - - - - - - - + + + + - + - + - + - + + + + + - + + + + + - + + + + + - + + + + + - + - + - + - + + + + + - + - + - + + + + + + + + + - + - + + + + + - + - + - + - + + + + + - + - + + + + + - + + + + + - + - + + + + + + + + + + + + + - + - + + + + + + + + + - + - + - + - - - - - - - - - + - + - - - - - + - + - + - + - + - + - + - - - - - - - - - - - - - + - + - + - + + + - + - + - - - - - - - - - - - - - + - + - + - + - + - - - - - + - - - - - + - + - + - + - + + + + + + + - - - - - + + + - + + + + + + + + + + + + + - - - - + + + + - - - - + + + + - + - - - - - + - + - + - + - + - + - + - - - - + + + + + + + + + + + + - + - - - - - + + + + + - - - - - - - - - + - + - + - - - - - - + + + + + + + + + + + + - + + + + + - + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - + + + + - + + + + + - + + + + + - + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - - + + + + + + + + + + + + - - - - - - - - - + FAISS_API @@ -1262,9 +1262,9 @@ - + - + @@ -1401,13 +1401,13 @@ #elifdefined(__clang__) #ifdefined(__PPC__) #defineFAISS_PRAGMA_IMPRECISE_LOOP\ -_Pragma("clangloopvectorize_width(4)interleave_count(8)") +_Pragma("clangloopvectorize_width(4)interleave_count(8)") #defineFAISS_PRAGMA_IMPRECISE_FUNCTION_BEGIN\ -_Pragma("float_control(precise,off,push)") -#defineFAISS_PRAGMA_IMPRECISE_FUNCTION_END_Pragma("float_control(pop)") +_Pragma("float_control(precise,off,push)") +#defineFAISS_PRAGMA_IMPRECISE_FUNCTION_END_Pragma("float_control(pop)") #else #defineFAISS_PRAGMA_IMPRECISE_LOOP\ -_Pragma("clangloopvectorize(enable)interleave(enable)") +_Pragma("clangloopvectorize(enable)interleave(enable)") //clang-formatoff @@ -1417,8 +1417,8 @@ //TODO:findouthowtoenableFMAsonclang10andearlier. #ifdefined(__x86_64__)&&(defined(__clang_major__)&&(__clang_major__>10)) #defineFAISS_PRAGMA_IMPRECISE_FUNCTION_BEGIN\ -_Pragma("float_control(precise,off,push)") -#defineFAISS_PRAGMA_IMPRECISE_FUNCTION_END_Pragma("float_control(pop)") +_Pragma("float_control(precise,off,push)") +#defineFAISS_PRAGMA_IMPRECISE_FUNCTION_END_Pragma("float_control(pop)") #else #defineFAISS_PRAGMA_IMPRECISE_FUNCTION_BEGIN #defineFAISS_PRAGMA_IMPRECISE_FUNCTION_END @@ -1434,10 +1434,10 @@ #defineFAISS_PRAGMA_IMPRECISE_LOOP #defineFAISS_PRAGMA_IMPRECISE_FUNCTION_BEGIN\ -_Pragma("GCCpush_options")\ -_Pragma("GCCoptimize(\"unroll-loops,associative-math,no-signed-zeros\")") +_Pragma("GCCpush_options")\ +_Pragma("GCCoptimize(\"unroll-loops,associative-math,no-signed-zeros\")") #defineFAISS_PRAGMA_IMPRECISE_FUNCTION_END\ -_Pragma("GCCpop_options") +_Pragma("GCCpop_options") #else #defineFAISS_PRAGMA_IMPRECISE_LOOP #defineFAISS_PRAGMA_IMPRECISE_FUNCTION_BEGIN diff --git a/xml/pq4__fast__scan_8h.xml b/xml/pq4__fast__scan_8h.xml index 910e295a77..e795e9c60c 100644 --- a/xml/pq4__fast__scan_8h.xml +++ b/xml/pq4__fast__scan_8h.xml @@ -1,30 +1,30 @@ - + pq4_fast_scan.h cstdint cstdlib faiss/impl/CodePacker.h - - - - - - + + + + - - - - - + + + + + + + @@ -36,15 +36,15 @@ + + + + + + - - - - - - faiss::CodePackerPQ4 faiss diff --git a/xml/prefetch_8h.xml b/xml/prefetch_8h.xml index e22dddee5f..e9c9d5abc2 100644 --- a/xml/prefetch_8h.xml +++ b/xml/prefetch_8h.xml @@ -1,8 +1,8 @@ - + prefetch.h - + void void prefetch_L1 @@ -54,7 +54,7 @@ - + diff --git a/xml/python__callbacks_8h.xml b/xml/python__callbacks_8h.xml index 3db23bc8bd..96ffdcea31 100644 --- a/xml/python__callbacks_8h.xml +++ b/xml/python__callbacks_8h.xml @@ -1,5 +1,5 @@ - + python_callbacks.h faiss/impl/IDSelector.h @@ -7,30 +7,25 @@ faiss/invlists/InvertedLists.h Python.h - - - - + + + + - - - - - - - - + - + + + - - - - - + + + + + @@ -42,33 +37,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -81,25 +49,57 @@ - - - - + + + + - - - + + + + + - + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + PyCallbackIOWriter @@ -141,7 +141,7 @@ size_toperator()(constvoid*ptrv,size_tsize,size_tnitems)override; -~PyCallbackIOWriter()override; +~PyCallbackIOWriter()override; }; structPyCallbackIOReader:faiss::IOReader{ @@ -154,7 +154,7 @@ size_toperator()(void*ptrv,size_tsize,size_tnitems)override; -~PyCallbackIOReader()override; +~PyCallbackIOReader()override; }; /*********************************************************** @@ -168,7 +168,7 @@ boolis_member(faiss::idx_tid)constoverride; -~PyCallbackIDSelector()override; +~PyCallbackIDSelector()override; }; diff --git a/xml/quantize__lut_8h.xml b/xml/quantize__lut_8h.xml index 32a967f0fe..d69eac3b11 100644 --- a/xml/quantize__lut_8h.xml +++ b/xml/quantize__lut_8h.xml @@ -1,16 +1,10 @@ - + quantize_lut.h cstdint cstdio - - - - - - @@ -19,6 +13,12 @@ + + + + + + faiss faiss::quantize_lut diff --git a/xml/random_8h.xml b/xml/random_8h.xml index aeb83bdcbc..d685345c75 100644 --- a/xml/random_8h.xml +++ b/xml/random_8h.xml @@ -1,5 +1,5 @@ - + random.h stdint.h @@ -16,36 +16,14 @@ - - - - - - - - - - - - - - - - - - - - - - - - - + + + @@ -58,28 +36,50 @@ - - - + + + + + + + + + + + + + + + + + + + - - - - - - - + + + + + + + + + + + + + faiss::RandomGenerator faiss::SplitMix64RandomGenerator diff --git a/xml/residual__quantizer__encode__steps_8h.xml b/xml/residual__quantizer__encode__steps_8h.xml index 8abacb8e17..fae37952ff 100644 --- a/xml/residual__quantizer__encode__steps_8h.xml +++ b/xml/residual__quantizer__encode__steps_8h.xml @@ -1,5 +1,5 @@ - + residual_quantizer_encode_steps.h cstdint @@ -7,6 +7,26 @@ faiss/Index.h faiss/utils/approx_topk/mode.h + + + + + + + + + + + + + + + + + + + + @@ -15,9 +35,6 @@ - - - @@ -30,44 +47,27 @@ - - - - - + + - - - - - - - - - - - - - - - - + + - - - - - + + + + + faiss::rq_encode_steps::RefineBeamMemoryPool diff --git a/xml/simd__result__handlers_8h.xml b/xml/simd__result__handlers_8h.xml index 3023fa0067..d5fd51ffdb 100644 --- a/xml/simd__result__handlers_8h.xml +++ b/xml/simd__result__handlers_8h.xml @@ -1,5 +1,5 @@ - + simd_result_handlers.h algorithm @@ -14,6 +14,44 @@ faiss/utils/AlignedTable.h faiss/utils/partitioning.h + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -26,25 +64,34 @@ - - - - + + + + - + - + - + + + + + + + + + + + + + - + - - - @@ -53,39 +100,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -112,41 +126,22 @@ - - - - - - - - - - + + + + - + - + - - - - - + - + - - - - - - - - - @@ -179,11 +174,21 @@ - - + + + + + + + + + - - + + + + + @@ -197,70 +202,65 @@ + + + + + + - - + + - - - - - + + - - - - - + + - - + + - - + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + + - - + + - - - - - - - - - - - - - + + - - + + + + + faiss::SIMDResultHandler @@ -327,7 +327,7 @@ ///setthesub-matrixthatisbeingcomputed virtualvoidset_block_origin(size_ti0,size_tj0)=0; -virtual~SIMDResultHandler(){} +virtual~SIMDResultHandler(){} }; /*Resulthandlerthatwillreturnfloatresutlseventually*/ @@ -371,7 +371,7 @@ voidset_block_origin(size_t,size_t)final{} -~DummyResultHandler(){} +~DummyResultHandler(){} }; /**memorizeresultsinanq-by-nbmatrix. @@ -429,7 +429,7 @@ /**Resulthandlerthatcomparesdistancestocheckiftheyneedtobekept*/ template<classC,boolwith_id_map> structResultHandlerCompare:SIMDResultHandlerToFloat{ -usingTI=typenameC::TI; +usingTI=typenameC::TI; booldisable=false; @@ -484,7 +484,7 @@ simd16uint16thr16(thr); uint32_tlt_mask; -constexprboolkeep_min=C::is_max; +constexprboolkeep_min=C::is_max; if(keep_min){ lt_mask=~cmp_ge32(d0,d1,thr16); }else{ @@ -505,16 +505,16 @@ returnlt_mask; } -virtual~ResultHandlerCompare(){} +virtual~ResultHandlerCompare(){} }; /**Specialversionfork=1*/ template<classC,boolwith_id_map=false> structSingleResultHandler:ResultHandlerCompare<C,with_id_map>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingRHC=ResultHandlerCompare<C, with_id_map>; -usingRHC::normalizers; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingRHC=ResultHandlerCompare<C, with_id_map>; +usingRHC::normalizers; std::vector<int16_t>idis; float*dis; @@ -593,10 +593,10 @@ /**Structurethatcollectsresultsinamin-ormax-heap*/ template<classC,boolwith_id_map=false> structHeapHandler:ResultHandlerCompare<C,with_id_map>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingRHC=ResultHandlerCompare<C, with_id_map>; -usingRHC::normalizers; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingRHC=ResultHandlerCompare<C, with_id_map>; +usingRHC::normalizers; std::vector<uint16_t>idis; std::vector<TI>iids; @@ -702,10 +702,10 @@ /**HandlerbuiltfromseveralReservoirTopN(oneperquery)*/ template<classC,boolwith_id_map=false> structReservoirHandler:ResultHandlerCompare<C,with_id_map>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingRHC=ResultHandlerCompare<C, with_id_map>; -usingRHC::normalizers; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingRHC=ResultHandlerCompare<C, with_id_map>; +usingRHC::normalizers; size_tcapacity;//roundeduptomultipleof16 @@ -780,7 +780,7 @@ } voidend()override{ -usingCf=typenamestd::conditional< +usingCf=typenamestd::conditional< C::is_max, CMax<float, int64_t>, CMin<float, int64_t>>::type; @@ -825,11 +825,11 @@ template<classC,boolwith_id_map=false> structRangeHandler:ResultHandlerCompare<C,with_id_map>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingRHC=ResultHandlerCompare<C, with_id_map>; -usingRHC::normalizers; -usingRHC::nq; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingRHC=ResultHandlerCompare<C, with_id_map>; +usingRHC::normalizers; +usingRHC::nq; RangeSearchResult&rres; floatradius; @@ -931,11 +931,11 @@ //handlerforasubsetofqueries template<classC,boolwith_id_map=false> structPartialRangeHandler:RangeHandler<C,with_id_map>{ -usingT=typenameC::T; -usingTI=typenameC::TI; -usingRHC=RangeHandler<C, with_id_map>; -usingRHC::normalizers; -usingRHC::nq,RHC::q0,RHC::triplets,RHC::n_per_query; +usingT=typenameC::T; +usingTI=typenameC::TI; +usingRHC=RangeHandler<C, with_id_map>; +usingRHC::normalizers; +usingRHC::nq,RHC::q0,RHC::triplets,RHC::n_per_query; RangeSearchPartialResult&pres; @@ -978,7 +978,7 @@ for(intq=0;q<nq;q++){ floatone_a=1/normalizers[2*q]; floatb=normalizers[2*q+1]; -RangeQueryResult&qres=pres.new_result(q+q0); +RangeQueryResult&qres=pres.new_result(q+q0); for(size_ti=lims[q];i<lims[q+1];i++){ qres.add( sorted_triplets[i].dis*one_a+b, diff --git a/xml/simdlib_8h.xml b/xml/simdlib_8h.xml index 97b31a52e0..db6c946f69 100644 --- a/xml/simdlib_8h.xml +++ b/xml/simdlib_8h.xml @@ -1,5 +1,5 @@ - + simdlib.h faiss/utils/simdlib_emulated.h @@ -7,11 +7,11 @@ faiss/impl/simd_result_handlers.h faiss/utils/approx_topk_hamming/approx_topk_hamming.h - - - - - + + + + + @@ -25,18 +25,18 @@ - - - - - - + + + + + + diff --git a/xml/simdlib__avx2_8h.xml b/xml/simdlib__avx2_8h.xml index f42f261ceb..b0ac346d13 100644 --- a/xml/simdlib__avx2_8h.xml +++ b/xml/simdlib__avx2_8h.xml @@ -1,5 +1,5 @@ - + simdlib_avx2.h cstdint @@ -16,15 +16,6 @@ - - - - - - - - - @@ -37,9 +28,18 @@ + + + + + + + + + diff --git a/xml/simdlib__avx512_8h.xml b/xml/simdlib__avx512_8h.xml index 961b38570b..2e2507b9de 100644 --- a/xml/simdlib__avx512_8h.xml +++ b/xml/simdlib__avx512_8h.xml @@ -1,5 +1,5 @@ - + simdlib_avx512.h cstdint @@ -16,15 +16,6 @@ - - - - - - - - - @@ -37,9 +28,6 @@ - - - @@ -54,6 +42,18 @@ + + + + + + + + + + + + faiss::simd512bit faiss::simd32uint16 diff --git a/xml/simdlib__based_8h.xml b/xml/simdlib__based_8h.xml index 0a99bd07fd..d4af079cff 100644 --- a/xml/simdlib__based_8h.xml +++ b/xml/simdlib__based_8h.xml @@ -1,40 +1,17 @@ - + simdlib_based.h faiss/impl/ResultHandler.h faiss/impl/platform_macros.h faiss/utils/Heap.h - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - @@ -53,29 +30,16 @@ - - - - - - - - - - - - - - - - - - - + + + + - + - + + + @@ -88,24 +52,31 @@ - - - - + + + + - + - + + + + + + + + + - - - - - - - - + + + + + + + @@ -129,6 +100,16 @@ + + + + + + + + + + @@ -139,51 +120,70 @@ - - - - - - - - - - - - + + + + + + + - - + + - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/xml/simdlib__emulated_8h.xml b/xml/simdlib__emulated_8h.xml index 3ea3dab6d5..c5a90314b6 100644 --- a/xml/simdlib__emulated_8h.xml +++ b/xml/simdlib__emulated_8h.xml @@ -1,5 +1,5 @@ - + simdlib_emulated.h algorithm @@ -8,12 +8,6 @@ string faiss/utils/simdlib.h - - - - - - @@ -29,9 +23,15 @@ + + + + + + @@ -46,12 +46,6 @@ - - - - - - @@ -62,6 +56,12 @@ + + + + + + faiss::simd256bit faiss::simd16uint16 diff --git a/xml/simdlib__neon_8h.xml b/xml/simdlib__neon_8h.xml index 94b42b7d06..1ab0f83dea 100644 --- a/xml/simdlib__neon_8h.xml +++ b/xml/simdlib__neon_8h.xml @@ -1,5 +1,5 @@ - + simdlib_neon.h algorithm @@ -11,6 +11,20 @@ arm_neon.h faiss/impl/FaissAssert.h + + + + + + + + + + + + + + @@ -23,9 +37,6 @@ - - - @@ -34,15 +45,6 @@ - - - - - - - - - @@ -63,43 +65,41 @@ - - + + - - + + - - + + + + + + + + - - + + + + + + + + - - - - - + + - - - - - - - - - - - - - + + faiss::detail::simdlib::is_simd256bit @@ -229,8 +229,8 @@ template< typenameT, -typenameU=decltype(reinterpret_u8(std::declval<T>().data))> -structis_simd256bit:std::is_same<U,uint8x16x2_t>{}; +typenameU=decltype(reinterpret_u8(std::declval<T>().data))> +structis_simd256bit:std::is_same<U,uint8x16x2_t>{}; staticinlinevoidbin(constchar(&bytes)[32],charbits[257]){ for(inti=0;i<256;++i){ @@ -241,8 +241,8 @@ template<typenameT,size_tN,typenameS> staticinlinevoidbin(constS&simd,charbits[257]){ -static_assert( -std::is_same<void(S::*)(T*)const,decltype(&S::store)>::value, +static_assert( +std::is_same<void(S::*)(T*)const,decltype(&S::store)>::value, "invalidT"); Tds[N]; simd.store(ds); @@ -259,7 +259,7 @@ } template<typenameT> -usingremove_cv_ref_t= +usingremove_cv_ref_t= typenamestd::remove_reference<typenamestd::remove_cv<T>::type>::type; template<typenameD,typenameT> @@ -281,8 +281,8 @@ template<typenameT,size_tN,typenameS> staticinlinestd::stringelements_to_string(constchar*fmt,constS&simd){ -static_assert( -std::is_same<void(S::*)(T*)const,decltype(&S::store)>::value, +static_assert( +std::is_same<void(S::*)(T*)const,decltype(&S::store)>::value, "invalidT"); Tbytes[N]; simd.store(bytes); @@ -301,8 +301,8 @@ template<typenameT,typenameU> structunary_func_impl{ constU&a; -usingTelem=remove_cv_ref_t<decltype(std::declval<T>().val[0])>; -usingUelem=remove_cv_ref_t<decltype(std::declval<U>().val[0])>; +usingTelem=remove_cv_ref_t<decltype(std::declval<T>().val[0])>; +usingUelem=remove_cv_ref_t<decltype(std::declval<U>().val[0])>; template<Telem(*F)(Uelem)> inlineTcall(){ Tt; @@ -328,8 +328,8 @@ structbinary_func_impl{ constU&a; constU&b; -usingTelem=remove_cv_ref_t<decltype(std::declval<T>().val[0])>; -usingUelem=remove_cv_ref_t<decltype(std::declval<U>().val[0])>; +usingTelem=remove_cv_ref_t<decltype(std::declval<T>().val[0])>; +usingUelem=remove_cv_ref_t<decltype(std::declval<U>().val[0])>; template<Telem(*F)(Uelem,Uelem)> inlineTcall(){ Tt; @@ -884,7 +884,7 @@ uint8_t_30, uint8_t_31> staticsimd32uint8create(){ -constexpruint8_tds[32]={_0,_1,_2,_3,_4,_5,_6,_7, +constexpruint8_tds[32]={_0,_1,_2,_3,_4,_5,_6,_7, _8,_9,_10,_11,_12,_13,_14,_15, _16,_17,_18,_19,_20,_21,_22,_23, _24,_25,_26,_27,_28,_29,_30,_31}; @@ -1009,7 +1009,7 @@ ///getmostsignificantbitofeachbyte inlineuint32_tget_MSBs(constsimd32uint8&a){ -usingdetail::simdlib::vmovmask_u8; +usingdetail::simdlib::vmovmask_u8; returnvmovmask_u8(a.data.val[0])| static_cast<uint32_t>(vmovmask_u8(a.data.val[1]))<<16u; } diff --git a/xml/simdlib__ppc64_8h.xml b/xml/simdlib__ppc64_8h.xml index 3c6c183e33..a4a052409e 100644 --- a/xml/simdlib__ppc64_8h.xml +++ b/xml/simdlib__ppc64_8h.xml @@ -1,5 +1,5 @@ - + simdlib_ppc64.h algorithm @@ -7,9 +7,6 @@ cstring string - - - @@ -22,15 +19,18 @@ - - - + + + + + + faiss::simd256bit faiss::simd16uint16 diff --git a/xml/sorting_8h.xml b/xml/sorting_8h.xml index f9905ff559..64b19c57dc 100644 --- a/xml/sorting_8h.xml +++ b/xml/sorting_8h.xml @@ -1,5 +1,5 @@ - + sorting.h faiss/impl/platform_macros.h @@ -12,18 +12,18 @@ - - - - - - + + + + + + faiss diff --git a/xml/structPyCallbackIDSelector.xml b/xml/structPyCallbackIDSelector.xml index bbbf872ec0..0b07fe7a16 100644 --- a/xml/structPyCallbackIDSelector.xml +++ b/xml/structPyCallbackIDSelector.xml @@ -1,14 +1,15 @@ - + PyCallbackIDSelector faiss::IDSelector - + PyObject * PyObject* PyCallbackIDSelector::callback callback + PyCallbackIDSelector::callback @@ -17,13 +18,14 @@ - - + + PyCallbackIDSelector::PyCallbackIDSelector (PyObject *callback) PyCallbackIDSelector + PyCallbackIDSelector::PyCallbackIDSelector PyObject * callback @@ -41,6 +43,7 @@ bool PyCallbackIDSelector::is_member (faiss::idx_t id) const override is_member + PyCallbackIDSelector::is_member is_member faiss::idx_t @@ -59,6 +62,7 @@ PyCallbackIDSelector::~PyCallbackIDSelector () override ~PyCallbackIDSelector + PyCallbackIDSelector::~PyCallbackIDSelector @@ -67,7 +71,7 @@ - + diff --git a/xml/structPyCallbackIOReader.xml b/xml/structPyCallbackIOReader.xml index 3e0753484a..971ccb58c3 100644 --- a/xml/structPyCallbackIOReader.xml +++ b/xml/structPyCallbackIOReader.xml @@ -1,14 +1,15 @@ - + PyCallbackIOReader faiss::IOReader - + PyObject * PyObject* PyCallbackIOReader::callback callback + PyCallbackIOReader::callback @@ -22,6 +23,7 @@ size_t PyCallbackIOReader::bs bs + PyCallbackIOReader::bs @@ -35,6 +37,7 @@ std::string faiss::IOReader::name name + faiss::IOReader::name @@ -43,13 +46,14 @@ - - + + PyCallbackIOReader::PyCallbackIOReader (PyObject *callback, size_t bs=1024 *1024) PyCallbackIOReader + PyCallbackIOReader::PyCallbackIOReader PyObject * callback @@ -73,6 +77,7 @@ size_t PyCallbackIOReader::operator() (void *ptrv, size_t size, size_t nitems) override operator() + PyCallbackIOReader::operator() operator() void * @@ -99,6 +104,7 @@ PyCallbackIOReader::~PyCallbackIOReader () override ~PyCallbackIOReader + PyCallbackIOReader::~PyCallbackIOReader @@ -112,6 +118,7 @@ virtual int faiss::IOReader::filedescriptor () filedescriptor + faiss::IOReader::filedescriptor filedescriptor @@ -121,7 +128,7 @@ - + diff --git a/xml/structPyCallbackIOWriter.xml b/xml/structPyCallbackIOWriter.xml index 4aee2da465..faa8e64da8 100644 --- a/xml/structPyCallbackIOWriter.xml +++ b/xml/structPyCallbackIOWriter.xml @@ -1,14 +1,15 @@ - + PyCallbackIOWriter faiss::IOWriter - + PyObject * PyObject* PyCallbackIOWriter::callback callback + PyCallbackIOWriter::callback @@ -22,6 +23,7 @@ size_t PyCallbackIOWriter::bs bs + PyCallbackIOWriter::bs @@ -35,6 +37,7 @@ std::string faiss::IOWriter::name name + faiss::IOWriter::name @@ -43,13 +46,14 @@ - - + + PyCallbackIOWriter::PyCallbackIOWriter (PyObject *callback, size_t bs=1024 *1024) PyCallbackIOWriter + PyCallbackIOWriter::PyCallbackIOWriter PyObject * callback @@ -73,6 +77,7 @@ size_t PyCallbackIOWriter::operator() (const void *ptrv, size_t size, size_t nitems) override operator() + PyCallbackIOWriter::operator() operator() const void * @@ -99,6 +104,7 @@ PyCallbackIOWriter::~PyCallbackIOWriter () override ~PyCallbackIOWriter + PyCallbackIOWriter::~PyCallbackIOWriter @@ -112,6 +118,7 @@ virtual int faiss::IOWriter::filedescriptor () filedescriptor + faiss::IOWriter::filedescriptor filedescriptor @@ -121,7 +128,7 @@ - + diff --git a/xml/structfaiss_1_1AdditiveCoarseQuantizer.xml b/xml/structfaiss_1_1AdditiveCoarseQuantizer.xml index e1c5bf3e38..52c8be12eb 100644 --- a/xml/structfaiss_1_1AdditiveCoarseQuantizer.xml +++ b/xml/structfaiss_1_1AdditiveCoarseQuantizer.xml @@ -1,17 +1,18 @@ - + faiss::AdditiveCoarseQuantizer faiss::Index faiss::LocalSearchCoarseQuantizer faiss::ResidualCoarseQuantizer IndexAdditiveQuantizer.h - + AdditiveQuantizer * AdditiveQuantizer* faiss::AdditiveCoarseQuantizer::aq aq + faiss::AdditiveCoarseQuantizer::aq @@ -25,6 +26,7 @@ std::vector<float> faiss::AdditiveCoarseQuantizer::centroid_norms centroid_norms + faiss::AdditiveCoarseQuantizer::centroid_norms norms of centroids, useful for knn-search @@ -39,6 +41,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -53,6 +56,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -67,6 +71,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -81,6 +86,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -95,6 +101,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -109,6 +116,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -118,13 +126,14 @@ - - + + faiss::AdditiveCoarseQuantizer::AdditiveCoarseQuantizer (idx_t d=0, AdditiveQuantizer *aq=nullptr, MetricType metric=METRIC_L2) AdditiveCoarseQuantizer + faiss::AdditiveCoarseQuantizer::AdditiveCoarseQuantizer idx_t d @@ -153,6 +162,7 @@ void faiss::AdditiveCoarseQuantizer::add (idx_t n, const float *x) override add + faiss::AdditiveCoarseQuantizer::add add idx_t @@ -176,6 +186,7 @@ void faiss::AdditiveCoarseQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::AdditiveCoarseQuantizer::search search search @@ -260,6 +271,7 @@ void faiss::AdditiveCoarseQuantizer::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::AdditiveCoarseQuantizer::reconstruct reconstruct idx_t @@ -301,6 +313,7 @@ void faiss::AdditiveCoarseQuantizer::train (idx_t n, const float *x) override train + faiss::AdditiveCoarseQuantizer::train train idx_t @@ -342,6 +355,7 @@ void faiss::AdditiveCoarseQuantizer::reset () override reset + faiss::AdditiveCoarseQuantizer::reset reset N/A. @@ -357,6 +371,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -416,6 +431,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -494,6 +510,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -560,6 +577,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -584,6 +602,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -637,6 +656,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -694,6 +714,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -791,6 +812,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -846,6 +868,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -908,15 +931,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -932,6 +956,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -953,8 +979,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1018,14 +1046,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1090,6 +1118,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1118,6 +1147,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1140,6 +1170,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1181,13 +1212,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1201,6 +1233,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1209,7 +1242,7 @@ - + @@ -1217,30 +1250,52 @@ Intended for use as a coarse quantizer in an IndexIVF. - - - - + + + + + + + + - - - + + + + + + + + + aq + + + + + + + + + qnorm + + + + + - - @@ -1253,44 +1308,22 @@ + + + + + + - - - - - - - - - - - qnorm - - - - - - - - - - - - - - - aq - - @@ -1307,7 +1340,7 @@ faiss::AdditiveCoarseQuantizercompute_residual_n faiss::AdditiveCoarseQuantizerd faiss::AdditiveCoarseQuantizerdistance_t - faiss::AdditiveCoarseQuantizerget_distance_computer + faiss::AdditiveCoarseQuantizerget_distance_computer faiss::AdditiveCoarseQuantizerIndex faiss::AdditiveCoarseQuantizeris_trained faiss::AdditiveCoarseQuantizermerge_from diff --git a/xml/structfaiss_1_1AdditiveQuantizer.xml b/xml/structfaiss_1_1AdditiveQuantizer.xml index c407a69fda..159d2796b6 100644 --- a/xml/structfaiss_1_1AdditiveQuantizer.xml +++ b/xml/structfaiss_1_1AdditiveQuantizer.xml @@ -1,5 +1,5 @@ - + faiss::AdditiveQuantizer faiss::Quantizer @@ -7,10 +7,11 @@ faiss::ProductAdditiveQuantizer faiss::ResidualQuantizer AdditiveQuantizer.h - + Search_type_t + faiss::AdditiveQuantizer::Search_type_t ST_decompress @@ -98,13 +99,14 @@ - - + + size_t size_t faiss::AdditiveQuantizer::M M + faiss::AdditiveQuantizer::M number of codebooks @@ -119,6 +121,7 @@ std::vector<size_t> faiss::AdditiveQuantizer::nbits nbits + faiss::AdditiveQuantizer::nbits bits for each step @@ -133,6 +136,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebooks codebooks + faiss::AdditiveQuantizer::codebooks codebooks @@ -147,6 +151,7 @@ std::vector<uint64_t> faiss::AdditiveQuantizer::codebook_offsets codebook_offsets + faiss::AdditiveQuantizer::codebook_offsets @@ -161,6 +166,7 @@ size_t faiss::AdditiveQuantizer::tot_bits tot_bits + faiss::AdditiveQuantizer::tot_bits = 0 total number of bits (indexes + norms) @@ -176,6 +182,7 @@ size_t faiss::AdditiveQuantizer::norm_bits norm_bits + faiss::AdditiveQuantizer::norm_bits = 0 bits allocated for the norms @@ -191,6 +198,7 @@ size_t faiss::AdditiveQuantizer::total_codebook_size total_codebook_size + faiss::AdditiveQuantizer::total_codebook_size = 0 size of the codebook in vectors @@ -206,6 +214,7 @@ bool faiss::AdditiveQuantizer::only_8bit only_8bit + faiss::AdditiveQuantizer::only_8bit = false are all nbits = 8 (use faster decoder) @@ -221,6 +230,7 @@ bool faiss::AdditiveQuantizer::verbose verbose + faiss::AdditiveQuantizer::verbose = false verbose during training? @@ -236,6 +246,7 @@ bool faiss::AdditiveQuantizer::is_trained is_trained + faiss::AdditiveQuantizer::is_trained = false is trained or not @@ -251,6 +262,7 @@ std::vector<float> faiss::AdditiveQuantizer::norm_tabs norm_tabs + faiss::AdditiveQuantizer::norm_tabs @@ -265,6 +277,7 @@ IndexFlat1D faiss::AdditiveQuantizer::qnorm qnorm + faiss::AdditiveQuantizer::qnorm store and search norms @@ -279,6 +292,7 @@ std::vector<float> faiss::AdditiveQuantizer::centroid_norms centroid_norms + faiss::AdditiveQuantizer::centroid_norms norms of all codebook entries (size total_codebook_size) @@ -293,6 +307,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebook_cross_products codebook_cross_products + faiss::AdditiveQuantizer::codebook_cross_products @@ -307,6 +322,7 @@ size_t faiss::AdditiveQuantizer::max_mem_distances max_mem_distances + faiss::AdditiveQuantizer::max_mem_distances = 5 * (size_t(1) << 30) @@ -322,6 +338,7 @@ Search_type_t faiss::AdditiveQuantizer::search_type search_type + faiss::AdditiveQuantizer::search_type Also determines what's in the codes. @@ -336,6 +353,7 @@ float faiss::AdditiveQuantizer::norm_min norm_min + faiss::AdditiveQuantizer::norm_min = NAN min/max for quantization of norms @@ -351,6 +369,7 @@ float faiss::AdditiveQuantizer::norm_max norm_max + faiss::AdditiveQuantizer::norm_max = NAN @@ -365,6 +384,7 @@ size_t faiss::Quantizer::d d + faiss::Quantizer::d size of the input vectors @@ -379,6 +399,7 @@ size_t faiss::Quantizer::code_size code_size + faiss::Quantizer::code_size bytes per indexed vector @@ -388,13 +409,14 @@ - - + + void void faiss::AdditiveQuantizer::compute_codebook_tables () compute_codebook_tables + faiss::AdditiveQuantizer::compute_codebook_tables @@ -408,6 +430,7 @@ uint64_t faiss::AdditiveQuantizer::encode_norm (float norm) const encode_norm + faiss::AdditiveQuantizer::encode_norm float norm @@ -426,6 +449,7 @@ uint32_t faiss::AdditiveQuantizer::encode_qcint (float x) const encode_qcint + faiss::AdditiveQuantizer::encode_qcint float x @@ -444,6 +468,7 @@ float faiss::AdditiveQuantizer::decode_qcint (uint32_t c) const decode_qcint + faiss::AdditiveQuantizer::decode_qcint uint32_t c @@ -462,6 +487,7 @@ faiss::AdditiveQuantizer::AdditiveQuantizer (size_t d, const std::vector< size_t > &nbits, Search_type_t search_type=ST_decompress) AdditiveQuantizer + faiss::AdditiveQuantizer::AdditiveQuantizer size_t d @@ -488,6 +514,7 @@ faiss::AdditiveQuantizer::AdditiveQuantizer () AdditiveQuantizer + faiss::AdditiveQuantizer::AdditiveQuantizer compute derived values when d, M and nbits have been set @@ -502,6 +529,7 @@ void faiss::AdditiveQuantizer::set_derived_values () set_derived_values + faiss::AdditiveQuantizer::set_derived_values Train the norm quantizer. @@ -516,6 +544,7 @@ void faiss::AdditiveQuantizer::train_norm (size_t n, const float *norms) train_norm + faiss::AdditiveQuantizer::train_norm size_t n @@ -537,6 +566,7 @@ void faiss::AdditiveQuantizer::compute_codes (const float *x, uint8_t *codes, size_t n) const override compute_codes + faiss::AdditiveQuantizer::compute_codes compute_codes const float * @@ -582,6 +612,7 @@ virtual void faiss::AdditiveQuantizer::compute_codes_add_centroids (const float *x, uint8_t *codes, size_t n, const float *centroids=nullptr) const =0 compute_codes_add_centroids + faiss::AdditiveQuantizer::compute_codes_add_centroids compute_codes_add_centroids compute_codes_add_centroids compute_codes_add_centroids @@ -642,6 +673,7 @@ void faiss::AdditiveQuantizer::pack_codes (size_t n, const int32_t *codes, uint8_t *packed_codes, int64_t ld_codes=-1, const float *norms=nullptr, const float *centroids=nullptr) const pack_codes + faiss::AdditiveQuantizer::pack_codes size_t n @@ -725,6 +757,7 @@ void faiss::AdditiveQuantizer::decode (const uint8_t *codes, float *x, size_t n) const override decode + faiss::AdditiveQuantizer::decode decode decode @@ -771,6 +804,7 @@ virtual void faiss::AdditiveQuantizer::decode_unpacked (const int32_t *codes, float *x, size_t n, int64_t ld_codes=-1) const decode_unpacked + faiss::AdditiveQuantizer::decode_unpacked decode_unpacked const int32_t * @@ -833,6 +867,7 @@ float faiss::AdditiveQuantizer::compute_1_distance_LUT (const uint8_t *codes, const float *LUT) const compute_1_distance_LUT + faiss::AdditiveQuantizer::compute_1_distance_LUT const uint8_t * codes @@ -854,6 +889,7 @@ void faiss::AdditiveQuantizer::decode_64bit (idx_t n, float *x) const decode_64bit + faiss::AdditiveQuantizer::decode_64bit idx_t n @@ -876,6 +912,7 @@ virtual void faiss::AdditiveQuantizer::compute_LUT (size_t n, const float *xq, float *LUT, float alpha=1.0f, long ld_lut=-1) const compute_LUT + faiss::AdditiveQuantizer::compute_LUT compute_LUT size_t @@ -947,6 +984,7 @@ void faiss::AdditiveQuantizer::knn_centroids_inner_product (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels) const knn_centroids_inner_product + faiss::AdditiveQuantizer::knn_centroids_inner_product idx_t n @@ -981,6 +1019,7 @@ void faiss::AdditiveQuantizer::compute_centroid_norms (float *norms) const compute_centroid_norms + faiss::AdditiveQuantizer::compute_centroid_norms float * norms @@ -1009,6 +1048,7 @@ void faiss::AdditiveQuantizer::knn_centroids_L2 (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels, const float *centroid_norms) const knn_centroids_L2 + faiss::AdditiveQuantizer::knn_centroids_L2 idx_t n @@ -1047,6 +1087,7 @@ virtual faiss::AdditiveQuantizer::~AdditiveQuantizer () ~AdditiveQuantizer + faiss::AdditiveQuantizer::~AdditiveQuantizer @@ -1060,6 +1101,7 @@ virtual void faiss::Quantizer::train (size_t n, const float *x)=0 train + faiss::Quantizer::train train train train @@ -1092,7 +1134,7 @@ - + @@ -1100,9 +1142,15 @@ Different from the product quantizer in which the decoded vector is the concatenation of M sub-vectors, additive quantizers sum M sub-vectors to get the decoded vector. - - - + + + + + + + + + @@ -1112,24 +1160,12 @@ - - - - - - - - - - - - @@ -1140,8 +1176,27 @@ + + + + + + + + + + + + + qnorm + + + + + + @@ -1154,35 +1209,22 @@ + + + + + + - - - - - - - - - - - qnorm - - - - - - - - diff --git a/xml/structfaiss_1_1AlignedTable.xml b/xml/structfaiss_1_1AlignedTable.xml index abaf3a99b3..cffc2d1f1f 100644 --- a/xml/structfaiss_1_1AlignedTable.xml +++ b/xml/structfaiss_1_1AlignedTable.xml @@ -1,5 +1,5 @@ - + faiss::AlignedTable @@ -13,12 +13,13 @@ 32 - + AlignedTableTightAlloc< T, A > AlignedTableTightAlloc<T, A> faiss::AlignedTable< T, A >::tab tab + faiss::AlignedTable::tab @@ -32,6 +33,7 @@ size_t faiss::AlignedTable< T, A >::numel numel + faiss::AlignedTable::numel = 0 @@ -41,13 +43,14 @@ - - + + size_t static size_t faiss::AlignedTable< T, A >::round_capacity (size_t n) round_capacity + faiss::AlignedTable::round_capacity size_t n @@ -60,13 +63,14 @@ - - + + faiss::AlignedTable< T, A >::AlignedTable () AlignedTable + faiss::AlignedTable::AlignedTable @@ -80,6 +84,7 @@ faiss::AlignedTable< T, A >::AlignedTable (size_t n) AlignedTable + faiss::AlignedTable::AlignedTable size_t n @@ -97,6 +102,7 @@ size_t faiss::AlignedTable< T, A >::itemsize () const itemsize + faiss::AlignedTable::itemsize @@ -110,6 +116,7 @@ void faiss::AlignedTable< T, A >::resize (size_t n) resize + faiss::AlignedTable::resize size_t n @@ -127,6 +134,7 @@ void faiss::AlignedTable< T, A >::clear () clear + faiss::AlignedTable::clear @@ -140,6 +148,7 @@ size_t faiss::AlignedTable< T, A >::size () const size + faiss::AlignedTable::size @@ -153,6 +162,7 @@ size_t faiss::AlignedTable< T, A >::nbytes () const nbytes + faiss::AlignedTable::nbytes @@ -161,11 +171,12 @@ - + T * - T* faiss::AlignedTable< T, A >::get + T * faiss::AlignedTable< T, A >::get () get + faiss::AlignedTable::get @@ -174,11 +185,12 @@ - + const T * - const T* faiss::AlignedTable< T, A >::get + const T * faiss::AlignedTable< T, A >::get () const get + faiss::AlignedTable::get @@ -187,11 +199,12 @@ - + T * - T* faiss::AlignedTable< T, A >::data + T * faiss::AlignedTable< T, A >::data () data + faiss::AlignedTable::data @@ -200,11 +213,12 @@ - + const T * - const T* faiss::AlignedTable< T, A >::data + const T * faiss::AlignedTable< T, A >::data () const data + faiss::AlignedTable::data @@ -213,11 +227,12 @@ - + T & - T& faiss::AlignedTable< T, A >::operator[] + T & faiss::AlignedTable< T, A >::operator[] (size_t i) operator[] + faiss::AlignedTable::operator[] size_t i @@ -235,6 +250,7 @@ T faiss::AlignedTable< T, A >::operator[] (size_t i) const operator[] + faiss::AlignedTable::operator[] size_t i @@ -247,7 +263,7 @@ - + @@ -270,14 +286,14 @@ faiss::AlignedTableAlignedTable faiss::AlignedTableAlignedTable faiss::AlignedTableclear - faiss::AlignedTabledata - faiss::AlignedTabledata - faiss::AlignedTableget - faiss::AlignedTableget + faiss::AlignedTabledata + faiss::AlignedTabledata + faiss::AlignedTableget + faiss::AlignedTableget faiss::AlignedTableitemsize faiss::AlignedTablenbytes faiss::AlignedTablenumel - faiss::AlignedTableoperator[] + faiss::AlignedTableoperator[] faiss::AlignedTableoperator[] faiss::AlignedTableresize faiss::AlignedTableround_capacity diff --git a/xml/structfaiss_1_1AlignedTableTightAlloc.xml b/xml/structfaiss_1_1AlignedTableTightAlloc.xml index 1d045e6160..b97f762b38 100644 --- a/xml/structfaiss_1_1AlignedTableTightAlloc.xml +++ b/xml/structfaiss_1_1AlignedTableTightAlloc.xml @@ -1,5 +1,5 @@ - + faiss::AlignedTableTightAlloc @@ -13,12 +13,13 @@ 32 - + T * T* faiss::AlignedTableTightAlloc< T, A >::ptr ptr + faiss::AlignedTableTightAlloc::ptr @@ -32,6 +33,7 @@ size_t faiss::AlignedTableTightAlloc< T, A >::numel numel + faiss::AlignedTableTightAlloc::numel @@ -40,13 +42,14 @@ - - + + faiss::AlignedTableTightAlloc< T, A >::AlignedTableTightAlloc () AlignedTableTightAlloc + faiss::AlignedTableTightAlloc::AlignedTableTightAlloc @@ -60,6 +63,7 @@ faiss::AlignedTableTightAlloc< T, A >::AlignedTableTightAlloc (size_t n) AlignedTableTightAlloc + faiss::AlignedTableTightAlloc::AlignedTableTightAlloc size_t n @@ -77,6 +81,7 @@ size_t faiss::AlignedTableTightAlloc< T, A >::itemsize () const itemsize + faiss::AlignedTableTightAlloc::itemsize @@ -90,6 +95,7 @@ void faiss::AlignedTableTightAlloc< T, A >::resize (size_t n) resize + faiss::AlignedTableTightAlloc::resize size_t n @@ -107,6 +113,7 @@ void faiss::AlignedTableTightAlloc< T, A >::clear () clear + faiss::AlignedTableTightAlloc::clear @@ -120,6 +127,7 @@ size_t faiss::AlignedTableTightAlloc< T, A >::size () const size + faiss::AlignedTableTightAlloc::size @@ -133,6 +141,7 @@ size_t faiss::AlignedTableTightAlloc< T, A >::nbytes () const nbytes + faiss::AlignedTableTightAlloc::nbytes @@ -141,11 +150,12 @@ - + T * - T* faiss::AlignedTableTightAlloc< T, A >::get + T * faiss::AlignedTableTightAlloc< T, A >::get () get + faiss::AlignedTableTightAlloc::get @@ -154,11 +164,12 @@ - + const T * - const T* faiss::AlignedTableTightAlloc< T, A >::get + const T * faiss::AlignedTableTightAlloc< T, A >::get () const get + faiss::AlignedTableTightAlloc::get @@ -167,11 +178,12 @@ - + T * - T* faiss::AlignedTableTightAlloc< T, A >::data + T * faiss::AlignedTableTightAlloc< T, A >::data () data + faiss::AlignedTableTightAlloc::data @@ -180,11 +192,12 @@ - + const T * - const T* faiss::AlignedTableTightAlloc< T, A >::data + const T * faiss::AlignedTableTightAlloc< T, A >::data () const data + faiss::AlignedTableTightAlloc::data @@ -193,11 +206,12 @@ - + T & - T& faiss::AlignedTableTightAlloc< T, A >::operator[] + T & faiss::AlignedTableTightAlloc< T, A >::operator[] (size_t i) operator[] + faiss::AlignedTableTightAlloc::operator[] size_t i @@ -215,6 +229,7 @@ T faiss::AlignedTableTightAlloc< T, A >::operator[] (size_t i) const operator[] + faiss::AlignedTableTightAlloc::operator[] size_t i @@ -232,6 +247,7 @@ faiss::AlignedTableTightAlloc< T, A >::~AlignedTableTightAlloc () ~AlignedTableTightAlloc + faiss::AlignedTableTightAlloc::~AlignedTableTightAlloc @@ -240,11 +256,12 @@ - + AlignedTableTightAlloc< T, A > & - AlignedTableTightAlloc<T, A>& faiss::AlignedTableTightAlloc< T, A >::operator= + AlignedTableTightAlloc< T, A > & faiss::AlignedTableTightAlloc< T, A >::operator= (const AlignedTableTightAlloc< T, A > &other) operator= + faiss::AlignedTableTightAlloc::operator= const AlignedTableTightAlloc< T, A > & other @@ -262,6 +279,7 @@ faiss::AlignedTableTightAlloc< T, A >::AlignedTableTightAlloc (const AlignedTableTightAlloc< T, A > &other) AlignedTableTightAlloc + faiss::AlignedTableTightAlloc::AlignedTableTightAlloc const AlignedTableTightAlloc< T, A > & other @@ -274,7 +292,7 @@ - + @@ -285,15 +303,15 @@ faiss::AlignedTableTightAllocAlignedTableTightAlloc faiss::AlignedTableTightAllocAlignedTableTightAlloc faiss::AlignedTableTightAllocclear - faiss::AlignedTableTightAllocdata - faiss::AlignedTableTightAllocdata - faiss::AlignedTableTightAllocget - faiss::AlignedTableTightAllocget + faiss::AlignedTableTightAllocdata + faiss::AlignedTableTightAllocdata + faiss::AlignedTableTightAllocget + faiss::AlignedTableTightAllocget faiss::AlignedTableTightAllocitemsize faiss::AlignedTableTightAllocnbytes faiss::AlignedTableTightAllocnumel - faiss::AlignedTableTightAllocoperator= - faiss::AlignedTableTightAllocoperator[] + faiss::AlignedTableTightAllocoperator= + faiss::AlignedTableTightAllocoperator[] faiss::AlignedTableTightAllocoperator[] faiss::AlignedTableTightAllocptr faiss::AlignedTableTightAllocresize diff --git a/xml/structfaiss_1_1ArrayInvertedLists.xml b/xml/structfaiss_1_1ArrayInvertedLists.xml index 80a327c6ea..e8906f7097 100644 --- a/xml/structfaiss_1_1ArrayInvertedLists.xml +++ b/xml/structfaiss_1_1ArrayInvertedLists.xml @@ -1,15 +1,16 @@ - + faiss::ArrayInvertedLists faiss::InvertedLists InvertedLists.h - + std::vector< std::vector< uint8_t > > std::vector<std::vector<uint8_t> > faiss::ArrayInvertedLists::codes codes + faiss::ArrayInvertedLists::codes @@ -23,6 +24,7 @@ std::vector<std::vector<idx_t> > faiss::ArrayInvertedLists::ids ids + faiss::ArrayInvertedLists::ids Inverted lists for indexes. @@ -37,6 +39,7 @@ size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -51,6 +54,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -65,6 +69,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -75,13 +80,14 @@ - - + + faiss::ArrayInvertedLists::ArrayInvertedLists (size_t nlist, size_t code_size) ArrayInvertedLists + faiss::ArrayInvertedLists::ArrayInvertedLists size_t nlist @@ -103,6 +109,7 @@ size_t faiss::ArrayInvertedLists::list_size (size_t list_no) const override list_size + faiss::ArrayInvertedLists::list_size list_size size_t @@ -117,12 +124,13 @@ - + const uint8_t * - const uint8_t* faiss::ArrayInvertedLists::get_codes + const uint8_t * faiss::ArrayInvertedLists::get_codes (size_t list_no) const override get_codes - get_codes + faiss::ArrayInvertedLists::get_codes + get_codes size_t list_no @@ -139,12 +147,13 @@ - + const idx_t * - const idx_t* faiss::ArrayInvertedLists::get_ids + const idx_t * faiss::ArrayInvertedLists::get_ids (size_t list_no) const override get_ids - get_ids + faiss::ArrayInvertedLists::get_ids + get_ids size_t list_no @@ -166,6 +175,7 @@ size_t faiss::ArrayInvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override add_entries + faiss::ArrayInvertedLists::add_entries add_entries size_t @@ -196,6 +206,7 @@ void faiss::ArrayInvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override update_entries + faiss::ArrayInvertedLists::update_entries update_entries size_t @@ -230,6 +241,7 @@ void faiss::ArrayInvertedLists::resize (size_t list_no, size_t new_size) override resize + faiss::ArrayInvertedLists::resize resize size_t @@ -252,6 +264,7 @@ void faiss::ArrayInvertedLists::permute_invlists (const idx_t *map) permute_invlists + faiss::ArrayInvertedLists::permute_invlists const idx_t * map @@ -270,6 +283,7 @@ bool faiss::ArrayInvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const override is_empty + faiss::ArrayInvertedLists::is_empty is_empty size_t @@ -294,6 +308,7 @@ faiss::ArrayInvertedLists::~ArrayInvertedLists () override ~ArrayInvertedLists + faiss::ArrayInvertedLists::~ArrayInvertedLists @@ -307,6 +322,7 @@ virtual void faiss::InvertedLists::release_codes (size_t list_no, const uint8_t *codes) const release_codes + faiss::InvertedLists::release_codes release_codes release_codes release_codes @@ -334,6 +350,7 @@ virtual void faiss::InvertedLists::release_ids (size_t list_no, const idx_t *ids) const release_ids + faiss::InvertedLists::release_ids release_ids release_ids release_ids @@ -361,6 +378,7 @@ virtual idx_t faiss::InvertedLists::get_single_id (size_t list_no, size_t offset) const get_single_id + faiss::InvertedLists::get_single_id get_single_id get_single_id get_single_id @@ -385,16 +403,17 @@ - + const uint8_t * - virtual const uint8_t* faiss::InvertedLists::get_single_code + virtual const uint8_t * faiss::InvertedLists::get_single_code (size_t list_no, size_t offset) const get_single_code - get_single_code - get_single_code - get_single_code - get_single_code - get_single_code + faiss::InvertedLists::get_single_code + get_single_code + get_single_code + get_single_code + get_single_code + get_single_code size_t list_no @@ -419,6 +438,7 @@ virtual void faiss::InvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const prefetch_lists + faiss::InvertedLists::prefetch_lists prefetch_lists prefetch_lists prefetch_lists @@ -442,11 +462,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -470,6 +491,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -501,6 +523,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -530,6 +553,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -543,6 +567,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -565,6 +590,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -597,6 +623,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -611,6 +638,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -625,6 +653,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -634,11 +663,12 @@ - - + + int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -689,13 +719,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -706,35 +737,35 @@ - + simple (default) implementation as an array of inverted lists - - - - - - + + + + + + @@ -745,10 +776,10 @@ faiss::ArrayInvertedListscodes faiss::ArrayInvertedListscompute_ntotal faiss::ArrayInvertedListscopy_subset_to - faiss::ArrayInvertedListsget_codes - faiss::ArrayInvertedListsget_ids - faiss::ArrayInvertedListsget_iterator - faiss::ArrayInvertedListsget_single_code + faiss::ArrayInvertedListsget_codes + faiss::ArrayInvertedListsget_ids + faiss::ArrayInvertedListsget_iterator + faiss::ArrayInvertedListsget_single_code faiss::ArrayInvertedListsget_single_id faiss::ArrayInvertedListsids faiss::ArrayInvertedListsimbalance_factor diff --git a/xml/structfaiss_1_1AutoTuneCriterion.xml b/xml/structfaiss_1_1AutoTuneCriterion.xml index 5423991ceb..c42e74a31e 100644 --- a/xml/structfaiss_1_1AutoTuneCriterion.xml +++ b/xml/structfaiss_1_1AutoTuneCriterion.xml @@ -1,16 +1,17 @@ - + faiss::AutoTuneCriterion faiss::IntersectionCriterion faiss::OneRecallAtRCriterion AutoTune.h - + idx_t idx_t faiss::AutoTuneCriterion::nq nq + faiss::AutoTuneCriterion::nq nb of queries this criterion is evaluated on @@ -25,6 +26,7 @@ idx_t faiss::AutoTuneCriterion::nnn nnn + faiss::AutoTuneCriterion::nnn nb of NNs that the query should request @@ -39,6 +41,7 @@ idx_t faiss::AutoTuneCriterion::gt_nnn gt_nnn + faiss::AutoTuneCriterion::gt_nnn nb of GT NNs required to evaluate criterion @@ -53,6 +56,7 @@ std::vector<float> faiss::AutoTuneCriterion::gt_D gt_D + faiss::AutoTuneCriterion::gt_D Ground-truth distances (size nq * gt_nnn) @@ -67,6 +71,7 @@ std::vector<idx_t> faiss::AutoTuneCriterion::gt_I gt_I + faiss::AutoTuneCriterion::gt_I Ground-truth indexes (size nq * gt_nnn) @@ -76,13 +81,14 @@ - - + + faiss::AutoTuneCriterion::AutoTuneCriterion (idx_t nq, idx_t nnn) AutoTuneCriterion + faiss::AutoTuneCriterion::AutoTuneCriterion idx_t nq @@ -104,6 +110,7 @@ void faiss::AutoTuneCriterion::set_groundtruth (int gt_nnn, const float *gt_D_in, const idx_t *gt_I_in) set_groundtruth + faiss::AutoTuneCriterion::set_groundtruth int gt_nnn @@ -148,6 +155,7 @@ virtual double faiss::AutoTuneCriterion::evaluate (const float *D, const idx_t *I) const =0 evaluate + faiss::AutoTuneCriterion::evaluate evaluate evaluate @@ -192,6 +200,7 @@ virtual faiss::AutoTuneCriterion::~AutoTuneCriterion () ~AutoTuneCriterion + faiss::AutoTuneCriterion::~AutoTuneCriterion @@ -200,13 +209,17 @@ - + Evaluation criterion. Returns a performance measure in [0,1], higher is better. + + + + @@ -219,10 +232,6 @@ - - - - diff --git a/xml/structfaiss_1_1BinaryInvertedListScanner.xml b/xml/structfaiss_1_1BinaryInvertedListScanner.xml index dc196f9274..14ef6011ac 100644 --- a/xml/structfaiss_1_1BinaryInvertedListScanner.xml +++ b/xml/structfaiss_1_1BinaryInvertedListScanner.xml @@ -1,13 +1,14 @@ - + faiss::BinaryInvertedListScanner - + void virtual void faiss::BinaryInvertedListScanner::set_query (const uint8_t *query_vector)=0 set_query + faiss::BinaryInvertedListScanner::set_query const uint8_t * query_vector @@ -26,6 +27,7 @@ virtual void faiss::BinaryInvertedListScanner::set_list (idx_t list_no, uint8_t coarse_dis)=0 set_list + faiss::BinaryInvertedListScanner::set_list idx_t list_no @@ -48,6 +50,7 @@ virtual uint32_t faiss::BinaryInvertedListScanner::distance_to_code (const uint8_t *code) const =0 distance_to_code + faiss::BinaryInvertedListScanner::distance_to_code const uint8_t * code @@ -66,6 +69,7 @@ virtual size_t faiss::BinaryInvertedListScanner::scan_codes (size_t n, const uint8_t *codes, const idx_t *ids, int32_t *distances, idx_t *labels, size_t k) const =0 scan_codes + faiss::BinaryInvertedListScanner::scan_codes size_t n @@ -154,6 +158,7 @@ virtual void faiss::BinaryInvertedListScanner::scan_codes_range (size_t n, const uint8_t *codes, const idx_t *ids, int radius, RangeQueryResult &result) const =0 scan_codes_range + faiss::BinaryInvertedListScanner::scan_codes_range size_t n @@ -187,6 +192,7 @@ virtual faiss::BinaryInvertedListScanner::~BinaryInvertedListScanner () ~BinaryInvertedListScanner + faiss::BinaryInvertedListScanner::~BinaryInvertedListScanner @@ -195,7 +201,7 @@ - + diff --git a/xml/structfaiss_1_1BitstringReader.xml b/xml/structfaiss_1_1BitstringReader.xml index 1e263341ff..56daff8886 100644 --- a/xml/structfaiss_1_1BitstringReader.xml +++ b/xml/structfaiss_1_1BitstringReader.xml @@ -1,13 +1,14 @@ - + faiss::BitstringReader - + const uint8_t * const uint8_t* faiss::BitstringReader::code code + faiss::BitstringReader::code @@ -21,6 +22,7 @@ size_t faiss::BitstringReader::code_size code_size + faiss::BitstringReader::code_size @@ -34,6 +36,7 @@ size_t faiss::BitstringReader::i i + faiss::BitstringReader::i @@ -42,13 +45,14 @@ - - + + faiss::BitstringReader::BitstringReader (const uint8_t *code, size_t code_size) BitstringReader + faiss::BitstringReader::BitstringReader const uint8_t * code @@ -70,6 +74,7 @@ uint64_t faiss::BitstringReader::read (int nbit) read + faiss::BitstringReader::read int nbit @@ -82,7 +87,7 @@ - + diff --git a/xml/structfaiss_1_1BitstringWriter.xml b/xml/structfaiss_1_1BitstringWriter.xml index 0322216b05..3bff014e83 100644 --- a/xml/structfaiss_1_1BitstringWriter.xml +++ b/xml/structfaiss_1_1BitstringWriter.xml @@ -1,13 +1,14 @@ - + faiss::BitstringWriter - + uint8_t * uint8_t* faiss::BitstringWriter::code code + faiss::BitstringWriter::code @@ -21,6 +22,7 @@ size_t faiss::BitstringWriter::code_size code_size + faiss::BitstringWriter::code_size @@ -34,6 +36,7 @@ size_t faiss::BitstringWriter::i i + faiss::BitstringWriter::i @@ -42,13 +45,14 @@ - - + + faiss::BitstringWriter::BitstringWriter (uint8_t *code, size_t code_size) BitstringWriter + faiss::BitstringWriter::BitstringWriter uint8_t * code @@ -70,6 +74,7 @@ void faiss::BitstringWriter::write (uint64_t x, int nbit) write + faiss::BitstringWriter::write uint64_t x @@ -86,7 +91,7 @@ - + diff --git a/xml/structfaiss_1_1BlockInvertedLists.xml b/xml/structfaiss_1_1BlockInvertedLists.xml index b9c1ad1231..3728b63f97 100644 --- a/xml/structfaiss_1_1BlockInvertedLists.xml +++ b/xml/structfaiss_1_1BlockInvertedLists.xml @@ -1,15 +1,16 @@ - + faiss::BlockInvertedLists faiss::InvertedLists BlockInvertedLists.h - + size_t size_t faiss::BlockInvertedLists::n_per_block n_per_block + faiss::BlockInvertedLists::n_per_block = 0 @@ -24,6 +25,7 @@ size_t faiss::BlockInvertedLists::block_size block_size + faiss::BlockInvertedLists::block_size = 0 @@ -38,6 +40,7 @@ const CodePacker* faiss::BlockInvertedLists::packer packer + faiss::BlockInvertedLists::packer = nullptr @@ -52,6 +55,7 @@ std::vector<AlignedTable<uint8_t> > faiss::BlockInvertedLists::codes codes + faiss::BlockInvertedLists::codes @@ -65,6 +69,7 @@ std::vector<std::vector<idx_t> > faiss::BlockInvertedLists::ids ids + faiss::BlockInvertedLists::ids @@ -78,6 +83,7 @@ size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -92,6 +98,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -106,6 +113,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -116,13 +124,14 @@ - - + + faiss::BlockInvertedLists::BlockInvertedLists (size_t nlist, size_t vec_per_block, size_t block_size) BlockInvertedLists + faiss::BlockInvertedLists::BlockInvertedLists size_t nlist @@ -148,6 +157,7 @@ faiss::BlockInvertedLists::BlockInvertedLists (size_t nlist, const CodePacker *packer) BlockInvertedLists + faiss::BlockInvertedLists::BlockInvertedLists size_t nlist @@ -169,6 +179,7 @@ faiss::BlockInvertedLists::BlockInvertedLists () BlockInvertedLists + faiss::BlockInvertedLists::BlockInvertedLists @@ -182,6 +193,7 @@ size_t faiss::BlockInvertedLists::list_size (size_t list_no) const override list_size + faiss::BlockInvertedLists::list_size list_size size_t @@ -196,12 +208,13 @@ - + const uint8_t * - const uint8_t* faiss::BlockInvertedLists::get_codes + const uint8_t * faiss::BlockInvertedLists::get_codes (size_t list_no) const override get_codes - get_codes + faiss::BlockInvertedLists::get_codes + get_codes size_t list_no @@ -218,12 +231,13 @@ - + const idx_t * - const idx_t* faiss::BlockInvertedLists::get_ids + const idx_t * faiss::BlockInvertedLists::get_ids (size_t list_no) const override get_ids - get_ids + faiss::BlockInvertedLists::get_ids + get_ids size_t list_no @@ -245,6 +259,7 @@ size_t faiss::BlockInvertedLists::remove_ids (const IDSelector &sel) remove_ids + faiss::BlockInvertedLists::remove_ids const IDSelector & sel @@ -263,6 +278,7 @@ size_t faiss::BlockInvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override add_entries + faiss::BlockInvertedLists::add_entries add_entries size_t @@ -293,6 +309,7 @@ void faiss::BlockInvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override update_entries + faiss::BlockInvertedLists::update_entries update_entries size_t @@ -328,6 +345,7 @@ void faiss::BlockInvertedLists::resize (size_t list_no, size_t new_size) override resize + faiss::BlockInvertedLists::resize resize size_t @@ -350,6 +368,7 @@ faiss::BlockInvertedLists::~BlockInvertedLists () override ~BlockInvertedLists + faiss::BlockInvertedLists::~BlockInvertedLists @@ -363,6 +382,7 @@ virtual void faiss::InvertedLists::release_codes (size_t list_no, const uint8_t *codes) const release_codes + faiss::InvertedLists::release_codes release_codes release_codes release_codes @@ -390,6 +410,7 @@ virtual void faiss::InvertedLists::release_ids (size_t list_no, const idx_t *ids) const release_ids + faiss::InvertedLists::release_ids release_ids release_ids release_ids @@ -417,6 +438,7 @@ virtual idx_t faiss::InvertedLists::get_single_id (size_t list_no, size_t offset) const get_single_id + faiss::InvertedLists::get_single_id get_single_id get_single_id get_single_id @@ -441,16 +463,17 @@ - + const uint8_t * - virtual const uint8_t* faiss::InvertedLists::get_single_code + virtual const uint8_t * faiss::InvertedLists::get_single_code (size_t list_no, size_t offset) const get_single_code - get_single_code - get_single_code - get_single_code - get_single_code - get_single_code + faiss::InvertedLists::get_single_code + get_single_code + get_single_code + get_single_code + get_single_code + get_single_code size_t list_no @@ -475,6 +498,7 @@ virtual void faiss::InvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const prefetch_lists + faiss::InvertedLists::prefetch_lists prefetch_lists prefetch_lists prefetch_lists @@ -503,6 +527,7 @@ virtual bool faiss::InvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const is_empty + faiss::InvertedLists::is_empty is_empty size_t @@ -522,11 +547,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -550,6 +576,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -581,6 +608,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -610,6 +638,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -623,6 +652,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -645,6 +675,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -677,6 +708,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -691,6 +723,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -705,6 +738,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -714,11 +748,12 @@ - - + + int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -769,13 +804,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -786,7 +822,7 @@ - + @@ -796,22 +832,18 @@ The writing functions add_entries and update_entries operate on block-aligned data. - - - - - - + + @@ -825,6 +857,10 @@ + + + + @@ -838,10 +874,10 @@ faiss::BlockInvertedListscodes faiss::BlockInvertedListscompute_ntotal faiss::BlockInvertedListscopy_subset_to - faiss::BlockInvertedListsget_codes - faiss::BlockInvertedListsget_ids - faiss::BlockInvertedListsget_iterator - faiss::BlockInvertedListsget_single_code + faiss::BlockInvertedListsget_codes + faiss::BlockInvertedListsget_ids + faiss::BlockInvertedListsget_iterator + faiss::BlockInvertedListsget_single_code faiss::BlockInvertedListsget_single_id faiss::BlockInvertedListsids faiss::BlockInvertedListsimbalance_factor diff --git a/xml/structfaiss_1_1BlockInvertedListsIOHook.xml b/xml/structfaiss_1_1BlockInvertedListsIOHook.xml index 766ffd2e25..a0d471c199 100644 --- a/xml/structfaiss_1_1BlockInvertedListsIOHook.xml +++ b/xml/structfaiss_1_1BlockInvertedListsIOHook.xml @@ -1,14 +1,15 @@ - + faiss::BlockInvertedListsIOHook faiss::InvertedListsIOHook - + faiss::BlockInvertedListsIOHook::BlockInvertedListsIOHook () BlockInvertedListsIOHook + faiss::BlockInvertedListsIOHook::BlockInvertedListsIOHook @@ -22,6 +23,7 @@ void faiss::BlockInvertedListsIOHook::write (const InvertedLists *ils, IOWriter *f) const override write + faiss::BlockInvertedListsIOHook::write write const InvertedLists * @@ -40,12 +42,13 @@ - + InvertedLists * - InvertedLists* faiss::BlockInvertedListsIOHook::read + InvertedLists * faiss::BlockInvertedListsIOHook::read (IOReader *f, int io_flags) const override read - read + faiss::BlockInvertedListsIOHook::read + read IOReader * f @@ -63,12 +66,13 @@ - + InvertedLists * - virtual InvertedLists* faiss::InvertedListsIOHook::read_ArrayInvertedLists + virtual InvertedLists * faiss::InvertedListsIOHook::read_ArrayInvertedLists (IOReader *f, int io_flags, size_t nlist, size_t code_size, const std::vector< size_t > &sizes) const read_ArrayInvertedLists - read_ArrayInvertedLists + faiss::InvertedListsIOHook::read_ArrayInvertedLists + read_ArrayInvertedLists IOReader * f @@ -99,13 +103,14 @@ - - + + const std::string const std::string faiss::InvertedListsIOHook::key key + faiss::InvertedListsIOHook::key string version of the fourcc @@ -120,6 +125,7 @@ const std::string faiss::InvertedListsIOHook::classname classname + faiss::InvertedListsIOHook::classname typeid.name @@ -129,13 +135,14 @@ - - + + void static void faiss::InvertedListsIOHook::add_callback (InvertedListsIOHook *) add_callback + faiss::InvertedListsIOHook::add_callback InvertedListsIOHook * @@ -152,6 +159,7 @@ static void faiss::InvertedListsIOHook::print_callbacks () print_callbacks + faiss::InvertedListsIOHook::print_callbacks @@ -160,11 +168,12 @@ - + InvertedListsIOHook * - static InvertedListsIOHook* faiss::InvertedListsIOHook::lookup + static InvertedListsIOHook * faiss::InvertedListsIOHook::lookup (int h) lookup + faiss::InvertedListsIOHook::lookup int h @@ -177,11 +186,12 @@ - + InvertedListsIOHook * - static InvertedListsIOHook* faiss::InvertedListsIOHook::lookup_classname + static InvertedListsIOHook * faiss::InvertedListsIOHook::lookup_classname (const std::string &classname) lookup_classname + faiss::InvertedListsIOHook::lookup_classname const std::string & classname @@ -194,7 +204,7 @@ - + @@ -230,11 +240,11 @@ faiss::BlockInvertedListsIOHookclassname faiss::BlockInvertedListsIOHookInvertedListsIOHook faiss::BlockInvertedListsIOHookkey - faiss::BlockInvertedListsIOHooklookup - faiss::BlockInvertedListsIOHooklookup_classname + faiss::BlockInvertedListsIOHooklookup + faiss::BlockInvertedListsIOHooklookup_classname faiss::BlockInvertedListsIOHookprint_callbacks - faiss::BlockInvertedListsIOHookread - faiss::BlockInvertedListsIOHookread_ArrayInvertedLists + faiss::BlockInvertedListsIOHookread + faiss::BlockInvertedListsIOHookread_ArrayInvertedLists faiss::BlockInvertedListsIOHookwrite faiss::BlockInvertedListsIOHook~InvertedListsIOHook diff --git a/xml/structfaiss_1_1BlockResultHandler.xml b/xml/structfaiss_1_1BlockResultHandler.xml index a2e4c27069..4458f89907 100644 --- a/xml/structfaiss_1_1BlockResultHandler.xml +++ b/xml/structfaiss_1_1BlockResultHandler.xml @@ -1,7 +1,11 @@ - + faiss::BlockResultHandler + faiss::HeapBlockResultHandler< C, use_sel > + faiss::RangeSearchBlockResultHandler< C, use_sel > + faiss::ReservoirBlockResultHandler< C, use_sel > + faiss::Top1BlockResultHandler< C, use_sel > class C @@ -13,12 +17,13 @@ false - + size_t size_t faiss::BlockResultHandler< C, use_sel >::nq nq + faiss::BlockResultHandler::nq @@ -32,6 +37,7 @@ const IDSelector* faiss::BlockResultHandler< C, use_sel >::sel sel + faiss::BlockResultHandler::sel @@ -45,6 +51,7 @@ size_t faiss::BlockResultHandler< C, use_sel >::i0 i0 + faiss::BlockResultHandler::i0 = 0 @@ -59,6 +66,7 @@ size_t faiss::BlockResultHandler< C, use_sel >::i1 i1 + faiss::BlockResultHandler::i1 = 0 @@ -68,13 +76,14 @@ - - + + faiss::BlockResultHandler< C, use_sel >::BlockResultHandler (size_t nq, const IDSelector *sel=nullptr) BlockResultHandler + faiss::BlockResultHandler::BlockResultHandler size_t nq @@ -97,6 +106,7 @@ virtual void faiss::BlockResultHandler< C, use_sel >::begin_multiple (size_t i0_2, size_t i1_2) begin_multiple + faiss::BlockResultHandler::begin_multiple begin_multiple begin_multiple begin_multiple @@ -122,6 +132,7 @@ virtual void faiss::BlockResultHandler< C, use_sel >::add_results (size_t, size_t, const typename C::T *) add_results + faiss::BlockResultHandler::add_results size_t @@ -144,6 +155,7 @@ virtual void faiss::BlockResultHandler< C, use_sel >::end_multiple () end_multiple + faiss::BlockResultHandler::end_multiple end_multiple end_multiple @@ -159,6 +171,7 @@ virtual faiss::BlockResultHandler< C, use_sel >::~BlockResultHandler () ~BlockResultHandler + faiss::BlockResultHandler::~BlockResultHandler @@ -172,6 +185,7 @@ bool faiss::BlockResultHandler< C, use_sel >::is_in_selection (idx_t i) const is_in_selection + faiss::BlockResultHandler::is_in_selection idx_t i @@ -184,16 +198,42 @@ - + - + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + @@ -201,6 +241,10 @@ sel + + + + diff --git a/xml/structfaiss_1_1BufferList.xml b/xml/structfaiss_1_1BufferList.xml index d4117af7e7..4f7b091f6a 100644 --- a/xml/structfaiss_1_1BufferList.xml +++ b/xml/structfaiss_1_1BufferList.xml @@ -1,16 +1,17 @@ - + faiss::BufferList faiss::RangeSearchPartialResult AuxIndexStructures.h faiss::BufferList::Buffer - + size_t size_t faiss::BufferList::buffer_size buffer_size + faiss::BufferList::buffer_size @@ -24,6 +25,7 @@ std::vector<Buffer> faiss::BufferList::buffers buffers + faiss::BufferList::buffers @@ -37,6 +39,7 @@ size_t faiss::BufferList::wp wp + faiss::BufferList::wp write pointer in the last buffer. @@ -46,13 +49,14 @@ - - + + faiss::BufferList::BufferList (size_t buffer_size) BufferList + faiss::BufferList::BufferList size_t buffer_size @@ -70,6 +74,7 @@ faiss::BufferList::~BufferList () ~BufferList + faiss::BufferList::~BufferList @@ -83,6 +88,7 @@ void faiss::BufferList::append_buffer () append_buffer + faiss::BufferList::append_buffer create a new buffer @@ -97,6 +103,7 @@ void faiss::BufferList::add (idx_t id, float dis) add + faiss::BufferList::add idx_t id @@ -119,6 +126,7 @@ void faiss::BufferList::copy_range (size_t ofs, size_t n, idx_t *dest_ids, float *dest_dis) copy_range + faiss::BufferList::copy_range size_t ofs @@ -144,7 +152,7 @@ - + diff --git a/xml/structfaiss_1_1BufferList_1_1Buffer.xml b/xml/structfaiss_1_1BufferList_1_1Buffer.xml index 5ca3c7878d..0b28f97d78 100644 --- a/xml/structfaiss_1_1BufferList_1_1Buffer.xml +++ b/xml/structfaiss_1_1BufferList_1_1Buffer.xml @@ -1,13 +1,14 @@ - + faiss::BufferList::Buffer - + idx_t * idx_t* faiss::BufferList::Buffer::ids ids + faiss::BufferList::Buffer::ids @@ -21,6 +22,7 @@ float* faiss::BufferList::Buffer::dis dis + faiss::BufferList::Buffer::dis @@ -29,7 +31,7 @@ - + diff --git a/xml/structfaiss_1_1BufferedIOReader.xml b/xml/structfaiss_1_1BufferedIOReader.xml index f9952a763d..16a1f13b81 100644 --- a/xml/structfaiss_1_1BufferedIOReader.xml +++ b/xml/structfaiss_1_1BufferedIOReader.xml @@ -1,15 +1,16 @@ - + faiss::BufferedIOReader faiss::IOReader io.h - + IOReader * IOReader* faiss::BufferedIOReader::reader reader + faiss::BufferedIOReader::reader @@ -23,6 +24,7 @@ size_t faiss::BufferedIOReader::bsz bsz + faiss::BufferedIOReader::bsz @@ -36,6 +38,7 @@ size_t faiss::BufferedIOReader::ofs ofs + faiss::BufferedIOReader::ofs offset in input stream @@ -50,6 +53,7 @@ size_t faiss::BufferedIOReader::ofs2 ofs2 + faiss::BufferedIOReader::ofs2 number of bytes returned to caller @@ -64,6 +68,7 @@ size_t faiss::BufferedIOReader::b0 b0 + faiss::BufferedIOReader::b0 @@ -77,6 +82,7 @@ size_t faiss::BufferedIOReader::b1 b1 + faiss::BufferedIOReader::b1 range of available bytes in the buffer @@ -91,6 +97,7 @@ std::vector<char> faiss::BufferedIOReader::buffer buffer + faiss::BufferedIOReader::buffer @@ -104,6 +111,7 @@ std::string faiss::IOReader::name name + faiss::IOReader::name @@ -112,13 +120,14 @@ - - + + faiss::BufferedIOReader::BufferedIOReader (IOReader *reader, size_t bsz=1024 *1024) BufferedIOReader + faiss::BufferedIOReader::BufferedIOReader IOReader * reader @@ -151,6 +160,7 @@ size_t faiss::BufferedIOReader::operator() (void *ptr, size_t size, size_t nitems) override operator() + faiss::BufferedIOReader::operator() operator() void * @@ -177,6 +187,7 @@ virtual int faiss::IOReader::filedescriptor () filedescriptor + faiss::IOReader::filedescriptor filedescriptor @@ -186,7 +197,7 @@ - + diff --git a/xml/structfaiss_1_1BufferedIOWriter.xml b/xml/structfaiss_1_1BufferedIOWriter.xml index 139ba33056..34e47eb031 100644 --- a/xml/structfaiss_1_1BufferedIOWriter.xml +++ b/xml/structfaiss_1_1BufferedIOWriter.xml @@ -1,14 +1,15 @@ - + faiss::BufferedIOWriter faiss::IOWriter - + IOWriter * IOWriter* faiss::BufferedIOWriter::writer writer + faiss::BufferedIOWriter::writer @@ -22,6 +23,7 @@ size_t faiss::BufferedIOWriter::bsz bsz + faiss::BufferedIOWriter::bsz @@ -35,6 +37,7 @@ size_t faiss::BufferedIOWriter::ofs ofs + faiss::BufferedIOWriter::ofs @@ -48,6 +51,7 @@ size_t faiss::BufferedIOWriter::ofs2 ofs2 + faiss::BufferedIOWriter::ofs2 number of bytes received from caller @@ -62,6 +66,7 @@ size_t faiss::BufferedIOWriter::b0 b0 + faiss::BufferedIOWriter::b0 amount of data in buffer @@ -76,6 +81,7 @@ std::vector<char> faiss::BufferedIOWriter::buffer buffer + faiss::BufferedIOWriter::buffer @@ -89,6 +95,7 @@ std::string faiss::IOWriter::name name + faiss::IOWriter::name @@ -97,13 +104,14 @@ - - + + faiss::BufferedIOWriter::BufferedIOWriter (IOWriter *writer, size_t bsz=1024 *1024) BufferedIOWriter + faiss::BufferedIOWriter::BufferedIOWriter IOWriter * writer @@ -126,6 +134,7 @@ size_t faiss::BufferedIOWriter::operator() (const void *ptr, size_t size, size_t nitems) override operator() + faiss::BufferedIOWriter::operator() operator() const void * @@ -152,6 +161,7 @@ faiss::BufferedIOWriter::~BufferedIOWriter () override ~BufferedIOWriter + faiss::BufferedIOWriter::~BufferedIOWriter @@ -165,6 +175,7 @@ virtual int faiss::IOWriter::filedescriptor () filedescriptor + faiss::IOWriter::filedescriptor filedescriptor @@ -174,28 +185,24 @@ - + - - - - - - + + @@ -205,6 +212,10 @@ writer + + + + diff --git a/xml/structfaiss_1_1CMax.xml b/xml/structfaiss_1_1CMax.xml index b9ebfb62bb..2aea9ade57 100644 --- a/xml/structfaiss_1_1CMax.xml +++ b/xml/structfaiss_1_1CMax.xml @@ -1,5 +1,5 @@ - + faiss::CMax @@ -10,12 +10,13 @@ typename TI_ - + T_ typedef T_ faiss::CMax< T_, TI_ >::T T + faiss::CMax::T @@ -29,6 +30,7 @@ typedef TI_ faiss::CMax< T_, TI_ >::TI TI + faiss::CMax::TI @@ -42,6 +44,7 @@ typedef CMin<T_, TI_> faiss::CMax< T_, TI_ >::Crev Crev + faiss::CMax::Crev @@ -50,13 +53,14 @@ - - + + const bool const bool faiss::CMax< T_, TI_ >::is_max is_max + faiss::CMax::is_max = true @@ -66,13 +70,14 @@ - - + + bool static bool faiss::CMax< T_, TI_ >::cmp (T a, T b) cmp + faiss::CMax::cmp T a @@ -94,6 +99,7 @@ static bool faiss::CMax< T_, TI_ >::cmp2 (T a1, T b1, TI a2, TI b2) cmp2 + faiss::CMax::cmp2 T a1 @@ -123,6 +129,7 @@ static T faiss::CMax< T_, TI_ >::neutral () neutral + faiss::CMax::neutral @@ -136,6 +143,7 @@ static T faiss::CMax< T_, TI_ >::nextafter (T x) nextafter + faiss::CMax::nextafter T x @@ -148,7 +156,7 @@ - + diff --git a/xml/structfaiss_1_1CMin.xml b/xml/structfaiss_1_1CMin.xml index 91bce267e8..1c3a8d641d 100644 --- a/xml/structfaiss_1_1CMin.xml +++ b/xml/structfaiss_1_1CMin.xml @@ -1,5 +1,5 @@ - + faiss::CMin @@ -10,12 +10,13 @@ typename TI_ - + T_ typedef T_ faiss::CMin< T_, TI_ >::T T + faiss::CMin::T @@ -29,6 +30,7 @@ typedef TI_ faiss::CMin< T_, TI_ >::TI TI + faiss::CMin::TI @@ -42,6 +44,7 @@ typedef CMax<T_, TI_> faiss::CMin< T_, TI_ >::Crev Crev + faiss::CMin::Crev @@ -50,13 +53,14 @@ - - + + const bool const bool faiss::CMin< T_, TI_ >::is_max is_max + faiss::CMin::is_max = false @@ -66,13 +70,14 @@ - - + + bool static bool faiss::CMin< T_, TI_ >::cmp (T a, T b) cmp + faiss::CMin::cmp T a @@ -94,6 +99,7 @@ static bool faiss::CMin< T_, TI_ >::cmp2 (T a1, T b1, TI a2, TI b2) cmp2 + faiss::CMin::cmp2 T a1 @@ -123,6 +129,7 @@ static T faiss::CMin< T_, TI_ >::neutral () neutral + faiss::CMin::neutral @@ -136,6 +143,7 @@ static T faiss::CMin< T_, TI_ >::nextafter (T x) nextafter + faiss::CMin::nextafter T x @@ -148,7 +156,7 @@ - + diff --git a/xml/structfaiss_1_1CenteringTransform.xml b/xml/structfaiss_1_1CenteringTransform.xml index d80a7cceed..0d07a5ecdb 100644 --- a/xml/structfaiss_1_1CenteringTransform.xml +++ b/xml/structfaiss_1_1CenteringTransform.xml @@ -1,15 +1,16 @@ - + faiss::CenteringTransform faiss::VectorTransform VectorTransform.h - + std::vector< float > std::vector<float> faiss::CenteringTransform::mean mean + faiss::CenteringTransform::mean Mean, size d_in = d_out. @@ -24,6 +25,7 @@ int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -37,6 +39,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -51,6 +54,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -60,13 +64,14 @@ - - + + faiss::CenteringTransform::CenteringTransform (int d=0) CenteringTransform + faiss::CenteringTransform::CenteringTransform int d @@ -85,6 +90,7 @@ void faiss::CenteringTransform::train (idx_t n, const float *x) override train + faiss::CenteringTransform::train train idx_t @@ -108,6 +114,7 @@ void faiss::CenteringTransform::apply_noalloc (idx_t n, const float *x, float *xt) const override apply_noalloc + faiss::CenteringTransform::apply_noalloc apply_noalloc idx_t @@ -135,6 +142,7 @@ void faiss::CenteringTransform::reverse_transform (idx_t n, const float *xt, float *x) const override reverse_transform + faiss::CenteringTransform::reverse_transform reverse_transform idx_t @@ -162,6 +170,7 @@ void faiss::CenteringTransform::check_identical (const VectorTransform &other) const override check_identical + faiss::CenteringTransform::check_identical check_identical const VectorTransform & @@ -175,11 +184,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -216,39 +226,39 @@ - + Subtract the mean of each component from the vectors. - - - - - - + + + + + + - faiss::CenteringTransformapply + faiss::CenteringTransformapply faiss::CenteringTransformapply_noalloc faiss::CenteringTransformCenteringTransform faiss::CenteringTransformcheck_identical diff --git a/xml/structfaiss_1_1Cloner.xml b/xml/structfaiss_1_1Cloner.xml index c2879a8f29..57e342fd9d 100644 --- a/xml/structfaiss_1_1Cloner.xml +++ b/xml/structfaiss_1_1Cloner.xml @@ -1,17 +1,18 @@ - + faiss::Cloner faiss::gpu::ToCPUCloner faiss::gpu::ToGpuCloner faiss::gpu::ToGpuClonerMultiple clone_index.h - - + + VectorTransform * - virtual VectorTransform* faiss::Cloner::clone_VectorTransform + virtual VectorTransform * faiss::Cloner::clone_VectorTransform (const VectorTransform *) clone_VectorTransform + faiss::Cloner::clone_VectorTransform const VectorTransform * @@ -23,14 +24,15 @@ - + Index * - virtual Index* faiss::Cloner::clone_Index + virtual Index * faiss::Cloner::clone_Index (const Index *) clone_Index - clone_Index - clone_Index - clone_Index + faiss::Cloner::clone_Index + clone_Index + clone_Index + clone_Index const Index * @@ -42,11 +44,12 @@ - + IndexIVF * - virtual IndexIVF* faiss::Cloner::clone_IndexIVF + virtual IndexIVF * faiss::Cloner::clone_IndexIVF (const IndexIVF *) clone_IndexIVF + faiss::Cloner::clone_IndexIVF const IndexIVF * @@ -63,6 +66,7 @@ virtual faiss::Cloner::~Cloner () ~Cloner + faiss::Cloner::~Cloner @@ -71,7 +75,7 @@ - + @@ -88,24 +92,24 @@ - - - - - - + + + + + + - faiss::Clonerclone_Index - faiss::Clonerclone_IndexIVF - faiss::Clonerclone_VectorTransform + faiss::Clonerclone_Index + faiss::Clonerclone_IndexIVF + faiss::Clonerclone_VectorTransform faiss::Cloner~Cloner diff --git a/xml/structfaiss_1_1Clustering.xml b/xml/structfaiss_1_1Clustering.xml index 2a17ab27e8..ab75b313c2 100644 --- a/xml/structfaiss_1_1Clustering.xml +++ b/xml/structfaiss_1_1Clustering.xml @@ -1,16 +1,17 @@ - + faiss::Clustering faiss::ClusteringParameters faiss::Clustering1D Clustering.h - + size_t size_t faiss::Clustering::d d + faiss::Clustering::d dimension of the vectors @@ -25,6 +26,7 @@ size_t faiss::Clustering::k k + faiss::Clustering::k nb of centroids @@ -39,6 +41,7 @@ std::vector<float> faiss::Clustering::centroids centroids + faiss::Clustering::centroids @@ -53,6 +56,7 @@ std::vector<ClusteringIterationStats> faiss::Clustering::iteration_stats iteration_stats + faiss::Clustering::iteration_stats stats at every iteration of clustering @@ -67,6 +71,7 @@ int faiss::ClusteringParameters::niter niter + faiss::ClusteringParameters::niter = 25 number of clustering iterations @@ -82,6 +87,7 @@ int faiss::ClusteringParameters::nredo nredo + faiss::ClusteringParameters::nredo = 1 @@ -97,6 +103,7 @@ bool faiss::ClusteringParameters::verbose verbose + faiss::ClusteringParameters::verbose = false @@ -111,6 +118,7 @@ bool faiss::ClusteringParameters::spherical spherical + faiss::ClusteringParameters::spherical = false @@ -126,6 +134,7 @@ bool faiss::ClusteringParameters::int_centroids int_centroids + faiss::ClusteringParameters::int_centroids = false round centroids coordinates to integer after each iteration? @@ -141,6 +150,7 @@ bool faiss::ClusteringParameters::update_index update_index + faiss::ClusteringParameters::update_index = false re-train index after each iteration? @@ -156,6 +166,7 @@ bool faiss::ClusteringParameters::frozen_centroids frozen_centroids + faiss::ClusteringParameters::frozen_centroids = false @@ -171,6 +182,7 @@ int faiss::ClusteringParameters::min_points_per_centroid min_points_per_centroid + faiss::ClusteringParameters::min_points_per_centroid = 39 @@ -186,6 +198,7 @@ int faiss::ClusteringParameters::max_points_per_centroid max_points_per_centroid + faiss::ClusteringParameters::max_points_per_centroid = 256 to limit size of dataset, otherwise the training set is subsampled @@ -201,6 +214,7 @@ int faiss::ClusteringParameters::seed seed + faiss::ClusteringParameters::seed = 1234 @@ -216,6 +230,7 @@ size_t faiss::ClusteringParameters::decode_block_size decode_block_size + faiss::ClusteringParameters::decode_block_size = 32768 when the training set is encoded, batch size of the codec decoder @@ -231,6 +246,7 @@ bool faiss::ClusteringParameters::check_input_data_for_NaNs check_input_data_for_NaNs + faiss::ClusteringParameters::check_input_data_for_NaNs = true whether to check for NaNs in an input data @@ -246,6 +262,7 @@ bool faiss::ClusteringParameters::use_faster_subsampling use_faster_subsampling + faiss::ClusteringParameters::use_faster_subsampling = false @@ -256,13 +273,14 @@ - - + + faiss::Clustering::Clustering (int d, int k) Clustering + faiss::Clustering::Clustering int d @@ -284,6 +302,7 @@ faiss::Clustering::Clustering (int d, int k, const ClusteringParameters &cp) Clustering + faiss::Clustering::Clustering int d @@ -309,6 +328,7 @@ virtual void faiss::Clustering::train (idx_t n, const float *x, faiss::Index &index, const float *x_weights=nullptr) train + faiss::Clustering::train idx_t n @@ -366,6 +386,7 @@ void faiss::Clustering::train_encoded (idx_t nx, const uint8_t *x_in, const Index *codec, Index &index, const float *weights=nullptr) train_encoded + faiss::Clustering::train_encoded idx_t nx @@ -412,6 +433,7 @@ void faiss::Clustering::post_process_centroids () post_process_centroids + faiss::Clustering::post_process_centroids @@ -426,6 +448,7 @@ virtual faiss::Clustering::~Clustering () ~Clustering + faiss::Clustering::~Clustering @@ -434,7 +457,7 @@ - + @@ -443,18 +466,18 @@ On output, the centoids 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. - - - - - - + + + + + + diff --git a/xml/structfaiss_1_1Clustering1D.xml b/xml/structfaiss_1_1Clustering1D.xml index f4779d1346..7b47d919f4 100644 --- a/xml/structfaiss_1_1Clustering1D.xml +++ b/xml/structfaiss_1_1Clustering1D.xml @@ -1,15 +1,16 @@ - + faiss::Clustering1D faiss::Clustering Clustering.h - + faiss::Clustering1D::Clustering1D (int k) Clustering1D + faiss::Clustering1D::Clustering1D int k @@ -27,6 +28,7 @@ faiss::Clustering1D::Clustering1D (int k, const ClusteringParameters &cp) Clustering1D + faiss::Clustering1D::Clustering1D int k @@ -48,6 +50,7 @@ void faiss::Clustering1D::train_exact (idx_t n, const float *x) train_exact + faiss::Clustering1D::train_exact idx_t n @@ -69,6 +72,7 @@ virtual faiss::Clustering1D::~Clustering1D () ~Clustering1D + faiss::Clustering1D::~Clustering1D @@ -82,6 +86,7 @@ virtual void faiss::Clustering::train (idx_t n, const float *x, faiss::Index &index, const float *x_weights=nullptr) train + faiss::Clustering::train idx_t n @@ -139,6 +144,7 @@ void faiss::Clustering::train_encoded (idx_t nx, const uint8_t *x_in, const Index *codec, Index &index, const float *weights=nullptr) train_encoded + faiss::Clustering::train_encoded idx_t nx @@ -185,6 +191,7 @@ void faiss::Clustering::post_process_centroids () post_process_centroids + faiss::Clustering::post_process_centroids @@ -194,13 +201,14 @@ - - + + size_t size_t faiss::Clustering::d d + faiss::Clustering::d dimension of the vectors @@ -215,6 +223,7 @@ size_t faiss::Clustering::k k + faiss::Clustering::k nb of centroids @@ -229,6 +238,7 @@ std::vector<float> faiss::Clustering::centroids centroids + faiss::Clustering::centroids @@ -243,6 +253,7 @@ std::vector<ClusteringIterationStats> faiss::Clustering::iteration_stats iteration_stats + faiss::Clustering::iteration_stats stats at every iteration of clustering @@ -257,6 +268,7 @@ int faiss::ClusteringParameters::niter niter + faiss::ClusteringParameters::niter = 25 number of clustering iterations @@ -272,6 +284,7 @@ int faiss::ClusteringParameters::nredo nredo + faiss::ClusteringParameters::nredo = 1 @@ -287,6 +300,7 @@ bool faiss::ClusteringParameters::verbose verbose + faiss::ClusteringParameters::verbose = false @@ -301,6 +315,7 @@ bool faiss::ClusteringParameters::spherical spherical + faiss::ClusteringParameters::spherical = false @@ -316,6 +331,7 @@ bool faiss::ClusteringParameters::int_centroids int_centroids + faiss::ClusteringParameters::int_centroids = false round centroids coordinates to integer after each iteration? @@ -331,6 +347,7 @@ bool faiss::ClusteringParameters::update_index update_index + faiss::ClusteringParameters::update_index = false re-train index after each iteration? @@ -346,6 +363,7 @@ bool faiss::ClusteringParameters::frozen_centroids frozen_centroids + faiss::ClusteringParameters::frozen_centroids = false @@ -361,6 +379,7 @@ int faiss::ClusteringParameters::min_points_per_centroid min_points_per_centroid + faiss::ClusteringParameters::min_points_per_centroid = 39 @@ -376,6 +395,7 @@ int faiss::ClusteringParameters::max_points_per_centroid max_points_per_centroid + faiss::ClusteringParameters::max_points_per_centroid = 256 to limit size of dataset, otherwise the training set is subsampled @@ -391,6 +411,7 @@ int faiss::ClusteringParameters::seed seed + faiss::ClusteringParameters::seed = 1234 @@ -406,6 +427,7 @@ size_t faiss::ClusteringParameters::decode_block_size decode_block_size + faiss::ClusteringParameters::decode_block_size = 32768 when the training set is encoded, batch size of the codec decoder @@ -421,6 +443,7 @@ bool faiss::ClusteringParameters::check_input_data_for_NaNs check_input_data_for_NaNs + faiss::ClusteringParameters::check_input_data_for_NaNs = true whether to check for NaNs in an input data @@ -436,6 +459,7 @@ bool faiss::ClusteringParameters::use_faster_subsampling use_faster_subsampling + faiss::ClusteringParameters::use_faster_subsampling = false @@ -446,7 +470,7 @@ - + @@ -454,36 +478,36 @@ Since it does not use an index, it does not overload the train() function - - - - - - - - - - - - + + + + + + + + + + + + diff --git a/xml/structfaiss_1_1ClusteringIterationStats.xml b/xml/structfaiss_1_1ClusteringIterationStats.xml index df8f59236c..e400f0e066 100644 --- a/xml/structfaiss_1_1ClusteringIterationStats.xml +++ b/xml/structfaiss_1_1ClusteringIterationStats.xml @@ -1,13 +1,14 @@ - + faiss::ClusteringIterationStats - + float float faiss::ClusteringIterationStats::obj obj + faiss::ClusteringIterationStats::obj objective values (sum of distances reported by index) @@ -22,6 +23,7 @@ double faiss::ClusteringIterationStats::time time + faiss::ClusteringIterationStats::time seconds for iteration @@ -36,6 +38,7 @@ double faiss::ClusteringIterationStats::time_search time_search + faiss::ClusteringIterationStats::time_search seconds for just search @@ -50,6 +53,7 @@ double faiss::ClusteringIterationStats::imbalance_factor imbalance_factor + faiss::ClusteringIterationStats::imbalance_factor imbalance factor of iteration @@ -64,6 +68,7 @@ int faiss::ClusteringIterationStats::nsplit nsplit + faiss::ClusteringIterationStats::nsplit number of cluster splits @@ -73,7 +78,7 @@ - + diff --git a/xml/structfaiss_1_1ClusteringParameters.xml b/xml/structfaiss_1_1ClusteringParameters.xml index 718ac27379..66bd4e877a 100644 --- a/xml/structfaiss_1_1ClusteringParameters.xml +++ b/xml/structfaiss_1_1ClusteringParameters.xml @@ -1,16 +1,17 @@ - + faiss::ClusteringParameters faiss::Clustering faiss::ProgressiveDimClusteringParameters Clustering.h - + int int faiss::ClusteringParameters::niter niter + faiss::ClusteringParameters::niter = 25 number of clustering iterations @@ -26,6 +27,7 @@ int faiss::ClusteringParameters::nredo nredo + faiss::ClusteringParameters::nredo = 1 @@ -41,6 +43,7 @@ bool faiss::ClusteringParameters::verbose verbose + faiss::ClusteringParameters::verbose = false @@ -55,6 +58,7 @@ bool faiss::ClusteringParameters::spherical spherical + faiss::ClusteringParameters::spherical = false @@ -70,6 +74,7 @@ bool faiss::ClusteringParameters::int_centroids int_centroids + faiss::ClusteringParameters::int_centroids = false round centroids coordinates to integer after each iteration? @@ -85,6 +90,7 @@ bool faiss::ClusteringParameters::update_index update_index + faiss::ClusteringParameters::update_index = false re-train index after each iteration? @@ -100,6 +106,7 @@ bool faiss::ClusteringParameters::frozen_centroids frozen_centroids + faiss::ClusteringParameters::frozen_centroids = false @@ -115,6 +122,7 @@ int faiss::ClusteringParameters::min_points_per_centroid min_points_per_centroid + faiss::ClusteringParameters::min_points_per_centroid = 39 @@ -130,6 +138,7 @@ int faiss::ClusteringParameters::max_points_per_centroid max_points_per_centroid + faiss::ClusteringParameters::max_points_per_centroid = 256 to limit size of dataset, otherwise the training set is subsampled @@ -145,6 +154,7 @@ int faiss::ClusteringParameters::seed seed + faiss::ClusteringParameters::seed = 1234 @@ -160,6 +170,7 @@ size_t faiss::ClusteringParameters::decode_block_size decode_block_size + faiss::ClusteringParameters::decode_block_size = 32768 when the training set is encoded, batch size of the codec decoder @@ -175,6 +186,7 @@ bool faiss::ClusteringParameters::check_input_data_for_NaNs check_input_data_for_NaNs + faiss::ClusteringParameters::check_input_data_for_NaNs = true whether to check for NaNs in an input data @@ -190,6 +202,7 @@ bool faiss::ClusteringParameters::use_faster_subsampling use_faster_subsampling + faiss::ClusteringParameters::use_faster_subsampling = false @@ -200,16 +213,16 @@ - + Class for the clustering parameters. Can be passed to the constructor of the Clustering object. - - - + + + @@ -219,11 +232,9 @@ - - - - - + + + @@ -231,9 +242,11 @@ - - - + + + + + diff --git a/xml/structfaiss_1_1CodePacker.xml b/xml/structfaiss_1_1CodePacker.xml index 8e5a562119..8578068538 100644 --- a/xml/structfaiss_1_1CodePacker.xml +++ b/xml/structfaiss_1_1CodePacker.xml @@ -1,16 +1,17 @@ - + faiss::CodePacker faiss::CodePackerFlat faiss::CodePackerPQ4 CodePacker.h - + size_t size_t faiss::CodePacker::code_size code_size + faiss::CodePacker::code_size @@ -24,6 +25,7 @@ size_t faiss::CodePacker::nvec nvec + faiss::CodePacker::nvec @@ -37,6 +39,7 @@ size_t faiss::CodePacker::block_size block_size + faiss::CodePacker::block_size @@ -45,13 +48,14 @@ - - + + void virtual void faiss::CodePacker::pack_1 (const uint8_t *flat_code, size_t offset, uint8_t *block) const =0 pack_1 + faiss::CodePacker::pack_1 pack_1 pack_1 @@ -79,6 +83,7 @@ virtual void faiss::CodePacker::unpack_1 (const uint8_t *block, size_t offset, uint8_t *flat_code) const =0 unpack_1 + faiss::CodePacker::unpack_1 unpack_1 unpack_1 @@ -106,6 +111,7 @@ virtual void faiss::CodePacker::pack_all (const uint8_t *flat_codes, uint8_t *block) const pack_all + faiss::CodePacker::pack_all pack_all const uint8_t * @@ -128,6 +134,7 @@ virtual void faiss::CodePacker::unpack_all (const uint8_t *block, uint8_t *flat_codes) const unpack_all + faiss::CodePacker::unpack_all unpack_all const uint8_t * @@ -150,6 +157,7 @@ virtual faiss::CodePacker::~CodePacker () ~CodePacker + faiss::CodePacker::~CodePacker @@ -158,7 +166,7 @@ - + diff --git a/xml/structfaiss_1_1CodePackerFlat.xml b/xml/structfaiss_1_1CodePackerFlat.xml index e6cfb0c30f..7ea5f0d28c 100644 --- a/xml/structfaiss_1_1CodePackerFlat.xml +++ b/xml/structfaiss_1_1CodePackerFlat.xml @@ -1,15 +1,16 @@ - + faiss::CodePackerFlat faiss::CodePacker CodePacker.h - + faiss::CodePackerFlat::CodePackerFlat (size_t code_size) CodePackerFlat + faiss::CodePackerFlat::CodePackerFlat size_t code_size @@ -27,6 +28,7 @@ void faiss::CodePackerFlat::pack_1 (const uint8_t *flat_code, size_t offset, uint8_t *block) const final pack_1 + faiss::CodePackerFlat::pack_1 pack_1 const uint8_t * @@ -53,6 +55,7 @@ void faiss::CodePackerFlat::unpack_1 (const uint8_t *block, size_t offset, uint8_t *flat_code) const final unpack_1 + faiss::CodePackerFlat::unpack_1 unpack_1 const uint8_t * @@ -79,6 +82,7 @@ void faiss::CodePackerFlat::pack_all (const uint8_t *flat_codes, uint8_t *block) const final pack_all + faiss::CodePackerFlat::pack_all pack_all const uint8_t * @@ -101,6 +105,7 @@ void faiss::CodePackerFlat::unpack_all (const uint8_t *block, uint8_t *flat_codes) const final unpack_all + faiss::CodePackerFlat::unpack_all unpack_all const uint8_t * @@ -118,13 +123,14 @@ - - + + size_t size_t faiss::CodePacker::code_size code_size + faiss::CodePacker::code_size @@ -138,6 +144,7 @@ size_t faiss::CodePacker::nvec nvec + faiss::CodePacker::nvec @@ -151,6 +158,7 @@ size_t faiss::CodePacker::block_size block_size + faiss::CodePacker::block_size @@ -159,7 +167,7 @@ - + diff --git a/xml/structfaiss_1_1CodePackerPQ4.xml b/xml/structfaiss_1_1CodePackerPQ4.xml index cca54781db..5d61805621 100644 --- a/xml/structfaiss_1_1CodePackerPQ4.xml +++ b/xml/structfaiss_1_1CodePackerPQ4.xml @@ -1,15 +1,16 @@ - + faiss::CodePackerPQ4 faiss::CodePacker pq4_fast_scan.h - + size_t size_t faiss::CodePackerPQ4::nsq nsq + faiss::CodePackerPQ4::nsq @@ -23,6 +24,7 @@ size_t faiss::CodePacker::code_size code_size + faiss::CodePacker::code_size @@ -36,6 +38,7 @@ size_t faiss::CodePacker::nvec nvec + faiss::CodePacker::nvec @@ -49,6 +52,7 @@ size_t faiss::CodePacker::block_size block_size + faiss::CodePacker::block_size @@ -57,13 +61,14 @@ - - + + faiss::CodePackerPQ4::CodePackerPQ4 (size_t nsq, size_t bbs) CodePackerPQ4 + faiss::CodePackerPQ4::CodePackerPQ4 size_t nsq @@ -85,6 +90,7 @@ void faiss::CodePackerPQ4::pack_1 (const uint8_t *flat_code, size_t offset, uint8_t *block) const final pack_1 + faiss::CodePackerPQ4::pack_1 pack_1 const uint8_t * @@ -111,6 +117,7 @@ void faiss::CodePackerPQ4::unpack_1 (const uint8_t *block, size_t offset, uint8_t *flat_code) const final unpack_1 + faiss::CodePackerPQ4::unpack_1 unpack_1 const uint8_t * @@ -137,6 +144,7 @@ virtual void faiss::CodePacker::pack_all (const uint8_t *flat_codes, uint8_t *block) const pack_all + faiss::CodePacker::pack_all pack_all const uint8_t * @@ -159,6 +167,7 @@ virtual void faiss::CodePacker::unpack_all (const uint8_t *block, uint8_t *flat_codes) const unpack_all + faiss::CodePacker::unpack_all unpack_all const uint8_t * @@ -176,7 +185,7 @@ - + diff --git a/xml/structfaiss_1_1CodeSet.xml b/xml/structfaiss_1_1CodeSet.xml index 8e5f568d41..1fd6775fb0 100644 --- a/xml/structfaiss_1_1CodeSet.xml +++ b/xml/structfaiss_1_1CodeSet.xml @@ -1,13 +1,14 @@ - + faiss::CodeSet - + size_t size_t faiss::CodeSet::d d + faiss::CodeSet::d @@ -21,6 +22,7 @@ std::set<std::vector<uint8_t> > faiss::CodeSet::s s + faiss::CodeSet::s @@ -29,13 +31,14 @@ - - + + faiss::CodeSet::CodeSet (size_t d) CodeSet + faiss::CodeSet::CodeSet size_t d @@ -53,6 +56,7 @@ void faiss::CodeSet::insert (size_t n, const uint8_t *codes, bool *inserted) insert + faiss::CodeSet::insert size_t n @@ -73,7 +77,7 @@ - + diff --git a/xml/structfaiss_1_1CombinerRangeKNN.xml b/xml/structfaiss_1_1CombinerRangeKNN.xml index 55779ecb0a..9c0190c80a 100644 --- a/xml/structfaiss_1_1CombinerRangeKNN.xml +++ b/xml/structfaiss_1_1CombinerRangeKNN.xml @@ -1,5 +1,5 @@ - + faiss::CombinerRangeKNN utils.h @@ -8,12 +8,13 @@ typename T - + int64_t int64_t faiss::CombinerRangeKNN< T >::nq nq + faiss::CombinerRangeKNN::nq @@ -27,6 +28,7 @@ size_t faiss::CombinerRangeKNN< T >::k k + faiss::CombinerRangeKNN::k nb of queries @@ -41,6 +43,7 @@ T faiss::CombinerRangeKNN< T >::r2 r2 + faiss::CombinerRangeKNN::r2 number of neighbors for the knn search part @@ -55,6 +58,7 @@ bool faiss::CombinerRangeKNN< T >::keep_max keep_max + faiss::CombinerRangeKNN::keep_max range search radius @@ -69,6 +73,7 @@ const int64_t* faiss::CombinerRangeKNN< T >::I I + faiss::CombinerRangeKNN::I = nullptr Knn search results. @@ -84,6 +89,7 @@ const T* faiss::CombinerRangeKNN< T >::D D + faiss::CombinerRangeKNN::D = nullptr size nq * k @@ -99,6 +105,7 @@ const bool* faiss::CombinerRangeKNN< T >::mask mask + faiss::CombinerRangeKNN::mask = nullptr @@ -116,6 +123,7 @@ const int64_t* faiss::CombinerRangeKNN< T >::lim_remain lim_remain + faiss::CombinerRangeKNN::lim_remain = nullptr mask for where knn results are valid, size nq @@ -131,6 +139,7 @@ const T* faiss::CombinerRangeKNN< T >::D_remain D_remain + faiss::CombinerRangeKNN::D_remain = nullptr size nrange + 1 @@ -146,6 +155,7 @@ const int64_t* faiss::CombinerRangeKNN< T >::I_remain I_remain + faiss::CombinerRangeKNN::I_remain = nullptr size lim_remain[nrange] @@ -161,6 +171,7 @@ const int64_t* faiss::CombinerRangeKNN< T >::L_res L_res + faiss::CombinerRangeKNN::L_res = nullptr size lim_remain[nrange] @@ -171,13 +182,14 @@ - - + + faiss::CombinerRangeKNN< T >::CombinerRangeKNN (int64_t nq, size_t k, T r2, bool keep_max) CombinerRangeKNN + faiss::CombinerRangeKNN::CombinerRangeKNN int64_t nq @@ -208,6 +220,7 @@ void faiss::CombinerRangeKNN< T >::compute_sizes (int64_t *L_res) compute_sizes + faiss::CombinerRangeKNN::compute_sizes int64_t * L_res @@ -226,6 +239,7 @@ void faiss::CombinerRangeKNN< T >::write_result (T *D_res, int64_t *I_res) write_result + faiss::CombinerRangeKNN::write_result T * D_res @@ -243,7 +257,7 @@ - + diff --git a/xml/structfaiss_1_1DirectMap.xml b/xml/structfaiss_1_1DirectMap.xml index 36fc942349..12b8c0dca1 100644 --- a/xml/structfaiss_1_1DirectMap.xml +++ b/xml/structfaiss_1_1DirectMap.xml @@ -1,12 +1,13 @@ - + faiss::DirectMap DirectMap.h - + Type + faiss::DirectMap::Type NoMap = 0 @@ -39,13 +40,14 @@ - - + + Type Type faiss::DirectMap::type type + faiss::DirectMap::type @@ -59,6 +61,7 @@ std::vector<idx_t> faiss::DirectMap::array array + faiss::DirectMap::array map for direct access to the elements. Map ids to LO-encoded entries. @@ -73,6 +76,7 @@ std::unordered_map<idx_t, idx_t> faiss::DirectMap::hashtable hashtable + faiss::DirectMap::hashtable @@ -81,13 +85,14 @@ - - + + faiss::DirectMap::DirectMap () DirectMap + faiss::DirectMap::DirectMap @@ -101,6 +106,7 @@ void faiss::DirectMap::set_type (Type new_type, const InvertedLists *invlists, size_t ntotal) set_type + faiss::DirectMap::set_type Type new_type @@ -127,6 +133,7 @@ idx_t faiss::DirectMap::get (idx_t id) const get + faiss::DirectMap::get idx_t id @@ -145,6 +152,7 @@ bool faiss::DirectMap::no () const no + faiss::DirectMap::no for quick checks @@ -159,6 +167,7 @@ void faiss::DirectMap::check_can_add (const idx_t *ids) check_can_add + faiss::DirectMap::check_can_add const idx_t * ids @@ -178,6 +187,7 @@ void faiss::DirectMap::add_single_id (idx_t id, idx_t list_no, size_t offset) add_single_id + faiss::DirectMap::add_single_id idx_t id @@ -204,6 +214,7 @@ void faiss::DirectMap::clear () clear + faiss::DirectMap::clear remove all entries @@ -218,6 +229,7 @@ size_t faiss::DirectMap::remove_ids (const IDSelector &sel, InvertedLists *invlists) remove_ids + faiss::DirectMap::remove_ids const IDSelector & sel @@ -241,6 +253,7 @@ void faiss::DirectMap::update_codes (InvertedLists *invlists, int n, const idx_t *ids, const idx_t *list_nos, const uint8_t *codes) update_codes + faiss::DirectMap::update_codes InvertedLists * invlists @@ -270,7 +283,7 @@ - + diff --git a/xml/structfaiss_1_1DirectMapAdd.xml b/xml/structfaiss_1_1DirectMapAdd.xml index 88a967a0fa..71468770ac 100644 --- a/xml/structfaiss_1_1DirectMapAdd.xml +++ b/xml/structfaiss_1_1DirectMapAdd.xml @@ -1,14 +1,15 @@ - + faiss::DirectMapAdd DirectMap.h - + DirectMap::Type using faiss::DirectMapAdd::Type = DirectMap::Type Type + faiss::DirectMapAdd::Type @@ -17,13 +18,14 @@ - - + + DirectMap & DirectMap& faiss::DirectMapAdd::direct_map direct_map + faiss::DirectMapAdd::direct_map @@ -37,6 +39,7 @@ DirectMap::Type faiss::DirectMapAdd::type type + faiss::DirectMapAdd::type @@ -50,6 +53,7 @@ size_t faiss::DirectMapAdd::ntotal ntotal + faiss::DirectMapAdd::ntotal @@ -63,6 +67,7 @@ size_t faiss::DirectMapAdd::n n + faiss::DirectMapAdd::n @@ -76,6 +81,7 @@ const idx_t* faiss::DirectMapAdd::xids xids + faiss::DirectMapAdd::xids @@ -89,6 +95,7 @@ std::vector<idx_t> faiss::DirectMapAdd::all_ofs all_ofs + faiss::DirectMapAdd::all_ofs @@ -97,13 +104,14 @@ - - + + faiss::DirectMapAdd::DirectMapAdd (DirectMap &direct_map, size_t n, const idx_t *xids) DirectMapAdd + faiss::DirectMapAdd::DirectMapAdd DirectMap & direct_map @@ -129,6 +137,7 @@ void faiss::DirectMapAdd::add (size_t i, idx_t list_no, size_t offset) add + faiss::DirectMapAdd::add size_t i @@ -155,6 +164,7 @@ faiss::DirectMapAdd::~DirectMapAdd () ~DirectMapAdd + faiss::DirectMapAdd::~DirectMapAdd @@ -163,7 +173,7 @@ - + Thread-safe way of updating the direct_map. diff --git a/xml/structfaiss_1_1DistanceComputer.xml b/xml/structfaiss_1_1DistanceComputer.xml index bf80222cc1..ac154a74ab 100644 --- a/xml/structfaiss_1_1DistanceComputer.xml +++ b/xml/structfaiss_1_1DistanceComputer.xml @@ -1,15 +1,16 @@ - + faiss::DistanceComputer faiss::FlatCodesDistanceComputer faiss::NegativeDistanceComputer - + void virtual void faiss::DistanceComputer::set_query (const float *x)=0 set_query + faiss::DistanceComputer::set_query set_query const float * @@ -29,6 +30,7 @@ virtual float faiss::DistanceComputer::operator() (idx_t i)=0 operator() + faiss::DistanceComputer::operator() operator() operator() @@ -49,6 +51,7 @@ virtual void faiss::DistanceComputer::distances_batch_4 (const idx_t idx0, const idx_t idx1, const idx_t idx2, const idx_t idx3, float &dis0, float &dis1, float &dis2, float &dis3) distances_batch_4 + faiss::DistanceComputer::distances_batch_4 distances_batch_4 const idx_t @@ -96,6 +99,7 @@ virtual float faiss::DistanceComputer::symmetric_dis (idx_t i, idx_t j)=0 symmetric_dis + faiss::DistanceComputer::symmetric_dis symmetric_dis idx_t @@ -119,6 +123,7 @@ virtual faiss::DistanceComputer::~DistanceComputer () ~DistanceComputer + faiss::DistanceComputer::~DistanceComputer @@ -127,12 +132,22 @@ - + + + + + + + + + + + @@ -145,16 +160,6 @@ - - - - - - - - - - diff --git a/xml/structfaiss_1_1DummyScaler.xml b/xml/structfaiss_1_1DummyScaler.xml index 2a7d971ed8..3cc099b75a 100644 --- a/xml/structfaiss_1_1DummyScaler.xml +++ b/xml/structfaiss_1_1DummyScaler.xml @@ -1,14 +1,15 @@ - + faiss::DummyScaler LookupTableScaler.h - + constexpr int constexpr int faiss::DummyScaler::nscale nscale + faiss::DummyScaler::nscale = 0 @@ -18,13 +19,14 @@ - - + + simd32uint8 simd32uint8 faiss::DummyScaler::lookup (const simd32uint8 &, const simd32uint8 &) const lookup + faiss::DummyScaler::lookup const simd32uint8 & @@ -44,6 +46,7 @@ simd16uint16 faiss::DummyScaler::scale_lo (const simd32uint8 &) const scale_lo + faiss::DummyScaler::scale_lo const simd32uint8 & @@ -60,6 +63,7 @@ simd16uint16 faiss::DummyScaler::scale_hi (const simd32uint8 &) const scale_hi + faiss::DummyScaler::scale_hi const simd32uint8 & @@ -81,6 +85,7 @@ dist_t faiss::DummyScaler::scale_one (const dist_t &) const scale_one + faiss::DummyScaler::scale_one const dist_t & @@ -92,7 +97,7 @@ - + no-op handler diff --git a/xml/structfaiss_1_1EnumeratedVectors.xml b/xml/structfaiss_1_1EnumeratedVectors.xml index c0d516172a..ac346bba1a 100644 --- a/xml/structfaiss_1_1EnumeratedVectors.xml +++ b/xml/structfaiss_1_1EnumeratedVectors.xml @@ -1,15 +1,16 @@ - + faiss::EnumeratedVectors faiss::ZnSphereCodec faiss::ZnSphereCodecRec - + uint64_t uint64_t faiss::EnumeratedVectors::nv nv + faiss::EnumeratedVectors::nv size of the collection @@ -24,6 +25,7 @@ int faiss::EnumeratedVectors::dim dim + faiss::EnumeratedVectors::dim @@ -32,13 +34,14 @@ - - + + faiss::EnumeratedVectors::EnumeratedVectors (int dim) EnumeratedVectors + faiss::EnumeratedVectors::EnumeratedVectors int dim @@ -56,6 +59,7 @@ virtual uint64_t faiss::EnumeratedVectors::encode (const float *x) const =0 encode + faiss::EnumeratedVectors::encode encode encode encode @@ -77,6 +81,7 @@ virtual void faiss::EnumeratedVectors::decode (uint64_t code, float *c) const =0 decode + faiss::EnumeratedVectors::decode decode decode decode @@ -102,6 +107,7 @@ void faiss::EnumeratedVectors::encode_multi (size_t nc, const float *c, uint64_t *codes) const encode_multi + faiss::EnumeratedVectors::encode_multi size_t nc @@ -127,6 +133,7 @@ void faiss::EnumeratedVectors::decode_multi (size_t nc, const uint64_t *codes, float *c) const decode_multi + faiss::EnumeratedVectors::decode_multi size_t nc @@ -152,6 +159,7 @@ void faiss::EnumeratedVectors::find_nn (size_t n, const uint64_t *codes, size_t nq, const float *xq, int64_t *idx, float *dis) find_nn + faiss::EnumeratedVectors::find_nn size_t n @@ -189,6 +197,7 @@ virtual faiss::EnumeratedVectors::~EnumeratedVectors () ~EnumeratedVectors + faiss::EnumeratedVectors::~EnumeratedVectors @@ -197,12 +206,22 @@ - + + + + + + + + + + + @@ -215,16 +234,6 @@ - - - - - - - - - - diff --git a/xml/structfaiss_1_1FastScanStats.xml b/xml/structfaiss_1_1FastScanStats.xml index 4509156040..e5d34ac2e9 100644 --- a/xml/structfaiss_1_1FastScanStats.xml +++ b/xml/structfaiss_1_1FastScanStats.xml @@ -1,94 +1,100 @@ - + faiss::FastScanStats - + uint64_t uint64_t faiss::FastScanStats::t0 t0 + faiss::FastScanStats::t0 - + uint64_t uint64_t faiss::FastScanStats::t1 t1 + faiss::FastScanStats::t1 - + uint64_t uint64_t faiss::FastScanStats::t2 t2 + faiss::FastScanStats::t2 - + uint64_t uint64_t faiss::FastScanStats::t3 t3 + faiss::FastScanStats::t3 - + - - + + faiss::FastScanStats::FastScanStats () FastScanStats + faiss::FastScanStats::FastScanStats - + void void faiss::FastScanStats::reset () reset + faiss::FastScanStats::reset - + - + - + faiss::FastScanStatsFastScanStats faiss::FastScanStatsreset diff --git a/xml/structfaiss_1_1FileIOReader.xml b/xml/structfaiss_1_1FileIOReader.xml index 4439f252c1..b3b4153a32 100644 --- a/xml/structfaiss_1_1FileIOReader.xml +++ b/xml/structfaiss_1_1FileIOReader.xml @@ -1,14 +1,15 @@ - + faiss::FileIOReader faiss::IOReader - + FILE * FILE* faiss::FileIOReader::f f + faiss::FileIOReader::f = nullptr @@ -23,6 +24,7 @@ bool faiss::FileIOReader::need_close need_close + faiss::FileIOReader::need_close = false @@ -37,6 +39,7 @@ std::string faiss::IOReader::name name + faiss::IOReader::name @@ -45,13 +48,14 @@ - - + + faiss::FileIOReader::FileIOReader (FILE *rf) FileIOReader + faiss::FileIOReader::FileIOReader FILE * rf @@ -69,6 +73,7 @@ faiss::FileIOReader::FileIOReader (const char *fname) FileIOReader + faiss::FileIOReader::FileIOReader const char * fname @@ -86,6 +91,7 @@ faiss::FileIOReader::~FileIOReader () override ~FileIOReader + faiss::FileIOReader::~FileIOReader @@ -99,6 +105,7 @@ size_t faiss::FileIOReader::operator() (void *ptr, size_t size, size_t nitems) override operator() + faiss::FileIOReader::operator() operator() void * @@ -125,6 +132,7 @@ int faiss::FileIOReader::filedescriptor () override filedescriptor + faiss::FileIOReader::filedescriptor filedescriptor @@ -134,7 +142,7 @@ - + diff --git a/xml/structfaiss_1_1FileIOWriter.xml b/xml/structfaiss_1_1FileIOWriter.xml index f7c37c811b..acab171957 100644 --- a/xml/structfaiss_1_1FileIOWriter.xml +++ b/xml/structfaiss_1_1FileIOWriter.xml @@ -1,14 +1,15 @@ - + faiss::FileIOWriter faiss::IOWriter - + FILE * FILE* faiss::FileIOWriter::f f + faiss::FileIOWriter::f = nullptr @@ -23,6 +24,7 @@ bool faiss::FileIOWriter::need_close need_close + faiss::FileIOWriter::need_close = false @@ -37,6 +39,7 @@ std::string faiss::IOWriter::name name + faiss::IOWriter::name @@ -45,13 +48,14 @@ - - + + faiss::FileIOWriter::FileIOWriter (FILE *wf) FileIOWriter + faiss::FileIOWriter::FileIOWriter FILE * wf @@ -69,6 +73,7 @@ faiss::FileIOWriter::FileIOWriter (const char *fname) FileIOWriter + faiss::FileIOWriter::FileIOWriter const char * fname @@ -86,6 +91,7 @@ faiss::FileIOWriter::~FileIOWriter () override ~FileIOWriter + faiss::FileIOWriter::~FileIOWriter @@ -99,6 +105,7 @@ size_t faiss::FileIOWriter::operator() (const void *ptr, size_t size, size_t nitems) override operator() + faiss::FileIOWriter::operator() operator() const void * @@ -125,6 +132,7 @@ int faiss::FileIOWriter::filedescriptor () override filedescriptor + faiss::FileIOWriter::filedescriptor filedescriptor @@ -134,34 +142,34 @@ - + - - - - - - + + + + + + diff --git a/xml/structfaiss_1_1FlatCodesDistanceComputer.xml b/xml/structfaiss_1_1FlatCodesDistanceComputer.xml index 4ae651526b..1a3636f22a 100644 --- a/xml/structfaiss_1_1FlatCodesDistanceComputer.xml +++ b/xml/structfaiss_1_1FlatCodesDistanceComputer.xml @@ -1,15 +1,16 @@ - + faiss::FlatCodesDistanceComputer faiss::DistanceComputer faiss::ScalarQuantizer::SQDistanceComputer - + const uint8_t * const uint8_t* faiss::FlatCodesDistanceComputer::codes codes + faiss::FlatCodesDistanceComputer::codes @@ -23,6 +24,7 @@ size_t faiss::FlatCodesDistanceComputer::code_size code_size + faiss::FlatCodesDistanceComputer::code_size @@ -31,13 +33,14 @@ - - + + faiss::FlatCodesDistanceComputer::FlatCodesDistanceComputer (const uint8_t *codes, size_t code_size) FlatCodesDistanceComputer + faiss::FlatCodesDistanceComputer::FlatCodesDistanceComputer const uint8_t * codes @@ -59,6 +62,7 @@ faiss::FlatCodesDistanceComputer::FlatCodesDistanceComputer () FlatCodesDistanceComputer + faiss::FlatCodesDistanceComputer::FlatCodesDistanceComputer @@ -72,6 +76,7 @@ float faiss::FlatCodesDistanceComputer::operator() (idx_t i) override operator() + faiss::FlatCodesDistanceComputer::operator() operator() idx_t @@ -91,6 +96,7 @@ virtual float faiss::FlatCodesDistanceComputer::distance_to_code (const uint8_t *code)=0 distance_to_code + faiss::FlatCodesDistanceComputer::distance_to_code distance_to_code const uint8_t * @@ -110,6 +116,7 @@ virtual faiss::FlatCodesDistanceComputer::~FlatCodesDistanceComputer () ~FlatCodesDistanceComputer + faiss::FlatCodesDistanceComputer::~FlatCodesDistanceComputer @@ -123,6 +130,7 @@ virtual void faiss::DistanceComputer::set_query (const float *x)=0 set_query + faiss::DistanceComputer::set_query set_query const float * @@ -142,6 +150,7 @@ virtual void faiss::DistanceComputer::distances_batch_4 (const idx_t idx0, const idx_t idx1, const idx_t idx2, const idx_t idx3, float &dis0, float &dis1, float &dis2, float &dis3) distances_batch_4 + faiss::DistanceComputer::distances_batch_4 distances_batch_4 const idx_t @@ -189,6 +198,7 @@ virtual float faiss::DistanceComputer::symmetric_dis (idx_t i, idx_t j)=0 symmetric_dis + faiss::DistanceComputer::symmetric_dis symmetric_dis idx_t @@ -207,17 +217,15 @@ - + - - - - - + + + @@ -225,22 +233,24 @@ + + + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1GenHammingComputer16.xml b/xml/structfaiss_1_1GenHammingComputer16.xml index 8d4da025b1..54d0ffa001 100644 --- a/xml/structfaiss_1_1GenHammingComputer16.xml +++ b/xml/structfaiss_1_1GenHammingComputer16.xml @@ -1,13 +1,14 @@ - + faiss::GenHammingComputer16 - + __m128i __m128i faiss::GenHammingComputer16::a a + faiss::GenHammingComputer16::a @@ -21,6 +22,7 @@ uint64_t faiss::GenHammingComputer16::a0 a0 + faiss::GenHammingComputer16::a0 @@ -34,6 +36,7 @@ uint64_t faiss::GenHammingComputer16::a1 a1 + faiss::GenHammingComputer16::a1 @@ -42,13 +45,14 @@ - - + + faiss::GenHammingComputer16::GenHammingComputer16 (const uint8_t *a8, int code_size) GenHammingComputer16 + faiss::GenHammingComputer16::GenHammingComputer16 const uint8_t * a8 @@ -70,6 +74,7 @@ int faiss::GenHammingComputer16::hamming (const uint8_t *b8) const hamming + faiss::GenHammingComputer16::hamming const uint8_t * b8 @@ -87,6 +92,7 @@ faiss::GenHammingComputer16::GenHammingComputer16 (const uint8_t *a8, int code_size) GenHammingComputer16 + faiss::GenHammingComputer16::GenHammingComputer16 const uint8_t * a8 @@ -108,6 +114,7 @@ int faiss::GenHammingComputer16::hamming (const uint8_t *b8) const hamming + faiss::GenHammingComputer16::hamming const uint8_t * b8 @@ -125,6 +132,7 @@ faiss::GenHammingComputer16::GenHammingComputer16 (const uint8_t *a8, int code_size) GenHammingComputer16 + faiss::GenHammingComputer16::GenHammingComputer16 const uint8_t * a8 @@ -146,6 +154,7 @@ int faiss::GenHammingComputer16::hamming (const uint8_t *b8) const hamming + faiss::GenHammingComputer16::hamming const uint8_t * b8 @@ -158,13 +167,14 @@ - - + + constexpr int static constexpr int faiss::GenHammingComputer16::get_code_size () get_code_size + faiss::GenHammingComputer16::get_code_size @@ -178,6 +188,7 @@ static constexpr int faiss::GenHammingComputer16::get_code_size () get_code_size + faiss::GenHammingComputer16::get_code_size @@ -191,6 +202,7 @@ static constexpr int faiss::GenHammingComputer16::get_code_size () get_code_size + faiss::GenHammingComputer16::get_code_size @@ -199,7 +211,7 @@ - + diff --git a/xml/structfaiss_1_1GenHammingComputer32.xml b/xml/structfaiss_1_1GenHammingComputer32.xml index d0d8e5660e..a52f035151 100644 --- a/xml/structfaiss_1_1GenHammingComputer32.xml +++ b/xml/structfaiss_1_1GenHammingComputer32.xml @@ -1,13 +1,14 @@ - + faiss::GenHammingComputer32 - + __m256i __m256i faiss::GenHammingComputer32::a a + faiss::GenHammingComputer32::a @@ -21,6 +22,7 @@ uint64_t faiss::GenHammingComputer32::a0 a0 + faiss::GenHammingComputer32::a0 @@ -34,6 +36,7 @@ uint64_t faiss::GenHammingComputer32::a1 a1 + faiss::GenHammingComputer32::a1 @@ -47,6 +50,7 @@ uint64_t faiss::GenHammingComputer32::a2 a2 + faiss::GenHammingComputer32::a2 @@ -60,6 +64,7 @@ uint64_t faiss::GenHammingComputer32::a3 a3 + faiss::GenHammingComputer32::a3 @@ -68,13 +73,14 @@ - - + + faiss::GenHammingComputer32::GenHammingComputer32 (const uint8_t *a8, int code_size) GenHammingComputer32 + faiss::GenHammingComputer32::GenHammingComputer32 const uint8_t * a8 @@ -96,6 +102,7 @@ int faiss::GenHammingComputer32::hamming (const uint8_t *b8) const hamming + faiss::GenHammingComputer32::hamming const uint8_t * b8 @@ -113,6 +120,7 @@ faiss::GenHammingComputer32::GenHammingComputer32 (const uint8_t *a8, int code_size) GenHammingComputer32 + faiss::GenHammingComputer32::GenHammingComputer32 const uint8_t * a8 @@ -134,6 +142,7 @@ int faiss::GenHammingComputer32::hamming (const uint8_t *b8) const hamming + faiss::GenHammingComputer32::hamming const uint8_t * b8 @@ -151,6 +160,7 @@ faiss::GenHammingComputer32::GenHammingComputer32 (const uint8_t *a8, int code_size) GenHammingComputer32 + faiss::GenHammingComputer32::GenHammingComputer32 const uint8_t * a8 @@ -172,6 +182,7 @@ int faiss::GenHammingComputer32::hamming (const uint8_t *b8) const hamming + faiss::GenHammingComputer32::hamming const uint8_t * b8 @@ -184,13 +195,14 @@ - - + + constexpr int static constexpr int faiss::GenHammingComputer32::get_code_size () get_code_size + faiss::GenHammingComputer32::get_code_size @@ -204,6 +216,7 @@ static constexpr int faiss::GenHammingComputer32::get_code_size () get_code_size + faiss::GenHammingComputer32::get_code_size @@ -217,6 +230,7 @@ static constexpr int faiss::GenHammingComputer32::get_code_size () get_code_size + faiss::GenHammingComputer32::get_code_size @@ -225,7 +239,7 @@ - + diff --git a/xml/structfaiss_1_1GenHammingComputer8.xml b/xml/structfaiss_1_1GenHammingComputer8.xml index 97c371aa2a..ecaefcecbc 100644 --- a/xml/structfaiss_1_1GenHammingComputer8.xml +++ b/xml/structfaiss_1_1GenHammingComputer8.xml @@ -1,13 +1,14 @@ - + faiss::GenHammingComputer8 - + uint64_t uint64_t faiss::GenHammingComputer8::a0 a0 + faiss::GenHammingComputer8::a0 @@ -16,13 +17,14 @@ - - + + faiss::GenHammingComputer8::GenHammingComputer8 (const uint8_t *a, int code_size) GenHammingComputer8 + faiss::GenHammingComputer8::GenHammingComputer8 const uint8_t * a @@ -44,6 +46,7 @@ int faiss::GenHammingComputer8::hamming (const uint8_t *b) const hamming + faiss::GenHammingComputer8::hamming const uint8_t * b @@ -61,6 +64,7 @@ faiss::GenHammingComputer8::GenHammingComputer8 (const uint8_t *a, int code_size) GenHammingComputer8 + faiss::GenHammingComputer8::GenHammingComputer8 const uint8_t * a @@ -82,6 +86,7 @@ int faiss::GenHammingComputer8::hamming (const uint8_t *b) const hamming + faiss::GenHammingComputer8::hamming const uint8_t * b @@ -99,6 +104,7 @@ faiss::GenHammingComputer8::GenHammingComputer8 (const uint8_t *a, int code_size) GenHammingComputer8 + faiss::GenHammingComputer8::GenHammingComputer8 const uint8_t * a @@ -120,6 +126,7 @@ int faiss::GenHammingComputer8::hamming (const uint8_t *b) const hamming + faiss::GenHammingComputer8::hamming const uint8_t * b @@ -132,13 +139,14 @@ - - + + constexpr int static constexpr int faiss::GenHammingComputer8::get_code_size () get_code_size + faiss::GenHammingComputer8::get_code_size @@ -152,6 +160,7 @@ static constexpr int faiss::GenHammingComputer8::get_code_size () get_code_size + faiss::GenHammingComputer8::get_code_size @@ -165,6 +174,7 @@ static constexpr int faiss::GenHammingComputer8::get_code_size () get_code_size + faiss::GenHammingComputer8::get_code_size @@ -173,7 +183,7 @@ - + diff --git a/xml/structfaiss_1_1GenHammingComputerM8.xml b/xml/structfaiss_1_1GenHammingComputerM8.xml index 32ad1abed1..fb74a1c4b4 100644 --- a/xml/structfaiss_1_1GenHammingComputerM8.xml +++ b/xml/structfaiss_1_1GenHammingComputerM8.xml @@ -1,13 +1,14 @@ - + faiss::GenHammingComputerM8 - + const uint64_t * const uint64_t * faiss::GenHammingComputerM8::a a + faiss::GenHammingComputerM8::a @@ -21,6 +22,7 @@ int faiss::GenHammingComputerM8::n n + faiss::GenHammingComputerM8::n @@ -29,13 +31,14 @@ - - + + faiss::GenHammingComputerM8::GenHammingComputerM8 (const uint8_t *a8, int code_size) GenHammingComputerM8 + faiss::GenHammingComputerM8::GenHammingComputerM8 const uint8_t * a8 @@ -57,6 +60,7 @@ int faiss::GenHammingComputerM8::hamming (const uint8_t *b8) const hamming + faiss::GenHammingComputerM8::hamming const uint8_t * b8 @@ -74,6 +78,7 @@ int faiss::GenHammingComputerM8::get_code_size () const get_code_size + faiss::GenHammingComputerM8::get_code_size @@ -87,6 +92,7 @@ faiss::GenHammingComputerM8::GenHammingComputerM8 (const uint8_t *a8, int code_size) GenHammingComputerM8 + faiss::GenHammingComputerM8::GenHammingComputerM8 const uint8_t * a8 @@ -108,6 +114,7 @@ int faiss::GenHammingComputerM8::hamming (const uint8_t *b8) const hamming + faiss::GenHammingComputerM8::hamming const uint8_t * b8 @@ -125,6 +132,7 @@ int faiss::GenHammingComputerM8::get_code_size () const get_code_size + faiss::GenHammingComputerM8::get_code_size @@ -138,6 +146,7 @@ faiss::GenHammingComputerM8::GenHammingComputerM8 (const uint8_t *a8, int code_size) GenHammingComputerM8 + faiss::GenHammingComputerM8::GenHammingComputerM8 const uint8_t * a8 @@ -159,6 +168,7 @@ int faiss::GenHammingComputerM8::hamming (const uint8_t *b8) const hamming + faiss::GenHammingComputerM8::hamming const uint8_t * b8 @@ -176,6 +186,7 @@ int faiss::GenHammingComputerM8::get_code_size () const get_code_size + faiss::GenHammingComputerM8::get_code_size @@ -184,7 +195,7 @@ - + diff --git a/xml/structfaiss_1_1HCounterState.xml b/xml/structfaiss_1_1HCounterState.xml index 80add89c1a..da118dc6f9 100644 --- a/xml/structfaiss_1_1HCounterState.xml +++ b/xml/structfaiss_1_1HCounterState.xml @@ -1,5 +1,5 @@ - + faiss::HCounterState hamming-inl.h @@ -8,12 +8,13 @@ class HammingComputer - + int * int* faiss::HCounterState< HammingComputer >::counters counters + faiss::HCounterState::counters @@ -27,6 +28,7 @@ int64_t* faiss::HCounterState< HammingComputer >::ids_per_dis ids_per_dis + faiss::HCounterState::ids_per_dis @@ -40,6 +42,7 @@ HammingComputer faiss::HCounterState< HammingComputer >::hc hc + faiss::HCounterState::hc @@ -53,6 +56,7 @@ int faiss::HCounterState< HammingComputer >::thres thres + faiss::HCounterState::thres @@ -66,6 +70,7 @@ int faiss::HCounterState< HammingComputer >::count_lt count_lt + faiss::HCounterState::count_lt @@ -79,6 +84,7 @@ int faiss::HCounterState< HammingComputer >::count_eq count_eq + faiss::HCounterState::count_eq @@ -92,6 +98,7 @@ int faiss::HCounterState< HammingComputer >::k k + faiss::HCounterState::k @@ -100,13 +107,14 @@ - - + + faiss::HCounterState< HammingComputer >::HCounterState (int *counters, int64_t *ids_per_dis, const uint8_t *x, int d, int k) HCounterState + faiss::HCounterState::HCounterState int * counters @@ -140,6 +148,7 @@ void faiss::HCounterState< HammingComputer >::update_counter (const uint8_t *y, size_t j) update_counter + faiss::HCounterState::update_counter const uint8_t * y @@ -156,7 +165,7 @@ - + @@ -164,10 +173,6 @@ Since the distances are in a limited range (0 to nbit), the object maintains one list per possible distance, and fills in only the n-first lists, such that the sum of sizes of the n lists is below k. - - - - @@ -181,6 +186,10 @@ + + + + diff --git a/xml/structfaiss_1_1HNSW.xml b/xml/structfaiss_1_1HNSW.xml index 396c043f3b..780216cae4 100644 --- a/xml/structfaiss_1_1HNSW.xml +++ b/xml/structfaiss_1_1HNSW.xml @@ -1,16 +1,17 @@ - + faiss::HNSW faiss::HNSW::MinimaxHeap faiss::HNSW::NodeDistCloser faiss::HNSW::NodeDistFarther - + int32_t using faiss::HNSW::storage_idx_t = int32_t storage_idx_t + faiss::HNSW::storage_idx_t internal storage of vectors (32 bits: this is expensive) @@ -25,6 +26,7 @@ using faiss::HNSW::C = CMax<float, int64_t> C + faiss::HNSW::C @@ -38,6 +40,7 @@ typedef std::pair<float, storage_idx_t> faiss::HNSW::Node Node + faiss::HNSW::Node @@ -46,13 +49,14 @@ - - + + std::vector< double > std::vector<double> faiss::HNSW::assign_probas assign_probas + faiss::HNSW::assign_probas assignment probability to each layer (sum=1) @@ -67,6 +71,7 @@ std::vector<int> faiss::HNSW::cum_nneighbor_per_level cum_nneighbor_per_level + faiss::HNSW::cum_nneighbor_per_level @@ -81,6 +86,7 @@ std::vector<int> faiss::HNSW::levels levels + faiss::HNSW::levels level of each vector (base level = 1), size = ntotal @@ -95,6 +101,7 @@ std::vector<size_t> faiss::HNSW::offsets offsets + faiss::HNSW::offsets @@ -109,6 +116,7 @@ std::vector<storage_idx_t> faiss::HNSW::neighbors neighbors + faiss::HNSW::neighbors @@ -123,6 +131,7 @@ storage_idx_t faiss::HNSW::entry_point entry_point + faiss::HNSW::entry_point = -1 @@ -138,6 +147,7 @@ faiss::RandomGenerator faiss::HNSW::rng rng + faiss::HNSW::rng @@ -151,6 +161,7 @@ int faiss::HNSW::max_level max_level + faiss::HNSW::max_level = -1 maximum level @@ -166,6 +177,7 @@ int faiss::HNSW::efConstruction efConstruction + faiss::HNSW::efConstruction = 40 expansion factor at construction time @@ -181,6 +193,7 @@ int faiss::HNSW::efSearch efSearch + faiss::HNSW::efSearch = 16 expansion factor at search time @@ -196,6 +209,7 @@ bool faiss::HNSW::check_relative_distance check_relative_distance + faiss::HNSW::check_relative_distance = true @@ -211,6 +225,7 @@ bool faiss::HNSW::search_bounded_queue search_bounded_queue + faiss::HNSW::search_bounded_queue = true use bounded queue during exploration @@ -221,13 +236,14 @@ - - + + void void faiss::HNSW::set_default_probas (int M, float levelMult) set_default_probas + faiss::HNSW::set_default_probas int M @@ -250,6 +266,7 @@ void faiss::HNSW::set_nb_neighbors (int level_no, int n) set_nb_neighbors + faiss::HNSW::set_nb_neighbors int level_no @@ -272,6 +289,7 @@ int faiss::HNSW::nb_neighbors (int layer_no) const nb_neighbors + faiss::HNSW::nb_neighbors int layer_no @@ -290,6 +308,7 @@ int faiss::HNSW::cum_nb_neighbors (int layer_no) const cum_nb_neighbors + faiss::HNSW::cum_nb_neighbors int layer_no @@ -308,6 +327,7 @@ void faiss::HNSW::neighbor_range (idx_t no, int layer_no, size_t *begin, size_t *end) const neighbor_range + faiss::HNSW::neighbor_range idx_t no @@ -338,6 +358,7 @@ faiss::HNSW::HNSW (int M=32) HNSW + faiss::HNSW::HNSW int M @@ -357,6 +378,7 @@ int faiss::HNSW::random_level () random_level + faiss::HNSW::random_level pick a random level for a new point @@ -371,6 +393,7 @@ void faiss::HNSW::fill_with_random_links (size_t n) fill_with_random_links + faiss::HNSW::fill_with_random_links size_t n @@ -389,6 +412,7 @@ void faiss::HNSW::add_links_starting_from (DistanceComputer &ptdis, storage_idx_t pt_id, storage_idx_t nearest, float d_nearest, int level, omp_lock_t *locks, VisitedTable &vt, bool keep_max_size_level0=false) add_links_starting_from + faiss::HNSW::add_links_starting_from DistanceComputer & ptdis @@ -435,6 +459,7 @@ void faiss::HNSW::add_with_locks (DistanceComputer &ptdis, int pt_level, int pt_id, std::vector< omp_lock_t > &locks, VisitedTable &vt, bool keep_max_size_level0=false) add_with_locks + faiss::HNSW::add_with_locks DistanceComputer & ptdis @@ -474,6 +499,7 @@ HNSWStats faiss::HNSW::search (DistanceComputer &qdis, ResultHandler< C > &res, VisitedTable &vt, const SearchParametersHNSW *params=nullptr) const search + faiss::HNSW::search DistanceComputer & qdis @@ -505,6 +531,7 @@ void faiss::HNSW::search_level_0 (DistanceComputer &qdis, ResultHandler< C > &res, idx_t nprobe, const storage_idx_t *nearest_i, const float *nearest_d, int search_type, HNSWStats &search_stats, VisitedTable &vt, const SearchParametersHNSW *params=nullptr) const search_level_0 + faiss::HNSW::search_level_0 DistanceComputer & qdis @@ -556,6 +583,7 @@ void faiss::HNSW::reset () reset + faiss::HNSW::reset @@ -569,6 +597,7 @@ void faiss::HNSW::clear_neighbor_tables (int level) clear_neighbor_tables + faiss::HNSW::clear_neighbor_tables int level @@ -586,6 +615,7 @@ void faiss::HNSW::print_neighbor_stats (int level) const print_neighbor_stats + faiss::HNSW::print_neighbor_stats int level @@ -603,6 +633,7 @@ int faiss::HNSW::prepare_level_tab (size_t n, bool preset_levels=false) prepare_level_tab + faiss::HNSW::prepare_level_tab size_t n @@ -625,6 +656,7 @@ void faiss::HNSW::permute_entries (const idx_t *map) permute_entries + faiss::HNSW::permute_entries const idx_t * map @@ -637,13 +669,14 @@ - - + + void static void faiss::HNSW::shrink_neighbor_list (DistanceComputer &qdis, std::priority_queue< NodeDistFarther > &input, std::vector< NodeDistFarther > &output, int max_size, bool keep_max_size_level0=false) shrink_neighbor_list + faiss::HNSW::shrink_neighbor_list DistanceComputer & qdis @@ -673,16 +706,12 @@ - + - - - - @@ -690,6 +719,10 @@ rng + + + + diff --git a/xml/structfaiss_1_1HNSWStats.xml b/xml/structfaiss_1_1HNSWStats.xml index f311bde547..e11bfb07da 100644 --- a/xml/structfaiss_1_1HNSWStats.xml +++ b/xml/structfaiss_1_1HNSWStats.xml @@ -1,13 +1,14 @@ - + faiss::HNSWStats - + size_t size_t faiss::HNSWStats::n1 n1 + faiss::HNSWStats::n1 = 0 @@ -22,6 +23,7 @@ size_t faiss::HNSWStats::n2 n2 + faiss::HNSWStats::n2 = 0 @@ -38,6 +40,7 @@ size_t faiss::HNSWStats::ndis ndis + faiss::HNSWStats::ndis = 0 number of queries for which the candidate list is exhausted @@ -53,6 +56,7 @@ size_t faiss::HNSWStats::nhops nhops + faiss::HNSWStats::nhops = 0 number of distances computed @@ -63,13 +67,14 @@ - - + + void void faiss::HNSWStats::reset () reset + faiss::HNSWStats::reset number of hops aka number of edges traversed @@ -84,6 +89,7 @@ void faiss::HNSWStats::combine (const HNSWStats &other) combine + faiss::HNSWStats::combine const HNSWStats & other @@ -96,7 +102,7 @@ - + diff --git a/xml/structfaiss_1_1HNSW_1_1MinimaxHeap.xml b/xml/structfaiss_1_1HNSW_1_1MinimaxHeap.xml index d371abcd82..0442d3aee1 100644 --- a/xml/structfaiss_1_1HNSW_1_1MinimaxHeap.xml +++ b/xml/structfaiss_1_1HNSW_1_1MinimaxHeap.xml @@ -1,14 +1,15 @@ - + faiss::HNSW::MinimaxHeap HNSW.h - + faiss::CMax< float, storage_idx_t > typedef faiss::CMax<float, storage_idx_t> faiss::HNSW::MinimaxHeap::HC HC + faiss::HNSW::MinimaxHeap::HC @@ -17,13 +18,14 @@ - - + + int int faiss::HNSW::MinimaxHeap::n n + faiss::HNSW::MinimaxHeap::n @@ -37,6 +39,7 @@ int faiss::HNSW::MinimaxHeap::k k + faiss::HNSW::MinimaxHeap::k @@ -50,6 +53,7 @@ int faiss::HNSW::MinimaxHeap::nvalid nvalid + faiss::HNSW::MinimaxHeap::nvalid @@ -63,6 +67,7 @@ std::vector<storage_idx_t> faiss::HNSW::MinimaxHeap::ids ids + faiss::HNSW::MinimaxHeap::ids @@ -76,6 +81,7 @@ std::vector<float> faiss::HNSW::MinimaxHeap::dis dis + faiss::HNSW::MinimaxHeap::dis @@ -84,13 +90,14 @@ - - + + faiss::HNSW::MinimaxHeap::MinimaxHeap (int n) MinimaxHeap + faiss::HNSW::MinimaxHeap::MinimaxHeap int n @@ -108,6 +115,7 @@ void faiss::HNSW::MinimaxHeap::push (storage_idx_t i, float v) push + faiss::HNSW::MinimaxHeap::push storage_idx_t i @@ -129,6 +137,7 @@ float faiss::HNSW::MinimaxHeap::max () const max + faiss::HNSW::MinimaxHeap::max @@ -142,6 +151,7 @@ int faiss::HNSW::MinimaxHeap::size () const size + faiss::HNSW::MinimaxHeap::size @@ -155,6 +165,7 @@ void faiss::HNSW::MinimaxHeap::clear () clear + faiss::HNSW::MinimaxHeap::clear @@ -168,6 +179,7 @@ int faiss::HNSW::MinimaxHeap::pop_min (float *vmin_out=nullptr) pop_min + faiss::HNSW::MinimaxHeap::pop_min float * vmin_out @@ -186,6 +198,7 @@ int faiss::HNSW::MinimaxHeap::count_below (float thresh) count_below + faiss::HNSW::MinimaxHeap::count_below float thresh @@ -198,7 +211,7 @@ - + diff --git a/xml/structfaiss_1_1HNSW_1_1NodeDistCloser.xml b/xml/structfaiss_1_1HNSW_1_1NodeDistCloser.xml index 12d1c576cc..1a78915909 100644 --- a/xml/structfaiss_1_1HNSW_1_1NodeDistCloser.xml +++ b/xml/structfaiss_1_1HNSW_1_1NodeDistCloser.xml @@ -1,14 +1,15 @@ - + faiss::HNSW::NodeDistCloser HNSW.h - + float float faiss::HNSW::NodeDistCloser::d d + faiss::HNSW::NodeDistCloser::d @@ -22,6 +23,7 @@ int faiss::HNSW::NodeDistCloser::id id + faiss::HNSW::NodeDistCloser::id @@ -30,13 +32,14 @@ - - + + faiss::HNSW::NodeDistCloser::NodeDistCloser (float d, int id) NodeDistCloser + faiss::HNSW::NodeDistCloser::NodeDistCloser float d @@ -58,6 +61,7 @@ bool faiss::HNSW::NodeDistCloser::operator< (const NodeDistCloser &obj1) const operator< + faiss::HNSW::NodeDistCloser::operator< const NodeDistCloser & obj1 @@ -70,7 +74,7 @@ - + to sort pairs of (id, distance) from nearest to fathest or the reverse diff --git a/xml/structfaiss_1_1HNSW_1_1NodeDistFarther.xml b/xml/structfaiss_1_1HNSW_1_1NodeDistFarther.xml index 40b384208c..80c73fc42a 100644 --- a/xml/structfaiss_1_1HNSW_1_1NodeDistFarther.xml +++ b/xml/structfaiss_1_1HNSW_1_1NodeDistFarther.xml @@ -1,13 +1,14 @@ - + faiss::HNSW::NodeDistFarther - + float float faiss::HNSW::NodeDistFarther::d d + faiss::HNSW::NodeDistFarther::d @@ -21,6 +22,7 @@ int faiss::HNSW::NodeDistFarther::id id + faiss::HNSW::NodeDistFarther::id @@ -29,13 +31,14 @@ - - + + faiss::HNSW::NodeDistFarther::NodeDistFarther (float d, int id) NodeDistFarther + faiss::HNSW::NodeDistFarther::NodeDistFarther float d @@ -57,6 +60,7 @@ bool faiss::HNSW::NodeDistFarther::operator< (const NodeDistFarther &obj1) const operator< + faiss::HNSW::NodeDistFarther::operator< const NodeDistFarther & obj1 @@ -69,7 +73,7 @@ - + diff --git a/xml/structfaiss_1_1HStackInvertedLists.xml b/xml/structfaiss_1_1HStackInvertedLists.xml index eddef760ad..559357253f 100644 --- a/xml/structfaiss_1_1HStackInvertedLists.xml +++ b/xml/structfaiss_1_1HStackInvertedLists.xml @@ -1,15 +1,16 @@ - + faiss::HStackInvertedLists faiss::ReadOnlyInvertedLists InvertedLists.h - + std::vector< const InvertedLists * > std::vector<const InvertedLists*> faiss::HStackInvertedLists::ils ils + faiss::HStackInvertedLists::ils @@ -23,6 +24,7 @@ size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -37,6 +39,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -51,6 +54,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -61,13 +65,14 @@ - - + + faiss::HStackInvertedLists::HStackInvertedLists (int nil, const InvertedLists **ils) HStackInvertedLists + faiss::HStackInvertedLists::HStackInvertedLists int nil @@ -90,6 +95,7 @@ size_t faiss::HStackInvertedLists::list_size (size_t list_no) const override list_size + faiss::HStackInvertedLists::list_size list_size size_t @@ -104,12 +110,13 @@ - + const uint8_t * - const uint8_t* faiss::HStackInvertedLists::get_codes + const uint8_t * faiss::HStackInvertedLists::get_codes (size_t list_no) const override get_codes - get_codes + faiss::HStackInvertedLists::get_codes + get_codes size_t list_no @@ -126,12 +133,13 @@ - + const idx_t * - const idx_t* faiss::HStackInvertedLists::get_ids + const idx_t * faiss::HStackInvertedLists::get_ids (size_t list_no) const override get_ids - get_ids + faiss::HStackInvertedLists::get_ids + get_ids size_t list_no @@ -153,6 +161,7 @@ void faiss::HStackInvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const override prefetch_lists + faiss::HStackInvertedLists::prefetch_lists prefetch_lists const idx_t * @@ -176,6 +185,7 @@ void faiss::HStackInvertedLists::release_codes (size_t list_no, const uint8_t *codes) const override release_codes + faiss::HStackInvertedLists::release_codes release_codes size_t @@ -199,6 +209,7 @@ void faiss::HStackInvertedLists::release_ids (size_t list_no, const idx_t *ids) const override release_ids + faiss::HStackInvertedLists::release_ids release_ids size_t @@ -222,6 +233,7 @@ idx_t faiss::HStackInvertedLists::get_single_id (size_t list_no, size_t offset) const override get_single_id + faiss::HStackInvertedLists::get_single_id get_single_id size_t @@ -242,12 +254,13 @@ - + const uint8_t * - const uint8_t* faiss::HStackInvertedLists::get_single_code + const uint8_t * faiss::HStackInvertedLists::get_single_code (size_t list_no, size_t offset) const override get_single_code - get_single_code + faiss::HStackInvertedLists::get_single_code + get_single_code size_t list_no @@ -272,6 +285,7 @@ size_t faiss::ReadOnlyInvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override add_entries + faiss::ReadOnlyInvertedLists::add_entries add_entries size_t @@ -302,6 +316,7 @@ void faiss::ReadOnlyInvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override update_entries + faiss::ReadOnlyInvertedLists::update_entries update_entries size_t @@ -336,6 +351,7 @@ void faiss::ReadOnlyInvertedLists::resize (size_t list_no, size_t new_size) override resize + faiss::ReadOnlyInvertedLists::resize resize size_t @@ -358,6 +374,7 @@ virtual bool faiss::InvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const is_empty + faiss::InvertedLists::is_empty is_empty size_t @@ -377,11 +394,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -405,6 +423,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -436,6 +455,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -465,6 +485,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -478,6 +499,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -500,6 +522,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -532,6 +555,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -546,6 +570,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -560,6 +585,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -569,11 +595,12 @@ - - + + int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -624,13 +651,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -641,23 +669,23 @@ - + Horizontal stack of inverted lists. - - - - + + + + @@ -666,16 +694,16 @@ - - - - + + + + @@ -690,10 +718,10 @@ faiss::HStackInvertedListscode_size faiss::HStackInvertedListscompute_ntotal faiss::HStackInvertedListscopy_subset_to - faiss::HStackInvertedListsget_codes - faiss::HStackInvertedListsget_ids - faiss::HStackInvertedListsget_iterator - faiss::HStackInvertedListsget_single_code + faiss::HStackInvertedListsget_codes + faiss::HStackInvertedListsget_ids + faiss::HStackInvertedListsget_iterator + faiss::HStackInvertedListsget_single_code faiss::HStackInvertedListsget_single_id faiss::HStackInvertedListsHStackInvertedLists faiss::HStackInvertedListsils diff --git a/xml/structfaiss_1_1HammingComputer.xml b/xml/structfaiss_1_1HammingComputer.xml index 91707f03cd..70bb943699 100644 --- a/xml/structfaiss_1_1HammingComputer.xml +++ b/xml/structfaiss_1_1HammingComputer.xml @@ -1,5 +1,5 @@ - + faiss::HammingComputer faiss::HammingComputerDefault @@ -10,12 +10,13 @@ CODE_SIZE - + faiss::HammingComputer< CODE_SIZE >::HammingComputer (const uint8_t *a, int code_size) HammingComputer + faiss::HammingComputer::HammingComputer const uint8_t * a @@ -37,6 +38,7 @@ void faiss::HammingComputerDefault::set (const uint8_t *a8_2, int code_size) set + faiss::HammingComputerDefault::set const uint8_t * a8_2 @@ -58,6 +60,7 @@ void faiss::HammingComputerDefault::set (const uint8_t *a8_2, int code_size) set + faiss::HammingComputerDefault::set const uint8_t * a8_2 @@ -79,6 +82,7 @@ void faiss::HammingComputerDefault::set (const uint8_t *a8, int code_size) set + faiss::HammingComputerDefault::set const uint8_t * a8 @@ -100,6 +104,7 @@ int faiss::HammingComputerDefault::hamming (const uint8_t *b8) const hamming + faiss::HammingComputerDefault::hamming const uint8_t * b8 @@ -117,6 +122,7 @@ int faiss::HammingComputerDefault::hamming (const uint8_t *b8) const hamming + faiss::HammingComputerDefault::hamming const uint8_t * b8 @@ -134,6 +140,7 @@ int faiss::HammingComputerDefault::hamming (const uint8_t *b8) const hamming + faiss::HammingComputerDefault::hamming const uint8_t * b8 @@ -151,6 +158,7 @@ int faiss::HammingComputerDefault::get_code_size () const get_code_size + faiss::HammingComputerDefault::get_code_size @@ -164,6 +172,7 @@ int faiss::HammingComputerDefault::get_code_size () const get_code_size + faiss::HammingComputerDefault::get_code_size @@ -177,6 +186,7 @@ int faiss::HammingComputerDefault::get_code_size () const get_code_size + faiss::HammingComputerDefault::get_code_size @@ -185,13 +195,14 @@ - - + + const uint8_t * const uint8_t * faiss::HammingComputerDefault::a8 a8 + faiss::HammingComputerDefault::a8 @@ -205,6 +216,7 @@ int faiss::HammingComputerDefault::quotient8 quotient8 + faiss::HammingComputerDefault::quotient8 @@ -218,6 +230,7 @@ int faiss::HammingComputerDefault::remainder8 remainder8 + faiss::HammingComputerDefault::remainder8 @@ -226,34 +239,34 @@ - + - - - - - - + + + + + + diff --git a/xml/structfaiss_1_1HammingComputer16.xml b/xml/structfaiss_1_1HammingComputer16.xml index 3d08906a0f..e48140e560 100644 --- a/xml/structfaiss_1_1HammingComputer16.xml +++ b/xml/structfaiss_1_1HammingComputer16.xml @@ -1,13 +1,14 @@ - + faiss::HammingComputer16 - + uint64_t uint64_t faiss::HammingComputer16::a0 a0 + faiss::HammingComputer16::a0 @@ -21,6 +22,7 @@ uint64_t faiss::HammingComputer16::a1 a1 + faiss::HammingComputer16::a1 @@ -29,13 +31,14 @@ - - + + faiss::HammingComputer16::HammingComputer16 () HammingComputer16 + faiss::HammingComputer16::HammingComputer16 @@ -49,6 +52,7 @@ faiss::HammingComputer16::HammingComputer16 (const uint8_t *a8, int code_size) HammingComputer16 + faiss::HammingComputer16::HammingComputer16 const uint8_t * a8 @@ -70,6 +74,7 @@ void faiss::HammingComputer16::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer16::set const uint8_t * a8 @@ -91,6 +96,7 @@ int faiss::HammingComputer16::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer16::hamming const uint8_t * b8 @@ -108,6 +114,7 @@ faiss::HammingComputer16::HammingComputer16 () HammingComputer16 + faiss::HammingComputer16::HammingComputer16 @@ -121,6 +128,7 @@ faiss::HammingComputer16::HammingComputer16 (const uint8_t *a8, int code_size) HammingComputer16 + faiss::HammingComputer16::HammingComputer16 const uint8_t * a8 @@ -142,6 +150,7 @@ void faiss::HammingComputer16::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer16::set const uint8_t * a8 @@ -163,6 +172,7 @@ int faiss::HammingComputer16::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer16::hamming const uint8_t * b8 @@ -180,6 +190,7 @@ faiss::HammingComputer16::HammingComputer16 () HammingComputer16 + faiss::HammingComputer16::HammingComputer16 @@ -193,6 +204,7 @@ faiss::HammingComputer16::HammingComputer16 (const uint8_t *a8, int code_size) HammingComputer16 + faiss::HammingComputer16::HammingComputer16 const uint8_t * a8 @@ -214,6 +226,7 @@ void faiss::HammingComputer16::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer16::set const uint8_t * a8 @@ -235,6 +248,7 @@ int faiss::HammingComputer16::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer16::hamming const uint8_t * b8 @@ -247,13 +261,14 @@ - - + + constexpr int static constexpr int faiss::HammingComputer16::get_code_size () get_code_size + faiss::HammingComputer16::get_code_size @@ -267,6 +282,7 @@ static constexpr int faiss::HammingComputer16::get_code_size () get_code_size + faiss::HammingComputer16::get_code_size @@ -280,6 +296,7 @@ static constexpr int faiss::HammingComputer16::get_code_size () get_code_size + faiss::HammingComputer16::get_code_size @@ -288,7 +305,7 @@ - + diff --git a/xml/structfaiss_1_1HammingComputer20.xml b/xml/structfaiss_1_1HammingComputer20.xml index d495c5af2a..c014a943bc 100644 --- a/xml/structfaiss_1_1HammingComputer20.xml +++ b/xml/structfaiss_1_1HammingComputer20.xml @@ -1,13 +1,14 @@ - + faiss::HammingComputer20 - + uint64_t uint64_t faiss::HammingComputer20::a0 a0 + faiss::HammingComputer20::a0 @@ -21,6 +22,7 @@ uint64_t faiss::HammingComputer20::a1 a1 + faiss::HammingComputer20::a1 @@ -34,6 +36,7 @@ uint32_t faiss::HammingComputer20::a2 a2 + faiss::HammingComputer20::a2 @@ -42,13 +45,14 @@ - - + + faiss::HammingComputer20::HammingComputer20 () HammingComputer20 + faiss::HammingComputer20::HammingComputer20 @@ -62,6 +66,7 @@ faiss::HammingComputer20::HammingComputer20 (const uint8_t *a8, int code_size) HammingComputer20 + faiss::HammingComputer20::HammingComputer20 const uint8_t * a8 @@ -83,6 +88,7 @@ void faiss::HammingComputer20::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer20::set const uint8_t * a8 @@ -104,6 +110,7 @@ int faiss::HammingComputer20::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer20::hamming const uint8_t * b8 @@ -121,6 +128,7 @@ faiss::HammingComputer20::HammingComputer20 () HammingComputer20 + faiss::HammingComputer20::HammingComputer20 @@ -134,6 +142,7 @@ faiss::HammingComputer20::HammingComputer20 (const uint8_t *a8, int code_size) HammingComputer20 + faiss::HammingComputer20::HammingComputer20 const uint8_t * a8 @@ -155,6 +164,7 @@ void faiss::HammingComputer20::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer20::set const uint8_t * a8 @@ -176,6 +186,7 @@ int faiss::HammingComputer20::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer20::hamming const uint8_t * b8 @@ -193,6 +204,7 @@ faiss::HammingComputer20::HammingComputer20 () HammingComputer20 + faiss::HammingComputer20::HammingComputer20 @@ -206,6 +218,7 @@ faiss::HammingComputer20::HammingComputer20 (const uint8_t *a8, int code_size) HammingComputer20 + faiss::HammingComputer20::HammingComputer20 const uint8_t * a8 @@ -227,6 +240,7 @@ void faiss::HammingComputer20::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer20::set const uint8_t * a8 @@ -248,6 +262,7 @@ int faiss::HammingComputer20::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer20::hamming const uint8_t * b8 @@ -260,13 +275,14 @@ - - + + constexpr int static constexpr int faiss::HammingComputer20::get_code_size () get_code_size + faiss::HammingComputer20::get_code_size @@ -280,6 +296,7 @@ static constexpr int faiss::HammingComputer20::get_code_size () get_code_size + faiss::HammingComputer20::get_code_size @@ -293,6 +310,7 @@ static constexpr int faiss::HammingComputer20::get_code_size () get_code_size + faiss::HammingComputer20::get_code_size @@ -301,7 +319,7 @@ - + diff --git a/xml/structfaiss_1_1HammingComputer32.xml b/xml/structfaiss_1_1HammingComputer32.xml index ef423f6dd6..ace9bf473f 100644 --- a/xml/structfaiss_1_1HammingComputer32.xml +++ b/xml/structfaiss_1_1HammingComputer32.xml @@ -1,13 +1,14 @@ - + faiss::HammingComputer32 - + uint64_t uint64_t faiss::HammingComputer32::a0 a0 + faiss::HammingComputer32::a0 @@ -21,6 +22,7 @@ uint64_t faiss::HammingComputer32::a1 a1 + faiss::HammingComputer32::a1 @@ -34,6 +36,7 @@ uint64_t faiss::HammingComputer32::a2 a2 + faiss::HammingComputer32::a2 @@ -47,6 +50,7 @@ uint64_t faiss::HammingComputer32::a3 a3 + faiss::HammingComputer32::a3 @@ -55,13 +59,14 @@ - - + + faiss::HammingComputer32::HammingComputer32 () HammingComputer32 + faiss::HammingComputer32::HammingComputer32 @@ -75,6 +80,7 @@ faiss::HammingComputer32::HammingComputer32 (const uint8_t *a8, int code_size) HammingComputer32 + faiss::HammingComputer32::HammingComputer32 const uint8_t * a8 @@ -96,6 +102,7 @@ void faiss::HammingComputer32::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer32::set const uint8_t * a8 @@ -117,6 +124,7 @@ int faiss::HammingComputer32::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer32::hamming const uint8_t * b8 @@ -134,6 +142,7 @@ faiss::HammingComputer32::HammingComputer32 () HammingComputer32 + faiss::HammingComputer32::HammingComputer32 @@ -147,6 +156,7 @@ faiss::HammingComputer32::HammingComputer32 (const uint8_t *a8, int code_size) HammingComputer32 + faiss::HammingComputer32::HammingComputer32 const uint8_t * a8 @@ -168,6 +178,7 @@ void faiss::HammingComputer32::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer32::set const uint8_t * a8 @@ -189,6 +200,7 @@ int faiss::HammingComputer32::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer32::hamming const uint8_t * b8 @@ -206,6 +218,7 @@ faiss::HammingComputer32::HammingComputer32 () HammingComputer32 + faiss::HammingComputer32::HammingComputer32 @@ -219,6 +232,7 @@ faiss::HammingComputer32::HammingComputer32 (const uint8_t *a8, int code_size) HammingComputer32 + faiss::HammingComputer32::HammingComputer32 const uint8_t * a8 @@ -240,6 +254,7 @@ void faiss::HammingComputer32::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer32::set const uint8_t * a8 @@ -261,6 +276,7 @@ int faiss::HammingComputer32::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer32::hamming const uint8_t * b8 @@ -273,13 +289,14 @@ - - + + constexpr int static constexpr int faiss::HammingComputer32::get_code_size () get_code_size + faiss::HammingComputer32::get_code_size @@ -293,6 +310,7 @@ static constexpr int faiss::HammingComputer32::get_code_size () get_code_size + faiss::HammingComputer32::get_code_size @@ -306,6 +324,7 @@ static constexpr int faiss::HammingComputer32::get_code_size () get_code_size + faiss::HammingComputer32::get_code_size @@ -314,7 +333,7 @@ - + diff --git a/xml/structfaiss_1_1HammingComputer4.xml b/xml/structfaiss_1_1HammingComputer4.xml index c97228221e..961ab92e89 100644 --- a/xml/structfaiss_1_1HammingComputer4.xml +++ b/xml/structfaiss_1_1HammingComputer4.xml @@ -1,13 +1,14 @@ - + faiss::HammingComputer4 - + uint32_t uint32_t faiss::HammingComputer4::a0 a0 + faiss::HammingComputer4::a0 @@ -16,13 +17,14 @@ - - + + faiss::HammingComputer4::HammingComputer4 () HammingComputer4 + faiss::HammingComputer4::HammingComputer4 @@ -36,6 +38,7 @@ faiss::HammingComputer4::HammingComputer4 (const uint8_t *a, int code_size) HammingComputer4 + faiss::HammingComputer4::HammingComputer4 const uint8_t * a @@ -57,6 +60,7 @@ void faiss::HammingComputer4::set (const uint8_t *a, int code_size) set + faiss::HammingComputer4::set const uint8_t * a @@ -78,6 +82,7 @@ int faiss::HammingComputer4::hamming (const uint8_t *b) const hamming + faiss::HammingComputer4::hamming const uint8_t * b @@ -95,6 +100,7 @@ faiss::HammingComputer4::HammingComputer4 () HammingComputer4 + faiss::HammingComputer4::HammingComputer4 @@ -108,6 +114,7 @@ faiss::HammingComputer4::HammingComputer4 (const uint8_t *a, int code_size) HammingComputer4 + faiss::HammingComputer4::HammingComputer4 const uint8_t * a @@ -129,6 +136,7 @@ void faiss::HammingComputer4::set (const uint8_t *a, int code_size) set + faiss::HammingComputer4::set const uint8_t * a @@ -150,6 +158,7 @@ int faiss::HammingComputer4::hamming (const uint8_t *b) const hamming + faiss::HammingComputer4::hamming const uint8_t * b @@ -167,6 +176,7 @@ faiss::HammingComputer4::HammingComputer4 () HammingComputer4 + faiss::HammingComputer4::HammingComputer4 @@ -180,6 +190,7 @@ faiss::HammingComputer4::HammingComputer4 (const uint8_t *a, int code_size) HammingComputer4 + faiss::HammingComputer4::HammingComputer4 const uint8_t * a @@ -201,6 +212,7 @@ void faiss::HammingComputer4::set (const uint8_t *a, int code_size) set + faiss::HammingComputer4::set const uint8_t * a @@ -222,6 +234,7 @@ int faiss::HammingComputer4::hamming (const uint8_t *b) const hamming + faiss::HammingComputer4::hamming const uint8_t * b @@ -234,13 +247,14 @@ - - + + constexpr int static constexpr int faiss::HammingComputer4::get_code_size () get_code_size + faiss::HammingComputer4::get_code_size @@ -254,6 +268,7 @@ static constexpr int faiss::HammingComputer4::get_code_size () get_code_size + faiss::HammingComputer4::get_code_size @@ -267,6 +282,7 @@ static constexpr int faiss::HammingComputer4::get_code_size () get_code_size + faiss::HammingComputer4::get_code_size @@ -275,7 +291,7 @@ - + diff --git a/xml/structfaiss_1_1HammingComputer64.xml b/xml/structfaiss_1_1HammingComputer64.xml index 2173d4a531..9edf930620 100644 --- a/xml/structfaiss_1_1HammingComputer64.xml +++ b/xml/structfaiss_1_1HammingComputer64.xml @@ -1,13 +1,14 @@ - + faiss::HammingComputer64 - + uint64_t uint64_t faiss::HammingComputer64::a0 a0 + faiss::HammingComputer64::a0 @@ -21,6 +22,7 @@ uint64_t faiss::HammingComputer64::a1 a1 + faiss::HammingComputer64::a1 @@ -34,6 +36,7 @@ uint64_t faiss::HammingComputer64::a2 a2 + faiss::HammingComputer64::a2 @@ -47,6 +50,7 @@ uint64_t faiss::HammingComputer64::a3 a3 + faiss::HammingComputer64::a3 @@ -60,6 +64,7 @@ uint64_t faiss::HammingComputer64::a4 a4 + faiss::HammingComputer64::a4 @@ -73,6 +78,7 @@ uint64_t faiss::HammingComputer64::a5 a5 + faiss::HammingComputer64::a5 @@ -86,6 +92,7 @@ uint64_t faiss::HammingComputer64::a6 a6 + faiss::HammingComputer64::a6 @@ -99,6 +106,7 @@ uint64_t faiss::HammingComputer64::a7 a7 + faiss::HammingComputer64::a7 @@ -112,6 +120,7 @@ const uint64_t* faiss::HammingComputer64::a a + faiss::HammingComputer64::a @@ -120,13 +129,14 @@ - - + + faiss::HammingComputer64::HammingComputer64 () HammingComputer64 + faiss::HammingComputer64::HammingComputer64 @@ -140,6 +150,7 @@ faiss::HammingComputer64::HammingComputer64 (const uint8_t *a8, int code_size) HammingComputer64 + faiss::HammingComputer64::HammingComputer64 const uint8_t * a8 @@ -161,6 +172,7 @@ void faiss::HammingComputer64::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer64::set const uint8_t * a8 @@ -182,6 +194,7 @@ int faiss::HammingComputer64::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer64::hamming const uint8_t * b8 @@ -199,6 +212,7 @@ faiss::HammingComputer64::HammingComputer64 () HammingComputer64 + faiss::HammingComputer64::HammingComputer64 @@ -212,6 +226,7 @@ faiss::HammingComputer64::HammingComputer64 (const uint8_t *a8, int code_size) HammingComputer64 + faiss::HammingComputer64::HammingComputer64 const uint8_t * a8 @@ -233,6 +248,7 @@ void faiss::HammingComputer64::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer64::set const uint8_t * a8 @@ -254,6 +270,7 @@ int faiss::HammingComputer64::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer64::hamming const uint8_t * b8 @@ -271,6 +288,7 @@ faiss::HammingComputer64::HammingComputer64 () HammingComputer64 + faiss::HammingComputer64::HammingComputer64 @@ -284,6 +302,7 @@ faiss::HammingComputer64::HammingComputer64 (const uint8_t *a8, int code_size) HammingComputer64 + faiss::HammingComputer64::HammingComputer64 const uint8_t * a8 @@ -305,6 +324,7 @@ void faiss::HammingComputer64::set (const uint8_t *a8, int code_size) set + faiss::HammingComputer64::set const uint8_t * a8 @@ -326,6 +346,7 @@ int faiss::HammingComputer64::hamming (const uint8_t *b8) const hamming + faiss::HammingComputer64::hamming const uint8_t * b8 @@ -338,13 +359,14 @@ - - + + constexpr int static constexpr int faiss::HammingComputer64::get_code_size () get_code_size + faiss::HammingComputer64::get_code_size @@ -358,6 +380,7 @@ static constexpr int faiss::HammingComputer64::get_code_size () get_code_size + faiss::HammingComputer64::get_code_size @@ -371,6 +394,7 @@ static constexpr int faiss::HammingComputer64::get_code_size () get_code_size + faiss::HammingComputer64::get_code_size @@ -379,7 +403,7 @@ - + diff --git a/xml/structfaiss_1_1HammingComputer8.xml b/xml/structfaiss_1_1HammingComputer8.xml index 5247d294b0..f85a1adaf1 100644 --- a/xml/structfaiss_1_1HammingComputer8.xml +++ b/xml/structfaiss_1_1HammingComputer8.xml @@ -1,13 +1,14 @@ - + faiss::HammingComputer8 - + uint64_t uint64_t faiss::HammingComputer8::a0 a0 + faiss::HammingComputer8::a0 @@ -16,13 +17,14 @@ - - + + faiss::HammingComputer8::HammingComputer8 () HammingComputer8 + faiss::HammingComputer8::HammingComputer8 @@ -36,6 +38,7 @@ faiss::HammingComputer8::HammingComputer8 (const uint8_t *a, int code_size) HammingComputer8 + faiss::HammingComputer8::HammingComputer8 const uint8_t * a @@ -57,6 +60,7 @@ void faiss::HammingComputer8::set (const uint8_t *a, int code_size) set + faiss::HammingComputer8::set const uint8_t * a @@ -78,6 +82,7 @@ int faiss::HammingComputer8::hamming (const uint8_t *b) const hamming + faiss::HammingComputer8::hamming const uint8_t * b @@ -95,6 +100,7 @@ faiss::HammingComputer8::HammingComputer8 () HammingComputer8 + faiss::HammingComputer8::HammingComputer8 @@ -108,6 +114,7 @@ faiss::HammingComputer8::HammingComputer8 (const uint8_t *a, int code_size) HammingComputer8 + faiss::HammingComputer8::HammingComputer8 const uint8_t * a @@ -129,6 +136,7 @@ void faiss::HammingComputer8::set (const uint8_t *a, int code_size) set + faiss::HammingComputer8::set const uint8_t * a @@ -150,6 +158,7 @@ int faiss::HammingComputer8::hamming (const uint8_t *b) const hamming + faiss::HammingComputer8::hamming const uint8_t * b @@ -167,6 +176,7 @@ faiss::HammingComputer8::HammingComputer8 () HammingComputer8 + faiss::HammingComputer8::HammingComputer8 @@ -180,6 +190,7 @@ faiss::HammingComputer8::HammingComputer8 (const uint8_t *a, int code_size) HammingComputer8 + faiss::HammingComputer8::HammingComputer8 const uint8_t * a @@ -201,6 +212,7 @@ void faiss::HammingComputer8::set (const uint8_t *a, int code_size) set + faiss::HammingComputer8::set const uint8_t * a @@ -222,6 +234,7 @@ int faiss::HammingComputer8::hamming (const uint8_t *b) const hamming + faiss::HammingComputer8::hamming const uint8_t * b @@ -234,13 +247,14 @@ - - + + constexpr int static constexpr int faiss::HammingComputer8::get_code_size () get_code_size + faiss::HammingComputer8::get_code_size @@ -254,6 +268,7 @@ static constexpr int faiss::HammingComputer8::get_code_size () get_code_size + faiss::HammingComputer8::get_code_size @@ -267,6 +282,7 @@ static constexpr int faiss::HammingComputer8::get_code_size () get_code_size + faiss::HammingComputer8::get_code_size @@ -275,7 +291,7 @@ - + diff --git a/xml/structfaiss_1_1HammingComputerDefault.xml b/xml/structfaiss_1_1HammingComputerDefault.xml index 4f16eeb144..7afa9c2595 100644 --- a/xml/structfaiss_1_1HammingComputerDefault.xml +++ b/xml/structfaiss_1_1HammingComputerDefault.xml @@ -1,14 +1,15 @@ - + faiss::HammingComputerDefault faiss::HammingComputer< CODE_SIZE > - + const uint8_t * const uint8_t * faiss::HammingComputerDefault::a8 a8 + faiss::HammingComputerDefault::a8 @@ -22,6 +23,7 @@ int faiss::HammingComputerDefault::quotient8 quotient8 + faiss::HammingComputerDefault::quotient8 @@ -35,6 +37,7 @@ int faiss::HammingComputerDefault::remainder8 remainder8 + faiss::HammingComputerDefault::remainder8 @@ -43,13 +46,14 @@ - - + + faiss::HammingComputerDefault::HammingComputerDefault () HammingComputerDefault + faiss::HammingComputerDefault::HammingComputerDefault @@ -63,6 +67,7 @@ faiss::HammingComputerDefault::HammingComputerDefault (const uint8_t *a8, int code_size) HammingComputerDefault + faiss::HammingComputerDefault::HammingComputerDefault const uint8_t * a8 @@ -84,6 +89,7 @@ void faiss::HammingComputerDefault::set (const uint8_t *a8_2, int code_size) set + faiss::HammingComputerDefault::set const uint8_t * a8_2 @@ -105,6 +111,7 @@ int faiss::HammingComputerDefault::hamming (const uint8_t *b8) const hamming + faiss::HammingComputerDefault::hamming const uint8_t * b8 @@ -122,6 +129,7 @@ int faiss::HammingComputerDefault::get_code_size () const get_code_size + faiss::HammingComputerDefault::get_code_size @@ -135,6 +143,7 @@ faiss::HammingComputerDefault::HammingComputerDefault () HammingComputerDefault + faiss::HammingComputerDefault::HammingComputerDefault @@ -148,6 +157,7 @@ faiss::HammingComputerDefault::HammingComputerDefault (const uint8_t *a8, int code_size) HammingComputerDefault + faiss::HammingComputerDefault::HammingComputerDefault const uint8_t * a8 @@ -169,6 +179,7 @@ void faiss::HammingComputerDefault::set (const uint8_t *a8_2, int code_size) set + faiss::HammingComputerDefault::set const uint8_t * a8_2 @@ -190,6 +201,7 @@ int faiss::HammingComputerDefault::hamming (const uint8_t *b8) const hamming + faiss::HammingComputerDefault::hamming const uint8_t * b8 @@ -207,6 +219,7 @@ int faiss::HammingComputerDefault::get_code_size () const get_code_size + faiss::HammingComputerDefault::get_code_size @@ -220,6 +233,7 @@ faiss::HammingComputerDefault::HammingComputerDefault () HammingComputerDefault + faiss::HammingComputerDefault::HammingComputerDefault @@ -233,6 +247,7 @@ faiss::HammingComputerDefault::HammingComputerDefault (const uint8_t *a8, int code_size) HammingComputerDefault + faiss::HammingComputerDefault::HammingComputerDefault const uint8_t * a8 @@ -254,6 +269,7 @@ void faiss::HammingComputerDefault::set (const uint8_t *a8, int code_size) set + faiss::HammingComputerDefault::set const uint8_t * a8 @@ -275,6 +291,7 @@ int faiss::HammingComputerDefault::hamming (const uint8_t *b8) const hamming + faiss::HammingComputerDefault::hamming const uint8_t * b8 @@ -292,6 +309,7 @@ int faiss::HammingComputerDefault::get_code_size () const get_code_size + faiss::HammingComputerDefault::get_code_size @@ -300,22 +318,22 @@ - + - - - - + + + + diff --git a/xml/structfaiss_1_1HeapArray.xml b/xml/structfaiss_1_1HeapArray.xml index a56049e571..d677eaaade 100644 --- a/xml/structfaiss_1_1HeapArray.xml +++ b/xml/structfaiss_1_1HeapArray.xml @@ -1,5 +1,5 @@ - + faiss::HeapArray Heap.h @@ -8,12 +8,13 @@ typename C - + C::TI typedef C::TI faiss::HeapArray< C >::TI TI + faiss::HeapArray::TI @@ -27,6 +28,7 @@ typedef C::T faiss::HeapArray< C >::T T + faiss::HeapArray::T @@ -35,13 +37,14 @@ - - + + size_t size_t faiss::HeapArray< C >::nh nh + faiss::HeapArray::nh number of heaps @@ -56,6 +59,7 @@ size_t faiss::HeapArray< C >::k k + faiss::HeapArray::k allocated size per heap @@ -70,6 +74,7 @@ TI* faiss::HeapArray< C >::ids ids + faiss::HeapArray::ids identifiers (size nh * k) @@ -84,6 +89,7 @@ T* faiss::HeapArray< C >::val val + faiss::HeapArray::val values (distances or similarities), size nh * k @@ -93,13 +99,14 @@ - - - + + + T * - T* faiss::HeapArray< C >::get_val + T * faiss::HeapArray< C >::get_val (size_t key) get_val + faiss::HeapArray::get_val size_t key @@ -113,11 +120,12 @@ - + TI * - TI* faiss::HeapArray< C >::get_ids + TI * faiss::HeapArray< C >::get_ids (size_t key) get_ids + faiss::HeapArray::get_ids size_t key @@ -136,6 +144,7 @@ void faiss::HeapArray< C >::heapify () heapify + faiss::HeapArray::heapify prepare all the heaps before adding @@ -150,6 +159,7 @@ void faiss::HeapArray< C >::addn (size_t nj, const T *vin, TI j0=0, size_t i0=0, int64_t ni=-1) addn + faiss::HeapArray::addn size_t nj @@ -229,6 +239,7 @@ void faiss::HeapArray< C >::addn_with_ids (size_t nj, const T *vin, const TI *id_in=nullptr, int64_t id_stride=0, size_t i0=0, int64_t ni=-1) addn_with_ids + faiss::HeapArray::addn_with_ids size_t nj @@ -289,6 +300,7 @@ void faiss::HeapArray< C >::addn_query_subset_with_ids (size_t nsubset, const TI *subset, size_t nj, const T *vin, const TI *id_in=nullptr, int64_t id_stride=0) addn_query_subset_with_ids + faiss::HeapArray::addn_query_subset_with_ids size_t nsubset @@ -347,6 +359,7 @@ void faiss::HeapArray< C >::reorder () reorder + faiss::HeapArray::reorder reorder all the heaps @@ -361,6 +374,7 @@ void faiss::HeapArray< C >::per_line_extrema (T *vals_out, TI *idx_out) const per_line_extrema + faiss::HeapArray::per_line_extrema T * vals_out @@ -395,7 +409,7 @@ - + @@ -406,8 +420,8 @@ faiss::HeapArrayaddn faiss::HeapArrayaddn_query_subset_with_ids faiss::HeapArrayaddn_with_ids - faiss::HeapArrayget_ids - faiss::HeapArrayget_val + faiss::HeapArrayget_ids + faiss::HeapArrayget_val faiss::HeapArrayheapify faiss::HeapArrayids faiss::HeapArrayk diff --git a/xml/structfaiss_1_1HeapBlockResultHandler.xml b/xml/structfaiss_1_1HeapBlockResultHandler.xml index 4ba921a86b..9792711102 100644 --- a/xml/structfaiss_1_1HeapBlockResultHandler.xml +++ b/xml/structfaiss_1_1HeapBlockResultHandler.xml @@ -1,5 +1,5 @@ - + faiss::HeapBlockResultHandler faiss::BlockResultHandler< C, false > @@ -15,12 +15,13 @@ false - + typename C::T using faiss::HeapBlockResultHandler< C, use_sel >::T = typename C::T T + faiss::HeapBlockResultHandler::T @@ -34,6 +35,7 @@ using faiss::HeapBlockResultHandler< C, use_sel >::TI = typename C::TI TI + faiss::HeapBlockResultHandler::TI @@ -42,13 +44,14 @@ - - + + T * T* faiss::HeapBlockResultHandler< C, use_sel >::heap_dis_tab heap_dis_tab + faiss::HeapBlockResultHandler::heap_dis_tab @@ -62,6 +65,7 @@ TI* faiss::HeapBlockResultHandler< C, use_sel >::heap_ids_tab heap_ids_tab + faiss::HeapBlockResultHandler::heap_ids_tab @@ -75,6 +79,7 @@ int64_t faiss::HeapBlockResultHandler< C, use_sel >::k k + faiss::HeapBlockResultHandler::k @@ -88,6 +93,7 @@ size_t faiss::BlockResultHandler< C, use_sel >::nq nq + faiss::BlockResultHandler::nq @@ -101,6 +107,7 @@ const IDSelector* faiss::BlockResultHandler< C, use_sel >::sel sel + faiss::BlockResultHandler::sel @@ -114,6 +121,8 @@ size_t faiss::BlockResultHandler< C, use_sel >::i0 i0 + faiss::BlockResultHandler::i0 + = 0 @@ -127,6 +136,8 @@ size_t faiss::BlockResultHandler< C, use_sel >::i1 i1 + faiss::BlockResultHandler::i1 + = 0 @@ -135,13 +146,14 @@ - - + + faiss::HeapBlockResultHandler< C, use_sel >::HeapBlockResultHandler (size_t nq, T *heap_dis_tab, TI *heap_ids_tab, size_t k, const IDSelector *sel=nullptr) HeapBlockResultHandler + faiss::HeapBlockResultHandler::HeapBlockResultHandler size_t nq @@ -176,6 +188,7 @@ void faiss::HeapBlockResultHandler< C, use_sel >::begin_multiple (size_t i0_2, size_t i1_2) final begin_multiple + faiss::HeapBlockResultHandler::begin_multiple begin_multiple size_t @@ -199,6 +212,7 @@ void faiss::HeapBlockResultHandler< C, use_sel >::add_results (size_t j0, size_t j1, const T *dis_tab) final add_results + faiss::HeapBlockResultHandler::add_results size_t j0 @@ -225,6 +239,7 @@ void faiss::HeapBlockResultHandler< C, use_sel >::end_multiple () final end_multiple + faiss::HeapBlockResultHandler::end_multiple end_multiple series of results for queries i0..i1 is done @@ -240,6 +255,7 @@ virtual void faiss::BlockResultHandler< C, use_sel >::add_results (size_t, size_t, const typename C::T *) add_results + faiss::BlockResultHandler::add_results size_t @@ -262,6 +278,7 @@ bool faiss::BlockResultHandler< C, use_sel >::is_in_selection (idx_t i) const is_in_selection + faiss::BlockResultHandler::is_in_selection idx_t i @@ -274,14 +291,14 @@ - + - + @@ -293,8 +310,11 @@ - + + + sel + @@ -302,11 +322,15 @@ + + + + faiss::HeapBlockResultHandleradd_results - faiss::HeapBlockResultHandleradd_results + faiss::HeapBlockResultHandleradd_results faiss::HeapBlockResultHandlerbegin_multiple faiss::HeapBlockResultHandlerBlockResultHandler faiss::HeapBlockResultHandlerend_multiple diff --git a/xml/structfaiss_1_1HeapBlockResultHandler_1_1SingleResultHandler.xml b/xml/structfaiss_1_1HeapBlockResultHandler_1_1SingleResultHandler.xml index 8b30dd9931..a1eeea36df 100644 --- a/xml/structfaiss_1_1HeapBlockResultHandler_1_1SingleResultHandler.xml +++ b/xml/structfaiss_1_1HeapBlockResultHandler_1_1SingleResultHandler.xml @@ -1,14 +1,15 @@ - + faiss::HeapBlockResultHandler::SingleResultHandler faiss::ResultHandler< C > - + HeapBlockResultHandler & HeapBlockResultHandler& faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler::hr hr + faiss::HeapBlockResultHandler::SingleResultHandler::hr @@ -22,6 +23,7 @@ size_t faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler::k k + faiss::HeapBlockResultHandler::SingleResultHandler::k @@ -35,6 +37,7 @@ T* faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler::heap_dis heap_dis + faiss::HeapBlockResultHandler::SingleResultHandler::heap_dis @@ -48,6 +51,7 @@ TI* faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler::heap_ids heap_ids + faiss::HeapBlockResultHandler::SingleResultHandler::heap_ids @@ -61,6 +65,7 @@ C::T faiss::ResultHandler< C >::threshold threshold + faiss::ResultHandler::threshold = C::neutral() @@ -70,13 +75,14 @@ - - + + faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler::SingleResultHandler (HeapBlockResultHandler &hr) SingleResultHandler + faiss::HeapBlockResultHandler::SingleResultHandler::SingleResultHandler HeapBlockResultHandler & hr @@ -94,6 +100,7 @@ void faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler::begin (size_t i) begin + faiss::HeapBlockResultHandler::SingleResultHandler::begin size_t i @@ -112,6 +119,7 @@ bool faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler::add_result (T dis, TI idx) final add_result + faiss::HeapBlockResultHandler::SingleResultHandler::add_result add_result T @@ -135,6 +143,7 @@ void faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler::end () end + faiss::HeapBlockResultHandler::SingleResultHandler::end series of results for query i is done @@ -144,31 +153,30 @@ - + - - - - + + + + - + - - - - + + sel + @@ -185,6 +193,14 @@ hr + + + + + + + + diff --git a/xml/structfaiss_1_1HeapWithBuckets.xml b/xml/structfaiss_1_1HeapWithBuckets.xml index 47c92e8da8..3a16400ef6 100644 --- a/xml/structfaiss_1_1HeapWithBuckets.xml +++ b/xml/structfaiss_1_1HeapWithBuckets.xml @@ -1,5 +1,5 @@ - + faiss::HeapWithBuckets diff --git a/xml/structfaiss_1_1HeapWithBucketsForHamming16.xml b/xml/structfaiss_1_1HeapWithBucketsForHamming16.xml index 6409dcd880..b34d50240f 100644 --- a/xml/structfaiss_1_1HeapWithBucketsForHamming16.xml +++ b/xml/structfaiss_1_1HeapWithBucketsForHamming16.xml @@ -1,5 +1,5 @@ - + faiss::HeapWithBucketsForHamming16 diff --git a/xml/structfaiss_1_1HeapWithBucketsForHamming16_3_01CMax_3_01int_00_01int64__t_01_4_00_01NBUCKETS_00_01N_00_01HammingComputerT_01_4.xml b/xml/structfaiss_1_1HeapWithBucketsForHamming16_3_01CMax_3_01int_00_01int64__t_01_4_00_01NBUCKETS_00_01N_00_01HammingComputerT_01_4.xml index 3f59326382..72ec3da95f 100644 --- a/xml/structfaiss_1_1HeapWithBucketsForHamming16_3_01CMax_3_01int_00_01int64__t_01_4_00_01NBUCKETS_00_01N_00_01HammingComputerT_01_4.xml +++ b/xml/structfaiss_1_1HeapWithBucketsForHamming16_3_01CMax_3_01int_00_01int64__t_01_4_00_01NBUCKETS_00_01N_00_01HammingComputerT_01_4.xml @@ -1,5 +1,5 @@ - + faiss::HeapWithBucketsForHamming16< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT > @@ -17,12 +17,13 @@ typename HammingComputerT - + constexpr uint32_t constexpr uint32_t faiss::HeapWithBucketsForHamming16< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::NBUCKETS_16 NBUCKETS_16 + faiss::HeapWithBucketsForHamming16< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::NBUCKETS_16 = NBUCKETS / 16 @@ -32,13 +33,14 @@ - - + + void static void faiss::HeapWithBucketsForHamming16< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::addn (const uint32_t n, const HammingComputerT &hc, const uint8_t *const __restrict binaryVectors, const uint32_t k, int *const __restrict bh_val, int64_t *const __restrict bh_ids) addn + faiss::HeapWithBucketsForHamming16< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::addn const uint32_t n @@ -76,6 +78,7 @@ static void faiss::HeapWithBucketsForHamming16< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::bs_addn (const uint32_t beam_size, const uint32_t n_per_beam, const HammingComputerT &hc, const uint8_t *const __restrict binary_vectors, const uint32_t k, int *const __restrict bh_val, int64_t *const __restrict bh_ids) bs_addn + faiss::HeapWithBucketsForHamming16< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::bs_addn const uint32_t beam_size @@ -112,7 +115,7 @@ - + diff --git a/xml/structfaiss_1_1HeapWithBucketsForHamming32.xml b/xml/structfaiss_1_1HeapWithBucketsForHamming32.xml index 8a03068de4..56457f300c 100644 --- a/xml/structfaiss_1_1HeapWithBucketsForHamming32.xml +++ b/xml/structfaiss_1_1HeapWithBucketsForHamming32.xml @@ -1,5 +1,5 @@ - + faiss::HeapWithBucketsForHamming32 diff --git a/xml/structfaiss_1_1HeapWithBucketsForHamming32_3_01CMax_3_01int_00_01int64__t_01_4_00_01NBUCKETS_00_01N_00_01HammingComputerT_01_4.xml b/xml/structfaiss_1_1HeapWithBucketsForHamming32_3_01CMax_3_01int_00_01int64__t_01_4_00_01NBUCKETS_00_01N_00_01HammingComputerT_01_4.xml index fb7409f53c..593306d823 100644 --- a/xml/structfaiss_1_1HeapWithBucketsForHamming32_3_01CMax_3_01int_00_01int64__t_01_4_00_01NBUCKETS_00_01N_00_01HammingComputerT_01_4.xml +++ b/xml/structfaiss_1_1HeapWithBucketsForHamming32_3_01CMax_3_01int_00_01int64__t_01_4_00_01NBUCKETS_00_01N_00_01HammingComputerT_01_4.xml @@ -1,5 +1,5 @@ - + faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT > @@ -17,12 +17,13 @@ typename HammingComputerT - + constexpr uint32_t constexpr uint32_t faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::NBUCKETS_8 NBUCKETS_8 + faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::NBUCKETS_8 = NBUCKETS / 8 @@ -32,13 +33,14 @@ - - + + void static void faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::addn (const uint32_t n, const HammingComputerT &hc, const uint8_t *const __restrict binaryVectors, const uint32_t k, int *const __restrict bh_val, int64_t *const __restrict bh_ids) addn + faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::addn const uint32_t n @@ -76,6 +78,7 @@ static void faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::bs_addn (const uint32_t beam_size, const uint32_t n_per_beam, const HammingComputerT &hc, const uint8_t *const __restrict binary_vectors, const uint32_t k, int *const __restrict bh_val, int64_t *const __restrict bh_ids) bs_addn + faiss::HeapWithBucketsForHamming32< CMax< int, int64_t >, NBUCKETS, N, HammingComputerT >::bs_addn const uint32_t beam_size @@ -112,7 +115,7 @@ - + diff --git a/xml/structfaiss_1_1HeapWithBuckets_3_01CMax_3_01float_00_01int_01_4_00_01NBUCKETS_00_01N_01_4.xml b/xml/structfaiss_1_1HeapWithBuckets_3_01CMax_3_01float_00_01int_01_4_00_01NBUCKETS_00_01N_01_4.xml index ce19fe2503..a9be24cb2d 100644 --- a/xml/structfaiss_1_1HeapWithBuckets_3_01CMax_3_01float_00_01int_01_4_00_01NBUCKETS_00_01N_01_4.xml +++ b/xml/structfaiss_1_1HeapWithBuckets_3_01CMax_3_01float_00_01int_01_4_00_01NBUCKETS_00_01N_01_4.xml @@ -1,5 +1,5 @@ - + faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N > @@ -14,12 +14,13 @@ N - + constexpr uint32_t constexpr uint32_t faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::NBUCKETS_8 NBUCKETS_8 + faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::NBUCKETS_8 = NBUCKETS / 8 @@ -29,13 +30,14 @@ - - + + void static void faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::addn (const uint32_t n, const float *const __restrict distances, const uint32_t k, float *const __restrict bh_val, int32_t *const __restrict bh_ids) addn + faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::addn const uint32_t n @@ -69,6 +71,7 @@ static void faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::bs_addn (const uint32_t beam_size, const uint32_t n_per_beam, const float *const __restrict distances, const uint32_t k, float *const __restrict bh_val, int32_t *const __restrict bh_ids) bs_addn + faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::bs_addn const uint32_t beam_size @@ -106,6 +109,7 @@ static void faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::addn (const uint32_t n, const float *const __restrict distances, const uint32_t k, float *const __restrict bh_val, int32_t *const __restrict bh_ids) addn + faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::addn const uint32_t n @@ -139,6 +143,7 @@ static void faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::bs_addn (const uint32_t beam_size, const uint32_t n_per_beam, const float *const __restrict distances, const uint32_t k, float *const __restrict bh_val, int32_t *const __restrict bh_ids) bs_addn + faiss::HeapWithBuckets< CMax< float, int >, NBUCKETS, N >::bs_addn const uint32_t beam_size @@ -171,7 +176,7 @@ - + diff --git a/xml/structfaiss_1_1IDSelector.xml b/xml/structfaiss_1_1IDSelector.xml index 5164b222dc..b964c8f8b4 100644 --- a/xml/structfaiss_1_1IDSelector.xml +++ b/xml/structfaiss_1_1IDSelector.xml @@ -1,5 +1,5 @@ - + faiss::IDSelector PyCallbackIDSelector @@ -14,12 +14,13 @@ faiss::IDSelectorTranslated faiss::IDSelectorXOr IDSelector.h - + bool virtual bool faiss::IDSelector::is_member (idx_t id) const =0 is_member + faiss::IDSelector::is_member is_member is_member is_member @@ -48,6 +49,7 @@ virtual faiss::IDSelector::~IDSelector () ~IDSelector + faiss::IDSelector::~IDSelector @@ -56,56 +58,62 @@ - + Encapsulates a set of ids to handle. - - - + + + - - - + + + + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + + + - - - + + + @@ -115,21 +123,15 @@ - - - - - - - - - + + + - - - + + + diff --git a/xml/structfaiss_1_1IDSelectorAll.xml b/xml/structfaiss_1_1IDSelectorAll.xml index 45cb0f5407..36667301c1 100644 --- a/xml/structfaiss_1_1IDSelectorAll.xml +++ b/xml/structfaiss_1_1IDSelectorAll.xml @@ -1,15 +1,16 @@ - + faiss::IDSelectorAll faiss::IDSelector IDSelector.h - + bool bool faiss::IDSelectorAll::is_member (idx_t id) const final is_member + faiss::IDSelectorAll::is_member is_member idx_t @@ -28,6 +29,7 @@ virtual faiss::IDSelectorAll::~IDSelectorAll () ~IDSelectorAll + faiss::IDSelectorAll::~IDSelectorAll @@ -36,7 +38,7 @@ - + selects all entries (useful for benchmarking) diff --git a/xml/structfaiss_1_1IDSelectorAnd.xml b/xml/structfaiss_1_1IDSelectorAnd.xml index ca77024a38..f1776d7b2f 100644 --- a/xml/structfaiss_1_1IDSelectorAnd.xml +++ b/xml/structfaiss_1_1IDSelectorAnd.xml @@ -1,15 +1,16 @@ - + faiss::IDSelectorAnd faiss::IDSelector IDSelector.h - + const IDSelector * const IDSelector* faiss::IDSelectorAnd::lhs lhs + faiss::IDSelectorAnd::lhs @@ -23,6 +24,7 @@ const IDSelector* faiss::IDSelectorAnd::rhs rhs + faiss::IDSelectorAnd::rhs @@ -31,13 +33,14 @@ - - + + faiss::IDSelectorAnd::IDSelectorAnd (const IDSelector *lhs, const IDSelector *rhs) IDSelectorAnd + faiss::IDSelectorAnd::IDSelectorAnd const IDSelector * lhs @@ -59,6 +62,7 @@ bool faiss::IDSelectorAnd::is_member (idx_t id) const final is_member + faiss::IDSelectorAnd::is_member is_member idx_t @@ -77,6 +81,7 @@ virtual faiss::IDSelectorAnd::~IDSelectorAnd () ~IDSelectorAnd + faiss::IDSelectorAnd::~IDSelectorAnd @@ -85,7 +90,7 @@ - + diff --git a/xml/structfaiss_1_1IDSelectorArray.xml b/xml/structfaiss_1_1IDSelectorArray.xml index 6e57a1db82..fd3cbb79b0 100644 --- a/xml/structfaiss_1_1IDSelectorArray.xml +++ b/xml/structfaiss_1_1IDSelectorArray.xml @@ -1,15 +1,16 @@ - + faiss::IDSelectorArray faiss::IDSelector IDSelector.h - + size_t size_t faiss::IDSelectorArray::n n + faiss::IDSelectorArray::n @@ -23,6 +24,7 @@ const idx_t* faiss::IDSelectorArray::ids ids + faiss::IDSelectorArray::ids @@ -31,13 +33,14 @@ - - + + faiss::IDSelectorArray::IDSelectorArray (size_t n, const idx_t *ids) IDSelectorArray + faiss::IDSelectorArray::IDSelectorArray size_t n @@ -78,6 +81,7 @@ bool faiss::IDSelectorArray::is_member (idx_t id) const final is_member + faiss::IDSelectorArray::is_member is_member idx_t @@ -96,6 +100,7 @@ faiss::IDSelectorArray::~IDSelectorArray () override ~IDSelectorArray + faiss::IDSelectorArray::~IDSelectorArray @@ -104,7 +109,7 @@ - + diff --git a/xml/structfaiss_1_1IDSelectorBatch.xml b/xml/structfaiss_1_1IDSelectorBatch.xml index 0d1b3aed52..e1097b9194 100644 --- a/xml/structfaiss_1_1IDSelectorBatch.xml +++ b/xml/structfaiss_1_1IDSelectorBatch.xml @@ -1,15 +1,16 @@ - + faiss::IDSelectorBatch faiss::IDSelector IDSelector.h - + std::unordered_set< idx_t > std::unordered_set<idx_t> faiss::IDSelectorBatch::set set + faiss::IDSelectorBatch::set @@ -23,6 +24,7 @@ std::vector<uint8_t> faiss::IDSelectorBatch::bloom bloom + faiss::IDSelectorBatch::bloom @@ -36,6 +38,7 @@ int faiss::IDSelectorBatch::nbits nbits + faiss::IDSelectorBatch::nbits @@ -49,6 +52,7 @@ idx_t faiss::IDSelectorBatch::mask mask + faiss::IDSelectorBatch::mask @@ -57,13 +61,14 @@ - - + + faiss::IDSelectorBatch::IDSelectorBatch (size_t n, const idx_t *indices) IDSelectorBatch + faiss::IDSelectorBatch::IDSelectorBatch size_t n @@ -104,6 +109,7 @@ bool faiss::IDSelectorBatch::is_member (idx_t id) const final is_member + faiss::IDSelectorBatch::is_member is_member idx_t @@ -122,6 +128,7 @@ faiss::IDSelectorBatch::~IDSelectorBatch () override ~IDSelectorBatch + faiss::IDSelectorBatch::~IDSelectorBatch @@ -130,7 +137,7 @@ - + @@ -139,28 +146,28 @@ The hash function used for the bloom filter and GCC's implementation of unordered_set are just the least significant bits of the id. This works fine for random ids or ids in sequences but will produce many hash collisions if lsb's are always the same + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1IDSelectorBitmap.xml b/xml/structfaiss_1_1IDSelectorBitmap.xml index 6e0b2673f3..ad8106de12 100644 --- a/xml/structfaiss_1_1IDSelectorBitmap.xml +++ b/xml/structfaiss_1_1IDSelectorBitmap.xml @@ -1,15 +1,16 @@ - + faiss::IDSelectorBitmap faiss::IDSelector IDSelector.h - + size_t size_t faiss::IDSelectorBitmap::n n + faiss::IDSelectorBitmap::n @@ -23,6 +24,7 @@ const uint8_t* faiss::IDSelectorBitmap::bitmap bitmap + faiss::IDSelectorBitmap::bitmap @@ -31,13 +33,14 @@ - - + + faiss::IDSelectorBitmap::IDSelectorBitmap (size_t n, const uint8_t *bitmap) IDSelectorBitmap + faiss::IDSelectorBitmap::IDSelectorBitmap size_t n @@ -78,6 +81,7 @@ bool faiss::IDSelectorBitmap::is_member (idx_t id) const final is_member + faiss::IDSelectorBitmap::is_member is_member idx_t @@ -96,6 +100,7 @@ faiss::IDSelectorBitmap::~IDSelectorBitmap () override ~IDSelectorBitmap + faiss::IDSelectorBitmap::~IDSelectorBitmap @@ -104,7 +109,7 @@ - + diff --git a/xml/structfaiss_1_1IDSelectorNot.xml b/xml/structfaiss_1_1IDSelectorNot.xml index a26ce4cce2..ae2e4e6f1c 100644 --- a/xml/structfaiss_1_1IDSelectorNot.xml +++ b/xml/structfaiss_1_1IDSelectorNot.xml @@ -1,15 +1,16 @@ - + faiss::IDSelectorNot faiss::IDSelector IDSelector.h - + const IDSelector * const IDSelector* faiss::IDSelectorNot::sel sel + faiss::IDSelectorNot::sel @@ -18,13 +19,14 @@ - - + + faiss::IDSelectorNot::IDSelectorNot (const IDSelector *sel) IDSelectorNot + faiss::IDSelectorNot::IDSelectorNot const IDSelector * sel @@ -42,6 +44,7 @@ bool faiss::IDSelectorNot::is_member (idx_t id) const final is_member + faiss::IDSelectorNot::is_member is_member idx_t @@ -60,6 +63,7 @@ virtual faiss::IDSelectorNot::~IDSelectorNot () ~IDSelectorNot + faiss::IDSelectorNot::~IDSelectorNot @@ -68,25 +72,29 @@ - + reverts the membership test of another selector + + + + + + - - @@ -96,10 +104,6 @@ sel - - - - diff --git a/xml/structfaiss_1_1IDSelectorOr.xml b/xml/structfaiss_1_1IDSelectorOr.xml index adab1a9369..aebd39fdd6 100644 --- a/xml/structfaiss_1_1IDSelectorOr.xml +++ b/xml/structfaiss_1_1IDSelectorOr.xml @@ -1,15 +1,16 @@ - + faiss::IDSelectorOr faiss::IDSelector IDSelector.h - + const IDSelector * const IDSelector* faiss::IDSelectorOr::lhs lhs + faiss::IDSelectorOr::lhs @@ -23,6 +24,7 @@ const IDSelector* faiss::IDSelectorOr::rhs rhs + faiss::IDSelectorOr::rhs @@ -31,13 +33,14 @@ - - + + faiss::IDSelectorOr::IDSelectorOr (const IDSelector *lhs, const IDSelector *rhs) IDSelectorOr + faiss::IDSelectorOr::IDSelectorOr const IDSelector * lhs @@ -59,6 +62,7 @@ bool faiss::IDSelectorOr::is_member (idx_t id) const final is_member + faiss::IDSelectorOr::is_member is_member idx_t @@ -77,6 +81,7 @@ virtual faiss::IDSelectorOr::~IDSelectorOr () ~IDSelectorOr + faiss::IDSelectorOr::~IDSelectorOr @@ -85,25 +90,29 @@ - + does an OR operation on the the two given IDSelector's is_membership results. + + + + + + - - @@ -114,10 +123,6 @@ rhs - - - - diff --git a/xml/structfaiss_1_1IDSelectorRange.xml b/xml/structfaiss_1_1IDSelectorRange.xml index d36e63687f..ca3587e4a3 100644 --- a/xml/structfaiss_1_1IDSelectorRange.xml +++ b/xml/structfaiss_1_1IDSelectorRange.xml @@ -1,15 +1,16 @@ - + faiss::IDSelectorRange faiss::IDSelector IDSelector.h - + idx_t idx_t faiss::IDSelectorRange::imin imin + faiss::IDSelectorRange::imin @@ -23,6 +24,7 @@ idx_t faiss::IDSelectorRange::imax imax + faiss::IDSelectorRange::imax @@ -36,6 +38,7 @@ bool faiss::IDSelectorRange::assume_sorted assume_sorted + faiss::IDSelectorRange::assume_sorted @@ -45,13 +48,14 @@ - - + + faiss::IDSelectorRange::IDSelectorRange (idx_t imin, idx_t imax, bool assume_sorted=false) IDSelectorRange + faiss::IDSelectorRange::IDSelectorRange idx_t imin @@ -78,6 +82,7 @@ bool faiss::IDSelectorRange::is_member (idx_t id) const final is_member + faiss::IDSelectorRange::is_member is_member idx_t @@ -96,6 +101,7 @@ void faiss::IDSelectorRange::find_sorted_ids_bounds (size_t list_size, const idx_t *ids, size_t *jmin, size_t *jmax) const find_sorted_ids_bounds + faiss::IDSelectorRange::find_sorted_ids_bounds size_t list_size @@ -126,6 +132,7 @@ faiss::IDSelectorRange::~IDSelectorRange () override ~IDSelectorRange + faiss::IDSelectorRange::~IDSelectorRange @@ -134,7 +141,7 @@ - + diff --git a/xml/structfaiss_1_1IDSelectorTranslated.xml b/xml/structfaiss_1_1IDSelectorTranslated.xml index b2aaa757ee..3544816540 100644 --- a/xml/structfaiss_1_1IDSelectorTranslated.xml +++ b/xml/structfaiss_1_1IDSelectorTranslated.xml @@ -1,14 +1,15 @@ - + faiss::IDSelectorTranslated faiss::IDSelector - + const std::vector< int64_t > & const std::vector<int64_t>& faiss::IDSelectorTranslated::id_map id_map + faiss::IDSelectorTranslated::id_map @@ -22,6 +23,7 @@ const IDSelector* faiss::IDSelectorTranslated::sel sel + faiss::IDSelectorTranslated::sel @@ -30,13 +32,14 @@ - - + + faiss::IDSelectorTranslated::IDSelectorTranslated (const std::vector< int64_t > &id_map, const IDSelector *sel) IDSelectorTranslated + faiss::IDSelectorTranslated::IDSelectorTranslated const std::vector< int64_t > & id_map @@ -58,6 +61,7 @@ faiss::IDSelectorTranslated::IDSelectorTranslated (IndexBinaryIDMap &index_idmap, const IDSelector *sel) IDSelectorTranslated + faiss::IDSelectorTranslated::IDSelectorTranslated IndexBinaryIDMap & index_idmap @@ -79,6 +83,7 @@ faiss::IDSelectorTranslated::IDSelectorTranslated (IndexIDMap &index_idmap, const IDSelector *sel) IDSelectorTranslated + faiss::IDSelectorTranslated::IDSelectorTranslated IndexIDMap & index_idmap @@ -100,6 +105,7 @@ bool faiss::IDSelectorTranslated::is_member (idx_t id) const override is_member + faiss::IDSelectorTranslated::is_member is_member idx_t @@ -113,24 +119,28 @@ - + + + + + + + - - @@ -140,10 +150,6 @@ sel - - - - diff --git a/xml/structfaiss_1_1IDSelectorXOr.xml b/xml/structfaiss_1_1IDSelectorXOr.xml index 2fc680593e..d3ddf80613 100644 --- a/xml/structfaiss_1_1IDSelectorXOr.xml +++ b/xml/structfaiss_1_1IDSelectorXOr.xml @@ -1,15 +1,16 @@ - + faiss::IDSelectorXOr faiss::IDSelector IDSelector.h - + const IDSelector * const IDSelector* faiss::IDSelectorXOr::lhs lhs + faiss::IDSelectorXOr::lhs @@ -23,6 +24,7 @@ const IDSelector* faiss::IDSelectorXOr::rhs rhs + faiss::IDSelectorXOr::rhs @@ -31,13 +33,14 @@ - - + + faiss::IDSelectorXOr::IDSelectorXOr (const IDSelector *lhs, const IDSelector *rhs) IDSelectorXOr + faiss::IDSelectorXOr::IDSelectorXOr const IDSelector * lhs @@ -59,6 +62,7 @@ bool faiss::IDSelectorXOr::is_member (idx_t id) const final is_member + faiss::IDSelectorXOr::is_member is_member idx_t @@ -77,6 +81,7 @@ virtual faiss::IDSelectorXOr::~IDSelectorXOr () ~IDSelectorXOr + faiss::IDSelectorXOr::~IDSelectorXOr @@ -85,25 +90,29 @@ - + does an XOR operation on the the two given IDSelector's is_membership results. + + + + + + - - @@ -114,10 +123,6 @@ rhs - - - - diff --git a/xml/structfaiss_1_1IOReader.xml b/xml/structfaiss_1_1IOReader.xml index 60142ca9de..eead58be86 100644 --- a/xml/structfaiss_1_1IOReader.xml +++ b/xml/structfaiss_1_1IOReader.xml @@ -1,17 +1,18 @@ - + faiss::IOReader PyCallbackIOReader faiss::BufferedIOReader faiss::FileIOReader faiss::VectorIOReader - + std::string std::string faiss::IOReader::name name + faiss::IOReader::name @@ -20,13 +21,14 @@ - - + + size_t virtual size_t faiss::IOReader::operator() (void *ptr, size_t size, size_t nitems)=0 operator() + faiss::IOReader::operator() operator() operator() operator() @@ -56,6 +58,7 @@ virtual int faiss::IOReader::filedescriptor () filedescriptor + faiss::IOReader::filedescriptor filedescriptor @@ -70,6 +73,7 @@ virtual faiss::IOReader::~IOReader () ~IOReader + faiss::IOReader::~IOReader @@ -78,15 +82,15 @@ - + - - - + + + @@ -96,15 +100,9 @@ - - - - - - - - - + + + @@ -112,6 +110,12 @@ + + + + + + diff --git a/xml/structfaiss_1_1IOWriter.xml b/xml/structfaiss_1_1IOWriter.xml index cbb849cdef..e6e3149288 100644 --- a/xml/structfaiss_1_1IOWriter.xml +++ b/xml/structfaiss_1_1IOWriter.xml @@ -1,17 +1,18 @@ - + faiss::IOWriter PyCallbackIOWriter faiss::BufferedIOWriter faiss::FileIOWriter faiss::VectorIOWriter - + std::string std::string faiss::IOWriter::name name + faiss::IOWriter::name @@ -20,13 +21,14 @@ - - + + size_t virtual size_t faiss::IOWriter::operator() (const void *ptr, size_t size, size_t nitems)=0 operator() + faiss::IOWriter::operator() operator() operator() operator() @@ -56,6 +58,7 @@ virtual int faiss::IOWriter::filedescriptor () filedescriptor + faiss::IOWriter::filedescriptor filedescriptor @@ -65,11 +68,12 @@ - + virtual faiss::IOWriter::~IOWriter () noexcept(false) ~IOWriter + faiss::IOWriter::~IOWriter @@ -78,27 +82,23 @@ - + - - - - - - - - - + + + + + @@ -106,9 +106,13 @@ - - - + + + + + + + diff --git a/xml/structfaiss_1_1ITQMatrix.xml b/xml/structfaiss_1_1ITQMatrix.xml index 5c0ae1b4cc..f4e942eed4 100644 --- a/xml/structfaiss_1_1ITQMatrix.xml +++ b/xml/structfaiss_1_1ITQMatrix.xml @@ -1,15 +1,16 @@ - + faiss::ITQMatrix faiss::LinearTransform VectorTransform.h - + int int faiss::ITQMatrix::max_iter max_iter + faiss::ITQMatrix::max_iter @@ -23,6 +24,7 @@ int faiss::ITQMatrix::seed seed + faiss::ITQMatrix::seed @@ -36,6 +38,7 @@ std::vector<double> faiss::ITQMatrix::init_rotation init_rotation + faiss::ITQMatrix::init_rotation @@ -49,6 +52,7 @@ bool faiss::LinearTransform::have_bias have_bias + faiss::LinearTransform::have_bias @@ -62,6 +66,7 @@ bool faiss::LinearTransform::is_orthonormal is_orthonormal + faiss::LinearTransform::is_orthonormal ! whether to use the bias term @@ -77,6 +82,7 @@ std::vector<float> faiss::LinearTransform::A A + faiss::LinearTransform::A Transformation matrix, size d_out * d_in. @@ -91,6 +97,7 @@ std::vector<float> faiss::LinearTransform::b b + faiss::LinearTransform::b bias vector, size d_out @@ -105,6 +112,7 @@ bool faiss::LinearTransform::verbose verbose + faiss::LinearTransform::verbose @@ -118,6 +126,7 @@ int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -131,6 +140,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -145,6 +155,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -154,13 +165,14 @@ - - + + faiss::ITQMatrix::ITQMatrix (int d=0) ITQMatrix + faiss::ITQMatrix::ITQMatrix int d @@ -179,6 +191,7 @@ void faiss::ITQMatrix::train (idx_t n, const float *x) override train + faiss::ITQMatrix::train train idx_t @@ -220,6 +233,7 @@ void faiss::LinearTransform::apply_noalloc (idx_t n, const float *x, float *xt) const override apply_noalloc + faiss::LinearTransform::apply_noalloc apply_noalloc idx_t @@ -247,6 +261,7 @@ void faiss::LinearTransform::transform_transpose (idx_t n, const float *y, float *x) const transform_transpose + faiss::LinearTransform::transform_transpose idx_t n @@ -273,6 +288,7 @@ void faiss::LinearTransform::reverse_transform (idx_t n, const float *xt, float *x) const override reverse_transform + faiss::LinearTransform::reverse_transform reverse_transform idx_t @@ -300,6 +316,7 @@ void faiss::LinearTransform::set_is_orthonormal () set_is_orthonormal + faiss::LinearTransform::set_is_orthonormal compute A^T * A to set the is_orthonormal flag @@ -314,6 +331,7 @@ void faiss::LinearTransform::print_if_verbose (const char *name, const std::vector< double > &mat, int n, int d) const print_if_verbose + faiss::LinearTransform::print_if_verbose const char * name @@ -343,6 +361,7 @@ void faiss::LinearTransform::check_identical (const VectorTransform &other) const override check_identical + faiss::LinearTransform::check_identical check_identical const VectorTransform & @@ -356,11 +375,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -397,7 +417,7 @@ - + @@ -406,6 +426,12 @@ Yunchao Gong, Svetlana Lazebnik, Albert Gordo, Florent Perronnin, PAMI'12. + + + + + + @@ -416,14 +442,14 @@ + + - - @@ -434,17 +460,11 @@ - - - - - - faiss::ITQMatrixA - faiss::ITQMatrixapply + faiss::ITQMatrixapply faiss::ITQMatrixapply_noalloc faiss::ITQMatrixb faiss::ITQMatrixcheck_identical diff --git a/xml/structfaiss_1_1ITQTransform.xml b/xml/structfaiss_1_1ITQTransform.xml index 50e2a0e181..357dfa97f3 100644 --- a/xml/structfaiss_1_1ITQTransform.xml +++ b/xml/structfaiss_1_1ITQTransform.xml @@ -1,15 +1,16 @@ - + faiss::ITQTransform faiss::VectorTransform VectorTransform.h - + std::vector< float > std::vector<float> faiss::ITQTransform::mean mean + faiss::ITQTransform::mean @@ -23,6 +24,7 @@ bool faiss::ITQTransform::do_pca do_pca + faiss::ITQTransform::do_pca @@ -36,6 +38,7 @@ ITQMatrix faiss::ITQTransform::itq itq + faiss::ITQTransform::itq @@ -49,6 +52,7 @@ int faiss::ITQTransform::max_train_per_dim max_train_per_dim + faiss::ITQTransform::max_train_per_dim max training points per dimension @@ -63,6 +67,7 @@ LinearTransform faiss::ITQTransform::pca_then_itq pca_then_itq + faiss::ITQTransform::pca_then_itq @@ -76,6 +81,7 @@ int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -89,6 +95,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -103,6 +110,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -112,13 +120,14 @@ - - + + faiss::ITQTransform::ITQTransform (int d_in=0, int d_out=0, bool do_pca=false) ITQTransform + faiss::ITQTransform::ITQTransform int d_in @@ -147,6 +156,7 @@ void faiss::ITQTransform::train (idx_t n, const float *x) override train + faiss::ITQTransform::train train idx_t @@ -188,6 +198,7 @@ void faiss::ITQTransform::apply_noalloc (idx_t n, const float *x, float *xt) const override apply_noalloc + faiss::ITQTransform::apply_noalloc apply_noalloc idx_t @@ -240,6 +251,7 @@ void faiss::ITQTransform::check_identical (const VectorTransform &other) const override check_identical + faiss::ITQTransform::check_identical check_identical const VectorTransform & @@ -253,11 +265,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -299,6 +312,7 @@ virtual void faiss::VectorTransform::reverse_transform (idx_t n, const float *xt, float *x) const reverse_transform + faiss::VectorTransform::reverse_transform reverse_transform reverse_transform reverse_transform @@ -324,7 +338,7 @@ - + @@ -343,10 +357,10 @@ - - - - + + + + @@ -361,20 +375,20 @@ pca_then_itq + + + + + + - - - - - - - faiss::ITQTransformapply + faiss::ITQTransformapply faiss::ITQTransformapply_noalloc faiss::ITQTransformcheck_identical faiss::ITQTransformd_in diff --git a/xml/structfaiss_1_1IVFFastScanStats.xml b/xml/structfaiss_1_1IVFFastScanStats.xml index bd82ac9972..b6c07d1069 100644 --- a/xml/structfaiss_1_1IVFFastScanStats.xml +++ b/xml/structfaiss_1_1IVFFastScanStats.xml @@ -1,132 +1,142 @@ - + faiss::IVFFastScanStats - + uint64_t uint64_t faiss::IVFFastScanStats::times[10] [10] times + faiss::IVFFastScanStats::times - + uint64_t uint64_t faiss::IVFFastScanStats::t_compute_distance_tables t_compute_distance_tables + faiss::IVFFastScanStats::t_compute_distance_tables - + uint64_t uint64_t faiss::IVFFastScanStats::t_round t_round + faiss::IVFFastScanStats::t_round - + uint64_t uint64_t faiss::IVFFastScanStats::t_copy_pack t_copy_pack + faiss::IVFFastScanStats::t_copy_pack - + uint64_t uint64_t faiss::IVFFastScanStats::t_scan t_scan + faiss::IVFFastScanStats::t_scan - + uint64_t uint64_t faiss::IVFFastScanStats::t_to_flat t_to_flat + faiss::IVFFastScanStats::t_to_flat - + uint64_t uint64_t faiss::IVFFastScanStats::reservoir_times[4] [4] reservoir_times + faiss::IVFFastScanStats::reservoir_times - + double double faiss::IVFFastScanStats::t_aq_encode t_aq_encode + faiss::IVFFastScanStats::t_aq_encode - + double double faiss::IVFFastScanStats::t_aq_norm_encode t_aq_norm_encode + faiss::IVFFastScanStats::t_aq_norm_encode - + - - + + double double faiss::IVFFastScanStats::Mcy_at (int i) Mcy_at + faiss::IVFFastScanStats::Mcy_at int i @@ -137,13 +147,14 @@ - + double double faiss::IVFFastScanStats::Mcy_reservoir_at (int i) Mcy_reservoir_at + faiss::IVFFastScanStats::Mcy_reservoir_at int i @@ -154,40 +165,42 @@ - + faiss::IVFFastScanStats::IVFFastScanStats () IVFFastScanStats + faiss::IVFFastScanStats::IVFFastScanStats - + void void faiss::IVFFastScanStats::reset () reset + faiss::IVFFastScanStats::reset - + - + - + faiss::IVFFastScanStatsIVFFastScanStats faiss::IVFFastScanStatsMcy_at diff --git a/xml/structfaiss_1_1IVFPQSearchParameters.xml b/xml/structfaiss_1_1IVFPQSearchParameters.xml index f6d69650f4..f83434cc52 100644 --- a/xml/structfaiss_1_1IVFPQSearchParameters.xml +++ b/xml/structfaiss_1_1IVFPQSearchParameters.xml @@ -1,14 +1,15 @@ - + faiss::IVFPQSearchParameters faiss::SearchParametersIVF - + size_t size_t faiss::IVFPQSearchParameters::scan_table_threshold scan_table_threshold + faiss::IVFPQSearchParameters::scan_table_threshold use table computation or on-the-fly? @@ -23,6 +24,7 @@ int faiss::IVFPQSearchParameters::polysemous_ht polysemous_ht + faiss::IVFPQSearchParameters::polysemous_ht Hamming thresh for polysemous filtering. @@ -37,6 +39,7 @@ size_t faiss::SearchParametersIVF::nprobe nprobe + faiss::SearchParametersIVF::nprobe = 1 number of probes at query time @@ -52,6 +55,7 @@ size_t faiss::SearchParametersIVF::max_codes max_codes + faiss::SearchParametersIVF::max_codes = 0 max nb of codes to visit to do a query @@ -67,6 +71,7 @@ SearchParameters* faiss::SearchParametersIVF::quantizer_params quantizer_params + faiss::SearchParametersIVF::quantizer_params = nullptr @@ -81,6 +86,7 @@ void* faiss::SearchParametersIVF::inverted_list_context inverted_list_context + faiss::SearchParametersIVF::inverted_list_context = nullptr context object to pass to InvertedLists @@ -96,6 +102,7 @@ IDSelector* faiss::SearchParameters::sel sel + faiss::SearchParameters::sel = nullptr if non-null, only these IDs will be considered during search. @@ -106,13 +113,14 @@ - - + + faiss::IVFPQSearchParameters::IVFPQSearchParameters () IVFPQSearchParameters + faiss::IVFPQSearchParameters::IVFPQSearchParameters @@ -126,6 +134,7 @@ faiss::IVFPQSearchParameters::~IVFPQSearchParameters () ~IVFPQSearchParameters + faiss::IVFPQSearchParameters::~IVFPQSearchParameters @@ -134,15 +143,17 @@ - + - - - + + + + + @@ -150,19 +161,19 @@ + + + + + + - - - - - - - - sel + + quantizer_params @@ -175,13 +186,11 @@ - - - - - - - quantizer_params + + + + + sel diff --git a/xml/structfaiss_1_1Index.xml b/xml/structfaiss_1_1Index.xml index 67d43b7f77..162cff6728 100644 --- a/xml/structfaiss_1_1Index.xml +++ b/xml/structfaiss_1_1Index.xml @@ -1,5 +1,5 @@ - + faiss::Index faiss::AdditiveCoarseQuantizer @@ -18,12 +18,13 @@ faiss::MultiIndexQuantizer faiss::gpu::GpuIndex Index.h - + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -37,6 +38,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -45,13 +47,14 @@ - - + + int int faiss::Index::d d + faiss::Index::d vector dimension @@ -66,6 +69,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -80,6 +84,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -94,6 +99,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -108,6 +114,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -122,6 +129,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -131,13 +139,14 @@ - - + + faiss::Index::Index (idx_t d=0, MetricType metric=METRIC_L2) Index + faiss::Index::Index idx_t d @@ -161,6 +170,7 @@ virtual faiss::Index::~Index () ~Index + faiss::Index::~Index @@ -174,6 +184,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -247,6 +258,7 @@ virtual void faiss::Index::add (idx_t n, const float *x)=0 add + faiss::Index::add add add add @@ -305,6 +317,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -364,6 +377,7 @@ virtual void faiss::Index::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const =0 search + faiss::Index::search search search search @@ -476,6 +490,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -554,6 +569,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -620,6 +636,7 @@ virtual void faiss::Index::reset ()=0 reset + faiss::Index::reset reset reset reset @@ -655,6 +672,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -679,6 +697,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -732,6 +751,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -785,6 +805,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -842,6 +863,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -939,6 +961,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -994,6 +1017,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1056,15 +1080,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1080,6 +1105,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1101,8 +1128,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1166,14 +1195,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1238,6 +1267,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1266,6 +1296,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1288,6 +1319,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1329,7 +1361,7 @@ - + @@ -1337,82 +1369,86 @@ All vectors provided at add or search time are 32-bit float arrays, although the internal representation may vary. - - - - + + + + - - - + + + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + @@ -1421,16 +1457,22 @@ - - - - + + + + - - - - + + + + + + + + + + @@ -1439,82 +1481,94 @@ - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + + - - - - + + + + - - - - + + + + - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + + + + + + + + + + + + + @@ -1523,164 +1577,172 @@ - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + + - - - - + + + + - - - + + + - - - - + + + + - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - + + + + + - - - - + + + + + + + + + + @@ -1689,64 +1751,58 @@ - - - - - - - - - - + + + + - - - + + + - - - - + + + + - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + @@ -1755,58 +1811,34 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + @@ -1822,7 +1854,7 @@ faiss::Indexcompute_residual_n faiss::Indexd faiss::Indexdistance_t - faiss::Indexget_distance_computer + faiss::Indexget_distance_computer faiss::IndexIndex faiss::Indexis_trained faiss::Indexmerge_from diff --git a/xml/structfaiss_1_1Index2Layer.xml b/xml/structfaiss_1_1Index2Layer.xml index fe8cd89e9e..fd08662749 100644 --- a/xml/structfaiss_1_1Index2Layer.xml +++ b/xml/structfaiss_1_1Index2Layer.xml @@ -1,15 +1,16 @@ - + faiss::Index2Layer faiss::IndexFlatCodes Index2Layer.h - + Level1Quantizer Level1Quantizer faiss::Index2Layer::q1 q1 + faiss::Index2Layer::q1 first level quantizer @@ -24,6 +25,7 @@ ProductQuantizer faiss::Index2Layer::pq pq + faiss::Index2Layer::pq second level quantizer is always a PQ @@ -38,6 +40,7 @@ size_t faiss::Index2Layer::code_size_1 code_size_1 + faiss::Index2Layer::code_size_1 size of the code for the first level (ceil(log8(q1.nlist))) @@ -52,6 +55,7 @@ size_t faiss::Index2Layer::code_size_2 code_size_2 + faiss::Index2Layer::code_size_2 size of the code for the second level @@ -66,6 +70,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -79,6 +84,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -93,6 +99,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -107,6 +114,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -121,6 +129,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -135,6 +144,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -149,6 +159,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -163,6 +174,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -172,13 +184,14 @@ - - + + faiss::Index2Layer::Index2Layer (Index *quantizer, size_t nlist, int M, int nbit=8, MetricType metric=METRIC_L2) Index2Layer + faiss::Index2Layer::Index2Layer Index * quantizer @@ -214,6 +227,7 @@ faiss::Index2Layer::Index2Layer () Index2Layer + faiss::Index2Layer::Index2Layer @@ -227,6 +241,7 @@ faiss::Index2Layer::~Index2Layer () ~Index2Layer + faiss::Index2Layer::~Index2Layer @@ -240,6 +255,7 @@ void faiss::Index2Layer::train (idx_t n, const float *x) override train + faiss::Index2Layer::train train idx_t @@ -281,6 +297,7 @@ void faiss::Index2Layer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::Index2Layer::search search idx_t @@ -316,12 +333,13 @@ - + DistanceComputer * - DistanceComputer* faiss::Index2Layer::get_distance_computer + DistanceComputer * faiss::Index2Layer::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::Index2Layer::get_distance_computer + get_distance_computer @@ -337,6 +355,7 @@ void faiss::Index2Layer::transfer_to_IVFPQ (IndexIVFPQ &other) const transfer_to_IVFPQ + faiss::Index2Layer::transfer_to_IVFPQ IndexIVFPQ & other @@ -355,6 +374,7 @@ void faiss::Index2Layer::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::Index2Layer::sa_encode sa_encode idx_t @@ -408,6 +428,7 @@ void faiss::Index2Layer::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::Index2Layer::sa_decode sa_decode idx_t @@ -461,6 +482,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -484,6 +506,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -499,6 +522,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -552,6 +576,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -593,6 +618,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -609,6 +635,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -623,16 +650,17 @@ - + FlatCodesDistanceComputer * - virtual FlatCodesDistanceComputer* faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + virtual FlatCodesDistanceComputer * faiss::IndexFlatCodes::get_FlatCodesDistanceComputer () const get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -648,6 +676,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -714,11 +743,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -732,6 +762,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -751,6 +782,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -775,6 +807,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -820,6 +853,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -837,6 +871,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -896,6 +931,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -962,6 +998,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1015,6 +1052,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1112,6 +1150,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1167,6 +1206,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1229,13 +1269,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1249,6 +1290,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1257,7 +1299,7 @@ - + @@ -1265,16 +1307,16 @@ The class is mainly inteded to store encoded vectors that can be accessed randomly, the search function is not implemented. + + + + - - - - @@ -1283,16 +1325,13 @@ - - - - - cp - - - clustering_index - quantizer - + + + + + + + @@ -1306,35 +1345,38 @@ pq - - - - - - - - - - - - + + + + + clustering_index + quantizer + + + cp + + - - assign_index - cp + + assign_index + + + + + @@ -1353,9 +1395,9 @@ faiss::Index2Layercompute_residual_n faiss::Index2Layerd faiss::Index2Layerdistance_t - faiss::Index2Layerget_CodePacker - faiss::Index2Layerget_distance_computer - faiss::Index2Layerget_FlatCodesDistanceComputer + faiss::Index2Layerget_CodePacker + faiss::Index2Layerget_distance_computer + faiss::Index2Layerget_FlatCodesDistanceComputer faiss::Index2LayerIndex faiss::Index2LayerIndex2Layer faiss::Index2LayerIndex2Layer diff --git a/xml/structfaiss_1_1IndexAdditiveQuantizer.xml b/xml/structfaiss_1_1IndexAdditiveQuantizer.xml index b68068bc2b..0dfa7ae602 100644 --- a/xml/structfaiss_1_1IndexAdditiveQuantizer.xml +++ b/xml/structfaiss_1_1IndexAdditiveQuantizer.xml @@ -1,5 +1,5 @@ - + faiss::IndexAdditiveQuantizer faiss::IndexFlatCodes @@ -8,12 +8,13 @@ faiss::IndexProductResidualQuantizer faiss::IndexResidualQuantizer IndexAdditiveQuantizer.h - + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizer::Search_type_t @@ -27,6 +28,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -40,6 +42,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -48,13 +51,14 @@ - - + + AdditiveQuantizer * AdditiveQuantizer* faiss::IndexAdditiveQuantizer::aq aq + faiss::IndexAdditiveQuantizer::aq @@ -68,6 +72,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -81,6 +86,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -95,6 +101,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -109,6 +116,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -123,6 +131,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -137,6 +146,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -151,6 +161,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -165,6 +176,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -174,13 +186,14 @@ - - + + faiss::IndexAdditiveQuantizer::IndexAdditiveQuantizer (idx_t d, AdditiveQuantizer *aq, MetricType metric=METRIC_L2) IndexAdditiveQuantizer + faiss::IndexAdditiveQuantizer::IndexAdditiveQuantizer idx_t d @@ -207,6 +220,7 @@ void faiss::IndexAdditiveQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizer::search search idx_t @@ -290,6 +304,7 @@ void faiss::IndexAdditiveQuantizer::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexAdditiveQuantizer::sa_encode sa_encode idx_t @@ -343,6 +358,7 @@ void faiss::IndexAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizer::sa_decode sa_decode idx_t @@ -391,12 +407,13 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -412,6 +429,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -435,6 +453,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -450,6 +469,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -503,6 +523,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -544,6 +565,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -560,6 +582,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -574,12 +597,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -595,6 +619,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -661,11 +686,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -679,6 +705,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -698,6 +725,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -722,6 +750,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -767,6 +796,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -784,6 +814,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -857,6 +888,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -916,6 +948,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -982,6 +1015,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1035,6 +1069,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1132,6 +1167,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1187,6 +1223,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1249,19 +1286,41 @@ - + Abstract class for additive quantizers. The search functions are in common. + + + + + + + + + + + + + + + + + + + + + + @@ -1274,30 +1333,30 @@ - - - - + + + + + + + + + qnorm - - - - + + + + - - - - - + + aq - - @@ -1310,13 +1369,10 @@ - - - - - - - aq + + + + @@ -1325,29 +1381,10 @@ - - - - - - - - - - - qnorm - - - - - - - - @@ -1364,9 +1401,9 @@ faiss::IndexAdditiveQuantizercompute_residual_n faiss::IndexAdditiveQuantizerd faiss::IndexAdditiveQuantizerdistance_t - faiss::IndexAdditiveQuantizerget_CodePacker - faiss::IndexAdditiveQuantizerget_distance_computer - faiss::IndexAdditiveQuantizerget_FlatCodesDistanceComputer + faiss::IndexAdditiveQuantizerget_CodePacker + faiss::IndexAdditiveQuantizerget_distance_computer + faiss::IndexAdditiveQuantizerget_FlatCodesDistanceComputer faiss::IndexAdditiveQuantizerIndex faiss::IndexAdditiveQuantizerIndexAdditiveQuantizer faiss::IndexAdditiveQuantizerIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexAdditiveQuantizerFastScan.xml b/xml/structfaiss_1_1IndexAdditiveQuantizerFastScan.xml index e208b68a06..0ac0126acb 100644 --- a/xml/structfaiss_1_1IndexAdditiveQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexAdditiveQuantizerFastScan.xml @@ -1,5 +1,5 @@ - + faiss::IndexAdditiveQuantizerFastScan faiss::IndexFastScan @@ -8,12 +8,13 @@ faiss::IndexProductResidualQuantizerFastScan faiss::IndexResidualQuantizerFastScan IndexAdditiveQuantizerFastScan.h - + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizerFastScan::Search_type_t @@ -27,6 +28,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -40,6 +42,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -48,13 +51,14 @@ - - + + AdditiveQuantizer * AdditiveQuantizer* faiss::IndexAdditiveQuantizerFastScan::aq aq + faiss::IndexAdditiveQuantizerFastScan::aq @@ -68,6 +72,7 @@ bool faiss::IndexAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexAdditiveQuantizerFastScan::rescale_norm = true @@ -82,6 +87,7 @@ int faiss::IndexAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexAdditiveQuantizerFastScan::norm_scale = 1 @@ -96,6 +102,7 @@ size_t faiss::IndexAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexAdditiveQuantizerFastScan::max_train_points = 0 @@ -110,6 +117,7 @@ int faiss::IndexFastScan::implem implem + faiss::IndexFastScan::implem = 0 @@ -124,6 +132,7 @@ int faiss::IndexFastScan::skip skip + faiss::IndexFastScan::skip = 0 @@ -138,6 +147,7 @@ int faiss::IndexFastScan::bbs bbs + faiss::IndexFastScan::bbs @@ -151,6 +161,7 @@ int faiss::IndexFastScan::qbs qbs + faiss::IndexFastScan::qbs = 0 @@ -165,6 +176,7 @@ size_t faiss::IndexFastScan::M M + faiss::IndexFastScan::M @@ -178,6 +190,7 @@ size_t faiss::IndexFastScan::nbits nbits + faiss::IndexFastScan::nbits @@ -191,6 +204,7 @@ size_t faiss::IndexFastScan::ksub ksub + faiss::IndexFastScan::ksub @@ -204,6 +218,7 @@ size_t faiss::IndexFastScan::code_size code_size + faiss::IndexFastScan::code_size @@ -217,6 +232,7 @@ size_t faiss::IndexFastScan::ntotal2 ntotal2 + faiss::IndexFastScan::ntotal2 @@ -230,6 +246,7 @@ size_t faiss::IndexFastScan::M2 M2 + faiss::IndexFastScan::M2 @@ -243,6 +260,7 @@ AlignedTable<uint8_t> faiss::IndexFastScan::codes codes + faiss::IndexFastScan::codes @@ -256,6 +274,7 @@ const uint8_t* faiss::IndexFastScan::orig_codes orig_codes + faiss::IndexFastScan::orig_codes = nullptr @@ -270,6 +289,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -284,6 +304,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -298,6 +319,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -312,6 +334,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -326,6 +349,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -340,6 +364,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -349,13 +374,14 @@ - - + + faiss::IndexAdditiveQuantizerFastScan::IndexAdditiveQuantizerFastScan (AdditiveQuantizer *aq, MetricType metric=METRIC_L2, int bbs=32) IndexAdditiveQuantizerFastScan + faiss::IndexAdditiveQuantizerFastScan::IndexAdditiveQuantizerFastScan AdditiveQuantizer * aq @@ -383,6 +409,7 @@ void faiss::IndexAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, MetricType metric=METRIC_L2, int bbs=32) init + faiss::IndexAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -410,6 +437,7 @@ faiss::IndexAdditiveQuantizerFastScan::IndexAdditiveQuantizerFastScan () IndexAdditiveQuantizerFastScan + faiss::IndexAdditiveQuantizerFastScan::IndexAdditiveQuantizerFastScan @@ -423,6 +451,7 @@ faiss::IndexAdditiveQuantizerFastScan::~IndexAdditiveQuantizerFastScan () override ~IndexAdditiveQuantizerFastScan + faiss::IndexAdditiveQuantizerFastScan::~IndexAdditiveQuantizerFastScan @@ -436,6 +465,7 @@ faiss::IndexAdditiveQuantizerFastScan::IndexAdditiveQuantizerFastScan (const IndexAdditiveQuantizer &orig, int bbs=32) IndexAdditiveQuantizerFastScan + faiss::IndexAdditiveQuantizerFastScan::IndexAdditiveQuantizerFastScan const IndexAdditiveQuantizer & orig @@ -459,6 +489,7 @@ void faiss::IndexAdditiveQuantizerFastScan::train (idx_t n, const float *x) override train + faiss::IndexAdditiveQuantizerFastScan::train train idx_t @@ -500,6 +531,7 @@ void faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -521,6 +553,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_codes (uint8_t *codes, idx_t n, const float *x) const override compute_codes + faiss::IndexAdditiveQuantizerFastScan::compute_codes compute_codes uint8_t * @@ -547,6 +580,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT (float *lut, idx_t n, const float *x) const override compute_float_LUT + faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT compute_float_LUT float * @@ -573,6 +607,7 @@ void faiss::IndexAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizerFastScan::search search idx_t @@ -656,6 +691,7 @@ void faiss::IndexAdditiveQuantizerFastScan::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizerFastScan::sa_decode sa_decode idx_t @@ -710,6 +746,7 @@ void faiss::IndexFastScan::init_fastscan (int d, size_t M, size_t nbits, MetricType metric, int bbs) init_fastscan + faiss::IndexFastScan::init_fastscan int d @@ -743,6 +780,7 @@ void faiss::IndexFastScan::reset () override reset + faiss::IndexFastScan::reset reset removes all elements from the database. @@ -758,6 +796,7 @@ void faiss::IndexFastScan::add (idx_t n, const float *x) override add + faiss::IndexFastScan::add add idx_t @@ -799,6 +838,7 @@ void faiss::IndexFastScan::compute_quantized_LUT (idx_t n, const float *x, uint8_t *lut, float *normalizers) const compute_quantized_LUT + faiss::IndexFastScan::compute_quantized_LUT idx_t n @@ -835,6 +875,7 @@ void faiss::IndexFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_dispatch_implem + faiss::IndexFastScan::search_dispatch_implem idx_t n @@ -877,6 +918,7 @@ void faiss::IndexFastScan::search_implem_234 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_implem_234 + faiss::IndexFastScan::search_implem_234 idx_t n @@ -919,6 +961,7 @@ void faiss::IndexFastScan::search_implem_12 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_12 + faiss::IndexFastScan::search_implem_12 idx_t n @@ -965,6 +1008,7 @@ void faiss::IndexFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_14 + faiss::IndexFastScan::search_implem_14 idx_t n @@ -1006,6 +1050,7 @@ void faiss::IndexFastScan::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFastScan::reconstruct reconstruct idx_t @@ -1047,6 +1092,7 @@ size_t faiss::IndexFastScan::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFastScan::remove_ids remove_ids const IDSelector & @@ -1061,11 +1107,12 @@ - + CodePacker * - CodePacker* faiss::IndexFastScan::get_CodePacker + CodePacker * faiss::IndexFastScan::get_CodePacker () const get_CodePacker + faiss::IndexFastScan::get_CodePacker @@ -1079,6 +1126,7 @@ void faiss::IndexFastScan::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFastScan::merge_from merge_from Index & @@ -1103,6 +1151,7 @@ void faiss::IndexFastScan::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFastScan::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1117,11 +1166,82 @@ + + size_t + size_t faiss::IndexFastScan::sa_code_size + () const override + sa_code_size + faiss::IndexFastScan::sa_code_size + sa_code_size + +standalone codes interface (but the codes are flattened) + + + + + + + + + void + void faiss::IndexFastScan::sa_encode + (idx_t n, const float *x, uint8_t *bytes) const override + sa_encode + faiss::IndexFastScan::sa_encode + sa_encode + + idx_t + n + + + const float * + x + + + uint8_t * + bytes + + + + +encode a set of vectors + + +n + + +number of vectors + + + + +x + + +input vectors, size n * d + + + + +bytes + + +output encoded vectors, size n * sa_code_size() + + + + + + + + + void virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -1181,6 +1301,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1259,6 +1380,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1325,6 +1447,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1378,6 +1501,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1435,6 +1559,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1532,6 +1657,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1587,6 +1713,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1649,15 +1776,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1668,97 +1796,12 @@ - - size_t - virtual size_t faiss::Index::sa_code_size - () const - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - - - -size of the produced codes in bytes - - - - - - - void - virtual void faiss::Index::sa_encode - (idx_t n, const float *x, uint8_t *bytes) const - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - - idx_t - n - - - const float * - x - - - uint8_t * - bytes - - - - -encode a set of vectors - - -n - - -number of vectors - - - - -x - - -input vectors, size n * d - - - - -bytes - - -output encoded vectors, size n * sa_code_size() - - - - - - - - - void virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1800,7 +1843,7 @@ - + @@ -1809,9 +1852,25 @@ Implementations: 12: blocked loop with internal loop on Q with qbs 13: same with reservoir accumulator to store results 14: no qbs with heap accumulator 15: no qbs with reservoir accumulator - - - + + + + + + + + + + + + + + + + + + + @@ -1821,10 +1880,10 @@ - - - - + + + + @@ -1833,10 +1892,26 @@ + + - - - + + + + tab + + + + + + + + + + + + + qnorm @@ -1848,23 +1923,8 @@ - - - - - - - - - - - - - - - - - + + aq @@ -1876,44 +1936,34 @@ codes + + + + + + - - + + - - - - - - - - - - - aq + + + + - - - - - - - qnorm + + + + - + - - - - - - @@ -1935,8 +1985,8 @@ faiss::IndexAdditiveQuantizerFastScand faiss::IndexAdditiveQuantizerFastScandistance_t faiss::IndexAdditiveQuantizerFastScanestimate_norm_scale - faiss::IndexAdditiveQuantizerFastScanget_CodePacker - faiss::IndexAdditiveQuantizerFastScanget_distance_computer + faiss::IndexAdditiveQuantizerFastScanget_CodePacker + faiss::IndexAdditiveQuantizerFastScanget_distance_computer faiss::IndexAdditiveQuantizerFastScanimplem faiss::IndexAdditiveQuantizerFastScanIndex faiss::IndexAdditiveQuantizerFastScanIndexAdditiveQuantizerFastScan @@ -1966,9 +2016,9 @@ faiss::IndexAdditiveQuantizerFastScanremove_ids faiss::IndexAdditiveQuantizerFastScanrescale_norm faiss::IndexAdditiveQuantizerFastScanreset - faiss::IndexAdditiveQuantizerFastScansa_code_size + faiss::IndexAdditiveQuantizerFastScansa_code_size faiss::IndexAdditiveQuantizerFastScansa_decode - faiss::IndexAdditiveQuantizerFastScansa_encode + faiss::IndexAdditiveQuantizerFastScansa_encode faiss::IndexAdditiveQuantizerFastScansearch faiss::IndexAdditiveQuantizerFastScansearch_and_reconstruct faiss::IndexAdditiveQuantizerFastScansearch_dispatch_implem diff --git a/xml/structfaiss_1_1IndexBinary.xml b/xml/structfaiss_1_1IndexBinary.xml index 5720ae57a4..bc822bb390 100644 --- a/xml/structfaiss_1_1IndexBinary.xml +++ b/xml/structfaiss_1_1IndexBinary.xml @@ -1,5 +1,5 @@ - + faiss::IndexBinary faiss::IndexBinaryFlat @@ -10,12 +10,13 @@ faiss::IndexBinaryMultiHash faiss::gpu::GpuIndexBinaryFlat IndexBinary.h - + uint8_t using faiss::IndexBinary::component_t = uint8_t component_t + faiss::IndexBinary::component_t @@ -29,6 +30,7 @@ using faiss::IndexBinary::distance_t = int32_t distance_t + faiss::IndexBinary::distance_t @@ -37,13 +39,14 @@ - - + + int int faiss::IndexBinary::d d + faiss::IndexBinary::d = 0 vector dimension @@ -59,6 +62,7 @@ int faiss::IndexBinary::code_size code_size + faiss::IndexBinary::code_size = 0 number of bytes per vector ( = d / 8 ) @@ -74,6 +78,7 @@ idx_t faiss::IndexBinary::ntotal ntotal + faiss::IndexBinary::ntotal = 0 total nb of indexed vectors @@ -89,6 +94,7 @@ bool faiss::IndexBinary::verbose verbose + faiss::IndexBinary::verbose = false verbosity level @@ -104,6 +110,7 @@ bool faiss::IndexBinary::is_trained is_trained + faiss::IndexBinary::is_trained = true @@ -119,6 +126,7 @@ MetricType faiss::IndexBinary::metric_type metric_type + faiss::IndexBinary::metric_type = METRIC_L2 type of metric this index uses for search @@ -129,13 +137,14 @@ - - + + faiss::IndexBinary::IndexBinary (idx_t d=0, MetricType metric=METRIC_L2) IndexBinary + faiss::IndexBinary::IndexBinary idx_t d @@ -159,6 +168,7 @@ virtual faiss::IndexBinary::~IndexBinary () ~IndexBinary + faiss::IndexBinary::~IndexBinary @@ -172,6 +182,7 @@ virtual void faiss::IndexBinary::train (idx_t n, const uint8_t *x) train + faiss::IndexBinary::train train train train @@ -215,6 +226,7 @@ virtual void faiss::IndexBinary::add (idx_t n, const uint8_t *x)=0 add + faiss::IndexBinary::add add add add @@ -254,6 +266,7 @@ virtual void faiss::IndexBinary::add_with_ids (idx_t n, const uint8_t *x, const idx_t *xids) add_with_ids + faiss::IndexBinary::add_with_ids add_with_ids add_with_ids @@ -293,6 +306,7 @@ virtual void faiss::IndexBinary::search (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const =0 search + faiss::IndexBinary::search search search search @@ -366,6 +380,7 @@ virtual void faiss::IndexBinary::range_search (idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::IndexBinary::range_search range_search range_search range_search @@ -432,6 +447,7 @@ void faiss::IndexBinary::assign (idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1) const assign + faiss::IndexBinary::assign idx_t n @@ -481,6 +497,7 @@ virtual void faiss::IndexBinary::reset ()=0 reset + faiss::IndexBinary::reset reset reset reset @@ -502,6 +519,7 @@ virtual size_t faiss::IndexBinary::remove_ids (const IDSelector &sel) remove_ids + faiss::IndexBinary::remove_ids remove_ids remove_ids @@ -522,6 +540,7 @@ virtual void faiss::IndexBinary::reconstruct (idx_t key, uint8_t *recons) const reconstruct + faiss::IndexBinary::reconstruct reconstruct reconstruct reconstruct @@ -566,6 +585,7 @@ virtual void faiss::IndexBinary::reconstruct_n (idx_t i0, idx_t ni, uint8_t *recons) const reconstruct_n + faiss::IndexBinary::reconstruct_n reconstruct_n idx_t @@ -603,6 +623,7 @@ virtual void faiss::IndexBinary::search_and_reconstruct (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::IndexBinary::search_and_reconstruct search_and_reconstruct idx_t @@ -658,6 +679,7 @@ void faiss::IndexBinary::display () const display + faiss::IndexBinary::display @@ -672,6 +694,7 @@ virtual void faiss::IndexBinary::merge_from (IndexBinary &otherIndex, idx_t add_id=0) merge_from + faiss::IndexBinary::merge_from merge_from IndexBinary & @@ -696,6 +719,7 @@ virtual void faiss::IndexBinary::check_compatible_for_merge (const IndexBinary &otherIndex) const check_compatible_for_merge + faiss::IndexBinary::check_compatible_for_merge check_compatible_for_merge const IndexBinary & @@ -715,6 +739,7 @@ virtual size_t faiss::IndexBinary::sa_code_size () const sa_code_size + faiss::IndexBinary::sa_code_size @@ -729,6 +754,7 @@ virtual void faiss::IndexBinary::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::IndexBinary::add_sa_codes idx_t n @@ -750,7 +776,7 @@ - + @@ -759,6 +785,22 @@ All queries are symmetric because there is no distinction between codes and vectors. + + + + + + + + + + + + + + + + @@ -771,12 +813,6 @@ - - - - - - @@ -789,22 +825,12 @@ - - - - - - - - - + + + - - - - diff --git a/xml/structfaiss_1_1IndexBinaryFlat.xml b/xml/structfaiss_1_1IndexBinaryFlat.xml index 0dc255cc9c..38375d0c27 100644 --- a/xml/structfaiss_1_1IndexBinaryFlat.xml +++ b/xml/structfaiss_1_1IndexBinaryFlat.xml @@ -1,15 +1,16 @@ - + faiss::IndexBinaryFlat faiss::IndexBinary IndexBinaryFlat.h - + std::vector< uint8_t > std::vector<uint8_t> faiss::IndexBinaryFlat::xb xb + faiss::IndexBinaryFlat::xb database vectors, size ntotal * d / 8 @@ -24,6 +25,7 @@ bool faiss::IndexBinaryFlat::use_heap use_heap + faiss::IndexBinaryFlat::use_heap = true @@ -39,6 +41,7 @@ size_t faiss::IndexBinaryFlat::query_batch_size query_batch_size + faiss::IndexBinaryFlat::query_batch_size = 32 @@ -53,6 +56,7 @@ ApproxTopK_mode_t faiss::IndexBinaryFlat::approx_topk_mode approx_topk_mode + faiss::IndexBinaryFlat::approx_topk_mode = ApproxTopK_mode_t::EXACT_TOPK @@ -67,6 +71,7 @@ int faiss::IndexBinary::d d + faiss::IndexBinary::d = 0 vector dimension @@ -82,6 +87,7 @@ int faiss::IndexBinary::code_size code_size + faiss::IndexBinary::code_size = 0 number of bytes per vector ( = d / 8 ) @@ -97,6 +103,7 @@ idx_t faiss::IndexBinary::ntotal ntotal + faiss::IndexBinary::ntotal = 0 total nb of indexed vectors @@ -112,6 +119,7 @@ bool faiss::IndexBinary::verbose verbose + faiss::IndexBinary::verbose = false verbosity level @@ -127,6 +135,7 @@ bool faiss::IndexBinary::is_trained is_trained + faiss::IndexBinary::is_trained = true @@ -142,6 +151,7 @@ MetricType faiss::IndexBinary::metric_type metric_type + faiss::IndexBinary::metric_type = METRIC_L2 type of metric this index uses for search @@ -152,13 +162,14 @@ - - + + faiss::IndexBinaryFlat::IndexBinaryFlat (idx_t d) IndexBinaryFlat + faiss::IndexBinaryFlat::IndexBinaryFlat idx_t d @@ -176,6 +187,7 @@ void faiss::IndexBinaryFlat::add (idx_t n, const uint8_t *x) override add + faiss::IndexBinaryFlat::add add idx_t @@ -209,6 +221,7 @@ void faiss::IndexBinaryFlat::reset () override reset + faiss::IndexBinaryFlat::reset reset Removes all elements from the database. @@ -224,6 +237,7 @@ void faiss::IndexBinaryFlat::search (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexBinaryFlat::search search idx_t @@ -291,6 +305,7 @@ void faiss::IndexBinaryFlat::range_search (idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexBinaryFlat::range_search range_search idx_t @@ -354,6 +369,7 @@ void faiss::IndexBinaryFlat::reconstruct (idx_t key, uint8_t *recons) const override reconstruct + faiss::IndexBinaryFlat::reconstruct reconstruct idx_t @@ -395,6 +411,7 @@ size_t faiss::IndexBinaryFlat::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexBinaryFlat::remove_ids remove_ids const IDSelector & @@ -414,6 +431,7 @@ faiss::IndexBinaryFlat::IndexBinaryFlat () IndexBinaryFlat + faiss::IndexBinaryFlat::IndexBinaryFlat @@ -427,6 +445,7 @@ virtual void faiss::IndexBinary::train (idx_t n, const uint8_t *x) train + faiss::IndexBinary::train train train train @@ -470,6 +489,7 @@ virtual void faiss::IndexBinary::add_with_ids (idx_t n, const uint8_t *x, const idx_t *xids) add_with_ids + faiss::IndexBinary::add_with_ids add_with_ids add_with_ids @@ -509,6 +529,7 @@ void faiss::IndexBinary::assign (idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1) const assign + faiss::IndexBinary::assign idx_t n @@ -558,6 +579,7 @@ virtual void faiss::IndexBinary::reconstruct_n (idx_t i0, idx_t ni, uint8_t *recons) const reconstruct_n + faiss::IndexBinary::reconstruct_n reconstruct_n idx_t @@ -595,6 +617,7 @@ virtual void faiss::IndexBinary::search_and_reconstruct (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::IndexBinary::search_and_reconstruct search_and_reconstruct idx_t @@ -650,6 +673,7 @@ void faiss::IndexBinary::display () const display + faiss::IndexBinary::display @@ -664,6 +688,7 @@ virtual void faiss::IndexBinary::merge_from (IndexBinary &otherIndex, idx_t add_id=0) merge_from + faiss::IndexBinary::merge_from merge_from IndexBinary & @@ -688,6 +713,7 @@ virtual void faiss::IndexBinary::check_compatible_for_merge (const IndexBinary &otherIndex) const check_compatible_for_merge + faiss::IndexBinary::check_compatible_for_merge check_compatible_for_merge const IndexBinary & @@ -707,6 +733,7 @@ virtual size_t faiss::IndexBinary::sa_code_size () const sa_code_size + faiss::IndexBinary::sa_code_size @@ -721,6 +748,7 @@ virtual void faiss::IndexBinary::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::IndexBinary::add_sa_codes idx_t n @@ -742,13 +770,14 @@ - - + + uint8_t using faiss::IndexBinary::component_t = uint8_t component_t + faiss::IndexBinary::component_t @@ -762,6 +791,7 @@ using faiss::IndexBinary::distance_t = int32_t distance_t + faiss::IndexBinary::distance_t @@ -770,35 +800,35 @@ - + Index that stores the full vectors and performs exhaustive search. + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1IndexBinaryFromFloat.xml b/xml/structfaiss_1_1IndexBinaryFromFloat.xml index 50a9f3a7cf..0cc55c2560 100644 --- a/xml/structfaiss_1_1IndexBinaryFromFloat.xml +++ b/xml/structfaiss_1_1IndexBinaryFromFloat.xml @@ -1,15 +1,16 @@ - + faiss::IndexBinaryFromFloat faiss::IndexBinary IndexBinaryFromFloat.h - + Index * Index* faiss::IndexBinaryFromFloat::index index + faiss::IndexBinaryFromFloat::index = nullptr @@ -24,6 +25,7 @@ bool faiss::IndexBinaryFromFloat::own_fields own_fields + faiss::IndexBinaryFromFloat::own_fields = false Whether object owns the index pointer. @@ -39,6 +41,7 @@ int faiss::IndexBinary::d d + faiss::IndexBinary::d = 0 vector dimension @@ -54,6 +57,7 @@ int faiss::IndexBinary::code_size code_size + faiss::IndexBinary::code_size = 0 number of bytes per vector ( = d / 8 ) @@ -69,6 +73,7 @@ idx_t faiss::IndexBinary::ntotal ntotal + faiss::IndexBinary::ntotal = 0 total nb of indexed vectors @@ -84,6 +89,7 @@ bool faiss::IndexBinary::verbose verbose + faiss::IndexBinary::verbose = false verbosity level @@ -99,6 +105,7 @@ bool faiss::IndexBinary::is_trained is_trained + faiss::IndexBinary::is_trained = true @@ -114,6 +121,7 @@ MetricType faiss::IndexBinary::metric_type metric_type + faiss::IndexBinary::metric_type = METRIC_L2 type of metric this index uses for search @@ -124,13 +132,14 @@ - - + + faiss::IndexBinaryFromFloat::IndexBinaryFromFloat () IndexBinaryFromFloat + faiss::IndexBinaryFromFloat::IndexBinaryFromFloat @@ -144,6 +153,7 @@ faiss::IndexBinaryFromFloat::IndexBinaryFromFloat (Index *index) IndexBinaryFromFloat + faiss::IndexBinaryFromFloat::IndexBinaryFromFloat Index * index @@ -161,6 +171,7 @@ faiss::IndexBinaryFromFloat::~IndexBinaryFromFloat () ~IndexBinaryFromFloat + faiss::IndexBinaryFromFloat::~IndexBinaryFromFloat @@ -174,6 +185,7 @@ void faiss::IndexBinaryFromFloat::add (idx_t n, const uint8_t *x) override add + faiss::IndexBinaryFromFloat::add add idx_t @@ -207,6 +219,7 @@ void faiss::IndexBinaryFromFloat::reset () override reset + faiss::IndexBinaryFromFloat::reset reset Removes all elements from the database. @@ -222,6 +235,7 @@ void faiss::IndexBinaryFromFloat::search (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexBinaryFromFloat::search search idx_t @@ -289,6 +303,7 @@ void faiss::IndexBinaryFromFloat::train (idx_t n, const uint8_t *x) override train + faiss::IndexBinaryFromFloat::train train idx_t @@ -330,6 +345,7 @@ virtual void faiss::IndexBinary::add_with_ids (idx_t n, const uint8_t *x, const idx_t *xids) add_with_ids + faiss::IndexBinary::add_with_ids add_with_ids add_with_ids @@ -369,6 +385,7 @@ virtual void faiss::IndexBinary::range_search (idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::IndexBinary::range_search range_search range_search range_search @@ -435,6 +452,7 @@ void faiss::IndexBinary::assign (idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1) const assign + faiss::IndexBinary::assign idx_t n @@ -484,6 +502,7 @@ virtual size_t faiss::IndexBinary::remove_ids (const IDSelector &sel) remove_ids + faiss::IndexBinary::remove_ids remove_ids remove_ids @@ -504,6 +523,7 @@ virtual void faiss::IndexBinary::reconstruct (idx_t key, uint8_t *recons) const reconstruct + faiss::IndexBinary::reconstruct reconstruct reconstruct reconstruct @@ -548,6 +568,7 @@ virtual void faiss::IndexBinary::reconstruct_n (idx_t i0, idx_t ni, uint8_t *recons) const reconstruct_n + faiss::IndexBinary::reconstruct_n reconstruct_n idx_t @@ -585,6 +606,7 @@ virtual void faiss::IndexBinary::search_and_reconstruct (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::IndexBinary::search_and_reconstruct search_and_reconstruct idx_t @@ -640,6 +662,7 @@ void faiss::IndexBinary::display () const display + faiss::IndexBinary::display @@ -654,6 +677,7 @@ virtual void faiss::IndexBinary::merge_from (IndexBinary &otherIndex, idx_t add_id=0) merge_from + faiss::IndexBinary::merge_from merge_from IndexBinary & @@ -678,6 +702,7 @@ virtual void faiss::IndexBinary::check_compatible_for_merge (const IndexBinary &otherIndex) const check_compatible_for_merge + faiss::IndexBinary::check_compatible_for_merge check_compatible_for_merge const IndexBinary & @@ -697,6 +722,7 @@ virtual size_t faiss::IndexBinary::sa_code_size () const sa_code_size + faiss::IndexBinary::sa_code_size @@ -711,6 +737,7 @@ virtual void faiss::IndexBinary::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::IndexBinary::add_sa_codes idx_t n @@ -732,13 +759,14 @@ - - + + uint8_t using faiss::IndexBinary::component_t = uint8_t component_t + faiss::IndexBinary::component_t @@ -752,6 +780,7 @@ using faiss::IndexBinary::distance_t = int32_t distance_t + faiss::IndexBinary::distance_t @@ -760,7 +789,7 @@ - + @@ -769,22 +798,26 @@ All queries are symmetric because there is no distinction between codes and vectors. + + + + - - - - + + + + @@ -794,10 +827,6 @@ index - - - - diff --git a/xml/structfaiss_1_1IndexBinaryHNSW.xml b/xml/structfaiss_1_1IndexBinaryHNSW.xml index cfde7b81ac..ee00fc3c3e 100644 --- a/xml/structfaiss_1_1IndexBinaryHNSW.xml +++ b/xml/structfaiss_1_1IndexBinaryHNSW.xml @@ -1,15 +1,16 @@ - + faiss::IndexBinaryHNSW faiss::IndexBinary IndexBinaryHNSW.h - + HNSW::storage_idx_t typedef HNSW::storage_idx_t faiss::IndexBinaryHNSW::storage_idx_t storage_idx_t + faiss::IndexBinaryHNSW::storage_idx_t @@ -23,6 +24,7 @@ using faiss::IndexBinary::component_t = uint8_t component_t + faiss::IndexBinary::component_t @@ -36,6 +38,7 @@ using faiss::IndexBinary::distance_t = int32_t distance_t + faiss::IndexBinary::distance_t @@ -44,13 +47,14 @@ - - + + HNSW HNSW faiss::IndexBinaryHNSW::hnsw hnsw + faiss::IndexBinaryHNSW::hnsw @@ -64,6 +68,7 @@ bool faiss::IndexBinaryHNSW::own_fields own_fields + faiss::IndexBinaryHNSW::own_fields @@ -77,6 +82,7 @@ IndexBinary* faiss::IndexBinaryHNSW::storage storage + faiss::IndexBinaryHNSW::storage @@ -90,6 +96,7 @@ int faiss::IndexBinary::d d + faiss::IndexBinary::d = 0 vector dimension @@ -105,6 +112,7 @@ int faiss::IndexBinary::code_size code_size + faiss::IndexBinary::code_size = 0 number of bytes per vector ( = d / 8 ) @@ -120,6 +128,7 @@ idx_t faiss::IndexBinary::ntotal ntotal + faiss::IndexBinary::ntotal = 0 total nb of indexed vectors @@ -135,6 +144,7 @@ bool faiss::IndexBinary::verbose verbose + faiss::IndexBinary::verbose = false verbosity level @@ -150,6 +160,7 @@ bool faiss::IndexBinary::is_trained is_trained + faiss::IndexBinary::is_trained = true @@ -165,6 +176,7 @@ MetricType faiss::IndexBinary::metric_type metric_type + faiss::IndexBinary::metric_type = METRIC_L2 type of metric this index uses for search @@ -175,13 +187,14 @@ - - + + faiss::IndexBinaryHNSW::IndexBinaryHNSW () IndexBinaryHNSW + faiss::IndexBinaryHNSW::IndexBinaryHNSW @@ -195,6 +208,7 @@ faiss::IndexBinaryHNSW::IndexBinaryHNSW (int d, int M=32) IndexBinaryHNSW + faiss::IndexBinaryHNSW::IndexBinaryHNSW int d @@ -217,6 +231,7 @@ faiss::IndexBinaryHNSW::IndexBinaryHNSW (IndexBinary *storage, int M=32) IndexBinaryHNSW + faiss::IndexBinaryHNSW::IndexBinaryHNSW IndexBinary * storage @@ -239,6 +254,7 @@ faiss::IndexBinaryHNSW::~IndexBinaryHNSW () override ~IndexBinaryHNSW + faiss::IndexBinaryHNSW::~IndexBinaryHNSW @@ -247,11 +263,12 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexBinaryHNSW::get_distance_computer + DistanceComputer * faiss::IndexBinaryHNSW::get_distance_computer () const get_distance_computer + faiss::IndexBinaryHNSW::get_distance_computer @@ -265,6 +282,7 @@ void faiss::IndexBinaryHNSW::add (idx_t n, const uint8_t *x) override add + faiss::IndexBinaryHNSW::add add idx_t @@ -298,6 +316,7 @@ void faiss::IndexBinaryHNSW::train (idx_t n, const uint8_t *x) override train + faiss::IndexBinaryHNSW::train train idx_t @@ -321,6 +340,7 @@ void faiss::IndexBinaryHNSW::search (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexBinaryHNSW::search search idx_t @@ -361,6 +381,7 @@ void faiss::IndexBinaryHNSW::reconstruct (idx_t key, uint8_t *recons) const override reconstruct + faiss::IndexBinaryHNSW::reconstruct reconstruct idx_t @@ -402,6 +423,7 @@ void faiss::IndexBinaryHNSW::reset () override reset + faiss::IndexBinaryHNSW::reset reset Removes all elements from the database. @@ -417,6 +439,7 @@ virtual void faiss::IndexBinary::add_with_ids (idx_t n, const uint8_t *x, const idx_t *xids) add_with_ids + faiss::IndexBinary::add_with_ids add_with_ids add_with_ids @@ -456,6 +479,7 @@ virtual void faiss::IndexBinary::range_search (idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::IndexBinary::range_search range_search range_search range_search @@ -522,6 +546,7 @@ void faiss::IndexBinary::assign (idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1) const assign + faiss::IndexBinary::assign idx_t n @@ -571,6 +596,7 @@ virtual size_t faiss::IndexBinary::remove_ids (const IDSelector &sel) remove_ids + faiss::IndexBinary::remove_ids remove_ids remove_ids @@ -591,6 +617,7 @@ virtual void faiss::IndexBinary::reconstruct_n (idx_t i0, idx_t ni, uint8_t *recons) const reconstruct_n + faiss::IndexBinary::reconstruct_n reconstruct_n idx_t @@ -628,6 +655,7 @@ virtual void faiss::IndexBinary::search_and_reconstruct (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::IndexBinary::search_and_reconstruct search_and_reconstruct idx_t @@ -683,6 +711,7 @@ void faiss::IndexBinary::display () const display + faiss::IndexBinary::display @@ -697,6 +726,7 @@ virtual void faiss::IndexBinary::merge_from (IndexBinary &otherIndex, idx_t add_id=0) merge_from + faiss::IndexBinary::merge_from merge_from IndexBinary & @@ -721,6 +751,7 @@ virtual void faiss::IndexBinary::check_compatible_for_merge (const IndexBinary &otherIndex) const check_compatible_for_merge + faiss::IndexBinary::check_compatible_for_merge check_compatible_for_merge const IndexBinary & @@ -740,6 +771,7 @@ virtual size_t faiss::IndexBinary::sa_code_size () const sa_code_size + faiss::IndexBinary::sa_code_size @@ -754,6 +786,7 @@ virtual void faiss::IndexBinary::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::IndexBinary::add_sa_codes idx_t n @@ -775,25 +808,36 @@ - + The HNSW index is a normal random-access index with a HNSW link structure built on top + + + + + + + + + + + rng + + - - @@ -810,17 +854,6 @@ - - - - - rng - - - - - - @@ -834,7 +867,7 @@ faiss::IndexBinaryHNSWd faiss::IndexBinaryHNSWdisplay faiss::IndexBinaryHNSWdistance_t - faiss::IndexBinaryHNSWget_distance_computer + faiss::IndexBinaryHNSWget_distance_computer faiss::IndexBinaryHNSWhnsw faiss::IndexBinaryHNSWIndexBinary faiss::IndexBinaryHNSWIndexBinaryHNSW diff --git a/xml/structfaiss_1_1IndexBinaryHash.xml b/xml/structfaiss_1_1IndexBinaryHash.xml index 123c799413..4c8d112fff 100644 --- a/xml/structfaiss_1_1IndexBinaryHash.xml +++ b/xml/structfaiss_1_1IndexBinaryHash.xml @@ -1,16 +1,17 @@ - + faiss::IndexBinaryHash faiss::IndexBinary IndexBinaryHash.h faiss::IndexBinaryHash::InvertedList - + std::unordered_map< idx_t, InvertedList > using faiss::IndexBinaryHash::InvertedListMap = std::unordered_map<idx_t, InvertedList> InvertedListMap + faiss::IndexBinaryHash::InvertedListMap @@ -24,6 +25,7 @@ using faiss::IndexBinary::component_t = uint8_t component_t + faiss::IndexBinary::component_t @@ -37,6 +39,7 @@ using faiss::IndexBinary::distance_t = int32_t distance_t + faiss::IndexBinary::distance_t @@ -45,13 +48,14 @@ - - + + InvertedListMap InvertedListMap faiss::IndexBinaryHash::invlists invlists + faiss::IndexBinaryHash::invlists @@ -65,6 +69,7 @@ int faiss::IndexBinaryHash::b b + faiss::IndexBinaryHash::b @@ -78,6 +83,7 @@ int faiss::IndexBinaryHash::nflip nflip + faiss::IndexBinaryHash::nflip @@ -91,6 +97,7 @@ int faiss::IndexBinary::d d + faiss::IndexBinary::d = 0 vector dimension @@ -106,6 +113,7 @@ int faiss::IndexBinary::code_size code_size + faiss::IndexBinary::code_size = 0 number of bytes per vector ( = d / 8 ) @@ -121,6 +129,7 @@ idx_t faiss::IndexBinary::ntotal ntotal + faiss::IndexBinary::ntotal = 0 total nb of indexed vectors @@ -136,6 +145,7 @@ bool faiss::IndexBinary::verbose verbose + faiss::IndexBinary::verbose = false verbosity level @@ -151,6 +161,7 @@ bool faiss::IndexBinary::is_trained is_trained + faiss::IndexBinary::is_trained = true @@ -166,6 +177,7 @@ MetricType faiss::IndexBinary::metric_type metric_type + faiss::IndexBinary::metric_type = METRIC_L2 type of metric this index uses for search @@ -176,13 +188,14 @@ - - + + faiss::IndexBinaryHash::IndexBinaryHash (int d, int b) IndexBinaryHash + faiss::IndexBinaryHash::IndexBinaryHash int d @@ -204,6 +217,7 @@ faiss::IndexBinaryHash::IndexBinaryHash () IndexBinaryHash + faiss::IndexBinaryHash::IndexBinaryHash @@ -217,6 +231,7 @@ void faiss::IndexBinaryHash::reset () override reset + faiss::IndexBinaryHash::reset reset Removes all elements from the database. @@ -232,6 +247,7 @@ void faiss::IndexBinaryHash::add (idx_t n, const uint8_t *x) override add + faiss::IndexBinaryHash::add add idx_t @@ -265,6 +281,7 @@ void faiss::IndexBinaryHash::add_with_ids (idx_t n, const uint8_t *x, const idx_t *xids) override add_with_ids + faiss::IndexBinaryHash::add_with_ids add_with_ids idx_t @@ -303,6 +320,7 @@ void faiss::IndexBinaryHash::range_search (idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexBinaryHash::range_search range_search idx_t @@ -366,6 +384,7 @@ void faiss::IndexBinaryHash::search (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexBinaryHash::search search idx_t @@ -433,6 +452,7 @@ void faiss::IndexBinaryHash::display () const display + faiss::IndexBinaryHash::display @@ -446,6 +466,7 @@ size_t faiss::IndexBinaryHash::hashtable_size () const hashtable_size + faiss::IndexBinaryHash::hashtable_size @@ -459,6 +480,7 @@ virtual void faiss::IndexBinary::train (idx_t n, const uint8_t *x) train + faiss::IndexBinary::train train train train @@ -502,6 +524,7 @@ void faiss::IndexBinary::assign (idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1) const assign + faiss::IndexBinary::assign idx_t n @@ -551,6 +574,7 @@ virtual size_t faiss::IndexBinary::remove_ids (const IDSelector &sel) remove_ids + faiss::IndexBinary::remove_ids remove_ids remove_ids @@ -571,6 +595,7 @@ virtual void faiss::IndexBinary::reconstruct (idx_t key, uint8_t *recons) const reconstruct + faiss::IndexBinary::reconstruct reconstruct reconstruct reconstruct @@ -615,6 +640,7 @@ virtual void faiss::IndexBinary::reconstruct_n (idx_t i0, idx_t ni, uint8_t *recons) const reconstruct_n + faiss::IndexBinary::reconstruct_n reconstruct_n idx_t @@ -652,6 +678,7 @@ virtual void faiss::IndexBinary::search_and_reconstruct (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::IndexBinary::search_and_reconstruct search_and_reconstruct idx_t @@ -707,6 +734,7 @@ virtual void faiss::IndexBinary::merge_from (IndexBinary &otherIndex, idx_t add_id=0) merge_from + faiss::IndexBinary::merge_from merge_from IndexBinary & @@ -731,6 +759,7 @@ virtual void faiss::IndexBinary::check_compatible_for_merge (const IndexBinary &otherIndex) const check_compatible_for_merge + faiss::IndexBinary::check_compatible_for_merge check_compatible_for_merge const IndexBinary & @@ -750,6 +779,7 @@ virtual size_t faiss::IndexBinary::sa_code_size () const sa_code_size + faiss::IndexBinary::sa_code_size @@ -764,6 +794,7 @@ virtual void faiss::IndexBinary::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::IndexBinary::add_sa_codes idx_t n @@ -785,35 +816,35 @@ - + just uses the b first bits as a hash value + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1IndexBinaryHashStats.xml b/xml/structfaiss_1_1IndexBinaryHashStats.xml index 107be0dd12..e1cd79fa91 100644 --- a/xml/structfaiss_1_1IndexBinaryHashStats.xml +++ b/xml/structfaiss_1_1IndexBinaryHashStats.xml @@ -1,13 +1,14 @@ - + faiss::IndexBinaryHashStats - + size_t size_t faiss::IndexBinaryHashStats::nq nq + faiss::IndexBinaryHashStats::nq @@ -21,6 +22,7 @@ size_t faiss::IndexBinaryHashStats::n0 n0 + faiss::IndexBinaryHashStats::n0 @@ -34,6 +36,7 @@ size_t faiss::IndexBinaryHashStats::nlist nlist + faiss::IndexBinaryHashStats::nlist @@ -47,6 +50,7 @@ size_t faiss::IndexBinaryHashStats::ndis ndis + faiss::IndexBinaryHashStats::ndis @@ -55,13 +59,14 @@ - - + + faiss::IndexBinaryHashStats::IndexBinaryHashStats () IndexBinaryHashStats + faiss::IndexBinaryHashStats::IndexBinaryHashStats @@ -75,6 +80,7 @@ void faiss::IndexBinaryHashStats::reset () reset + faiss::IndexBinaryHashStats::reset @@ -83,7 +89,7 @@ - + diff --git a/xml/structfaiss_1_1IndexBinaryHash_1_1InvertedList.xml b/xml/structfaiss_1_1IndexBinaryHash_1_1InvertedList.xml index 8fb29b638f..da42ab94a4 100644 --- a/xml/structfaiss_1_1IndexBinaryHash_1_1InvertedList.xml +++ b/xml/structfaiss_1_1IndexBinaryHash_1_1InvertedList.xml @@ -1,13 +1,14 @@ - + faiss::IndexBinaryHash::InvertedList - + std::vector< idx_t > std::vector<idx_t> faiss::IndexBinaryHash::InvertedList::ids ids + faiss::IndexBinaryHash::InvertedList::ids @@ -21,6 +22,7 @@ std::vector<uint8_t> faiss::IndexBinaryHash::InvertedList::vecs vecs + faiss::IndexBinaryHash::InvertedList::vecs @@ -29,13 +31,14 @@ - - + + void void faiss::IndexBinaryHash::InvertedList::add (idx_t id, size_t code_size, const uint8_t *code) add + faiss::IndexBinaryHash::InvertedList::add idx_t id @@ -56,7 +59,7 @@ - + diff --git a/xml/structfaiss_1_1IndexBinaryIVF.xml b/xml/structfaiss_1_1IndexBinaryIVF.xml index 8a406fabee..ee3dd10ddc 100644 --- a/xml/structfaiss_1_1IndexBinaryIVF.xml +++ b/xml/structfaiss_1_1IndexBinaryIVF.xml @@ -1,15 +1,16 @@ - + faiss::IndexBinaryIVF faiss::IndexBinary IndexBinaryIVF.h - + InvertedLists * InvertedLists* faiss::IndexBinaryIVF::invlists invlists + faiss::IndexBinaryIVF::invlists = nullptr Access to the actual data. @@ -25,6 +26,7 @@ bool faiss::IndexBinaryIVF::own_invlists own_invlists + faiss::IndexBinaryIVF::own_invlists = true @@ -39,6 +41,7 @@ size_t faiss::IndexBinaryIVF::nprobe nprobe + faiss::IndexBinaryIVF::nprobe = 1 number of probes at query time @@ -54,6 +57,7 @@ size_t faiss::IndexBinaryIVF::max_codes max_codes + faiss::IndexBinaryIVF::max_codes = 0 max nb of codes to visit to do a query @@ -69,6 +73,7 @@ bool faiss::IndexBinaryIVF::use_heap use_heap + faiss::IndexBinaryIVF::use_heap = true @@ -84,6 +89,7 @@ bool faiss::IndexBinaryIVF::per_invlist_search per_invlist_search + faiss::IndexBinaryIVF::per_invlist_search = false @@ -99,6 +105,7 @@ DirectMap faiss::IndexBinaryIVF::direct_map direct_map + faiss::IndexBinaryIVF::direct_map map for direct access to the elements. Enables reconstruct(). @@ -113,6 +120,7 @@ IndexBinary* faiss::IndexBinaryIVF::quantizer quantizer + faiss::IndexBinaryIVF::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -128,6 +136,7 @@ size_t faiss::IndexBinaryIVF::nlist nlist + faiss::IndexBinaryIVF::nlist = 0 number of possible key values @@ -143,6 +152,7 @@ bool faiss::IndexBinaryIVF::own_fields own_fields + faiss::IndexBinaryIVF::own_fields = false whether object owns the quantizer @@ -158,6 +168,7 @@ ClusteringParameters faiss::IndexBinaryIVF::cp cp + faiss::IndexBinaryIVF::cp to override default clustering params @@ -172,6 +183,7 @@ Index* faiss::IndexBinaryIVF::clustering_index clustering_index + faiss::IndexBinaryIVF::clustering_index = nullptr to override index used during clustering @@ -187,6 +199,7 @@ int faiss::IndexBinary::d d + faiss::IndexBinary::d = 0 vector dimension @@ -202,6 +215,7 @@ int faiss::IndexBinary::code_size code_size + faiss::IndexBinary::code_size = 0 number of bytes per vector ( = d / 8 ) @@ -217,6 +231,7 @@ idx_t faiss::IndexBinary::ntotal ntotal + faiss::IndexBinary::ntotal = 0 total nb of indexed vectors @@ -232,6 +247,7 @@ bool faiss::IndexBinary::verbose verbose + faiss::IndexBinary::verbose = false verbosity level @@ -247,6 +263,7 @@ bool faiss::IndexBinary::is_trained is_trained + faiss::IndexBinary::is_trained = true @@ -262,6 +279,7 @@ MetricType faiss::IndexBinary::metric_type metric_type + faiss::IndexBinary::metric_type = METRIC_L2 type of metric this index uses for search @@ -272,13 +290,14 @@ - - + + faiss::IndexBinaryIVF::IndexBinaryIVF (IndexBinary *quantizer, size_t d, size_t nlist) IndexBinaryIVF + faiss::IndexBinaryIVF::IndexBinaryIVF IndexBinary * quantizer @@ -305,6 +324,7 @@ faiss::IndexBinaryIVF::IndexBinaryIVF () IndexBinaryIVF + faiss::IndexBinaryIVF::IndexBinaryIVF @@ -318,6 +338,7 @@ faiss::IndexBinaryIVF::~IndexBinaryIVF () override ~IndexBinaryIVF + faiss::IndexBinaryIVF::~IndexBinaryIVF @@ -331,6 +352,7 @@ void faiss::IndexBinaryIVF::reset () override reset + faiss::IndexBinaryIVF::reset reset Removes all elements from the database. @@ -346,6 +368,7 @@ void faiss::IndexBinaryIVF::train (idx_t n, const uint8_t *x) override train + faiss::IndexBinaryIVF::train train idx_t @@ -369,6 +392,7 @@ void faiss::IndexBinaryIVF::add (idx_t n, const uint8_t *x) override add + faiss::IndexBinaryIVF::add add idx_t @@ -402,6 +426,7 @@ void faiss::IndexBinaryIVF::add_with_ids (idx_t n, const uint8_t *x, const idx_t *xids) override add_with_ids + faiss::IndexBinaryIVF::add_with_ids add_with_ids idx_t @@ -440,6 +465,7 @@ void faiss::IndexBinaryIVF::add_core (idx_t n, const uint8_t *x, const idx_t *xids, const idx_t *precomputed_idx) add_core + faiss::IndexBinaryIVF::add_core idx_t n @@ -480,6 +506,7 @@ void faiss::IndexBinaryIVF::search_preassigned (idx_t n, const uint8_t *x, idx_t k, const idx_t *assign, const int32_t *centroid_dis, int32_t *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr) const search_preassigned + faiss::IndexBinaryIVF::search_preassigned idx_t n @@ -592,11 +619,12 @@ - + BinaryInvertedListScanner * - virtual BinaryInvertedListScanner* faiss::IndexBinaryIVF::get_InvertedListScanner + virtual BinaryInvertedListScanner * faiss::IndexBinaryIVF::get_InvertedListScanner (bool store_pairs=false) const get_InvertedListScanner + faiss::IndexBinaryIVF::get_InvertedListScanner bool store_pairs @@ -615,6 +643,7 @@ void faiss::IndexBinaryIVF::search (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexBinaryIVF::search search idx_t @@ -655,6 +684,7 @@ void faiss::IndexBinaryIVF::range_search (idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexBinaryIVF::range_search range_search idx_t @@ -718,6 +748,7 @@ void faiss::IndexBinaryIVF::range_search_preassigned (idx_t n, const uint8_t *x, int radius, const idx_t *assign, const int32_t *centroid_dis, RangeSearchResult *result) const range_search_preassigned + faiss::IndexBinaryIVF::range_search_preassigned idx_t n @@ -755,6 +786,7 @@ void faiss::IndexBinaryIVF::reconstruct (idx_t key, uint8_t *recons) const override reconstruct + faiss::IndexBinaryIVF::reconstruct reconstruct idx_t @@ -796,6 +828,7 @@ void faiss::IndexBinaryIVF::reconstruct_n (idx_t i0, idx_t ni, uint8_t *recons) const override reconstruct_n + faiss::IndexBinaryIVF::reconstruct_n reconstruct_n idx_t @@ -850,6 +883,7 @@ void faiss::IndexBinaryIVF::search_and_reconstruct (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexBinaryIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -905,6 +939,7 @@ virtual void faiss::IndexBinaryIVF::reconstruct_from_offset (idx_t list_no, idx_t offset, uint8_t *recons) const reconstruct_from_offset + faiss::IndexBinaryIVF::reconstruct_from_offset idx_t list_no @@ -932,6 +967,7 @@ size_t faiss::IndexBinaryIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexBinaryIVF::remove_ids remove_ids const IDSelector & @@ -951,6 +987,7 @@ void faiss::IndexBinaryIVF::merge_from (IndexBinary &other, idx_t add_id) override merge_from + faiss::IndexBinaryIVF::merge_from merge_from IndexBinary & @@ -974,6 +1011,7 @@ void faiss::IndexBinaryIVF::check_compatible_for_merge (const IndexBinary &otherIndex) const override check_compatible_for_merge + faiss::IndexBinaryIVF::check_compatible_for_merge check_compatible_for_merge const IndexBinary & @@ -993,6 +1031,7 @@ size_t faiss::IndexBinaryIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexBinaryIVF::get_list_size size_t list_no @@ -1010,6 +1049,7 @@ void faiss::IndexBinaryIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexBinaryIVF::make_direct_map bool new_maintain_direct_map @@ -1039,6 +1079,7 @@ void faiss::IndexBinaryIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexBinaryIVF::set_direct_map_type DirectMap::Type type @@ -1056,6 +1097,7 @@ void faiss::IndexBinaryIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexBinaryIVF::replace_invlists InvertedLists * il @@ -1078,6 +1120,7 @@ void faiss::IndexBinary::assign (idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1) const assign + faiss::IndexBinary::assign idx_t n @@ -1127,6 +1170,7 @@ void faiss::IndexBinary::display () const display + faiss::IndexBinary::display @@ -1141,6 +1185,7 @@ virtual size_t faiss::IndexBinary::sa_code_size () const sa_code_size + faiss::IndexBinary::sa_code_size @@ -1155,6 +1200,7 @@ virtual void faiss::IndexBinary::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::IndexBinary::add_sa_codes idx_t n @@ -1176,13 +1222,14 @@ - - + + uint8_t using faiss::IndexBinary::component_t = uint8_t component_t + faiss::IndexBinary::component_t @@ -1196,6 +1243,7 @@ using faiss::IndexBinary::distance_t = int32_t distance_t + faiss::IndexBinary::distance_t @@ -1204,7 +1252,7 @@ - + @@ -1213,58 +1261,58 @@ Otherwise the object is similar to the IndexIVF + + + + - - - - + + + + - - + + + + + + + + + + - - quantizer - - direct_map + invlists - invlists + direct_map + + + quantizer - clustering_index + cp - cp + clustering_index - - - - - - - - - - - - - - + + @@ -1283,7 +1331,7 @@ faiss::IndexBinaryIVFdirect_map faiss::IndexBinaryIVFdisplay faiss::IndexBinaryIVFdistance_t - faiss::IndexBinaryIVFget_InvertedListScanner + faiss::IndexBinaryIVFget_InvertedListScanner faiss::IndexBinaryIVFget_list_size faiss::IndexBinaryIVFIndexBinary faiss::IndexBinaryIVFIndexBinaryIVF diff --git a/xml/structfaiss_1_1IndexBinaryMultiHash.xml b/xml/structfaiss_1_1IndexBinaryMultiHash.xml index 47de992fdb..9830c9401d 100644 --- a/xml/structfaiss_1_1IndexBinaryMultiHash.xml +++ b/xml/structfaiss_1_1IndexBinaryMultiHash.xml @@ -1,15 +1,16 @@ - + faiss::IndexBinaryMultiHash faiss::IndexBinary IndexBinaryHash.h - + std::unordered_map< idx_t, std::vector< idx_t > > using faiss::IndexBinaryMultiHash::Map = std::unordered_map<idx_t, std::vector<idx_t> > Map + faiss::IndexBinaryMultiHash::Map @@ -23,6 +24,7 @@ using faiss::IndexBinary::component_t = uint8_t component_t + faiss::IndexBinary::component_t @@ -36,6 +38,7 @@ using faiss::IndexBinary::distance_t = int32_t distance_t + faiss::IndexBinary::distance_t @@ -44,13 +47,14 @@ - - + + IndexBinaryFlat * IndexBinaryFlat* faiss::IndexBinaryMultiHash::storage storage + faiss::IndexBinaryMultiHash::storage @@ -64,6 +68,7 @@ bool faiss::IndexBinaryMultiHash::own_fields own_fields + faiss::IndexBinaryMultiHash::own_fields @@ -77,6 +82,7 @@ std::vector<Map> faiss::IndexBinaryMultiHash::maps maps + faiss::IndexBinaryMultiHash::maps @@ -90,6 +96,7 @@ int faiss::IndexBinaryMultiHash::nhash nhash + faiss::IndexBinaryMultiHash::nhash nb of hash maps @@ -104,6 +111,7 @@ int faiss::IndexBinaryMultiHash::b b + faiss::IndexBinaryMultiHash::b nb bits per hash map @@ -118,6 +126,7 @@ int faiss::IndexBinaryMultiHash::nflip nflip + faiss::IndexBinaryMultiHash::nflip nb bit flips to use at search time @@ -132,6 +141,7 @@ int faiss::IndexBinary::d d + faiss::IndexBinary::d = 0 vector dimension @@ -147,6 +157,7 @@ int faiss::IndexBinary::code_size code_size + faiss::IndexBinary::code_size = 0 number of bytes per vector ( = d / 8 ) @@ -162,6 +173,7 @@ idx_t faiss::IndexBinary::ntotal ntotal + faiss::IndexBinary::ntotal = 0 total nb of indexed vectors @@ -177,6 +189,7 @@ bool faiss::IndexBinary::verbose verbose + faiss::IndexBinary::verbose = false verbosity level @@ -192,6 +205,7 @@ bool faiss::IndexBinary::is_trained is_trained + faiss::IndexBinary::is_trained = true @@ -207,6 +221,7 @@ MetricType faiss::IndexBinary::metric_type metric_type + faiss::IndexBinary::metric_type = METRIC_L2 type of metric this index uses for search @@ -217,13 +232,14 @@ - - + + faiss::IndexBinaryMultiHash::IndexBinaryMultiHash (int d, int nhash, int b) IndexBinaryMultiHash + faiss::IndexBinaryMultiHash::IndexBinaryMultiHash int d @@ -249,6 +265,7 @@ faiss::IndexBinaryMultiHash::IndexBinaryMultiHash () IndexBinaryMultiHash + faiss::IndexBinaryMultiHash::IndexBinaryMultiHash @@ -262,6 +279,7 @@ faiss::IndexBinaryMultiHash::~IndexBinaryMultiHash () ~IndexBinaryMultiHash + faiss::IndexBinaryMultiHash::~IndexBinaryMultiHash @@ -275,6 +293,7 @@ void faiss::IndexBinaryMultiHash::reset () override reset + faiss::IndexBinaryMultiHash::reset reset Removes all elements from the database. @@ -290,6 +309,7 @@ void faiss::IndexBinaryMultiHash::add (idx_t n, const uint8_t *x) override add + faiss::IndexBinaryMultiHash::add add idx_t @@ -323,6 +343,7 @@ void faiss::IndexBinaryMultiHash::range_search (idx_t n, const uint8_t *x, int radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexBinaryMultiHash::range_search range_search idx_t @@ -386,6 +407,7 @@ void faiss::IndexBinaryMultiHash::search (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexBinaryMultiHash::search search idx_t @@ -453,6 +475,7 @@ size_t faiss::IndexBinaryMultiHash::hashtable_size () const hashtable_size + faiss::IndexBinaryMultiHash::hashtable_size @@ -466,6 +489,7 @@ virtual void faiss::IndexBinary::train (idx_t n, const uint8_t *x) train + faiss::IndexBinary::train train train train @@ -509,6 +533,7 @@ virtual void faiss::IndexBinary::add_with_ids (idx_t n, const uint8_t *x, const idx_t *xids) add_with_ids + faiss::IndexBinary::add_with_ids add_with_ids add_with_ids @@ -548,6 +573,7 @@ void faiss::IndexBinary::assign (idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1) const assign + faiss::IndexBinary::assign idx_t n @@ -597,6 +623,7 @@ virtual size_t faiss::IndexBinary::remove_ids (const IDSelector &sel) remove_ids + faiss::IndexBinary::remove_ids remove_ids remove_ids @@ -617,6 +644,7 @@ virtual void faiss::IndexBinary::reconstruct (idx_t key, uint8_t *recons) const reconstruct + faiss::IndexBinary::reconstruct reconstruct reconstruct reconstruct @@ -661,6 +689,7 @@ virtual void faiss::IndexBinary::reconstruct_n (idx_t i0, idx_t ni, uint8_t *recons) const reconstruct_n + faiss::IndexBinary::reconstruct_n reconstruct_n idx_t @@ -698,6 +727,7 @@ virtual void faiss::IndexBinary::search_and_reconstruct (idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::IndexBinary::search_and_reconstruct search_and_reconstruct idx_t @@ -753,6 +783,7 @@ void faiss::IndexBinary::display () const display + faiss::IndexBinary::display @@ -767,6 +798,7 @@ virtual void faiss::IndexBinary::merge_from (IndexBinary &otherIndex, idx_t add_id=0) merge_from + faiss::IndexBinary::merge_from merge_from IndexBinary & @@ -791,6 +823,7 @@ virtual void faiss::IndexBinary::check_compatible_for_merge (const IndexBinary &otherIndex) const check_compatible_for_merge + faiss::IndexBinary::check_compatible_for_merge check_compatible_for_merge const IndexBinary & @@ -810,6 +843,7 @@ virtual size_t faiss::IndexBinary::sa_code_size () const sa_code_size + faiss::IndexBinary::sa_code_size @@ -824,6 +858,7 @@ virtual void faiss::IndexBinary::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::IndexBinary::add_sa_codes idx_t n @@ -845,25 +880,35 @@ - + just uses the b first bits as a hash value + + + + + + - - + + + + + + @@ -873,16 +918,6 @@ storage - - - - - - - - - - diff --git a/xml/structfaiss_1_1IndexFastScan.xml b/xml/structfaiss_1_1IndexFastScan.xml index ea77e37f6e..fef810db43 100644 --- a/xml/structfaiss_1_1IndexFastScan.xml +++ b/xml/structfaiss_1_1IndexFastScan.xml @@ -1,17 +1,18 @@ - + faiss::IndexFastScan faiss::Index faiss::IndexAdditiveQuantizerFastScan faiss::IndexPQFastScan IndexFastScan.h - + int int faiss::IndexFastScan::implem implem + faiss::IndexFastScan::implem = 0 @@ -26,6 +27,7 @@ int faiss::IndexFastScan::skip skip + faiss::IndexFastScan::skip = 0 @@ -40,6 +42,7 @@ int faiss::IndexFastScan::bbs bbs + faiss::IndexFastScan::bbs @@ -53,6 +56,7 @@ int faiss::IndexFastScan::qbs qbs + faiss::IndexFastScan::qbs = 0 @@ -67,6 +71,7 @@ size_t faiss::IndexFastScan::M M + faiss::IndexFastScan::M @@ -80,6 +85,7 @@ size_t faiss::IndexFastScan::nbits nbits + faiss::IndexFastScan::nbits @@ -93,6 +99,7 @@ size_t faiss::IndexFastScan::ksub ksub + faiss::IndexFastScan::ksub @@ -106,6 +113,7 @@ size_t faiss::IndexFastScan::code_size code_size + faiss::IndexFastScan::code_size @@ -119,6 +127,7 @@ size_t faiss::IndexFastScan::ntotal2 ntotal2 + faiss::IndexFastScan::ntotal2 @@ -132,6 +141,7 @@ size_t faiss::IndexFastScan::M2 M2 + faiss::IndexFastScan::M2 @@ -145,6 +155,7 @@ AlignedTable<uint8_t> faiss::IndexFastScan::codes codes + faiss::IndexFastScan::codes @@ -158,6 +169,7 @@ const uint8_t* faiss::IndexFastScan::orig_codes orig_codes + faiss::IndexFastScan::orig_codes = nullptr @@ -172,6 +184,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -186,6 +199,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -200,6 +214,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -214,6 +229,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -228,6 +244,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -242,6 +259,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -251,13 +269,14 @@ - - + + void void faiss::IndexFastScan::init_fastscan (int d, size_t M, size_t nbits, MetricType metric, int bbs) init_fastscan + faiss::IndexFastScan::init_fastscan int d @@ -291,6 +310,7 @@ faiss::IndexFastScan::IndexFastScan () IndexFastScan + faiss::IndexFastScan::IndexFastScan @@ -304,6 +324,7 @@ void faiss::IndexFastScan::reset () override reset + faiss::IndexFastScan::reset reset removes all elements from the database. @@ -319,6 +340,7 @@ void faiss::IndexFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFastScan::search search idx_t @@ -402,6 +424,7 @@ void faiss::IndexFastScan::add (idx_t n, const float *x) override add + faiss::IndexFastScan::add add idx_t @@ -443,6 +466,7 @@ virtual void faiss::IndexFastScan::compute_codes (uint8_t *codes, idx_t n, const float *x) const =0 compute_codes + faiss::IndexFastScan::compute_codes compute_codes compute_codes @@ -470,6 +494,7 @@ virtual void faiss::IndexFastScan::compute_float_LUT (float *lut, idx_t n, const float *x) const =0 compute_float_LUT + faiss::IndexFastScan::compute_float_LUT compute_float_LUT compute_float_LUT @@ -497,6 +522,7 @@ void faiss::IndexFastScan::compute_quantized_LUT (idx_t n, const float *x, uint8_t *lut, float *normalizers) const compute_quantized_LUT + faiss::IndexFastScan::compute_quantized_LUT idx_t n @@ -533,6 +559,7 @@ void faiss::IndexFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_dispatch_implem + faiss::IndexFastScan::search_dispatch_implem idx_t n @@ -575,6 +602,7 @@ void faiss::IndexFastScan::search_implem_234 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_implem_234 + faiss::IndexFastScan::search_implem_234 idx_t n @@ -617,6 +645,7 @@ void faiss::IndexFastScan::search_implem_12 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_12 + faiss::IndexFastScan::search_implem_12 idx_t n @@ -663,6 +692,7 @@ void faiss::IndexFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_14 + faiss::IndexFastScan::search_implem_14 idx_t n @@ -704,6 +734,7 @@ void faiss::IndexFastScan::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFastScan::reconstruct reconstruct idx_t @@ -745,6 +776,7 @@ size_t faiss::IndexFastScan::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFastScan::remove_ids remove_ids const IDSelector & @@ -759,11 +791,12 @@ - + CodePacker * - CodePacker* faiss::IndexFastScan::get_CodePacker + CodePacker * faiss::IndexFastScan::get_CodePacker () const get_CodePacker + faiss::IndexFastScan::get_CodePacker @@ -777,6 +810,7 @@ void faiss::IndexFastScan::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFastScan::merge_from merge_from Index & @@ -801,6 +835,7 @@ void faiss::IndexFastScan::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFastScan::check_compatible_for_merge check_compatible_for_merge const Index & @@ -815,11 +850,82 @@ + + size_t + size_t faiss::IndexFastScan::sa_code_size + () const override + sa_code_size + faiss::IndexFastScan::sa_code_size + sa_code_size + +standalone codes interface (but the codes are flattened) + + + + + + + + + void + void faiss::IndexFastScan::sa_encode + (idx_t n, const float *x, uint8_t *bytes) const override + sa_encode + faiss::IndexFastScan::sa_encode + sa_encode + + idx_t + n + + + const float * + x + + + uint8_t * + bytes + + + + +encode a set of vectors + + +n + + +number of vectors + + + + +x + + +input vectors, size n * d + + + + +bytes + + +output encoded vectors, size n * sa_code_size() + + + + + + + + + void virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -893,6 +999,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -952,6 +1059,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1030,6 +1138,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1096,6 +1205,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1149,6 +1259,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1206,6 +1317,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1303,6 +1415,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1358,6 +1471,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1420,15 +1534,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1439,105 +1554,19 @@ - - size_t - virtual size_t faiss::Index::sa_code_size - () const - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - - - -size of the produced codes in bytes - - - - - - - void - virtual void faiss::Index::sa_encode - (idx_t n, const float *x, uint8_t *bytes) const - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - - idx_t - n - - - const float * - x - - - uint8_t * - bytes - - - - -encode a set of vectors - - -n - - -number of vectors - - - - -x - - -input vectors, size n * d - - - - -bytes - - -output encoded vectors, size n * sa_code_size() - - - - - - - - - void virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1602,6 +1631,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1643,13 +1673,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1663,6 +1694,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1671,7 +1703,7 @@ - + @@ -1680,16 +1712,14 @@ Implementations: 12: blocked loop with internal loop on Q with qbs 13: same with reservoir accumulator to store results 14: no qbs with heap accumulator 15: no qbs with reservoir accumulator - - - - - + + + - - - - + + + + @@ -1698,39 +1728,52 @@ - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + tab + + + + + + + + + @@ -1741,12 +1784,8 @@ codes - - - - - + faiss::IndexFastScanadd faiss::IndexFastScanadd_sa_codes @@ -1764,8 +1803,8 @@ faiss::IndexFastScancompute_residual_n faiss::IndexFastScand faiss::IndexFastScandistance_t - faiss::IndexFastScanget_CodePacker - faiss::IndexFastScanget_distance_computer + faiss::IndexFastScanget_CodePacker + faiss::IndexFastScanget_distance_computer faiss::IndexFastScanimplem faiss::IndexFastScanIndex faiss::IndexFastScanIndexFastScan @@ -1788,9 +1827,9 @@ faiss::IndexFastScanreconstruct_n faiss::IndexFastScanremove_ids faiss::IndexFastScanreset - faiss::IndexFastScansa_code_size + faiss::IndexFastScansa_code_size faiss::IndexFastScansa_decode - faiss::IndexFastScansa_encode + faiss::IndexFastScansa_encode faiss::IndexFastScansearch faiss::IndexFastScansearch_and_reconstruct faiss::IndexFastScansearch_dispatch_implem diff --git a/xml/structfaiss_1_1IndexFlat.xml b/xml/structfaiss_1_1IndexFlat.xml index 3bfc480685..faeefa94aa 100644 --- a/xml/structfaiss_1_1IndexFlat.xml +++ b/xml/structfaiss_1_1IndexFlat.xml @@ -1,17 +1,18 @@ - + faiss::IndexFlat faiss::IndexFlatCodes faiss::IndexFlatIP faiss::IndexFlatL2 IndexFlat.h - + faiss::IndexFlat::IndexFlat (idx_t d, MetricType metric=METRIC_L2) IndexFlat + faiss::IndexFlat::IndexFlat idx_t d @@ -36,6 +37,7 @@ void faiss::IndexFlat::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFlat::search search search @@ -120,6 +122,7 @@ void faiss::IndexFlat::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlat::range_search range_search idx_t @@ -191,6 +194,7 @@ void faiss::IndexFlat::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlat::reconstruct reconstruct idx_t @@ -232,6 +236,7 @@ void faiss::IndexFlat::compute_distance_subset (idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const compute_distance_subset + faiss::IndexFlat::compute_distance_subset idx_t n @@ -287,11 +292,12 @@ - + float * - float* faiss::IndexFlat::get_xb + float * faiss::IndexFlat::get_xb () get_xb + faiss::IndexFlat::get_xb @@ -300,11 +306,12 @@ - + const float * - const float* faiss::IndexFlat::get_xb + const float * faiss::IndexFlat::get_xb () const get_xb + faiss::IndexFlat::get_xb @@ -318,6 +325,7 @@ faiss::IndexFlat::IndexFlat () IndexFlat + faiss::IndexFlat::IndexFlat @@ -326,13 +334,14 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexFlat::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexFlat::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlat::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -348,6 +357,7 @@ void faiss::IndexFlat::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexFlat::sa_encode sa_encode idx_t @@ -401,6 +411,7 @@ void faiss::IndexFlat::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexFlat::sa_decode sa_decode idx_t @@ -454,6 +465,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -477,6 +489,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -492,6 +505,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -545,6 +559,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -561,6 +576,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -575,12 +591,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -591,11 +608,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -609,6 +627,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -628,6 +647,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -652,6 +672,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -697,6 +718,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -714,6 +736,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -787,6 +810,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -846,6 +870,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -912,6 +937,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -965,6 +991,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1062,6 +1089,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1117,6 +1145,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1179,13 +1208,14 @@ - - + + size_t size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -1199,6 +1229,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -1213,6 +1244,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1227,6 +1259,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1241,6 +1274,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1255,6 +1289,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1269,6 +1304,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1283,6 +1319,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1292,13 +1329,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1312,6 +1350,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1320,13 +1359,17 @@ - + Index that stores the full vectors and performs exhaustive search + + + + @@ -1339,6 +1382,12 @@ + + + + + + @@ -1351,28 +1400,18 @@ + + - - - - - - - - - - - - @@ -1395,11 +1434,11 @@ faiss::IndexFlatcompute_residual_n faiss::IndexFlatd faiss::IndexFlatdistance_t - faiss::IndexFlatget_CodePacker - faiss::IndexFlatget_distance_computer - faiss::IndexFlatget_FlatCodesDistanceComputer - faiss::IndexFlatget_xb - faiss::IndexFlatget_xb + faiss::IndexFlatget_CodePacker + faiss::IndexFlatget_distance_computer + faiss::IndexFlatget_FlatCodesDistanceComputer + faiss::IndexFlatget_xb + faiss::IndexFlatget_xb faiss::IndexFlatIndex faiss::IndexFlatIndexFlat faiss::IndexFlatIndexFlat diff --git a/xml/structfaiss_1_1IndexFlat1D.xml b/xml/structfaiss_1_1IndexFlat1D.xml index 2e8b1b0d49..d980b38341 100644 --- a/xml/structfaiss_1_1IndexFlat1D.xml +++ b/xml/structfaiss_1_1IndexFlat1D.xml @@ -1,15 +1,16 @@ - + faiss::IndexFlat1D faiss::IndexFlatL2 IndexFlat.h - + bool bool faiss::IndexFlat1D::continuous_update continuous_update + faiss::IndexFlat1D::continuous_update = true is the permutation updated continuously? @@ -25,6 +26,7 @@ std::vector<idx_t> faiss::IndexFlat1D::perm perm + faiss::IndexFlat1D::perm sorted database indices @@ -39,6 +41,7 @@ std::vector<float> faiss::IndexFlatL2::cached_l2norms cached_l2norms + faiss::IndexFlatL2::cached_l2norms @@ -52,6 +55,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -65,6 +69,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -79,6 +84,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -93,6 +99,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -107,6 +114,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -121,6 +129,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -135,6 +144,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -149,6 +159,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -158,13 +169,14 @@ - - + + faiss::IndexFlat1D::IndexFlat1D (bool continuous_update=true) IndexFlat1D + faiss::IndexFlat1D::IndexFlat1D bool continuous_update @@ -183,6 +195,7 @@ void faiss::IndexFlat1D::update_permutation () update_permutation + faiss::IndexFlat1D::update_permutation @@ -197,6 +210,7 @@ void faiss::IndexFlat1D::add (idx_t n, const float *x) override add + faiss::IndexFlat1D::add add idx_t @@ -238,6 +252,7 @@ void faiss::IndexFlat1D::reset () override reset + faiss::IndexFlat1D::reset reset removes all elements from the database. @@ -253,6 +268,7 @@ void faiss::IndexFlat1D::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFlat1D::search search idx_t @@ -288,12 +304,13 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexFlatL2::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexFlatL2::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlatL2::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -309,6 +326,7 @@ void faiss::IndexFlatL2::sync_l2norms () sync_l2norms + faiss::IndexFlatL2::sync_l2norms @@ -322,6 +340,7 @@ void faiss::IndexFlatL2::clear_l2norms () clear_l2norms + faiss::IndexFlatL2::clear_l2norms @@ -335,6 +354,7 @@ void faiss::IndexFlat::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlat::range_search range_search idx_t @@ -406,6 +426,7 @@ void faiss::IndexFlat::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlat::reconstruct reconstruct idx_t @@ -447,6 +468,7 @@ void faiss::IndexFlat::compute_distance_subset (idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const compute_distance_subset + faiss::IndexFlat::compute_distance_subset idx_t n @@ -502,11 +524,12 @@ - + float * - float* faiss::IndexFlat::get_xb + float * faiss::IndexFlat::get_xb () get_xb + faiss::IndexFlat::get_xb @@ -515,11 +538,12 @@ - + const float * - const float* faiss::IndexFlat::get_xb + const float * faiss::IndexFlat::get_xb () const get_xb + faiss::IndexFlat::get_xb @@ -533,6 +557,7 @@ void faiss::IndexFlat::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexFlat::sa_encode sa_encode idx_t @@ -586,6 +611,7 @@ void faiss::IndexFlat::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexFlat::sa_decode sa_decode idx_t @@ -639,6 +665,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -692,6 +719,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -708,6 +736,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -722,12 +751,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -738,11 +768,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -756,6 +787,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -775,6 +807,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -799,6 +832,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -844,6 +878,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -861,6 +896,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -934,6 +970,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -993,6 +1030,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1059,6 +1097,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1112,6 +1151,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1209,6 +1249,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1264,6 +1305,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1326,13 +1368,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1346,6 +1389,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1354,13 +1398,17 @@ - + optimized version for 1D "vectors". + + + + @@ -1373,24 +1421,24 @@ + + + + + + + + - - - - - - - - @@ -1403,22 +1451,18 @@ - - - - - - - - - - + + + + + + @@ -1438,11 +1482,11 @@ faiss::IndexFlat1Dcontinuous_update faiss::IndexFlat1Dd faiss::IndexFlat1Ddistance_t - faiss::IndexFlat1Dget_CodePacker - faiss::IndexFlat1Dget_distance_computer - faiss::IndexFlat1Dget_FlatCodesDistanceComputer - faiss::IndexFlat1Dget_xb - faiss::IndexFlat1Dget_xb + faiss::IndexFlat1Dget_CodePacker + faiss::IndexFlat1Dget_distance_computer + faiss::IndexFlat1Dget_FlatCodesDistanceComputer + faiss::IndexFlat1Dget_xb + faiss::IndexFlat1Dget_xb faiss::IndexFlat1DIndex faiss::IndexFlat1DIndexFlat faiss::IndexFlat1DIndexFlat diff --git a/xml/structfaiss_1_1IndexFlatCodes.xml b/xml/structfaiss_1_1IndexFlatCodes.xml index 9245a8e685..a10587fc1e 100644 --- a/xml/structfaiss_1_1IndexFlatCodes.xml +++ b/xml/structfaiss_1_1IndexFlatCodes.xml @@ -1,5 +1,5 @@ - + faiss::IndexFlatCodes faiss::Index @@ -12,12 +12,13 @@ faiss::IndexPQ faiss::IndexScalarQuantizer IndexFlatCodes.h - + size_t size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -31,6 +32,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -45,6 +47,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -59,6 +62,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -73,6 +77,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -87,6 +92,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -101,6 +107,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -115,6 +122,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -124,13 +132,14 @@ - - + + faiss::IndexFlatCodes::IndexFlatCodes () IndexFlatCodes + faiss::IndexFlatCodes::IndexFlatCodes @@ -144,6 +153,7 @@ faiss::IndexFlatCodes::IndexFlatCodes (size_t code_size, idx_t d, MetricType metric=METRIC_L2) IndexFlatCodes + faiss::IndexFlatCodes::IndexFlatCodes size_t code_size @@ -170,6 +180,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -193,6 +204,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -208,6 +220,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -261,6 +274,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -302,6 +316,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -318,6 +333,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -332,16 +348,17 @@ - + FlatCodesDistanceComputer * - virtual FlatCodesDistanceComputer* faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + virtual FlatCodesDistanceComputer * faiss::IndexFlatCodes::get_FlatCodesDistanceComputer () const get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -352,12 +369,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -373,6 +391,7 @@ void faiss::IndexFlatCodes::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFlatCodes::search search search search @@ -416,6 +435,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -482,11 +502,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -500,6 +521,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -519,6 +541,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -543,6 +566,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -588,6 +612,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -605,6 +630,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -678,6 +704,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -737,6 +764,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -803,6 +831,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -856,6 +885,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -953,6 +983,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1008,6 +1039,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1075,8 +1107,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1140,14 +1174,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1207,13 +1241,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1227,6 +1262,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1235,36 +1271,16 @@ - + Index that encodes all vectors as fixed-size codes (size code_size). Storage is in the codes vector - - - - - - - - - - - - - - - - - - - - - - - + + + @@ -1272,21 +1288,9 @@ - - - - - - - - - - - - - - - + + + @@ -1302,33 +1306,65 @@ + + + + + + - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + + + + + @@ -1336,16 +1372,16 @@ - - - - + + + + - - - - + + + + @@ -1375,9 +1411,9 @@ faiss::IndexFlatCodescompute_residual_n faiss::IndexFlatCodesd faiss::IndexFlatCodesdistance_t - faiss::IndexFlatCodesget_CodePacker - faiss::IndexFlatCodesget_distance_computer - faiss::IndexFlatCodesget_FlatCodesDistanceComputer + faiss::IndexFlatCodesget_CodePacker + faiss::IndexFlatCodesget_distance_computer + faiss::IndexFlatCodesget_FlatCodesDistanceComputer faiss::IndexFlatCodesIndex faiss::IndexFlatCodesIndexFlatCodes faiss::IndexFlatCodesIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexFlatIP.xml b/xml/structfaiss_1_1IndexFlatIP.xml index a038a90fc8..5839954db8 100644 --- a/xml/structfaiss_1_1IndexFlatIP.xml +++ b/xml/structfaiss_1_1IndexFlatIP.xml @@ -1,14 +1,15 @@ - + faiss::IndexFlatIP faiss::IndexFlat - + faiss::IndexFlatIP::IndexFlatIP (idx_t d) IndexFlatIP + faiss::IndexFlatIP::IndexFlatIP idx_t d @@ -26,6 +27,7 @@ faiss::IndexFlatIP::IndexFlatIP () IndexFlatIP + faiss::IndexFlatIP::IndexFlatIP @@ -39,6 +41,7 @@ void faiss::IndexFlat::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFlat::search search search @@ -123,6 +126,7 @@ void faiss::IndexFlat::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlat::range_search range_search idx_t @@ -194,6 +198,7 @@ void faiss::IndexFlat::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlat::reconstruct reconstruct idx_t @@ -235,6 +240,7 @@ void faiss::IndexFlat::compute_distance_subset (idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const compute_distance_subset + faiss::IndexFlat::compute_distance_subset idx_t n @@ -290,11 +296,12 @@ - + float * - float* faiss::IndexFlat::get_xb + float * faiss::IndexFlat::get_xb () get_xb + faiss::IndexFlat::get_xb @@ -303,11 +310,12 @@ - + const float * - const float* faiss::IndexFlat::get_xb + const float * faiss::IndexFlat::get_xb () const get_xb + faiss::IndexFlat::get_xb @@ -316,13 +324,14 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexFlat::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexFlat::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlat::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -338,6 +347,7 @@ void faiss::IndexFlat::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexFlat::sa_encode sa_encode idx_t @@ -391,6 +401,7 @@ void faiss::IndexFlat::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexFlat::sa_decode sa_decode idx_t @@ -444,6 +455,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -467,6 +479,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -482,6 +495,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -535,6 +549,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -551,6 +566,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -565,12 +581,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -581,11 +598,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -599,6 +617,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -618,6 +637,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -642,6 +662,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -687,6 +708,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -704,6 +726,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -777,6 +800,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -836,6 +860,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -902,6 +927,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -955,6 +981,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1052,6 +1079,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1107,6 +1135,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1169,13 +1198,14 @@ - - + + size_t size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -1189,6 +1219,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -1203,6 +1234,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1217,6 +1249,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1231,6 +1264,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1245,6 +1279,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1259,6 +1294,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1273,6 +1309,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1282,13 +1319,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1302,6 +1340,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1310,58 +1349,58 @@ - + + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + @@ -1378,11 +1417,11 @@ faiss::IndexFlatIPcompute_residual_n faiss::IndexFlatIPd faiss::IndexFlatIPdistance_t - faiss::IndexFlatIPget_CodePacker - faiss::IndexFlatIPget_distance_computer - faiss::IndexFlatIPget_FlatCodesDistanceComputer - faiss::IndexFlatIPget_xb - faiss::IndexFlatIPget_xb + faiss::IndexFlatIPget_CodePacker + faiss::IndexFlatIPget_distance_computer + faiss::IndexFlatIPget_FlatCodesDistanceComputer + faiss::IndexFlatIPget_xb + faiss::IndexFlatIPget_xb faiss::IndexFlatIPIndex faiss::IndexFlatIPIndexFlat faiss::IndexFlatIPIndexFlat diff --git a/xml/structfaiss_1_1IndexFlatL2.xml b/xml/structfaiss_1_1IndexFlatL2.xml index b4db7128e1..501a4a5488 100644 --- a/xml/structfaiss_1_1IndexFlatL2.xml +++ b/xml/structfaiss_1_1IndexFlatL2.xml @@ -1,15 +1,16 @@ - + faiss::IndexFlatL2 faiss::IndexFlat faiss::IndexFlat1D - + std::vector< float > std::vector<float> faiss::IndexFlatL2::cached_l2norms cached_l2norms + faiss::IndexFlatL2::cached_l2norms @@ -23,6 +24,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -36,6 +38,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -50,6 +53,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -64,6 +68,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -78,6 +83,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -92,6 +98,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -106,6 +113,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -120,6 +128,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -129,13 +138,14 @@ - - + + faiss::IndexFlatL2::IndexFlatL2 (idx_t d) IndexFlatL2 + faiss::IndexFlatL2::IndexFlatL2 idx_t d @@ -163,6 +173,7 @@ faiss::IndexFlatL2::IndexFlatL2 () IndexFlatL2 + faiss::IndexFlatL2::IndexFlatL2 @@ -171,12 +182,13 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexFlatL2::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexFlatL2::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlatL2::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -192,6 +204,7 @@ void faiss::IndexFlatL2::sync_l2norms () sync_l2norms + faiss::IndexFlatL2::sync_l2norms @@ -205,6 +218,7 @@ void faiss::IndexFlatL2::clear_l2norms () clear_l2norms + faiss::IndexFlatL2::clear_l2norms @@ -218,6 +232,7 @@ void faiss::IndexFlat::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFlat::search search search @@ -302,6 +317,7 @@ void faiss::IndexFlat::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlat::range_search range_search idx_t @@ -373,6 +389,7 @@ void faiss::IndexFlat::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlat::reconstruct reconstruct idx_t @@ -414,6 +431,7 @@ void faiss::IndexFlat::compute_distance_subset (idx_t n, const float *x, idx_t k, float *distances, const idx_t *labels) const compute_distance_subset + faiss::IndexFlat::compute_distance_subset idx_t n @@ -469,11 +487,12 @@ - + float * - float* faiss::IndexFlat::get_xb + float * faiss::IndexFlat::get_xb () get_xb + faiss::IndexFlat::get_xb @@ -482,11 +501,12 @@ - + const float * - const float* faiss::IndexFlat::get_xb + const float * faiss::IndexFlat::get_xb () const get_xb + faiss::IndexFlat::get_xb @@ -500,6 +520,7 @@ void faiss::IndexFlat::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexFlat::sa_encode sa_encode idx_t @@ -553,6 +574,7 @@ void faiss::IndexFlat::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexFlat::sa_decode sa_decode idx_t @@ -606,6 +628,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -629,6 +652,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -644,6 +668,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -697,6 +722,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -713,6 +739,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -727,12 +754,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -743,11 +771,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -761,6 +790,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -780,6 +810,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -804,6 +835,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -849,6 +881,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -866,6 +899,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -939,6 +973,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -998,6 +1033,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1064,6 +1100,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1117,6 +1154,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1214,6 +1252,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1269,6 +1308,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1331,13 +1371,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1351,6 +1392,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1359,12 +1401,16 @@ - + + + + + @@ -1377,46 +1423,42 @@ - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + @@ -1435,11 +1477,11 @@ faiss::IndexFlatL2compute_residual_n faiss::IndexFlatL2d faiss::IndexFlatL2distance_t - faiss::IndexFlatL2get_CodePacker - faiss::IndexFlatL2get_distance_computer - faiss::IndexFlatL2get_FlatCodesDistanceComputer - faiss::IndexFlatL2get_xb - faiss::IndexFlatL2get_xb + faiss::IndexFlatL2get_CodePacker + faiss::IndexFlatL2get_distance_computer + faiss::IndexFlatL2get_FlatCodesDistanceComputer + faiss::IndexFlatL2get_xb + faiss::IndexFlatL2get_xb faiss::IndexFlatL2Index faiss::IndexFlatL2IndexFlat faiss::IndexFlatL2IndexFlat diff --git a/xml/structfaiss_1_1IndexHNSW.xml b/xml/structfaiss_1_1IndexHNSW.xml index ee144aa720..464a67e1fd 100644 --- a/xml/structfaiss_1_1IndexHNSW.xml +++ b/xml/structfaiss_1_1IndexHNSW.xml @@ -1,5 +1,5 @@ - + faiss::IndexHNSW faiss::Index @@ -9,12 +9,13 @@ faiss::IndexHNSWPQ faiss::IndexHNSWSQ IndexHNSW.h - + HNSW::storage_idx_t typedef HNSW::storage_idx_t faiss::IndexHNSW::storage_idx_t storage_idx_t + faiss::IndexHNSW::storage_idx_t @@ -28,6 +29,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -41,6 +43,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -49,13 +52,14 @@ - - + + HNSW HNSW faiss::IndexHNSW::hnsw hnsw + faiss::IndexHNSW::hnsw @@ -69,6 +73,7 @@ bool faiss::IndexHNSW::own_fields own_fields + faiss::IndexHNSW::own_fields = false @@ -83,6 +88,7 @@ Index* faiss::IndexHNSW::storage storage + faiss::IndexHNSW::storage = nullptr @@ -97,6 +103,7 @@ bool faiss::IndexHNSW::init_level0 init_level0 + faiss::IndexHNSW::init_level0 = true @@ -111,6 +118,7 @@ bool faiss::IndexHNSW::keep_max_size_level0 keep_max_size_level0 + faiss::IndexHNSW::keep_max_size_level0 = false @@ -125,6 +133,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -139,6 +148,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -153,6 +163,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -167,6 +178,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -181,6 +193,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -195,6 +208,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -204,13 +218,14 @@ - - + + faiss::IndexHNSW::IndexHNSW (int d=0, int M=32, MetricType metric=METRIC_L2) IndexHNSW + faiss::IndexHNSW::IndexHNSW int d @@ -239,6 +254,7 @@ faiss::IndexHNSW::IndexHNSW (Index *storage, int M=32) IndexHNSW + faiss::IndexHNSW::IndexHNSW Index * storage @@ -261,6 +277,7 @@ faiss::IndexHNSW::~IndexHNSW () override ~IndexHNSW + faiss::IndexHNSW::~IndexHNSW @@ -274,6 +291,7 @@ void faiss::IndexHNSW::add (idx_t n, const float *x) override add + faiss::IndexHNSW::add add add @@ -316,6 +334,7 @@ void faiss::IndexHNSW::train (idx_t n, const float *x) override train + faiss::IndexHNSW::train train train @@ -340,6 +359,7 @@ void faiss::IndexHNSW::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexHNSW::search search search search @@ -382,6 +402,7 @@ void faiss::IndexHNSW::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexHNSW::range_search range_search idx_t @@ -453,6 +474,7 @@ void faiss::IndexHNSW::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexHNSW::reconstruct reconstruct idx_t @@ -494,6 +516,7 @@ void faiss::IndexHNSW::reset () override reset + faiss::IndexHNSW::reset reset removes all elements from the database. @@ -509,6 +532,7 @@ void faiss::IndexHNSW::shrink_level_0_neighbors (int size) shrink_level_0_neighbors + faiss::IndexHNSW::shrink_level_0_neighbors int size @@ -526,6 +550,7 @@ void faiss::IndexHNSW::search_level_0 (idx_t n, const float *x, idx_t k, const storage_idx_t *nearest, const float *nearest_d, float *distances, idx_t *labels, int nprobe=1, int search_type=1, const SearchParameters *params=nullptr) const search_level_0 + faiss::IndexHNSW::search_level_0 idx_t n @@ -593,6 +618,7 @@ void faiss::IndexHNSW::init_level_0_from_knngraph (int k, const float *D, const idx_t *I) init_level_0_from_knngraph + faiss::IndexHNSW::init_level_0_from_knngraph int k @@ -619,6 +645,7 @@ void faiss::IndexHNSW::init_level_0_from_entry_points (int npt, const storage_idx_t *points, const storage_idx_t *nearests) init_level_0_from_entry_points + faiss::IndexHNSW::init_level_0_from_entry_points int npt @@ -645,6 +672,7 @@ void faiss::IndexHNSW::reorder_links () reorder_links + faiss::IndexHNSW::reorder_links @@ -658,6 +686,7 @@ void faiss::IndexHNSW::link_singletons () link_singletons + faiss::IndexHNSW::link_singletons @@ -671,6 +700,7 @@ void faiss::IndexHNSW::permute_entries (const idx_t *perm) permute_entries + faiss::IndexHNSW::permute_entries const idx_t * perm @@ -683,12 +713,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexHNSW::get_distance_computer + DistanceComputer * faiss::IndexHNSW::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexHNSW::get_distance_computer + get_distance_computer @@ -704,6 +735,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -763,6 +795,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -829,6 +862,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -853,6 +887,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -906,6 +941,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -963,6 +999,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1060,6 +1097,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1115,6 +1153,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1182,6 +1221,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1203,8 +1244,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1268,14 +1311,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1340,6 +1383,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1368,6 +1412,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1390,6 +1435,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1431,17 +1477,21 @@ - + The HNSW index is a normal random-access index with a HNSW link structure built on top - - - - + + + + + + + + @@ -1456,33 +1506,32 @@ - - - + + + - - - - - - - - - - + + + + + + - - - + + + + + rng + @@ -1500,12 +1549,9 @@ storage - - - - - rng - + + + @@ -1520,7 +1566,7 @@ faiss::IndexHNSWcompute_residual_n faiss::IndexHNSWd faiss::IndexHNSWdistance_t - faiss::IndexHNSWget_distance_computer + faiss::IndexHNSWget_distance_computer faiss::IndexHNSWhnsw faiss::IndexHNSWIndex faiss::IndexHNSWIndexHNSW diff --git a/xml/structfaiss_1_1IndexHNSW2Level.xml b/xml/structfaiss_1_1IndexHNSW2Level.xml index 16d0da5346..e4a0f9998d 100644 --- a/xml/structfaiss_1_1IndexHNSW2Level.xml +++ b/xml/structfaiss_1_1IndexHNSW2Level.xml @@ -1,15 +1,16 @@ - + faiss::IndexHNSW2Level faiss::IndexHNSW IndexHNSW.h - + faiss::IndexHNSW2Level::IndexHNSW2Level () IndexHNSW2Level + faiss::IndexHNSW2Level::IndexHNSW2Level @@ -23,6 +24,7 @@ faiss::IndexHNSW2Level::IndexHNSW2Level (Index *quantizer, size_t nlist, int m_pq, int M) IndexHNSW2Level + faiss::IndexHNSW2Level::IndexHNSW2Level Index * quantizer @@ -52,6 +54,7 @@ void faiss::IndexHNSW2Level::flip_to_ivf () flip_to_ivf + faiss::IndexHNSW2Level::flip_to_ivf @@ -65,6 +68,7 @@ void faiss::IndexHNSW2Level::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexHNSW2Level::search search idx_t @@ -105,6 +109,7 @@ void faiss::IndexHNSW::add (idx_t n, const float *x) override add + faiss::IndexHNSW::add add add @@ -147,6 +152,7 @@ void faiss::IndexHNSW::train (idx_t n, const float *x) override train + faiss::IndexHNSW::train train train @@ -171,6 +177,7 @@ void faiss::IndexHNSW::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexHNSW::range_search range_search idx_t @@ -242,6 +249,7 @@ void faiss::IndexHNSW::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexHNSW::reconstruct reconstruct idx_t @@ -283,6 +291,7 @@ void faiss::IndexHNSW::reset () override reset + faiss::IndexHNSW::reset reset removes all elements from the database. @@ -298,6 +307,7 @@ void faiss::IndexHNSW::shrink_level_0_neighbors (int size) shrink_level_0_neighbors + faiss::IndexHNSW::shrink_level_0_neighbors int size @@ -315,6 +325,7 @@ void faiss::IndexHNSW::search_level_0 (idx_t n, const float *x, idx_t k, const storage_idx_t *nearest, const float *nearest_d, float *distances, idx_t *labels, int nprobe=1, int search_type=1, const SearchParameters *params=nullptr) const search_level_0 + faiss::IndexHNSW::search_level_0 idx_t n @@ -382,6 +393,7 @@ void faiss::IndexHNSW::init_level_0_from_knngraph (int k, const float *D, const idx_t *I) init_level_0_from_knngraph + faiss::IndexHNSW::init_level_0_from_knngraph int k @@ -408,6 +420,7 @@ void faiss::IndexHNSW::init_level_0_from_entry_points (int npt, const storage_idx_t *points, const storage_idx_t *nearests) init_level_0_from_entry_points + faiss::IndexHNSW::init_level_0_from_entry_points int npt @@ -434,6 +447,7 @@ void faiss::IndexHNSW::reorder_links () reorder_links + faiss::IndexHNSW::reorder_links @@ -447,6 +461,7 @@ void faiss::IndexHNSW::link_singletons () link_singletons + faiss::IndexHNSW::link_singletons @@ -460,6 +475,7 @@ void faiss::IndexHNSW::permute_entries (const idx_t *perm) permute_entries + faiss::IndexHNSW::permute_entries const idx_t * perm @@ -472,12 +488,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexHNSW::get_distance_computer + DistanceComputer * faiss::IndexHNSW::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexHNSW::get_distance_computer + get_distance_computer @@ -493,6 +510,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -552,6 +570,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -618,6 +637,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -642,6 +662,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -695,6 +716,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -752,6 +774,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -849,6 +872,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -904,6 +928,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -971,6 +996,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -992,8 +1019,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1057,14 +1086,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1129,6 +1158,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1157,6 +1187,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1179,6 +1210,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1220,13 +1252,14 @@ - - + + HNSW::storage_idx_t typedef HNSW::storage_idx_t faiss::IndexHNSW::storage_idx_t storage_idx_t + faiss::IndexHNSW::storage_idx_t @@ -1240,6 +1273,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1253,6 +1287,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1261,13 +1296,14 @@ - - + + HNSW HNSW faiss::IndexHNSW::hnsw hnsw + faiss::IndexHNSW::hnsw @@ -1281,6 +1317,7 @@ bool faiss::IndexHNSW::own_fields own_fields + faiss::IndexHNSW::own_fields = false @@ -1295,6 +1332,7 @@ Index* faiss::IndexHNSW::storage storage + faiss::IndexHNSW::storage = nullptr @@ -1309,6 +1347,7 @@ bool faiss::IndexHNSW::init_level0 init_level0 + faiss::IndexHNSW::init_level0 = true @@ -1323,6 +1362,7 @@ bool faiss::IndexHNSW::keep_max_size_level0 keep_max_size_level0 + faiss::IndexHNSW::keep_max_size_level0 = false @@ -1337,6 +1377,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1351,6 +1392,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1365,6 +1407,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1379,6 +1422,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1393,6 +1437,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1407,6 +1452,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1416,19 +1462,13 @@ - + 2-level code structure with fast random access - - - - - - @@ -1439,18 +1479,21 @@ - - - - - - + + + + + + + rng + + @@ -1467,13 +1510,16 @@ storage - - - - - rng + + + + + + + + @@ -1488,7 +1534,7 @@ faiss::IndexHNSW2Leveld faiss::IndexHNSW2Leveldistance_t faiss::IndexHNSW2Levelflip_to_ivf - faiss::IndexHNSW2Levelget_distance_computer + faiss::IndexHNSW2Levelget_distance_computer faiss::IndexHNSW2Levelhnsw faiss::IndexHNSW2LevelIndex faiss::IndexHNSW2LevelIndexHNSW diff --git a/xml/structfaiss_1_1IndexHNSWCagra.xml b/xml/structfaiss_1_1IndexHNSWCagra.xml index 38041a561d..031d1f5d49 100644 --- a/xml/structfaiss_1_1IndexHNSWCagra.xml +++ b/xml/structfaiss_1_1IndexHNSWCagra.xml @@ -1,14 +1,15 @@ - + faiss::IndexHNSWCagra faiss::IndexHNSW - + bool bool faiss::IndexHNSWCagra::base_level_only base_level_only + faiss::IndexHNSWCagra::base_level_only = false @@ -24,6 +25,7 @@ int faiss::IndexHNSWCagra::num_base_level_search_entrypoints num_base_level_search_entrypoints + faiss::IndexHNSWCagra::num_base_level_search_entrypoints = 32 @@ -39,6 +41,7 @@ HNSW faiss::IndexHNSW::hnsw hnsw + faiss::IndexHNSW::hnsw @@ -52,6 +55,7 @@ bool faiss::IndexHNSW::own_fields own_fields + faiss::IndexHNSW::own_fields = false @@ -66,6 +70,7 @@ Index* faiss::IndexHNSW::storage storage + faiss::IndexHNSW::storage = nullptr @@ -80,6 +85,7 @@ bool faiss::IndexHNSW::init_level0 init_level0 + faiss::IndexHNSW::init_level0 = true @@ -94,6 +100,7 @@ bool faiss::IndexHNSW::keep_max_size_level0 keep_max_size_level0 + faiss::IndexHNSW::keep_max_size_level0 = false @@ -108,6 +115,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -122,6 +130,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -136,6 +145,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -150,6 +160,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -164,6 +175,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -178,6 +190,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -187,13 +200,14 @@ - - + + faiss::IndexHNSWCagra::IndexHNSWCagra () IndexHNSWCagra + faiss::IndexHNSWCagra::IndexHNSWCagra @@ -207,6 +221,7 @@ faiss::IndexHNSWCagra::IndexHNSWCagra (int d, int M, MetricType metric=METRIC_L2) IndexHNSWCagra + faiss::IndexHNSWCagra::IndexHNSWCagra int d @@ -233,6 +248,7 @@ void faiss::IndexHNSWCagra::add (idx_t n, const float *x) override add + faiss::IndexHNSWCagra::add add idx_t @@ -274,6 +290,7 @@ void faiss::IndexHNSWCagra::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexHNSWCagra::search search idx_t @@ -314,6 +331,7 @@ void faiss::IndexHNSW::train (idx_t n, const float *x) override train + faiss::IndexHNSW::train train train @@ -338,6 +356,7 @@ void faiss::IndexHNSW::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexHNSW::range_search range_search idx_t @@ -409,6 +428,7 @@ void faiss::IndexHNSW::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexHNSW::reconstruct reconstruct idx_t @@ -450,6 +470,7 @@ void faiss::IndexHNSW::reset () override reset + faiss::IndexHNSW::reset reset removes all elements from the database. @@ -465,6 +486,7 @@ void faiss::IndexHNSW::shrink_level_0_neighbors (int size) shrink_level_0_neighbors + faiss::IndexHNSW::shrink_level_0_neighbors int size @@ -482,6 +504,7 @@ void faiss::IndexHNSW::search_level_0 (idx_t n, const float *x, idx_t k, const storage_idx_t *nearest, const float *nearest_d, float *distances, idx_t *labels, int nprobe=1, int search_type=1, const SearchParameters *params=nullptr) const search_level_0 + faiss::IndexHNSW::search_level_0 idx_t n @@ -549,6 +572,7 @@ void faiss::IndexHNSW::init_level_0_from_knngraph (int k, const float *D, const idx_t *I) init_level_0_from_knngraph + faiss::IndexHNSW::init_level_0_from_knngraph int k @@ -575,6 +599,7 @@ void faiss::IndexHNSW::init_level_0_from_entry_points (int npt, const storage_idx_t *points, const storage_idx_t *nearests) init_level_0_from_entry_points + faiss::IndexHNSW::init_level_0_from_entry_points int npt @@ -601,6 +626,7 @@ void faiss::IndexHNSW::reorder_links () reorder_links + faiss::IndexHNSW::reorder_links @@ -614,6 +640,7 @@ void faiss::IndexHNSW::link_singletons () link_singletons + faiss::IndexHNSW::link_singletons @@ -627,6 +654,7 @@ void faiss::IndexHNSW::permute_entries (const idx_t *perm) permute_entries + faiss::IndexHNSW::permute_entries const idx_t * perm @@ -639,12 +667,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexHNSW::get_distance_computer + DistanceComputer * faiss::IndexHNSW::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexHNSW::get_distance_computer + get_distance_computer @@ -660,6 +689,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -719,6 +749,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -785,6 +816,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -809,6 +841,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -862,6 +895,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -919,6 +953,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1016,6 +1051,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1071,6 +1107,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1138,6 +1175,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1159,8 +1198,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1224,14 +1265,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1296,6 +1337,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1324,6 +1366,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1346,6 +1389,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1387,13 +1431,14 @@ - - + + HNSW::storage_idx_t typedef HNSW::storage_idx_t faiss::IndexHNSW::storage_idx_t storage_idx_t + faiss::IndexHNSW::storage_idx_t @@ -1407,6 +1452,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1420,6 +1466,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1428,18 +1475,12 @@ - + - - - - - - @@ -1450,18 +1491,21 @@ - - - - - - + + + + + + + rng + + @@ -1478,13 +1522,16 @@ storage - - - - - rng + + + + + + + + @@ -1499,7 +1546,7 @@ faiss::IndexHNSWCagracompute_residual_n faiss::IndexHNSWCagrad faiss::IndexHNSWCagradistance_t - faiss::IndexHNSWCagraget_distance_computer + faiss::IndexHNSWCagraget_distance_computer faiss::IndexHNSWCagrahnsw faiss::IndexHNSWCagraIndex faiss::IndexHNSWCagraIndexHNSW diff --git a/xml/structfaiss_1_1IndexHNSWFlat.xml b/xml/structfaiss_1_1IndexHNSWFlat.xml index 9bbd468054..505eefe6ad 100644 --- a/xml/structfaiss_1_1IndexHNSWFlat.xml +++ b/xml/structfaiss_1_1IndexHNSWFlat.xml @@ -1,15 +1,16 @@ - + faiss::IndexHNSWFlat faiss::IndexHNSW IndexHNSW.h - + faiss::IndexHNSWFlat::IndexHNSWFlat () IndexHNSWFlat + faiss::IndexHNSWFlat::IndexHNSWFlat @@ -23,6 +24,7 @@ faiss::IndexHNSWFlat::IndexHNSWFlat (int d, int M, MetricType metric=METRIC_L2) IndexHNSWFlat + faiss::IndexHNSWFlat::IndexHNSWFlat int d @@ -49,6 +51,7 @@ void faiss::IndexHNSW::add (idx_t n, const float *x) override add + faiss::IndexHNSW::add add add @@ -91,6 +94,7 @@ void faiss::IndexHNSW::train (idx_t n, const float *x) override train + faiss::IndexHNSW::train train train @@ -115,6 +119,7 @@ void faiss::IndexHNSW::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexHNSW::search search search search @@ -157,6 +162,7 @@ void faiss::IndexHNSW::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexHNSW::range_search range_search idx_t @@ -228,6 +234,7 @@ void faiss::IndexHNSW::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexHNSW::reconstruct reconstruct idx_t @@ -269,6 +276,7 @@ void faiss::IndexHNSW::reset () override reset + faiss::IndexHNSW::reset reset removes all elements from the database. @@ -284,6 +292,7 @@ void faiss::IndexHNSW::shrink_level_0_neighbors (int size) shrink_level_0_neighbors + faiss::IndexHNSW::shrink_level_0_neighbors int size @@ -301,6 +310,7 @@ void faiss::IndexHNSW::search_level_0 (idx_t n, const float *x, idx_t k, const storage_idx_t *nearest, const float *nearest_d, float *distances, idx_t *labels, int nprobe=1, int search_type=1, const SearchParameters *params=nullptr) const search_level_0 + faiss::IndexHNSW::search_level_0 idx_t n @@ -368,6 +378,7 @@ void faiss::IndexHNSW::init_level_0_from_knngraph (int k, const float *D, const idx_t *I) init_level_0_from_knngraph + faiss::IndexHNSW::init_level_0_from_knngraph int k @@ -394,6 +405,7 @@ void faiss::IndexHNSW::init_level_0_from_entry_points (int npt, const storage_idx_t *points, const storage_idx_t *nearests) init_level_0_from_entry_points + faiss::IndexHNSW::init_level_0_from_entry_points int npt @@ -420,6 +432,7 @@ void faiss::IndexHNSW::reorder_links () reorder_links + faiss::IndexHNSW::reorder_links @@ -433,6 +446,7 @@ void faiss::IndexHNSW::link_singletons () link_singletons + faiss::IndexHNSW::link_singletons @@ -446,6 +460,7 @@ void faiss::IndexHNSW::permute_entries (const idx_t *perm) permute_entries + faiss::IndexHNSW::permute_entries const idx_t * perm @@ -458,12 +473,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexHNSW::get_distance_computer + DistanceComputer * faiss::IndexHNSW::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexHNSW::get_distance_computer + get_distance_computer @@ -479,6 +495,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -538,6 +555,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -604,6 +622,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -628,6 +647,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -681,6 +701,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -738,6 +759,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -835,6 +857,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -890,6 +913,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -957,6 +981,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -978,8 +1004,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1043,14 +1071,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1115,6 +1143,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1143,6 +1172,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1165,6 +1195,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1206,13 +1237,14 @@ - - + + HNSW::storage_idx_t typedef HNSW::storage_idx_t faiss::IndexHNSW::storage_idx_t storage_idx_t + faiss::IndexHNSW::storage_idx_t @@ -1226,6 +1258,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1239,6 +1272,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1247,13 +1281,14 @@ - - + + HNSW HNSW faiss::IndexHNSW::hnsw hnsw + faiss::IndexHNSW::hnsw @@ -1267,6 +1302,7 @@ bool faiss::IndexHNSW::own_fields own_fields + faiss::IndexHNSW::own_fields = false @@ -1281,6 +1317,7 @@ Index* faiss::IndexHNSW::storage storage + faiss::IndexHNSW::storage = nullptr @@ -1295,6 +1332,7 @@ bool faiss::IndexHNSW::init_level0 init_level0 + faiss::IndexHNSW::init_level0 = true @@ -1309,6 +1347,7 @@ bool faiss::IndexHNSW::keep_max_size_level0 keep_max_size_level0 + faiss::IndexHNSW::keep_max_size_level0 = false @@ -1323,6 +1362,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1337,6 +1377,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1351,6 +1392,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1365,6 +1407,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1379,6 +1422,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1393,6 +1437,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1402,19 +1447,13 @@ - + Flat index topped with with a HNSW structure to access elements more efficiently. - - - - - - @@ -1425,17 +1464,20 @@ - - - - - + + + + + + + rng + @@ -1453,13 +1495,16 @@ storage - - - - - rng + + + + + + + + @@ -1473,7 +1518,7 @@ faiss::IndexHNSWFlatcompute_residual_n faiss::IndexHNSWFlatd faiss::IndexHNSWFlatdistance_t - faiss::IndexHNSWFlatget_distance_computer + faiss::IndexHNSWFlatget_distance_computer faiss::IndexHNSWFlathnsw faiss::IndexHNSWFlatIndex faiss::IndexHNSWFlatIndexHNSW diff --git a/xml/structfaiss_1_1IndexHNSWPQ.xml b/xml/structfaiss_1_1IndexHNSWPQ.xml index 3ef1694f7f..897b790576 100644 --- a/xml/structfaiss_1_1IndexHNSWPQ.xml +++ b/xml/structfaiss_1_1IndexHNSWPQ.xml @@ -1,15 +1,16 @@ - + faiss::IndexHNSWPQ faiss::IndexHNSW IndexHNSW.h - + faiss::IndexHNSWPQ::IndexHNSWPQ () IndexHNSWPQ + faiss::IndexHNSWPQ::IndexHNSWPQ @@ -23,6 +24,7 @@ faiss::IndexHNSWPQ::IndexHNSWPQ (int d, int pq_m, int M, int pq_nbits=8, MetricType metric=METRIC_L2) IndexHNSWPQ + faiss::IndexHNSWPQ::IndexHNSWPQ int d @@ -58,6 +60,7 @@ void faiss::IndexHNSWPQ::train (idx_t n, const float *x) override train + faiss::IndexHNSWPQ::train train idx_t @@ -81,6 +84,7 @@ void faiss::IndexHNSW::add (idx_t n, const float *x) override add + faiss::IndexHNSW::add add add @@ -123,6 +127,7 @@ void faiss::IndexHNSW::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexHNSW::search search search search @@ -165,6 +170,7 @@ void faiss::IndexHNSW::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexHNSW::range_search range_search idx_t @@ -236,6 +242,7 @@ void faiss::IndexHNSW::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexHNSW::reconstruct reconstruct idx_t @@ -277,6 +284,7 @@ void faiss::IndexHNSW::reset () override reset + faiss::IndexHNSW::reset reset removes all elements from the database. @@ -292,6 +300,7 @@ void faiss::IndexHNSW::shrink_level_0_neighbors (int size) shrink_level_0_neighbors + faiss::IndexHNSW::shrink_level_0_neighbors int size @@ -309,6 +318,7 @@ void faiss::IndexHNSW::search_level_0 (idx_t n, const float *x, idx_t k, const storage_idx_t *nearest, const float *nearest_d, float *distances, idx_t *labels, int nprobe=1, int search_type=1, const SearchParameters *params=nullptr) const search_level_0 + faiss::IndexHNSW::search_level_0 idx_t n @@ -376,6 +386,7 @@ void faiss::IndexHNSW::init_level_0_from_knngraph (int k, const float *D, const idx_t *I) init_level_0_from_knngraph + faiss::IndexHNSW::init_level_0_from_knngraph int k @@ -402,6 +413,7 @@ void faiss::IndexHNSW::init_level_0_from_entry_points (int npt, const storage_idx_t *points, const storage_idx_t *nearests) init_level_0_from_entry_points + faiss::IndexHNSW::init_level_0_from_entry_points int npt @@ -428,6 +440,7 @@ void faiss::IndexHNSW::reorder_links () reorder_links + faiss::IndexHNSW::reorder_links @@ -441,6 +454,7 @@ void faiss::IndexHNSW::link_singletons () link_singletons + faiss::IndexHNSW::link_singletons @@ -454,6 +468,7 @@ void faiss::IndexHNSW::permute_entries (const idx_t *perm) permute_entries + faiss::IndexHNSW::permute_entries const idx_t * perm @@ -466,12 +481,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexHNSW::get_distance_computer + DistanceComputer * faiss::IndexHNSW::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexHNSW::get_distance_computer + get_distance_computer @@ -487,6 +503,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -546,6 +563,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -612,6 +630,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -636,6 +655,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -689,6 +709,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -746,6 +767,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -843,6 +865,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -898,6 +921,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -965,6 +989,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -986,8 +1012,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1051,14 +1079,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1123,6 +1151,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1151,6 +1180,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1173,6 +1203,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1214,13 +1245,14 @@ - - + + HNSW::storage_idx_t typedef HNSW::storage_idx_t faiss::IndexHNSW::storage_idx_t storage_idx_t + faiss::IndexHNSW::storage_idx_t @@ -1234,6 +1266,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1247,6 +1280,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1255,13 +1289,14 @@ - - + + HNSW HNSW faiss::IndexHNSW::hnsw hnsw + faiss::IndexHNSW::hnsw @@ -1275,6 +1310,7 @@ bool faiss::IndexHNSW::own_fields own_fields + faiss::IndexHNSW::own_fields = false @@ -1289,6 +1325,7 @@ Index* faiss::IndexHNSW::storage storage + faiss::IndexHNSW::storage = nullptr @@ -1303,6 +1340,7 @@ bool faiss::IndexHNSW::init_level0 init_level0 + faiss::IndexHNSW::init_level0 = true @@ -1317,6 +1355,7 @@ bool faiss::IndexHNSW::keep_max_size_level0 keep_max_size_level0 + faiss::IndexHNSW::keep_max_size_level0 = false @@ -1331,6 +1370,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1345,6 +1385,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1359,6 +1400,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1373,6 +1415,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1387,6 +1430,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1401,6 +1445,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1410,7 +1455,7 @@ - + @@ -1435,9 +1480,12 @@ - - - + + + + + rng + @@ -1461,12 +1509,9 @@ - - - - - rng - + + + @@ -1481,7 +1526,7 @@ faiss::IndexHNSWPQcompute_residual_n faiss::IndexHNSWPQd faiss::IndexHNSWPQdistance_t - faiss::IndexHNSWPQget_distance_computer + faiss::IndexHNSWPQget_distance_computer faiss::IndexHNSWPQhnsw faiss::IndexHNSWPQIndex faiss::IndexHNSWPQIndexHNSW diff --git a/xml/structfaiss_1_1IndexHNSWSQ.xml b/xml/structfaiss_1_1IndexHNSWSQ.xml index 675afc5fc3..f42be50ca5 100644 --- a/xml/structfaiss_1_1IndexHNSWSQ.xml +++ b/xml/structfaiss_1_1IndexHNSWSQ.xml @@ -1,15 +1,16 @@ - + faiss::IndexHNSWSQ faiss::IndexHNSW IndexHNSW.h - + faiss::IndexHNSWSQ::IndexHNSWSQ () IndexHNSWSQ + faiss::IndexHNSWSQ::IndexHNSWSQ @@ -23,6 +24,7 @@ faiss::IndexHNSWSQ::IndexHNSWSQ (int d, ScalarQuantizer::QuantizerType qtype, int M, MetricType metric=METRIC_L2) IndexHNSWSQ + faiss::IndexHNSWSQ::IndexHNSWSQ int d @@ -53,6 +55,7 @@ void faiss::IndexHNSW::add (idx_t n, const float *x) override add + faiss::IndexHNSW::add add add @@ -95,6 +98,7 @@ void faiss::IndexHNSW::train (idx_t n, const float *x) override train + faiss::IndexHNSW::train train train @@ -119,6 +123,7 @@ void faiss::IndexHNSW::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexHNSW::search search search search @@ -161,6 +166,7 @@ void faiss::IndexHNSW::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexHNSW::range_search range_search idx_t @@ -232,6 +238,7 @@ void faiss::IndexHNSW::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexHNSW::reconstruct reconstruct idx_t @@ -273,6 +280,7 @@ void faiss::IndexHNSW::reset () override reset + faiss::IndexHNSW::reset reset removes all elements from the database. @@ -288,6 +296,7 @@ void faiss::IndexHNSW::shrink_level_0_neighbors (int size) shrink_level_0_neighbors + faiss::IndexHNSW::shrink_level_0_neighbors int size @@ -305,6 +314,7 @@ void faiss::IndexHNSW::search_level_0 (idx_t n, const float *x, idx_t k, const storage_idx_t *nearest, const float *nearest_d, float *distances, idx_t *labels, int nprobe=1, int search_type=1, const SearchParameters *params=nullptr) const search_level_0 + faiss::IndexHNSW::search_level_0 idx_t n @@ -372,6 +382,7 @@ void faiss::IndexHNSW::init_level_0_from_knngraph (int k, const float *D, const idx_t *I) init_level_0_from_knngraph + faiss::IndexHNSW::init_level_0_from_knngraph int k @@ -398,6 +409,7 @@ void faiss::IndexHNSW::init_level_0_from_entry_points (int npt, const storage_idx_t *points, const storage_idx_t *nearests) init_level_0_from_entry_points + faiss::IndexHNSW::init_level_0_from_entry_points int npt @@ -424,6 +436,7 @@ void faiss::IndexHNSW::reorder_links () reorder_links + faiss::IndexHNSW::reorder_links @@ -437,6 +450,7 @@ void faiss::IndexHNSW::link_singletons () link_singletons + faiss::IndexHNSW::link_singletons @@ -450,6 +464,7 @@ void faiss::IndexHNSW::permute_entries (const idx_t *perm) permute_entries + faiss::IndexHNSW::permute_entries const idx_t * perm @@ -462,12 +477,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexHNSW::get_distance_computer + DistanceComputer * faiss::IndexHNSW::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexHNSW::get_distance_computer + get_distance_computer @@ -483,6 +499,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -542,6 +559,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -608,6 +626,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -632,6 +651,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -685,6 +705,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -742,6 +763,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -839,6 +861,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -894,6 +917,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -961,6 +985,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -982,8 +1008,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1047,14 +1075,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1119,6 +1147,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1147,6 +1176,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1169,6 +1199,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1210,13 +1241,14 @@ - - + + HNSW::storage_idx_t typedef HNSW::storage_idx_t faiss::IndexHNSW::storage_idx_t storage_idx_t + faiss::IndexHNSW::storage_idx_t @@ -1230,6 +1262,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1243,6 +1276,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1251,13 +1285,14 @@ - - + + HNSW HNSW faiss::IndexHNSW::hnsw hnsw + faiss::IndexHNSW::hnsw @@ -1271,6 +1306,7 @@ bool faiss::IndexHNSW::own_fields own_fields + faiss::IndexHNSW::own_fields = false @@ -1285,6 +1321,7 @@ Index* faiss::IndexHNSW::storage storage + faiss::IndexHNSW::storage = nullptr @@ -1299,6 +1336,7 @@ bool faiss::IndexHNSW::init_level0 init_level0 + faiss::IndexHNSW::init_level0 = true @@ -1313,6 +1351,7 @@ bool faiss::IndexHNSW::keep_max_size_level0 keep_max_size_level0 + faiss::IndexHNSW::keep_max_size_level0 = false @@ -1327,6 +1366,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1341,6 +1381,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1355,6 +1396,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1369,6 +1411,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1383,6 +1426,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1397,6 +1441,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1406,19 +1451,13 @@ - + SQ index topped with with a HNSW structure to access elements more efficiently. - - - - - - @@ -1429,18 +1468,21 @@ - - - - - - + + + + + + + rng + + @@ -1457,13 +1499,16 @@ storage - - - - - rng + + + + + + + + @@ -1477,7 +1522,7 @@ faiss::IndexHNSWSQcompute_residual_n faiss::IndexHNSWSQd faiss::IndexHNSWSQdistance_t - faiss::IndexHNSWSQget_distance_computer + faiss::IndexHNSWSQget_distance_computer faiss::IndexHNSWSQhnsw faiss::IndexHNSWSQIndex faiss::IndexHNSWSQIndexHNSW diff --git a/xml/structfaiss_1_1IndexIDMap2Template.xml b/xml/structfaiss_1_1IndexIDMap2Template.xml index 36eacda626..7cddf32010 100644 --- a/xml/structfaiss_1_1IndexIDMap2Template.xml +++ b/xml/structfaiss_1_1IndexIDMap2Template.xml @@ -1,5 +1,5 @@ - + faiss::IndexIDMap2Template faiss::IndexIDMapTemplate< IndexT > @@ -9,12 +9,13 @@ typename IndexT - + typename IndexT::component_t using faiss::IndexIDMap2Template< IndexT >::component_t = typename IndexT::component_t component_t + faiss::IndexIDMap2Template::component_t @@ -28,6 +29,7 @@ using faiss::IndexIDMap2Template< IndexT >::distance_t = typename IndexT::distance_t distance_t + faiss::IndexIDMap2Template::distance_t @@ -36,13 +38,14 @@ - - + + std::unordered_map< idx_t, idx_t > std::unordered_map<idx_t, idx_t> faiss::IndexIDMap2Template< IndexT >::rev_map rev_map + faiss::IndexIDMap2Template::rev_map @@ -56,6 +59,7 @@ IndexT* faiss::IndexIDMapTemplate< IndexT >::index index + faiss::IndexIDMapTemplate::index = nullptr @@ -70,6 +74,7 @@ bool faiss::IndexIDMapTemplate< IndexT >::own_fields own_fields + faiss::IndexIDMapTemplate::own_fields = false ! the sub-index @@ -85,6 +90,7 @@ std::vector<idx_t> faiss::IndexIDMapTemplate< IndexT >::id_map id_map + faiss::IndexIDMapTemplate::id_map ! whether pointers are deleted in destructo @@ -94,13 +100,14 @@ - - + + faiss::IndexIDMap2Template< IndexT >::IndexIDMap2Template (IndexT *index) IndexIDMap2Template + faiss::IndexIDMap2Template::IndexIDMap2Template IndexT * index @@ -118,6 +125,7 @@ void faiss::IndexIDMap2Template< IndexT >::construct_rev_map () construct_rev_map + faiss::IndexIDMap2Template::construct_rev_map make the rev_map from scratch @@ -132,6 +140,7 @@ void faiss::IndexIDMap2Template< IndexT >::add_with_ids (idx_t n, const component_t *x, const idx_t *xids) override add_with_ids + faiss::IndexIDMap2Template::add_with_ids idx_t n @@ -157,6 +166,7 @@ size_t faiss::IndexIDMap2Template< IndexT >::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIDMap2Template::remove_ids const IDSelector & sel @@ -174,6 +184,7 @@ void faiss::IndexIDMap2Template< IndexT >::reconstruct (idx_t key, component_t *recons) const override reconstruct + faiss::IndexIDMap2Template::reconstruct idx_t key @@ -195,6 +206,7 @@ void faiss::IndexIDMap2Template< IndexT >::check_consistency () const check_consistency + faiss::IndexIDMap2Template::check_consistency check that the rev_map and the id_map are in sync @@ -209,6 +221,7 @@ void faiss::IndexIDMap2Template< IndexT >::merge_from (IndexT &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexIDMap2Template::merge_from IndexT & otherIndex @@ -231,6 +244,7 @@ faiss::IndexIDMap2Template< IndexT >::~IndexIDMap2Template () override ~IndexIDMap2Template + faiss::IndexIDMap2Template::~IndexIDMap2Template @@ -244,6 +258,7 @@ faiss::IndexIDMap2Template< IndexT >::IndexIDMap2Template () IndexIDMap2Template + faiss::IndexIDMap2Template::IndexIDMap2Template @@ -257,6 +272,7 @@ void faiss::IndexIDMapTemplate< IndexT >::add (idx_t n, const component_t *x) override add + faiss::IndexIDMapTemplate::add idx_t n @@ -279,6 +295,7 @@ void faiss::IndexIDMapTemplate< IndexT >::search (idx_t n, const component_t *x, idx_t k, distance_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIDMapTemplate::search idx_t n @@ -317,6 +334,7 @@ void faiss::IndexIDMapTemplate< IndexT >::train (idx_t n, const component_t *x) override train + faiss::IndexIDMapTemplate::train idx_t n @@ -338,6 +356,7 @@ void faiss::IndexIDMapTemplate< IndexT >::reset () override reset + faiss::IndexIDMapTemplate::reset @@ -351,6 +370,7 @@ void faiss::IndexIDMapTemplate< IndexT >::range_search (idx_t n, const component_t *x, distance_t radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIDMapTemplate::range_search idx_t n @@ -385,6 +405,7 @@ void faiss::IndexIDMapTemplate< IndexT >::check_compatible_for_merge (const IndexT &otherIndex) const override check_compatible_for_merge + faiss::IndexIDMapTemplate::check_compatible_for_merge const IndexT & otherIndex @@ -402,6 +423,7 @@ size_t faiss::IndexIDMapTemplate< IndexT >::sa_code_size () const override sa_code_size + faiss::IndexIDMapTemplate::sa_code_size @@ -415,6 +437,7 @@ void faiss::IndexIDMapTemplate< IndexT >::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexIDMapTemplate::add_sa_codes idx_t n @@ -435,19 +458,13 @@ - + same as IndexIDMap but also provides an efficient reconstruction implementation via a 2-way index - - - - - - @@ -457,14 +474,14 @@ - - + + @@ -474,6 +491,12 @@ + + + + + + diff --git a/xml/structfaiss_1_1IndexIDMapTemplate.xml b/xml/structfaiss_1_1IndexIDMapTemplate.xml index 09483bb0fe..98a0e296f0 100644 --- a/xml/structfaiss_1_1IndexIDMapTemplate.xml +++ b/xml/structfaiss_1_1IndexIDMapTemplate.xml @@ -1,5 +1,5 @@ - + faiss::IndexIDMapTemplate IndexT @@ -10,12 +10,13 @@ typename IndexT - + typename IndexT::component_t using faiss::IndexIDMapTemplate< IndexT >::component_t = typename IndexT::component_t component_t + faiss::IndexIDMapTemplate::component_t @@ -29,6 +30,7 @@ using faiss::IndexIDMapTemplate< IndexT >::distance_t = typename IndexT::distance_t distance_t + faiss::IndexIDMapTemplate::distance_t @@ -37,13 +39,14 @@ - - + + IndexT * IndexT* faiss::IndexIDMapTemplate< IndexT >::index index + faiss::IndexIDMapTemplate::index = nullptr @@ -58,6 +61,7 @@ bool faiss::IndexIDMapTemplate< IndexT >::own_fields own_fields + faiss::IndexIDMapTemplate::own_fields = false ! the sub-index @@ -73,6 +77,7 @@ std::vector<idx_t> faiss::IndexIDMapTemplate< IndexT >::id_map id_map + faiss::IndexIDMapTemplate::id_map ! whether pointers are deleted in destructo @@ -82,13 +87,14 @@ - - + + faiss::IndexIDMapTemplate< IndexT >::IndexIDMapTemplate (IndexT *index) IndexIDMapTemplate + faiss::IndexIDMapTemplate::IndexIDMapTemplate IndexT * index @@ -106,6 +112,7 @@ void faiss::IndexIDMapTemplate< IndexT >::add_with_ids (idx_t n, const component_t *x, const idx_t *xids) override add_with_ids + faiss::IndexIDMapTemplate::add_with_ids idx_t n @@ -141,6 +148,7 @@ void faiss::IndexIDMapTemplate< IndexT >::add (idx_t n, const component_t *x) override add + faiss::IndexIDMapTemplate::add idx_t n @@ -163,6 +171,7 @@ void faiss::IndexIDMapTemplate< IndexT >::search (idx_t n, const component_t *x, idx_t k, distance_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIDMapTemplate::search idx_t n @@ -201,6 +210,7 @@ void faiss::IndexIDMapTemplate< IndexT >::train (idx_t n, const component_t *x) override train + faiss::IndexIDMapTemplate::train idx_t n @@ -222,6 +232,7 @@ void faiss::IndexIDMapTemplate< IndexT >::reset () override reset + faiss::IndexIDMapTemplate::reset @@ -235,6 +246,7 @@ size_t faiss::IndexIDMapTemplate< IndexT >::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIDMapTemplate::remove_ids const IDSelector & sel @@ -253,6 +265,7 @@ void faiss::IndexIDMapTemplate< IndexT >::range_search (idx_t n, const component_t *x, distance_t radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIDMapTemplate::range_search idx_t n @@ -287,6 +300,7 @@ void faiss::IndexIDMapTemplate< IndexT >::merge_from (IndexT &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexIDMapTemplate::merge_from IndexT & otherIndex @@ -309,6 +323,7 @@ void faiss::IndexIDMapTemplate< IndexT >::check_compatible_for_merge (const IndexT &otherIndex) const override check_compatible_for_merge + faiss::IndexIDMapTemplate::check_compatible_for_merge const IndexT & otherIndex @@ -326,6 +341,7 @@ size_t faiss::IndexIDMapTemplate< IndexT >::sa_code_size () const override sa_code_size + faiss::IndexIDMapTemplate::sa_code_size @@ -339,6 +355,7 @@ void faiss::IndexIDMapTemplate< IndexT >::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexIDMapTemplate::add_sa_codes idx_t n @@ -364,6 +381,7 @@ faiss::IndexIDMapTemplate< IndexT >::~IndexIDMapTemplate () override ~IndexIDMapTemplate + faiss::IndexIDMapTemplate::~IndexIDMapTemplate @@ -377,6 +395,7 @@ faiss::IndexIDMapTemplate< IndexT >::IndexIDMapTemplate () IndexIDMapTemplate + faiss::IndexIDMapTemplate::IndexIDMapTemplate @@ -385,19 +404,13 @@ - + Index that translates search results to ids - - - - - - @@ -407,17 +420,23 @@ - - + + + + + + + + diff --git a/xml/structfaiss_1_1IndexIVF.xml b/xml/structfaiss_1_1IndexIVF.xml index dbad8bd1e2..c621e6201a 100644 --- a/xml/structfaiss_1_1IndexIVF.xml +++ b/xml/structfaiss_1_1IndexIVF.xml @@ -1,5 +1,5 @@ - + faiss::IndexIVF faiss::Index @@ -11,12 +11,13 @@ faiss::IndexIVFScalarQuantizer faiss::IndexIVFSpectralHash IndexIVF.h - + InvertedLists * InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -32,6 +33,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -46,6 +48,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -61,6 +64,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -78,6 +82,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -92,6 +97,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -106,6 +112,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -121,6 +128,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -135,6 +143,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -149,6 +158,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -163,6 +173,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -177,6 +188,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -191,6 +203,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -205,6 +218,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -220,6 +234,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -235,6 +250,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -250,6 +266,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -265,6 +282,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -280,6 +298,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -295,6 +314,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -309,6 +329,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -319,13 +340,14 @@ - - + + faiss::IndexIVF::IndexIVF (Index *quantizer, size_t d, size_t nlist, size_t code_size, MetricType metric=METRIC_L2) IndexIVF + faiss::IndexIVF::IndexIVF Index * quantizer @@ -361,6 +383,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -377,6 +400,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -401,6 +425,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -424,6 +449,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -454,6 +480,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -503,6 +530,7 @@ virtual void faiss::IndexIVF::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listno=false) const =0 encode_vectors + faiss::IndexIVF::encode_vectors encode_vectors encode_vectors encode_vectors @@ -571,6 +599,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -616,6 +645,7 @@ virtual void faiss::IndexIVF::train_encoder (idx_t n, const float *x, const idx_t *assign) train_encoder + faiss::IndexIVF::train_encoder train_encoder train_encoder train_encoder @@ -650,6 +680,7 @@ virtual idx_t faiss::IndexIVF::train_encoder_num_vectors () const train_encoder_num_vectors + faiss::IndexIVF::train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors @@ -670,6 +701,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -804,6 +836,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -924,6 +957,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -966,6 +1000,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1034,16 +1069,17 @@ - + InvertedListScanner * - virtual InvertedListScanner* faiss::IndexIVF::get_InvertedListScanner + virtual InvertedListScanner * faiss::IndexIVF::get_InvertedListScanner (bool store_pairs=false, const IDSelector *sel=nullptr) const get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVF::get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -1069,6 +1105,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1092,6 +1129,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1146,6 +1184,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1200,6 +1239,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1255,6 +1295,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1321,6 +1362,7 @@ virtual void faiss::IndexIVF::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const reconstruct_from_offset + faiss::IndexIVF::reconstruct_from_offset reconstruct_from_offset reconstruct_from_offset reconstruct_from_offset @@ -1355,6 +1397,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1376,6 +1419,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1395,6 +1439,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1414,12 +1459,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1433,6 +1479,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1463,6 +1510,7 @@ faiss::IndexIVF::~IndexIVF () override ~IndexIVF + faiss::IndexIVF::~IndexIVF @@ -1476,6 +1524,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1493,6 +1542,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1507,6 +1557,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1536,6 +1587,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1553,6 +1605,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1576,6 +1629,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1591,6 +1645,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1607,7 +1662,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1645,6 +1700,7 @@ faiss::IndexIVF::IndexIVF () IndexIVF + faiss::IndexIVF::IndexIVF @@ -1658,6 +1714,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1724,6 +1781,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1777,6 +1835,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1832,6 +1891,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1894,15 +1954,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1918,14 +1979,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1990,6 +2051,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2020,6 +2082,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2034,6 +2097,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2055,6 +2119,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2067,13 +2132,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2087,6 +2153,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2095,7 +2162,7 @@ - + @@ -2106,34 +2173,16 @@ Sub-classes implement a post-filtering of the index that refines the distance estimation from the query to databse vectors. - - - - - - - - - - - - - - - - - + + + - - - - + + + + - - - - - + @@ -2142,69 +2191,71 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + + + + + + + + + + + + + @@ -2218,40 +2269,53 @@ - - - - + + + + - - - - + + + + - - - - + + + + + + + + + + + + + + + + - - - - cp - - - clustering_index - quantizer - + + + + + + - - + + + + + + @@ -2261,30 +2325,33 @@ - direct_map + invlists - invlists + direct_map - - - - - - - - - - - - + + + + + + + + + clustering_index + quantizer + + + cp + + @@ -2310,9 +2377,9 @@ faiss::IndexIVFdistance_t faiss::IndexIVFencode_listno faiss::IndexIVFencode_vectors - faiss::IndexIVFget_CodePacker - faiss::IndexIVFget_distance_computer - faiss::IndexIVFget_InvertedListScanner + faiss::IndexIVFget_CodePacker + faiss::IndexIVFget_distance_computer + faiss::IndexIVFget_InvertedListScanner faiss::IndexIVFget_list_size faiss::IndexIVFIndex faiss::IndexIVFIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFAdditiveQuantizer.xml b/xml/structfaiss_1_1IndexIVFAdditiveQuantizer.xml index 2b30e8d1fb..315fc8bbdb 100644 --- a/xml/structfaiss_1_1IndexIVFAdditiveQuantizer.xml +++ b/xml/structfaiss_1_1IndexIVFAdditiveQuantizer.xml @@ -1,5 +1,5 @@ - + faiss::IndexIVFAdditiveQuantizer faiss::IndexIVF @@ -8,12 +8,13 @@ faiss::IndexIVFProductResidualQuantizer faiss::IndexIVFResidualQuantizer IndexIVFAdditiveQuantizer.h - + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizer::Search_type_t @@ -27,6 +28,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -40,6 +42,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -48,13 +51,14 @@ - - + + AdditiveQuantizer * AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizer::aq aq + faiss::IndexIVFAdditiveQuantizer::aq @@ -68,6 +72,7 @@ int faiss::IndexIVFAdditiveQuantizer::use_precomputed_table use_precomputed_table + faiss::IndexIVFAdditiveQuantizer::use_precomputed_table = 0 @@ -82,6 +87,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -97,6 +103,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -111,6 +118,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -126,6 +134,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -143,6 +152,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -157,6 +167,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -171,6 +182,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -186,6 +198,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -200,6 +213,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -214,6 +228,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -228,6 +243,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -242,6 +258,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -256,6 +273,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -270,6 +288,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -285,6 +304,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -300,6 +320,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -315,6 +336,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -330,6 +352,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -345,6 +368,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -360,6 +384,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -374,6 +399,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -384,13 +410,14 @@ - - + + faiss::IndexIVFAdditiveQuantizer::IndexIVFAdditiveQuantizer (AdditiveQuantizer *aq, Index *quantizer, size_t d, size_t nlist, MetricType metric=METRIC_L2) IndexIVFAdditiveQuantizer + faiss::IndexIVFAdditiveQuantizer::IndexIVFAdditiveQuantizer AdditiveQuantizer * aq @@ -425,6 +452,7 @@ faiss::IndexIVFAdditiveQuantizer::IndexIVFAdditiveQuantizer (AdditiveQuantizer *aq) IndexIVFAdditiveQuantizer + faiss::IndexIVFAdditiveQuantizer::IndexIVFAdditiveQuantizer AdditiveQuantizer * aq @@ -442,6 +470,7 @@ void faiss::IndexIVFAdditiveQuantizer::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizer::train_encoder train_encoder idx_t @@ -470,6 +499,7 @@ idx_t faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors train_encoder_num_vectors @@ -485,6 +515,7 @@ void faiss::IndexIVFAdditiveQuantizer::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizer::encode_vectors encode_vectors idx_t @@ -542,12 +573,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -571,6 +603,7 @@ void faiss::IndexIVFAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *codes, float *x) const override sa_decode + faiss::IndexIVFAdditiveQuantizer::sa_decode sa_decode idx_t @@ -624,6 +657,7 @@ void faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset reconstruct_from_offset int64_t @@ -652,6 +686,7 @@ faiss::IndexIVFAdditiveQuantizer::~IndexIVFAdditiveQuantizer () override ~IndexIVFAdditiveQuantizer + faiss::IndexIVFAdditiveQuantizer::~IndexIVFAdditiveQuantizer @@ -665,6 +700,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -681,6 +717,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -705,6 +742,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -728,6 +766,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -758,6 +797,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -807,6 +847,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -852,6 +893,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -986,6 +1028,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1106,6 +1149,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1148,6 +1192,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1221,6 +1266,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1244,6 +1290,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1298,6 +1345,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1352,6 +1400,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1407,6 +1456,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1473,6 +1523,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1494,6 +1545,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1513,6 +1565,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1532,12 +1585,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1551,6 +1605,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1581,6 +1636,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1598,6 +1654,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1612,6 +1669,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1641,6 +1699,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1658,6 +1717,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1681,6 +1741,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1696,6 +1757,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1712,7 +1774,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1750,6 +1812,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1816,6 +1879,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1869,6 +1933,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1924,6 +1989,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1986,15 +2052,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2010,6 +2077,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2040,6 +2108,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2054,6 +2123,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2075,6 +2145,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2087,23 +2158,23 @@ - + Abstract class for IVF additive quantizers. The search functions are in common. - - - - - + + + - - - - + + + + + + @@ -2112,9 +2183,17 @@ - - - + + + + + + + + + + + @@ -2122,74 +2201,45 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - aq + + + + - - cp - - - clustering_index - quantizer - - - - - - - - - - - - - - direct_map + + + + + + - - invlists + + qnorm + + + + + + + + @@ -2202,37 +2252,39 @@ + + + + + + - - - - - - - - - - - - + + + + - - qnorm + + + + invlists + + + direct_map - - - - - - - - + + + + + + + aq @@ -2241,6 +2293,25 @@ + + + + + + + + + clustering_index + quantizer + + + cp + + + + + + @@ -2267,9 +2338,9 @@ faiss::IndexIVFAdditiveQuantizerdistance_t faiss::IndexIVFAdditiveQuantizerencode_listno faiss::IndexIVFAdditiveQuantizerencode_vectors - faiss::IndexIVFAdditiveQuantizerget_CodePacker - faiss::IndexIVFAdditiveQuantizerget_distance_computer - faiss::IndexIVFAdditiveQuantizerget_InvertedListScanner + faiss::IndexIVFAdditiveQuantizerget_CodePacker + faiss::IndexIVFAdditiveQuantizerget_distance_computer + faiss::IndexIVFAdditiveQuantizerget_InvertedListScanner faiss::IndexIVFAdditiveQuantizerget_list_size faiss::IndexIVFAdditiveQuantizerIndex faiss::IndexIVFAdditiveQuantizerIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFAdditiveQuantizerFastScan.xml b/xml/structfaiss_1_1IndexIVFAdditiveQuantizerFastScan.xml index c4d0484e1a..ddbd657577 100644 --- a/xml/structfaiss_1_1IndexIVFAdditiveQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexIVFAdditiveQuantizerFastScan.xml @@ -1,5 +1,5 @@ - + faiss::IndexIVFAdditiveQuantizerFastScan faiss::IndexIVFFastScan @@ -8,12 +8,13 @@ faiss::IndexIVFProductResidualQuantizerFastScan faiss::IndexIVFResidualQuantizerFastScan IndexIVFAdditiveQuantizerFastScan.h - + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t @@ -27,6 +28,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -40,6 +42,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -48,13 +51,14 @@ - - + + AdditiveQuantizer * AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizerFastScan::aq aq + faiss::IndexIVFAdditiveQuantizerFastScan::aq @@ -68,6 +72,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm = false @@ -82,6 +87,7 @@ int faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale = 1 @@ -96,6 +102,7 @@ size_t faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points @@ -109,71 +116,77 @@ int faiss::IndexIVFFastScan::bbs bbs + faiss::IndexIVFFastScan::bbs - + size_t size_t faiss::IndexIVFFastScan::M M + faiss::IndexIVFFastScan::M - + size_t size_t faiss::IndexIVFFastScan::nbits nbits + faiss::IndexIVFFastScan::nbits - + size_t size_t faiss::IndexIVFFastScan::ksub ksub + faiss::IndexIVFFastScan::ksub - + size_t size_t faiss::IndexIVFFastScan::M2 M2 + faiss::IndexIVFFastScan::M2 - + int int faiss::IndexIVFFastScan::implem implem + faiss::IndexIVFFastScan::implem = 0 @@ -181,13 +194,14 @@ - + int int faiss::IndexIVFFastScan::skip skip + faiss::IndexIVFFastScan::skip = 0 @@ -195,13 +209,14 @@ - + int int faiss::IndexIVFFastScan::qbs qbs + faiss::IndexIVFFastScan::qbs = 0 @@ -209,13 +224,14 @@ - + size_t size_t faiss::IndexIVFFastScan::qbs2 qbs2 + faiss::IndexIVFFastScan::qbs2 = 0 @@ -223,13 +239,29 @@ - + + + + Quantizer * + Quantizer* faiss::IndexIVFFastScan::fine_quantizer + + fine_quantizer + faiss::IndexIVFFastScan::fine_quantizer + = nullptr + + + + + + + InvertedLists * InvertedLists* faiss::IndexIVFFastScan::orig_invlists orig_invlists + faiss::IndexIVFFastScan::orig_invlists = nullptr orig's inverted lists (for debugging) @@ -238,13 +270,14 @@ - + InvertedLists * InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -260,6 +293,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -274,6 +308,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -289,6 +324,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -306,6 +342,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -320,6 +357,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -334,6 +372,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -349,6 +388,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -363,6 +403,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -377,6 +418,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -391,6 +433,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -405,6 +448,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -419,6 +463,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -433,6 +478,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -448,6 +494,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -463,6 +510,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -478,6 +526,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -493,6 +542,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -508,6 +558,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -523,6 +574,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -537,6 +589,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -547,13 +600,14 @@ - - + + faiss::IndexIVFAdditiveQuantizerFastScan::IndexIVFAdditiveQuantizerFastScan (Index *quantizer, AdditiveQuantizer *aq, size_t d, size_t nlist, MetricType metric=METRIC_L2, int bbs=32) IndexIVFAdditiveQuantizerFastScan + faiss::IndexIVFAdditiveQuantizerFastScan::IndexIVFAdditiveQuantizerFastScan Index * quantizer @@ -593,6 +647,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, size_t nlist, MetricType metric, int bbs) init + faiss::IndexIVFAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -622,6 +677,7 @@ faiss::IndexIVFAdditiveQuantizerFastScan::IndexIVFAdditiveQuantizerFastScan () IndexIVFAdditiveQuantizerFastScan + faiss::IndexIVFAdditiveQuantizerFastScan::IndexIVFAdditiveQuantizerFastScan @@ -635,6 +691,7 @@ faiss::IndexIVFAdditiveQuantizerFastScan::~IndexIVFAdditiveQuantizerFastScan () override ~IndexIVFAdditiveQuantizerFastScan + faiss::IndexIVFAdditiveQuantizerFastScan::~IndexIVFAdditiveQuantizerFastScan @@ -648,6 +705,7 @@ faiss::IndexIVFAdditiveQuantizerFastScan::IndexIVFAdditiveQuantizerFastScan (const IndexIVFAdditiveQuantizer &orig, int bbs=32) IndexIVFAdditiveQuantizerFastScan + faiss::IndexIVFAdditiveQuantizerFastScan::IndexIVFAdditiveQuantizerFastScan const IndexIVFAdditiveQuantizer & orig @@ -670,6 +728,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder train_encoder idx_t @@ -698,6 +757,7 @@ idx_t faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors train_encoder_num_vectors @@ -713,6 +773,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -734,6 +795,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listno=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors encode_vectors idx_t @@ -770,6 +832,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVFAdditiveQuantizerFastScan::search search idx_t @@ -810,6 +873,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d () const override lookup_table_is_3d + faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d lookup_table_is_3d @@ -824,6 +888,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< float > &dis_tables, AlignedTable< float > &biases) const override compute_LUT + faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT compute_LUT size_t @@ -853,64 +918,16 @@ - - void - void faiss::IndexIVFAdditiveQuantizerFastScan::sa_decode - (idx_t n, const uint8_t *bytes, float *x) const override - sa_decode - sa_decode - - idx_t - n - - - const uint8_t * - bytes - - - float * - x - - - - -decode a set of vectors - - -n - - -number of vectors - - - - -bytes - - -input encoded vectors, size n * sa_code_size() - - - - -x - - -output vectors, size n * d - - - - - - - - - - + void void faiss::IndexIVFFastScan::init_fastscan - (size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) + (Quantizer *fine_quantizer, size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) init_fastscan + faiss::IndexIVFFastScan::init_fastscan + + Quantizer * + fine_quantizer + size_t M @@ -932,31 +949,34 @@ bbs +called by implementations - + void void faiss::IndexIVFFastScan::init_code_packer () init_code_packer + faiss::IndexIVFFastScan::init_code_packer - + void void faiss::IndexIVFFastScan::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVFFastScan::add_with_ids add_with_ids idx_t @@ -977,13 +997,14 @@ - + void void faiss::IndexIVFFastScan::compute_LUT_uint8 (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< uint8_t > &dis_tables, AlignedTable< uint16_t > &biases, float *normalizers) const compute_LUT_uint8 + faiss::IndexIVFFastScan::compute_LUT_uint8 size_t n @@ -1014,13 +1035,14 @@ - + void void faiss::IndexIVFFastScan::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVFFastScan::search_preassigned search_preassigned idx_t @@ -1145,13 +1167,14 @@ - + void void faiss::IndexIVFFastScan::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVFFastScan::range_search range_search idx_t @@ -1216,13 +1239,14 @@ - + void void faiss::IndexIVFFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_dispatch_implem + faiss::IndexIVFFastScan::search_dispatch_implem idx_t n @@ -1262,13 +1286,14 @@ - + void void faiss::IndexIVFFastScan::range_search_dispatch_implem (idx_t n, const float *x, float radius, RangeSearchResult &rres, const CoarseQuantized &cq_in, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const range_search_dispatch_implem + faiss::IndexIVFFastScan::range_search_dispatch_implem idx_t n @@ -1304,7 +1329,7 @@ - + @@ -1316,6 +1341,7 @@ void faiss::IndexIVFFastScan::search_implem_1 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_1 + faiss::IndexIVFFastScan::search_implem_1 idx_t n @@ -1355,7 +1381,7 @@ - + @@ -1367,6 +1393,7 @@ void faiss::IndexIVFFastScan::search_implem_2 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_2 + faiss::IndexIVFFastScan::search_implem_2 idx_t n @@ -1406,13 +1433,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_10 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_10 + faiss::IndexIVFFastScan::search_implem_10 idx_t n @@ -1452,13 +1480,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_12 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_12 + faiss::IndexIVFFastScan::search_implem_12 idx_t n @@ -1498,13 +1527,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, int impl, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_14 + faiss::IndexIVFFastScan::search_implem_14 idx_t n @@ -1548,13 +1578,14 @@ - + void void faiss::IndexIVFFastScan::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFFastScan::reconstruct_from_offset reconstruct_from_offset int64_t @@ -1576,40 +1607,98 @@ - + - + CodePacker * - CodePacker* faiss::IndexIVFFastScan::get_CodePacker + CodePacker * faiss::IndexIVFFastScan::get_CodePacker () const override get_CodePacker - get_CodePacker + faiss::IndexIVFFastScan::get_CodePacker + get_CodePacker - + void void faiss::IndexIVFFastScan::reconstruct_orig_invlists () reconstruct_orig_invlists + faiss::IndexIVFFastScan::reconstruct_orig_invlists - + + + + void + void faiss::IndexIVFFastScan::sa_decode + (idx_t n, const uint8_t *bytes, float *x) const override + sa_decode + faiss::IndexIVFFastScan::sa_decode + sa_decode + + idx_t + n + + + const uint8_t * + bytes + + + float * + x + + + + +Decode a set of vectors. +NOTE: The codes in the IndexFastScan object are non-contiguous. But this method requires a contiguous representation. + + +n + + +number of vectors + + + + +bytes + + +input encoded vectors, size n * code_size + + + + +x + + +output vectors, size n * d + + + + + + + + void void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -1626,6 +1715,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -1650,6 +1740,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -1673,6 +1764,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -1722,6 +1814,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -1767,6 +1860,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1882,16 +1976,17 @@ - + InvertedListScanner * - virtual InvertedListScanner* faiss::IndexIVF::get_InvertedListScanner + virtual InvertedListScanner * faiss::IndexIVF::get_InvertedListScanner (bool store_pairs=false, const IDSelector *sel=nullptr) const get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVF::get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -1917,6 +2012,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1940,6 +2036,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1994,6 +2091,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -2048,6 +2146,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -2103,6 +2202,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -2169,6 +2269,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -2190,6 +2291,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -2209,6 +2311,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -2233,6 +2336,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -2263,6 +2367,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -2280,6 +2385,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -2294,6 +2400,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -2323,6 +2430,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -2340,6 +2448,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -2363,6 +2472,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -2378,6 +2488,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -2394,7 +2505,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -2432,6 +2543,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -2498,6 +2610,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -2551,6 +2664,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -2606,6 +2720,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2668,15 +2783,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2692,6 +2808,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2722,6 +2839,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2736,6 +2854,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2757,6 +2876,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2769,7 +2889,7 @@ - + @@ -2778,15 +2898,9 @@ Implementations (implem): 0: auto-select implementation (default) 1: orig's search, re-implemented 2: orig's search, re-ordered by invlist 10: optimizer int16 search, collect results in heap, no qbs 11: idem, collect results in reservoir 12: optimizer int16 search, collect results in heap, uses qbs 13: idem, collect results in reservoir - - - - - - - - - + + + @@ -2802,56 +2916,92 @@ - - - - - - + + + + + + - - - - - - - - + + + + + + + + + + - - - - cp + + + + + + + - - clustering_index - quantizer + + qnorm + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2861,10 +3011,10 @@ - direct_map + invlists - invlists + direct_map @@ -2872,76 +3022,49 @@ - + aq - - - - - - orig_invlists - - - - - - + + fine_quantizer - - - - - + + orig_invlists - - - - + + + + - - - - - - + + - - - - + + + + + clustering_index + quantizer - - qnorm + + cp - + - - - - - - - - - - - - - + faiss::IndexIVFAdditiveQuantizerFastScanadd faiss::IndexIVFAdditiveQuantizerFastScanadd_core @@ -2970,9 +3093,10 @@ faiss::IndexIVFAdditiveQuantizerFastScanencode_listno faiss::IndexIVFAdditiveQuantizerFastScanencode_vectors faiss::IndexIVFAdditiveQuantizerFastScanestimate_norm_scale - faiss::IndexIVFAdditiveQuantizerFastScanget_CodePacker - faiss::IndexIVFAdditiveQuantizerFastScanget_distance_computer - faiss::IndexIVFAdditiveQuantizerFastScanget_InvertedListScanner + faiss::IndexIVFAdditiveQuantizerFastScanfine_quantizer + faiss::IndexIVFAdditiveQuantizerFastScanget_CodePacker + faiss::IndexIVFAdditiveQuantizerFastScanget_distance_computer + faiss::IndexIVFAdditiveQuantizerFastScanget_InvertedListScanner faiss::IndexIVFAdditiveQuantizerFastScanget_list_size faiss::IndexIVFAdditiveQuantizerFastScanimplem faiss::IndexIVFAdditiveQuantizerFastScanIndex @@ -2986,7 +3110,7 @@ faiss::IndexIVFAdditiveQuantizerFastScanIndexIVFInterface faiss::IndexIVFAdditiveQuantizerFastScaninit faiss::IndexIVFAdditiveQuantizerFastScaninit_code_packer - faiss::IndexIVFAdditiveQuantizerFastScaninit_fastscan + faiss::IndexIVFAdditiveQuantizerFastScaninit_fastscan faiss::IndexIVFAdditiveQuantizerFastScaninvlists faiss::IndexIVFAdditiveQuantizerFastScanis_trained faiss::IndexIVFAdditiveQuantizerFastScanksub @@ -3028,7 +3152,7 @@ faiss::IndexIVFAdditiveQuantizerFastScanrescale_norm faiss::IndexIVFAdditiveQuantizerFastScanreset faiss::IndexIVFAdditiveQuantizerFastScansa_code_size - faiss::IndexIVFAdditiveQuantizerFastScansa_decode + faiss::IndexIVFAdditiveQuantizerFastScansa_decode faiss::IndexIVFAdditiveQuantizerFastScansa_encode faiss::IndexIVFAdditiveQuantizerFastScansearch faiss::IndexIVFAdditiveQuantizerFastScansearch_and_reconstruct diff --git a/xml/structfaiss_1_1IndexIVFFastScan.xml b/xml/structfaiss_1_1IndexIVFFastScan.xml index e37f0facc8..975a29bba0 100644 --- a/xml/structfaiss_1_1IndexIVFFastScan.xml +++ b/xml/structfaiss_1_1IndexIVFFastScan.xml @@ -1,5 +1,5 @@ - + faiss::IndexIVFFastScan faiss::IndexIVF @@ -7,77 +7,83 @@ faiss::IndexIVFPQFastScan IndexIVFFastScan.h faiss::IndexIVFFastScan::CoarseQuantized - + int int faiss::IndexIVFFastScan::bbs bbs + faiss::IndexIVFFastScan::bbs - + size_t size_t faiss::IndexIVFFastScan::M M + faiss::IndexIVFFastScan::M - + size_t size_t faiss::IndexIVFFastScan::nbits nbits + faiss::IndexIVFFastScan::nbits - + size_t size_t faiss::IndexIVFFastScan::ksub ksub + faiss::IndexIVFFastScan::ksub - + size_t size_t faiss::IndexIVFFastScan::M2 M2 + faiss::IndexIVFFastScan::M2 - + int int faiss::IndexIVFFastScan::implem implem + faiss::IndexIVFFastScan::implem = 0 @@ -85,13 +91,14 @@ - + int int faiss::IndexIVFFastScan::skip skip + faiss::IndexIVFFastScan::skip = 0 @@ -99,13 +106,14 @@ - + int int faiss::IndexIVFFastScan::qbs qbs + faiss::IndexIVFFastScan::qbs = 0 @@ -113,13 +121,14 @@ - + size_t size_t faiss::IndexIVFFastScan::qbs2 qbs2 + faiss::IndexIVFFastScan::qbs2 = 0 @@ -127,13 +136,29 @@ - + + + + Quantizer * + Quantizer* faiss::IndexIVFFastScan::fine_quantizer + + fine_quantizer + faiss::IndexIVFFastScan::fine_quantizer + = nullptr + + + + + + + InvertedLists * InvertedLists* faiss::IndexIVFFastScan::orig_invlists orig_invlists + faiss::IndexIVFFastScan::orig_invlists = nullptr orig's inverted lists (for debugging) @@ -142,13 +167,14 @@ - + InvertedLists * InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -164,6 +190,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -178,6 +205,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -193,6 +221,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -210,6 +239,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -224,6 +254,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -238,6 +269,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -253,6 +285,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -267,6 +300,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -281,6 +315,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -295,6 +330,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -309,6 +345,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -323,6 +360,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -337,6 +375,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -352,6 +391,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -367,6 +407,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -382,6 +423,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -397,6 +439,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -412,6 +455,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -427,6 +471,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -441,6 +486,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -451,13 +497,14 @@ - - + + faiss::IndexIVFFastScan::IndexIVFFastScan (Index *quantizer, size_t d, size_t nlist, size_t code_size, MetricType metric=METRIC_L2) IndexIVFFastScan + faiss::IndexIVFFastScan::IndexIVFFastScan Index * quantizer @@ -485,26 +532,32 @@ - + faiss::IndexIVFFastScan::IndexIVFFastScan () IndexIVFFastScan + faiss::IndexIVFFastScan::IndexIVFFastScan - + - + void void faiss::IndexIVFFastScan::init_fastscan - (size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) + (Quantizer *fine_quantizer, size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) init_fastscan + faiss::IndexIVFFastScan::init_fastscan + + Quantizer * + fine_quantizer + size_t M @@ -526,44 +579,48 @@ bbs +called by implementations - + void void faiss::IndexIVFFastScan::init_code_packer () init_code_packer + faiss::IndexIVFFastScan::init_code_packer - + faiss::IndexIVFFastScan::~IndexIVFFastScan () override ~IndexIVFFastScan + faiss::IndexIVFFastScan::~IndexIVFFastScan - + void void faiss::IndexIVFFastScan::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVFFastScan::add_with_ids add_with_ids idx_t @@ -584,13 +641,14 @@ - + bool virtual bool faiss::IndexIVFFastScan::lookup_table_is_3d () const =0 lookup_table_is_3d + faiss::IndexIVFFastScan::lookup_table_is_3d lookup_table_is_3d lookup_table_is_3d @@ -599,13 +657,14 @@ - + void virtual void faiss::IndexIVFFastScan::compute_LUT (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< float > &dis_tables, AlignedTable< float > &biases) const =0 compute_LUT + faiss::IndexIVFFastScan::compute_LUT compute_LUT compute_LUT @@ -634,13 +693,14 @@ - + void void faiss::IndexIVFFastScan::compute_LUT_uint8 (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< uint8_t > &dis_tables, AlignedTable< uint16_t > &biases, float *normalizers) const compute_LUT_uint8 + faiss::IndexIVFFastScan::compute_LUT_uint8 size_t n @@ -671,13 +731,14 @@ - + void void faiss::IndexIVFFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVFFastScan::search search idx_t @@ -711,13 +772,14 @@ - + void void faiss::IndexIVFFastScan::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVFFastScan::search_preassigned search_preassigned idx_t @@ -842,13 +904,14 @@ - + void void faiss::IndexIVFFastScan::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVFFastScan::range_search range_search idx_t @@ -913,13 +976,14 @@ - + void void faiss::IndexIVFFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_dispatch_implem + faiss::IndexIVFFastScan::search_dispatch_implem idx_t n @@ -959,13 +1023,14 @@ - + void void faiss::IndexIVFFastScan::range_search_dispatch_implem (idx_t n, const float *x, float radius, RangeSearchResult &rres, const CoarseQuantized &cq_in, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const range_search_dispatch_implem + faiss::IndexIVFFastScan::range_search_dispatch_implem idx_t n @@ -1001,7 +1066,7 @@ - + @@ -1013,6 +1078,7 @@ void faiss::IndexIVFFastScan::search_implem_1 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_1 + faiss::IndexIVFFastScan::search_implem_1 idx_t n @@ -1052,7 +1118,7 @@ - + @@ -1064,6 +1130,7 @@ void faiss::IndexIVFFastScan::search_implem_2 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_2 + faiss::IndexIVFFastScan::search_implem_2 idx_t n @@ -1103,13 +1170,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_10 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_10 + faiss::IndexIVFFastScan::search_implem_10 idx_t n @@ -1149,13 +1217,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_12 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_12 + faiss::IndexIVFFastScan::search_implem_12 idx_t n @@ -1195,13 +1264,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, int impl, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_14 + faiss::IndexIVFFastScan::search_implem_14 idx_t n @@ -1245,13 +1315,14 @@ - + void void faiss::IndexIVFFastScan::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFFastScan::reconstruct_from_offset reconstruct_from_offset int64_t @@ -1273,40 +1344,98 @@ - + - + CodePacker * - CodePacker* faiss::IndexIVFFastScan::get_CodePacker + CodePacker * faiss::IndexIVFFastScan::get_CodePacker () const override get_CodePacker - get_CodePacker + faiss::IndexIVFFastScan::get_CodePacker + get_CodePacker - + void void faiss::IndexIVFFastScan::reconstruct_orig_invlists () reconstruct_orig_invlists + faiss::IndexIVFFastScan::reconstruct_orig_invlists - + + + + void + void faiss::IndexIVFFastScan::sa_decode + (idx_t n, const uint8_t *bytes, float *x) const override + sa_decode + faiss::IndexIVFFastScan::sa_decode + sa_decode + + idx_t + n + + + const uint8_t * + bytes + + + float * + x + + + + +Decode a set of vectors. +NOTE: The codes in the IndexFastScan object are non-contiguous. But this method requires a contiguous representation. + + +n + + +number of vectors + + + + +bytes + + +input encoded vectors, size n * code_size + + + + +x + + +output vectors, size n * d + + + + + + + + void void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -1323,6 +1452,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -1347,6 +1477,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -1370,6 +1501,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -1419,6 +1551,7 @@ virtual void faiss::IndexIVF::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listno=false) const =0 encode_vectors + faiss::IndexIVF::encode_vectors encode_vectors encode_vectors encode_vectors @@ -1487,6 +1620,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -1532,6 +1666,7 @@ virtual void faiss::IndexIVF::train_encoder (idx_t n, const float *x, const idx_t *assign) train_encoder + faiss::IndexIVF::train_encoder train_encoder train_encoder train_encoder @@ -1566,6 +1701,7 @@ virtual idx_t faiss::IndexIVF::train_encoder_num_vectors () const train_encoder_num_vectors + faiss::IndexIVF::train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors @@ -1586,6 +1722,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1701,16 +1838,17 @@ - + InvertedListScanner * - virtual InvertedListScanner* faiss::IndexIVF::get_InvertedListScanner + virtual InvertedListScanner * faiss::IndexIVF::get_InvertedListScanner (bool store_pairs=false, const IDSelector *sel=nullptr) const get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVF::get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -1736,6 +1874,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1759,6 +1898,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1813,6 +1953,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1867,6 +2008,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1922,6 +2064,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1988,6 +2131,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -2009,6 +2153,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -2028,6 +2173,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -2052,6 +2198,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -2082,6 +2229,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -2099,6 +2247,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -2113,6 +2262,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -2142,6 +2292,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -2159,6 +2310,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -2182,6 +2334,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -2197,6 +2350,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -2213,7 +2367,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -2251,6 +2405,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -2317,6 +2472,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -2370,6 +2526,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -2425,6 +2582,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2487,15 +2645,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2506,83 +2665,12 @@ - - void - virtual void faiss::Index::sa_decode - (idx_t n, const uint8_t *bytes, float *x) const - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - sa_decode - - idx_t - n - - - const uint8_t * - bytes - - - float * - x - - - - -decode a set of vectors - - -n - - -number of vectors - - - - -bytes - - -input encoded vectors, size n * sa_code_size() - - - - -x - - -output vectors, size n * d - - - - - - - - - void void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2613,6 +2701,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2627,6 +2716,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2648,6 +2738,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2660,13 +2751,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2680,6 +2772,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2688,7 +2781,7 @@ - + @@ -2698,21 +2791,9 @@ For range search, only 10 and 12 are supported. add 100 to the implem to force single-thread scanning (the coarse quantizer may still use multiple threads). - - - - - - - - - - - - - - - + + + @@ -2728,27 +2809,29 @@ - - - - - - + + + + + + - - - + + + + + @@ -2756,28 +2839,35 @@ - - - - + + + + + + + + + + - - - - cp - - - clustering_index - quantizer - + + + + + + - - + + + + + + @@ -2787,41 +2877,51 @@ - direct_map + invlists - invlists + direct_map - - - - - + + fine_quantizer + + orig_invlists - - - - - - - - + + + + + + + + + clustering_index + quantizer + + + cp + + + + + + - + faiss::IndexIVFFastScanadd faiss::IndexIVFFastScanadd_core @@ -2848,9 +2948,10 @@ faiss::IndexIVFFastScandistance_t faiss::IndexIVFFastScanencode_listno faiss::IndexIVFFastScanencode_vectors - faiss::IndexIVFFastScanget_CodePacker - faiss::IndexIVFFastScanget_distance_computer - faiss::IndexIVFFastScanget_InvertedListScanner + faiss::IndexIVFFastScanfine_quantizer + faiss::IndexIVFFastScanget_CodePacker + faiss::IndexIVFFastScanget_distance_computer + faiss::IndexIVFFastScanget_InvertedListScanner faiss::IndexIVFFastScanget_list_size faiss::IndexIVFFastScanimplem faiss::IndexIVFFastScanIndex @@ -2860,7 +2961,7 @@ faiss::IndexIVFFastScanIndexIVFFastScan faiss::IndexIVFFastScanIndexIVFInterface faiss::IndexIVFFastScaninit_code_packer - faiss::IndexIVFFastScaninit_fastscan + faiss::IndexIVFFastScaninit_fastscan faiss::IndexIVFFastScaninvlists faiss::IndexIVFFastScanis_trained faiss::IndexIVFFastScanksub @@ -2899,7 +3000,7 @@ faiss::IndexIVFFastScanreplace_invlists faiss::IndexIVFFastScanreset faiss::IndexIVFFastScansa_code_size - faiss::IndexIVFFastScansa_decode + faiss::IndexIVFFastScansa_decode faiss::IndexIVFFastScansa_encode faiss::IndexIVFFastScansearch faiss::IndexIVFFastScansearch_and_reconstruct diff --git a/xml/structfaiss_1_1IndexIVFFastScan_1_1CoarseQuantized.xml b/xml/structfaiss_1_1IndexIVFFastScan_1_1CoarseQuantized.xml index 68727f397b..8e7c3fa185 100644 --- a/xml/structfaiss_1_1IndexIVFFastScan_1_1CoarseQuantized.xml +++ b/xml/structfaiss_1_1IndexIVFFastScan_1_1CoarseQuantized.xml @@ -1,26 +1,28 @@ - + faiss::IndexIVFFastScan::CoarseQuantized - + size_t size_t faiss::IndexIVFFastScan::CoarseQuantized::nprobe nprobe + faiss::IndexIVFFastScan::CoarseQuantized::nprobe - + const float * const float* faiss::IndexIVFFastScan::CoarseQuantized::dis dis + faiss::IndexIVFFastScan::CoarseQuantized::dis = nullptr @@ -28,13 +30,14 @@ - + const idx_t * const idx_t* faiss::IndexIVFFastScan::CoarseQuantized::ids ids + faiss::IndexIVFFastScan::CoarseQuantized::ids = nullptr @@ -42,14 +45,14 @@ - + - + - + faiss::IndexIVFFastScan::CoarseQuantizeddis faiss::IndexIVFFastScan::CoarseQuantizedids diff --git a/xml/structfaiss_1_1IndexIVFFlat.xml b/xml/structfaiss_1_1IndexIVFFlat.xml index 4b264f256b..46913cb31b 100644 --- a/xml/structfaiss_1_1IndexIVFFlat.xml +++ b/xml/structfaiss_1_1IndexIVFFlat.xml @@ -1,16 +1,17 @@ - + faiss::IndexIVFFlat faiss::IndexIVF faiss::IndexIVFFlatDedup IndexIVFFlat.h - + faiss::IndexIVFFlat::IndexIVFFlat (Index *quantizer, size_t d, size_t nlist_, MetricType=METRIC_L2) IndexIVFFlat + faiss::IndexIVFFlat::IndexIVFFlat Index * quantizer @@ -40,6 +41,7 @@ void faiss::IndexIVFFlat::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) override add_core + faiss::IndexIVFFlat::add_core add_core idx_t @@ -86,6 +88,7 @@ void faiss::IndexIVFFlat::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFFlat::encode_vectors encode_vectors idx_t @@ -143,12 +146,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFFlat::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFFlat::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFFlat::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -172,6 +176,7 @@ void faiss::IndexIVFFlat::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFFlat::reconstruct_from_offset reconstruct_from_offset reconstruct_from_offset @@ -201,6 +206,7 @@ void faiss::IndexIVFFlat::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexIVFFlat::sa_decode sa_decode idx_t @@ -254,6 +260,7 @@ faiss::IndexIVFFlat::IndexIVFFlat () IndexIVFFlat + faiss::IndexIVFFlat::IndexIVFFlat @@ -267,6 +274,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -283,6 +291,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -307,6 +316,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -330,6 +340,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -360,6 +371,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -405,6 +417,7 @@ virtual void faiss::IndexIVF::train_encoder (idx_t n, const float *x, const idx_t *assign) train_encoder + faiss::IndexIVF::train_encoder train_encoder train_encoder train_encoder @@ -439,6 +452,7 @@ virtual idx_t faiss::IndexIVF::train_encoder_num_vectors () const train_encoder_num_vectors + faiss::IndexIVF::train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors @@ -459,6 +473,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -593,6 +608,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -713,6 +729,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -755,6 +772,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -828,6 +846,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -851,6 +870,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -905,6 +925,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -959,6 +980,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1014,6 +1036,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1080,6 +1103,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1101,6 +1125,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1120,6 +1145,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1139,12 +1165,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1158,6 +1185,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1188,6 +1216,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1205,6 +1234,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1219,6 +1249,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1248,6 +1279,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1265,6 +1297,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1288,6 +1321,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1303,6 +1337,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1319,7 +1354,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1357,6 +1392,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1423,6 +1459,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1476,6 +1513,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1531,6 +1569,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1593,15 +1632,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1617,6 +1657,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -1647,6 +1688,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -1661,6 +1703,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -1682,6 +1725,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -1694,13 +1738,14 @@ - - + + InvertedLists * InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -1716,6 +1761,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -1730,6 +1776,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -1745,6 +1792,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -1762,6 +1810,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -1776,6 +1825,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -1790,6 +1840,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -1805,6 +1856,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1819,6 +1871,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1833,6 +1886,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1847,6 +1901,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1861,6 +1916,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1875,6 +1931,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1889,6 +1946,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -1904,6 +1962,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -1919,6 +1978,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -1934,6 +1994,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -1949,6 +2010,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -1964,6 +2026,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -1979,6 +2042,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -1993,6 +2057,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -2003,13 +2068,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2023,6 +2089,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2031,16 +2098,16 @@ - + 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. - - - + + + @@ -2056,10 +2123,6 @@ - - - - @@ -2072,22 +2135,23 @@ - - - - cp - - - clustering_index - quantizer - + + + + + + - - + + + + + + @@ -2097,36 +2161,39 @@ - direct_map + invlists - invlists + direct_map - - - - - - - - - - - - + + + + + + + + + clustering_index + quantizer + + + cp + + @@ -2152,9 +2219,9 @@ faiss::IndexIVFFlatdistance_t faiss::IndexIVFFlatencode_listno faiss::IndexIVFFlatencode_vectors - faiss::IndexIVFFlatget_CodePacker - faiss::IndexIVFFlatget_distance_computer - faiss::IndexIVFFlatget_InvertedListScanner + faiss::IndexIVFFlatget_CodePacker + faiss::IndexIVFFlatget_distance_computer + faiss::IndexIVFFlatget_InvertedListScanner faiss::IndexIVFFlatget_list_size faiss::IndexIVFFlatIndex faiss::IndexIVFFlatIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFFlatDedup.xml b/xml/structfaiss_1_1IndexIVFFlatDedup.xml index a403c0b1ec..06e9abf4c4 100644 --- a/xml/structfaiss_1_1IndexIVFFlatDedup.xml +++ b/xml/structfaiss_1_1IndexIVFFlatDedup.xml @@ -1,14 +1,15 @@ - + faiss::IndexIVFFlatDedup faiss::IndexIVFFlat - + std::unordered_multimap< idx_t, idx_t > std::unordered_multimap<idx_t, idx_t> faiss::IndexIVFFlatDedup::instances instances + faiss::IndexIVFFlatDedup::instances @@ -23,6 +24,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -38,6 +40,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -52,6 +55,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -67,6 +71,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -84,6 +89,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -98,6 +104,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -112,6 +119,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -127,6 +135,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -141,6 +150,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -155,6 +165,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -169,6 +180,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -183,6 +195,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -197,6 +210,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -211,6 +225,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -226,6 +241,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -241,6 +257,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -256,6 +273,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -271,6 +289,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -286,6 +305,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -301,6 +321,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -315,6 +336,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -325,13 +347,14 @@ - - + + faiss::IndexIVFFlatDedup::IndexIVFFlatDedup (Index *quantizer, size_t d, size_t nlist_, MetricType=METRIC_L2) IndexIVFFlatDedup + faiss::IndexIVFFlatDedup::IndexIVFFlatDedup Index * quantizer @@ -361,6 +384,7 @@ void faiss::IndexIVFFlatDedup::train (idx_t n, const float *x) override train + faiss::IndexIVFFlatDedup::train train idx_t @@ -384,6 +408,7 @@ void faiss::IndexIVFFlatDedup::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVFFlatDedup::add_with_ids add_with_ids idx_t @@ -411,6 +436,7 @@ void faiss::IndexIVFFlatDedup::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVFFlatDedup::search_preassigned search_preassigned idx_t @@ -542,6 +568,7 @@ size_t faiss::IndexIVFFlatDedup::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVFFlatDedup::remove_ids remove_ids const IDSelector & @@ -561,6 +588,7 @@ void faiss::IndexIVFFlatDedup::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVFFlatDedup::range_search range_search idx_t @@ -597,6 +625,7 @@ void faiss::IndexIVFFlatDedup::update_vectors (int nv, const idx_t *idx, const float *v) override update_vectors + faiss::IndexIVFFlatDedup::update_vectors update_vectors int @@ -624,6 +653,7 @@ void faiss::IndexIVFFlatDedup::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFFlatDedup::reconstruct_from_offset reconstruct_from_offset int64_t @@ -651,6 +681,7 @@ faiss::IndexIVFFlatDedup::IndexIVFFlatDedup () IndexIVFFlatDedup + faiss::IndexIVFFlatDedup::IndexIVFFlatDedup @@ -664,6 +695,7 @@ void faiss::IndexIVFFlat::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) override add_core + faiss::IndexIVFFlat::add_core add_core idx_t @@ -710,6 +742,7 @@ void faiss::IndexIVFFlat::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFFlat::encode_vectors encode_vectors idx_t @@ -767,12 +800,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFFlat::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFFlat::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFFlat::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -796,6 +830,7 @@ void faiss::IndexIVFFlat::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexIVFFlat::sa_decode sa_decode idx_t @@ -849,6 +884,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -865,6 +901,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -888,6 +925,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -933,6 +971,7 @@ virtual void faiss::IndexIVF::train_encoder (idx_t n, const float *x, const idx_t *assign) train_encoder + faiss::IndexIVF::train_encoder train_encoder train_encoder train_encoder @@ -967,6 +1006,7 @@ virtual idx_t faiss::IndexIVF::train_encoder_num_vectors () const train_encoder_num_vectors + faiss::IndexIVF::train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors @@ -987,6 +1027,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1107,6 +1148,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1149,6 +1191,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1172,6 +1215,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1226,6 +1270,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1281,6 +1326,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1347,6 +1393,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1366,6 +1413,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1385,12 +1433,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1404,6 +1453,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1434,6 +1484,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1451,6 +1502,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1465,6 +1517,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1494,6 +1547,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1511,6 +1565,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1534,6 +1589,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1549,6 +1605,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1565,7 +1622,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1603,6 +1660,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1669,6 +1727,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1722,6 +1781,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1777,6 +1837,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1839,15 +1900,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1863,6 +1925,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -1893,6 +1956,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -1907,6 +1971,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -1928,6 +1993,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -1940,13 +2006,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1960,6 +2027,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1968,15 +2036,15 @@ - + - - - + + + @@ -1992,10 +2060,6 @@ - - - - @@ -2008,22 +2072,23 @@ - - - - cp - - - clustering_index - quantizer - + + + + + + - - + + + + + + @@ -2033,30 +2098,18 @@ - direct_map + invlists - invlists + direct_map - - - - - - - - - - - - @@ -2069,6 +2122,21 @@ + + + + + + + + + clustering_index + quantizer + + + cp + + @@ -2094,9 +2162,9 @@ faiss::IndexIVFFlatDedupdistance_t faiss::IndexIVFFlatDedupencode_listno faiss::IndexIVFFlatDedupencode_vectors - faiss::IndexIVFFlatDedupget_CodePacker - faiss::IndexIVFFlatDedupget_distance_computer - faiss::IndexIVFFlatDedupget_InvertedListScanner + faiss::IndexIVFFlatDedupget_CodePacker + faiss::IndexIVFFlatDedupget_distance_computer + faiss::IndexIVFFlatDedupget_InvertedListScanner faiss::IndexIVFFlatDedupget_list_size faiss::IndexIVFFlatDedupIndex faiss::IndexIVFFlatDedupIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFIndependentQuantizer.xml b/xml/structfaiss_1_1IndexIVFIndependentQuantizer.xml index a2f799b94e..7e75798e1c 100644 --- a/xml/structfaiss_1_1IndexIVFIndependentQuantizer.xml +++ b/xml/structfaiss_1_1IndexIVFIndependentQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexIVFIndependentQuantizer faiss::Index IndexIVFIndependentQuantizer.h - + Index * Index* faiss::IndexIVFIndependentQuantizer::quantizer quantizer + faiss::IndexIVFIndependentQuantizer::quantizer = nullptr quantizer is fed directly with the input vectors @@ -25,6 +26,7 @@ VectorTransform* faiss::IndexIVFIndependentQuantizer::vt vt + faiss::IndexIVFIndependentQuantizer::vt = nullptr transform before the IVF vectors are applied @@ -40,6 +42,7 @@ IndexIVF* faiss::IndexIVFIndependentQuantizer::index_ivf index_ivf + faiss::IndexIVFIndependentQuantizer::index_ivf = nullptr the IVF index, controls nlist and nprobe @@ -55,6 +58,7 @@ bool faiss::IndexIVFIndependentQuantizer::own_fields own_fields + faiss::IndexIVFIndependentQuantizer::own_fields = false whether *this owns the 3 fields @@ -70,6 +74,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -84,6 +89,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -98,6 +104,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -112,6 +119,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -126,6 +134,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -140,6 +149,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -149,13 +159,14 @@ - - + + faiss::IndexIVFIndependentQuantizer::IndexIVFIndependentQuantizer (Index *quantizer, IndexIVF *index_ivf, VectorTransform *vt=nullptr) IndexIVFIndependentQuantizer + faiss::IndexIVFIndependentQuantizer::IndexIVFIndependentQuantizer Index * quantizer @@ -182,6 +193,7 @@ faiss::IndexIVFIndependentQuantizer::IndexIVFIndependentQuantizer () IndexIVFIndependentQuantizer + faiss::IndexIVFIndependentQuantizer::IndexIVFIndependentQuantizer @@ -195,6 +207,7 @@ void faiss::IndexIVFIndependentQuantizer::train (idx_t n, const float *x) override train + faiss::IndexIVFIndependentQuantizer::train train idx_t @@ -236,6 +249,7 @@ void faiss::IndexIVFIndependentQuantizer::add (idx_t n, const float *x) override add + faiss::IndexIVFIndependentQuantizer::add add idx_t @@ -277,6 +291,7 @@ void faiss::IndexIVFIndependentQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVFIndependentQuantizer::search search idx_t @@ -360,6 +375,7 @@ void faiss::IndexIVFIndependentQuantizer::reset () override reset + faiss::IndexIVFIndependentQuantizer::reset reset removes all elements from the database. @@ -375,6 +391,7 @@ faiss::IndexIVFIndependentQuantizer::~IndexIVFIndependentQuantizer () override ~IndexIVFIndependentQuantizer + faiss::IndexIVFIndependentQuantizer::~IndexIVFIndependentQuantizer @@ -388,6 +405,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -447,6 +465,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -525,6 +544,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -591,6 +611,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -615,6 +636,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -668,6 +690,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -721,6 +744,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -778,6 +802,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -875,6 +900,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -930,6 +956,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -992,15 +1019,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1016,6 +1044,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1037,8 +1067,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1102,14 +1134,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1174,6 +1206,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1202,6 +1235,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1224,6 +1258,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1265,13 +1300,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1285,6 +1321,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1293,90 +1330,90 @@ - + An IVF index with a quantizer that has a different input dimension from the payload size. The vectors to encode are obtained from the input vectors by a VectorTransform. + + + + + + + + + + + + + + - - + + + + + + + + + invlists + + + direct_map + + - - index_ivf + + quantizer - + vt - - quantizer + + index_ivf - - - - - - - - cp - - - clustering_index - quantizer + + + - - - - - - + + + + + clustering_index + quantizer - direct_map - - - invlists + cp - - - - - - - - - - - - - - - - - + + + @@ -1391,7 +1428,7 @@ faiss::IndexIVFIndependentQuantizercompute_residual_n faiss::IndexIVFIndependentQuantizerd faiss::IndexIVFIndependentQuantizerdistance_t - faiss::IndexIVFIndependentQuantizerget_distance_computer + faiss::IndexIVFIndependentQuantizerget_distance_computer faiss::IndexIVFIndependentQuantizerIndex faiss::IndexIVFIndependentQuantizerindex_ivf faiss::IndexIVFIndependentQuantizerIndexIVFIndependentQuantizer diff --git a/xml/structfaiss_1_1IndexIVFInterface.xml b/xml/structfaiss_1_1IndexIVFInterface.xml index 9795042a7e..14d24e9f99 100644 --- a/xml/structfaiss_1_1IndexIVFInterface.xml +++ b/xml/structfaiss_1_1IndexIVFInterface.xml @@ -1,16 +1,17 @@ - + faiss::IndexIVFInterface faiss::Level1Quantizer faiss::IndexIVF faiss::gpu::GpuIndexIVF - + size_t size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -26,6 +27,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -41,6 +43,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -56,6 +59,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -71,6 +75,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -86,6 +91,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -101,6 +107,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -115,6 +122,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -125,13 +133,14 @@ - - + + faiss::IndexIVFInterface::IndexIVFInterface (Index *quantizer=nullptr, size_t nlist=0) IndexIVFInterface + faiss::IndexIVFInterface::IndexIVFInterface Index * quantizer @@ -155,6 +164,7 @@ virtual void faiss::IndexIVFInterface::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const =0 search_preassigned + faiss::IndexIVFInterface::search_preassigned search_preassigned search_preassigned search_preassigned @@ -290,6 +300,7 @@ virtual void faiss::IndexIVFInterface::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const =0 range_search_preassigned + faiss::IndexIVFInterface::range_search_preassigned range_search_preassigned range_search_preassigned @@ -411,6 +422,7 @@ virtual faiss::IndexIVFInterface::~IndexIVFInterface () ~IndexIVFInterface + faiss::IndexIVFInterface::~IndexIVFInterface @@ -424,6 +436,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -454,6 +467,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -468,6 +482,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -489,6 +504,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -501,34 +517,52 @@ - + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + + + + + + + + + + + + + + + + + + + @@ -537,9 +571,15 @@ - - - + + + + + + + + + @@ -549,20 +589,10 @@ - - - - - - - - - - - - - - + + + + @@ -571,22 +601,28 @@ - - - - + + + + - - - - + + + + - - - - + + + + + + + + + + @@ -595,59 +631,55 @@ - - - + + + + + + + + + + + + + - - - - - - - - - - - - - - - - + + + + - - - - + + + + - - - - + + + + - - - - - + + + + + - - - - - + + + @@ -655,31 +687,15 @@ - - - cp - - clustering_index quantizer - - - - - - - - - - - - - + + cp diff --git a/xml/structfaiss_1_1IndexIVFLocalSearchQuantizer.xml b/xml/structfaiss_1_1IndexIVFLocalSearchQuantizer.xml index 61e3013a01..8648c21373 100644 --- a/xml/structfaiss_1_1IndexIVFLocalSearchQuantizer.xml +++ b/xml/structfaiss_1_1IndexIVFLocalSearchQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexIVFLocalSearchQuantizer faiss::IndexIVFAdditiveQuantizer IndexIVFAdditiveQuantizer.h - + LocalSearchQuantizer LocalSearchQuantizer faiss::IndexIVFLocalSearchQuantizer::lsq lsq + faiss::IndexIVFLocalSearchQuantizer::lsq The LSQ quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizer::aq aq + faiss::IndexIVFAdditiveQuantizer::aq @@ -37,6 +39,7 @@ int faiss::IndexIVFAdditiveQuantizer::use_precomputed_table use_precomputed_table + faiss::IndexIVFAdditiveQuantizer::use_precomputed_table = 0 @@ -51,6 +54,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -66,6 +70,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -80,6 +85,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -95,6 +101,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -112,6 +119,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -126,6 +134,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -140,6 +149,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -155,6 +165,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -169,6 +180,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -183,6 +195,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -197,6 +210,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -211,6 +225,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -225,6 +240,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -239,6 +255,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -254,6 +271,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -269,6 +287,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -284,6 +303,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -299,6 +319,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -314,6 +335,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -329,6 +351,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -343,6 +366,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -353,13 +377,14 @@ - - + + faiss::IndexIVFLocalSearchQuantizer::IndexIVFLocalSearchQuantizer (Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexIVFLocalSearchQuantizer + faiss::IndexIVFLocalSearchQuantizer::IndexIVFLocalSearchQuantizer Index * quantizer @@ -430,6 +455,7 @@ faiss::IndexIVFLocalSearchQuantizer::IndexIVFLocalSearchQuantizer () IndexIVFLocalSearchQuantizer + faiss::IndexIVFLocalSearchQuantizer::IndexIVFLocalSearchQuantizer @@ -443,6 +469,7 @@ virtual faiss::IndexIVFLocalSearchQuantizer::~IndexIVFLocalSearchQuantizer () ~IndexIVFLocalSearchQuantizer + faiss::IndexIVFLocalSearchQuantizer::~IndexIVFLocalSearchQuantizer @@ -456,6 +483,7 @@ void faiss::IndexIVFAdditiveQuantizer::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizer::train_encoder train_encoder idx_t @@ -484,6 +512,7 @@ idx_t faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors train_encoder_num_vectors @@ -499,6 +528,7 @@ void faiss::IndexIVFAdditiveQuantizer::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizer::encode_vectors encode_vectors idx_t @@ -556,12 +586,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -585,6 +616,7 @@ void faiss::IndexIVFAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *codes, float *x) const override sa_decode + faiss::IndexIVFAdditiveQuantizer::sa_decode sa_decode idx_t @@ -638,6 +670,7 @@ void faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset reconstruct_from_offset int64_t @@ -666,6 +699,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -682,6 +716,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -706,6 +741,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -729,6 +765,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -759,6 +796,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -808,6 +846,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -853,6 +892,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -987,6 +1027,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1107,6 +1148,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1149,6 +1191,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1222,6 +1265,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1245,6 +1289,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1299,6 +1344,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1353,6 +1399,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1408,6 +1455,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1474,6 +1522,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1495,6 +1544,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1514,6 +1564,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1533,12 +1584,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1552,6 +1604,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1582,6 +1635,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1599,6 +1653,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1613,6 +1668,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1642,6 +1698,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1659,6 +1716,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1682,6 +1740,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1697,6 +1756,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1713,7 +1773,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1751,6 +1811,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1817,6 +1878,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1870,6 +1932,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1925,6 +1988,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1987,15 +2051,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2011,6 +2076,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2041,6 +2107,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2055,6 +2122,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2076,6 +2144,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2088,13 +2157,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizer::Search_type_t @@ -2108,6 +2178,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2121,6 +2192,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2129,28 +2201,16 @@ - + IndexIVF based on a residual quantizer. Stored vectors are approximated by residual quantization codes. - - - - - - - - - - - - - - - + + + @@ -2160,9 +2220,11 @@ - - - + + + + + @@ -2170,72 +2232,39 @@ - - - - lsq - - - - - - - - - - - - - aq - - - cp - - - clustering_index - quantizer - - - - - - - - - - - - - - - direct_map - - - invlists - - - - - + + + + + + - - icm_encoder_factory + + qnorm + + + + + + + + @@ -2248,37 +2277,39 @@ + + + + + + - - - - - - - - - - - - + + + + - - qnorm + + + + invlists + + + direct_map - - - - - - - - + + + + + + + aq @@ -2287,6 +2318,47 @@ + + + + + + + lsq + + + + + + + + + + + clustering_index + quantizer + + + cp + + + + + + + + + icm_encoder_factory + + + + + + + + + + @@ -2313,9 +2385,9 @@ faiss::IndexIVFLocalSearchQuantizerdistance_t faiss::IndexIVFLocalSearchQuantizerencode_listno faiss::IndexIVFLocalSearchQuantizerencode_vectors - faiss::IndexIVFLocalSearchQuantizerget_CodePacker - faiss::IndexIVFLocalSearchQuantizerget_distance_computer - faiss::IndexIVFLocalSearchQuantizerget_InvertedListScanner + faiss::IndexIVFLocalSearchQuantizerget_CodePacker + faiss::IndexIVFLocalSearchQuantizerget_distance_computer + faiss::IndexIVFLocalSearchQuantizerget_InvertedListScanner faiss::IndexIVFLocalSearchQuantizerget_list_size faiss::IndexIVFLocalSearchQuantizerIndex faiss::IndexIVFLocalSearchQuantizerIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFLocalSearchQuantizerFastScan.xml b/xml/structfaiss_1_1IndexIVFLocalSearchQuantizerFastScan.xml index 7be21ed52b..18d4b37b7a 100644 --- a/xml/structfaiss_1_1IndexIVFLocalSearchQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexIVFLocalSearchQuantizerFastScan.xml @@ -1,27 +1,29 @@ - + faiss::IndexIVFLocalSearchQuantizerFastScan faiss::IndexIVFAdditiveQuantizerFastScan - + LocalSearchQuantizer LocalSearchQuantizer faiss::IndexIVFLocalSearchQuantizerFastScan::lsq lsq + faiss::IndexIVFLocalSearchQuantizerFastScan::lsq - + AdditiveQuantizer * AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizerFastScan::aq aq + faiss::IndexIVFAdditiveQuantizerFastScan::aq @@ -35,6 +37,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm = false @@ -49,6 +52,7 @@ int faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale = 1 @@ -63,6 +67,7 @@ size_t faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points @@ -76,71 +81,77 @@ int faiss::IndexIVFFastScan::bbs bbs + faiss::IndexIVFFastScan::bbs - + size_t size_t faiss::IndexIVFFastScan::M M + faiss::IndexIVFFastScan::M - + size_t size_t faiss::IndexIVFFastScan::nbits nbits + faiss::IndexIVFFastScan::nbits - + size_t size_t faiss::IndexIVFFastScan::ksub ksub + faiss::IndexIVFFastScan::ksub - + size_t size_t faiss::IndexIVFFastScan::M2 M2 + faiss::IndexIVFFastScan::M2 - + int int faiss::IndexIVFFastScan::implem implem + faiss::IndexIVFFastScan::implem = 0 @@ -148,13 +159,14 @@ - + int int faiss::IndexIVFFastScan::skip skip + faiss::IndexIVFFastScan::skip = 0 @@ -162,13 +174,14 @@ - + int int faiss::IndexIVFFastScan::qbs qbs + faiss::IndexIVFFastScan::qbs = 0 @@ -176,13 +189,14 @@ - + size_t size_t faiss::IndexIVFFastScan::qbs2 qbs2 + faiss::IndexIVFFastScan::qbs2 = 0 @@ -190,13 +204,29 @@ - + + + + Quantizer * + Quantizer* faiss::IndexIVFFastScan::fine_quantizer + + fine_quantizer + faiss::IndexIVFFastScan::fine_quantizer + = nullptr + + + + + + + InvertedLists * InvertedLists* faiss::IndexIVFFastScan::orig_invlists orig_invlists + faiss::IndexIVFFastScan::orig_invlists = nullptr orig's inverted lists (for debugging) @@ -205,13 +235,14 @@ - + InvertedLists * InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -227,6 +258,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -241,6 +273,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -256,6 +289,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -273,6 +307,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -287,6 +322,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -301,6 +337,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -316,6 +353,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -330,6 +368,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -344,6 +383,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -358,6 +398,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -372,6 +413,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -386,6 +428,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -400,6 +443,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -415,6 +459,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -430,6 +475,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -445,6 +491,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -460,6 +507,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -475,6 +523,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -490,6 +539,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -504,6 +554,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -514,13 +565,14 @@ - - + + faiss::IndexIVFLocalSearchQuantizerFastScan::IndexIVFLocalSearchQuantizerFastScan (Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_norm_lsq2x4, int bbs=32) IndexIVFLocalSearchQuantizerFastScan + faiss::IndexIVFLocalSearchQuantizerFastScan::IndexIVFLocalSearchQuantizerFastScan Index * quantizer @@ -562,26 +614,28 @@ - + faiss::IndexIVFLocalSearchQuantizerFastScan::IndexIVFLocalSearchQuantizerFastScan () IndexIVFLocalSearchQuantizerFastScan + faiss::IndexIVFLocalSearchQuantizerFastScan::IndexIVFLocalSearchQuantizerFastScan - + void void faiss::IndexIVFAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, size_t nlist, MetricType metric, int bbs) init + faiss::IndexIVFAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -611,6 +665,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder train_encoder idx_t @@ -639,6 +694,7 @@ idx_t faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors train_encoder_num_vectors @@ -654,6 +710,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -675,6 +732,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listno=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors encode_vectors idx_t @@ -711,6 +769,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVFAdditiveQuantizerFastScan::search search idx_t @@ -751,6 +810,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d () const override lookup_table_is_3d + faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d lookup_table_is_3d @@ -765,6 +825,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< float > &dis_tables, AlignedTable< float > &biases) const override compute_LUT + faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT compute_LUT size_t @@ -794,64 +855,16 @@ - - void - void faiss::IndexIVFAdditiveQuantizerFastScan::sa_decode - (idx_t n, const uint8_t *bytes, float *x) const override - sa_decode - sa_decode - - idx_t - n - - - const uint8_t * - bytes - - - float * - x - - - - -decode a set of vectors - - -n - - -number of vectors - - - - -bytes - - -input encoded vectors, size n * sa_code_size() - - - - -x - - -output vectors, size n * d - - - - - - - - - - + void void faiss::IndexIVFFastScan::init_fastscan - (size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) + (Quantizer *fine_quantizer, size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) init_fastscan + faiss::IndexIVFFastScan::init_fastscan + + Quantizer * + fine_quantizer + size_t M @@ -873,31 +886,34 @@ bbs +called by implementations - + void void faiss::IndexIVFFastScan::init_code_packer () init_code_packer + faiss::IndexIVFFastScan::init_code_packer - + void void faiss::IndexIVFFastScan::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVFFastScan::add_with_ids add_with_ids idx_t @@ -918,13 +934,14 @@ - + void void faiss::IndexIVFFastScan::compute_LUT_uint8 (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< uint8_t > &dis_tables, AlignedTable< uint16_t > &biases, float *normalizers) const compute_LUT_uint8 + faiss::IndexIVFFastScan::compute_LUT_uint8 size_t n @@ -955,13 +972,14 @@ - + void void faiss::IndexIVFFastScan::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVFFastScan::search_preassigned search_preassigned idx_t @@ -1086,13 +1104,14 @@ - + void void faiss::IndexIVFFastScan::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVFFastScan::range_search range_search idx_t @@ -1157,13 +1176,14 @@ - + void void faiss::IndexIVFFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_dispatch_implem + faiss::IndexIVFFastScan::search_dispatch_implem idx_t n @@ -1203,13 +1223,14 @@ - + void void faiss::IndexIVFFastScan::range_search_dispatch_implem (idx_t n, const float *x, float radius, RangeSearchResult &rres, const CoarseQuantized &cq_in, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const range_search_dispatch_implem + faiss::IndexIVFFastScan::range_search_dispatch_implem idx_t n @@ -1245,7 +1266,7 @@ - + @@ -1257,6 +1278,7 @@ void faiss::IndexIVFFastScan::search_implem_1 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_1 + faiss::IndexIVFFastScan::search_implem_1 idx_t n @@ -1296,7 +1318,7 @@ - + @@ -1308,6 +1330,7 @@ void faiss::IndexIVFFastScan::search_implem_2 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_2 + faiss::IndexIVFFastScan::search_implem_2 idx_t n @@ -1347,13 +1370,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_10 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_10 + faiss::IndexIVFFastScan::search_implem_10 idx_t n @@ -1393,13 +1417,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_12 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_12 + faiss::IndexIVFFastScan::search_implem_12 idx_t n @@ -1439,13 +1464,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, int impl, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_14 + faiss::IndexIVFFastScan::search_implem_14 idx_t n @@ -1489,13 +1515,14 @@ - + void void faiss::IndexIVFFastScan::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFFastScan::reconstruct_from_offset reconstruct_from_offset int64_t @@ -1517,40 +1544,98 @@ - + - + CodePacker * - CodePacker* faiss::IndexIVFFastScan::get_CodePacker + CodePacker * faiss::IndexIVFFastScan::get_CodePacker () const override get_CodePacker - get_CodePacker + faiss::IndexIVFFastScan::get_CodePacker + get_CodePacker - + void void faiss::IndexIVFFastScan::reconstruct_orig_invlists () reconstruct_orig_invlists + faiss::IndexIVFFastScan::reconstruct_orig_invlists - + + + + void + void faiss::IndexIVFFastScan::sa_decode + (idx_t n, const uint8_t *bytes, float *x) const override + sa_decode + faiss::IndexIVFFastScan::sa_decode + sa_decode + + idx_t + n + + + const uint8_t * + bytes + + + float * + x + + + + +Decode a set of vectors. +NOTE: The codes in the IndexFastScan object are non-contiguous. But this method requires a contiguous representation. + + +n + + +number of vectors + + + + +bytes + + +input encoded vectors, size n * code_size + + + + +x + + +output vectors, size n * d + + + + + + + + void void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -1567,6 +1652,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -1591,6 +1677,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -1614,6 +1701,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -1663,6 +1751,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -1708,6 +1797,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1823,16 +1913,17 @@ - + InvertedListScanner * - virtual InvertedListScanner* faiss::IndexIVF::get_InvertedListScanner + virtual InvertedListScanner * faiss::IndexIVF::get_InvertedListScanner (bool store_pairs=false, const IDSelector *sel=nullptr) const get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVF::get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -1858,6 +1949,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1881,6 +1973,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1935,6 +2028,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1989,6 +2083,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -2044,6 +2139,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -2110,6 +2206,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -2131,6 +2228,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -2150,6 +2248,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -2174,6 +2273,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -2204,6 +2304,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -2221,6 +2322,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -2235,6 +2337,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -2264,6 +2367,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -2281,6 +2385,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -2304,6 +2409,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -2319,6 +2425,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -2335,7 +2442,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -2373,6 +2480,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -2439,6 +2547,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -2492,6 +2601,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -2547,6 +2657,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2609,15 +2720,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2633,6 +2745,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2663,6 +2776,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2677,6 +2791,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2698,6 +2813,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2710,13 +2826,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t @@ -2730,6 +2847,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2743,6 +2861,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2751,15 +2870,15 @@ - + - - - + + + @@ -2781,42 +2900,68 @@ + + + + + + + + + + + + + + + + + + + qnorm + + + + + + + + + + - - - - + + + + - - - - - - - - - - - cp + + + + - - clustering_index - quantizer + + + + + - - - + + + + + @@ -2826,10 +2971,10 @@ - direct_map + invlists - invlists + direct_map @@ -2837,32 +2982,28 @@ - + aq - - - - - - - icm_encoder_factory - - - - - - - + + fine_quantizer + + orig_invlists + + + + + + @@ -2872,59 +3013,40 @@ lsq - - - - - + + + - - - - + + + + + clustering_index + quantizer - - - - - + + cp - - - - - - - - - - - + + + - - qnorm + + icm_encoder_factory - + - - - - - - - - - - - + + + - + faiss::IndexIVFLocalSearchQuantizerFastScanadd faiss::IndexIVFLocalSearchQuantizerFastScanadd_core @@ -2953,9 +3075,10 @@ faiss::IndexIVFLocalSearchQuantizerFastScanencode_listno faiss::IndexIVFLocalSearchQuantizerFastScanencode_vectors faiss::IndexIVFLocalSearchQuantizerFastScanestimate_norm_scale - faiss::IndexIVFLocalSearchQuantizerFastScanget_CodePacker - faiss::IndexIVFLocalSearchQuantizerFastScanget_distance_computer - faiss::IndexIVFLocalSearchQuantizerFastScanget_InvertedListScanner + faiss::IndexIVFLocalSearchQuantizerFastScanfine_quantizer + faiss::IndexIVFLocalSearchQuantizerFastScanget_CodePacker + faiss::IndexIVFLocalSearchQuantizerFastScanget_distance_computer + faiss::IndexIVFLocalSearchQuantizerFastScanget_InvertedListScanner faiss::IndexIVFLocalSearchQuantizerFastScanget_list_size faiss::IndexIVFLocalSearchQuantizerFastScanimplem faiss::IndexIVFLocalSearchQuantizerFastScanIndex @@ -2971,7 +3094,7 @@ faiss::IndexIVFLocalSearchQuantizerFastScanIndexIVFLocalSearchQuantizerFastScan faiss::IndexIVFLocalSearchQuantizerFastScaninit faiss::IndexIVFLocalSearchQuantizerFastScaninit_code_packer - faiss::IndexIVFLocalSearchQuantizerFastScaninit_fastscan + faiss::IndexIVFLocalSearchQuantizerFastScaninit_fastscan faiss::IndexIVFLocalSearchQuantizerFastScaninvlists faiss::IndexIVFLocalSearchQuantizerFastScanis_trained faiss::IndexIVFLocalSearchQuantizerFastScanksub @@ -3014,7 +3137,7 @@ faiss::IndexIVFLocalSearchQuantizerFastScanrescale_norm faiss::IndexIVFLocalSearchQuantizerFastScanreset faiss::IndexIVFLocalSearchQuantizerFastScansa_code_size - faiss::IndexIVFLocalSearchQuantizerFastScansa_decode + faiss::IndexIVFLocalSearchQuantizerFastScansa_decode faiss::IndexIVFLocalSearchQuantizerFastScansa_encode faiss::IndexIVFLocalSearchQuantizerFastScansearch faiss::IndexIVFLocalSearchQuantizerFastScansearch_and_reconstruct diff --git a/xml/structfaiss_1_1IndexIVFPQ.xml b/xml/structfaiss_1_1IndexIVFPQ.xml index 7d63f5a926..c741cea26c 100644 --- a/xml/structfaiss_1_1IndexIVFPQ.xml +++ b/xml/structfaiss_1_1IndexIVFPQ.xml @@ -1,16 +1,17 @@ - + faiss::IndexIVFPQ faiss::IndexIVF faiss::IndexIVFPQR IndexIVFPQ.h - + ProductQuantizer ProductQuantizer faiss::IndexIVFPQ::pq pq + faiss::IndexIVFPQ::pq produces the codes @@ -25,6 +26,7 @@ bool faiss::IndexIVFPQ::do_polysemous_training do_polysemous_training + faiss::IndexIVFPQ::do_polysemous_training reorder PQ centroids after training? @@ -39,6 +41,7 @@ PolysemousTraining* faiss::IndexIVFPQ::polysemous_training polysemous_training + faiss::IndexIVFPQ::polysemous_training if NULL, use default @@ -53,6 +56,7 @@ size_t faiss::IndexIVFPQ::scan_table_threshold scan_table_threshold + faiss::IndexIVFPQ::scan_table_threshold use table computation or on-the-fly? @@ -67,6 +71,7 @@ int faiss::IndexIVFPQ::polysemous_ht polysemous_ht + faiss::IndexIVFPQ::polysemous_ht Hamming thresh for polysemous filtering. @@ -81,6 +86,7 @@ int faiss::IndexIVFPQ::use_precomputed_table use_precomputed_table + faiss::IndexIVFPQ::use_precomputed_table @@ -95,6 +101,7 @@ AlignedTable<float> faiss::IndexIVFPQ::precomputed_table precomputed_table + faiss::IndexIVFPQ::precomputed_table @@ -109,6 +116,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -124,6 +132,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -138,6 +147,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -153,6 +163,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -170,6 +181,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -184,6 +196,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -198,6 +211,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -213,6 +227,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -227,6 +242,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -241,6 +257,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -255,6 +272,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -269,6 +287,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -283,6 +302,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -297,6 +317,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -312,6 +333,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -327,6 +349,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -342,6 +365,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -357,6 +381,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -372,6 +397,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -387,6 +413,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -401,6 +428,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -411,13 +439,14 @@ - - + + faiss::IndexIVFPQ::IndexIVFPQ (Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits_per_idx, MetricType metric=METRIC_L2) IndexIVFPQ + faiss::IndexIVFPQ::IndexIVFPQ Index * quantizer @@ -456,6 +485,7 @@ void faiss::IndexIVFPQ::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFPQ::encode_vectors encode_vectors idx_t @@ -518,6 +548,7 @@ void faiss::IndexIVFPQ::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexIVFPQ::sa_decode sa_decode idx_t @@ -571,6 +602,7 @@ void faiss::IndexIVFPQ::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) override add_core + faiss::IndexIVFPQ::add_core add_core add_core @@ -618,6 +650,7 @@ void faiss::IndexIVFPQ::add_core_o (idx_t n, const float *x, const idx_t *xids, float *residuals_2, const idx_t *precomputed_idx=nullptr, void *inverted_list_context=nullptr) add_core_o + faiss::IndexIVFPQ::add_core_o idx_t n @@ -662,6 +695,7 @@ void faiss::IndexIVFPQ::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFPQ::train_encoder train_encoder train_encoder @@ -690,6 +724,7 @@ idx_t faiss::IndexIVFPQ::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFPQ::train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors @@ -706,6 +741,7 @@ void faiss::IndexIVFPQ::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFPQ::reconstruct_from_offset reconstruct_from_offset reconstruct_from_offset @@ -735,6 +771,7 @@ size_t faiss::IndexIVFPQ::find_duplicates (idx_t *ids, size_t *lims) const find_duplicates + faiss::IndexIVFPQ::find_duplicates idx_t * ids @@ -778,6 +815,7 @@ void faiss::IndexIVFPQ::encode (idx_t key, const float *x, uint8_t *code) const encode + faiss::IndexIVFPQ::encode idx_t key @@ -803,6 +841,7 @@ void faiss::IndexIVFPQ::encode_multiple (size_t n, idx_t *keys, const float *x, uint8_t *codes, bool compute_keys=false) const encode_multiple + faiss::IndexIVFPQ::encode_multiple size_t n @@ -880,6 +919,7 @@ void faiss::IndexIVFPQ::decode_multiple (size_t n, const idx_t *keys, const uint8_t *xcodes, float *x) const decode_multiple + faiss::IndexIVFPQ::decode_multiple size_t n @@ -905,12 +945,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFPQ::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFPQ::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFPQ::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -934,6 +975,7 @@ void faiss::IndexIVFPQ::precompute_table () precompute_table + faiss::IndexIVFPQ::precompute_table build precomputed table @@ -948,6 +990,7 @@ faiss::IndexIVFPQ::IndexIVFPQ () IndexIVFPQ + faiss::IndexIVFPQ::IndexIVFPQ @@ -961,6 +1004,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -977,6 +1021,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -1001,6 +1046,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -1024,6 +1070,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -1054,6 +1101,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -1099,6 +1147,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -1233,6 +1282,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1353,6 +1403,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1395,6 +1446,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1468,6 +1520,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1491,6 +1544,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1545,6 +1599,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1599,6 +1654,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1654,6 +1710,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1720,6 +1777,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1741,6 +1799,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1760,6 +1819,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1779,12 +1839,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1798,6 +1859,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1828,6 +1890,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1845,6 +1908,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1859,6 +1923,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1888,6 +1953,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1905,6 +1971,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1928,6 +1995,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1943,6 +2011,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1959,7 +2028,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1997,6 +2066,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -2063,6 +2133,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -2116,6 +2187,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -2171,6 +2243,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2233,15 +2306,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2257,6 +2331,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2287,6 +2362,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2301,6 +2377,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2322,6 +2399,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2334,13 +2412,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2354,6 +2433,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2362,16 +2442,16 @@ - + Inverted file with Product Quantizer encoding. Each residual vector is encoded as a product quantizer code. - - - + + + @@ -2381,44 +2461,52 @@ + + + + + + - - - - - - - - - - - - - - cp - - - clustering_index - quantizer + + + + + + + + tab + + + + + + + + - - + + + + + + @@ -2428,15 +2516,17 @@ - direct_map + invlists - invlists + direct_map - - - + + + + + @@ -2444,58 +2534,55 @@ - polysemous_training + pq - precomputed_table + polysemous_training - - pq + + precomputed_table - - - - - - - - - - + + - - - - + + + + + clustering_index + quantizer + + + cp - - - - - - - - - - - + + + - + - - - - assign_index + cp + + assign_index + + + + + + + + + @@ -2528,9 +2615,9 @@ faiss::IndexIVFPQencode_multiple faiss::IndexIVFPQencode_vectors faiss::IndexIVFPQfind_duplicates - faiss::IndexIVFPQget_CodePacker - faiss::IndexIVFPQget_distance_computer - faiss::IndexIVFPQget_InvertedListScanner + faiss::IndexIVFPQget_CodePacker + faiss::IndexIVFPQget_distance_computer + faiss::IndexIVFPQget_InvertedListScanner faiss::IndexIVFPQget_list_size faiss::IndexIVFPQIndex faiss::IndexIVFPQIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFPQFastScan.xml b/xml/structfaiss_1_1IndexIVFPQFastScan.xml index fcea18d83b..2b927a762e 100644 --- a/xml/structfaiss_1_1IndexIVFPQFastScan.xml +++ b/xml/structfaiss_1_1IndexIVFPQFastScan.xml @@ -1,15 +1,16 @@ - + faiss::IndexIVFPQFastScan faiss::IndexIVFFastScan IndexIVFPQFastScan.h - + ProductQuantizer ProductQuantizer faiss::IndexIVFPQFastScan::pq pq + faiss::IndexIVFPQFastScan::pq produces the codes @@ -24,6 +25,7 @@ int faiss::IndexIVFPQFastScan::use_precomputed_table use_precomputed_table + faiss::IndexIVFPQFastScan::use_precomputed_table = 0 precomputed tables management @@ -39,6 +41,7 @@ AlignedTable<float> faiss::IndexIVFPQFastScan::precomputed_table precomputed_table + faiss::IndexIVFPQFastScan::precomputed_table if use_precompute_table size (nlist, pq.M, pq.ksub) @@ -53,71 +56,77 @@ int faiss::IndexIVFFastScan::bbs bbs + faiss::IndexIVFFastScan::bbs - + size_t size_t faiss::IndexIVFFastScan::M M + faiss::IndexIVFFastScan::M - + size_t size_t faiss::IndexIVFFastScan::nbits nbits + faiss::IndexIVFFastScan::nbits - + size_t size_t faiss::IndexIVFFastScan::ksub ksub + faiss::IndexIVFFastScan::ksub - + size_t size_t faiss::IndexIVFFastScan::M2 M2 + faiss::IndexIVFFastScan::M2 - + int int faiss::IndexIVFFastScan::implem implem + faiss::IndexIVFFastScan::implem = 0 @@ -125,13 +134,14 @@ - + int int faiss::IndexIVFFastScan::skip skip + faiss::IndexIVFFastScan::skip = 0 @@ -139,13 +149,14 @@ - + int int faiss::IndexIVFFastScan::qbs qbs + faiss::IndexIVFFastScan::qbs = 0 @@ -153,13 +164,14 @@ - + size_t size_t faiss::IndexIVFFastScan::qbs2 qbs2 + faiss::IndexIVFFastScan::qbs2 = 0 @@ -167,13 +179,29 @@ - + + + + Quantizer * + Quantizer* faiss::IndexIVFFastScan::fine_quantizer + + fine_quantizer + faiss::IndexIVFFastScan::fine_quantizer + = nullptr + + + + + + + InvertedLists * InvertedLists* faiss::IndexIVFFastScan::orig_invlists orig_invlists + faiss::IndexIVFFastScan::orig_invlists = nullptr orig's inverted lists (for debugging) @@ -182,13 +210,14 @@ - + InvertedLists * InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -204,6 +233,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -218,6 +248,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -233,6 +264,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -250,6 +282,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -264,6 +297,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -278,6 +312,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -293,6 +328,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -307,6 +343,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -321,6 +358,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -335,6 +373,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -349,6 +388,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -363,6 +403,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -377,6 +418,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -392,6 +434,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -407,6 +450,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -422,6 +466,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -437,6 +482,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -452,6 +498,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -467,6 +514,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -481,6 +529,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -491,13 +540,14 @@ - - + + faiss::IndexIVFPQFastScan::IndexIVFPQFastScan (Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits, MetricType metric=METRIC_L2, int bbs=32) IndexIVFPQFastScan + faiss::IndexIVFPQFastScan::IndexIVFPQFastScan Index * quantizer @@ -541,6 +591,7 @@ faiss::IndexIVFPQFastScan::IndexIVFPQFastScan () IndexIVFPQFastScan + faiss::IndexIVFPQFastScan::IndexIVFPQFastScan @@ -554,6 +605,7 @@ faiss::IndexIVFPQFastScan::IndexIVFPQFastScan (const IndexIVFPQ &orig, int bbs=32) IndexIVFPQFastScan + faiss::IndexIVFPQFastScan::IndexIVFPQFastScan const IndexIVFPQ & orig @@ -576,6 +628,7 @@ void faiss::IndexIVFPQFastScan::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFPQFastScan::train_encoder train_encoder idx_t @@ -604,6 +657,7 @@ idx_t faiss::IndexIVFPQFastScan::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFPQFastScan::train_encoder_num_vectors train_encoder_num_vectors @@ -619,6 +673,7 @@ void faiss::IndexIVFPQFastScan::precompute_table () precompute_table + faiss::IndexIVFPQFastScan::precompute_table build precomputed table, possibly updating use_precomputed_table @@ -633,6 +688,7 @@ void faiss::IndexIVFPQFastScan::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listno=false) const override encode_vectors + faiss::IndexIVFPQFastScan::encode_vectors encode_vectors idx_t @@ -669,6 +725,7 @@ bool faiss::IndexIVFPQFastScan::lookup_table_is_3d () const override lookup_table_is_3d + faiss::IndexIVFPQFastScan::lookup_table_is_3d lookup_table_is_3d @@ -683,6 +740,7 @@ void faiss::IndexIVFPQFastScan::compute_LUT (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< float > &dis_tables, AlignedTable< float > &biases) const override compute_LUT + faiss::IndexIVFPQFastScan::compute_LUT compute_LUT size_t @@ -712,64 +770,16 @@ - - void - void faiss::IndexIVFPQFastScan::sa_decode - (idx_t n, const uint8_t *bytes, float *x) const override - sa_decode - sa_decode - - idx_t - n - - - const uint8_t * - bytes - - - float * - x - - - - -decode a set of vectors - - -n - - -number of vectors - - - - -bytes - - -input encoded vectors, size n * sa_code_size() - - - - -x - - -output vectors, size n * d - - - - - - - - - - + void void faiss::IndexIVFFastScan::init_fastscan - (size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) + (Quantizer *fine_quantizer, size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) init_fastscan + faiss::IndexIVFFastScan::init_fastscan + + Quantizer * + fine_quantizer + size_t M @@ -791,31 +801,34 @@ bbs +called by implementations - + void void faiss::IndexIVFFastScan::init_code_packer () init_code_packer + faiss::IndexIVFFastScan::init_code_packer - + void void faiss::IndexIVFFastScan::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVFFastScan::add_with_ids add_with_ids idx_t @@ -836,13 +849,14 @@ - + void void faiss::IndexIVFFastScan::compute_LUT_uint8 (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< uint8_t > &dis_tables, AlignedTable< uint16_t > &biases, float *normalizers) const compute_LUT_uint8 + faiss::IndexIVFFastScan::compute_LUT_uint8 size_t n @@ -873,13 +887,14 @@ - + void void faiss::IndexIVFFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVFFastScan::search search idx_t @@ -913,13 +928,14 @@ - + void void faiss::IndexIVFFastScan::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVFFastScan::search_preassigned search_preassigned idx_t @@ -1044,13 +1060,14 @@ - + void void faiss::IndexIVFFastScan::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVFFastScan::range_search range_search idx_t @@ -1115,13 +1132,14 @@ - + void void faiss::IndexIVFFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_dispatch_implem + faiss::IndexIVFFastScan::search_dispatch_implem idx_t n @@ -1161,13 +1179,14 @@ - + void void faiss::IndexIVFFastScan::range_search_dispatch_implem (idx_t n, const float *x, float radius, RangeSearchResult &rres, const CoarseQuantized &cq_in, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const range_search_dispatch_implem + faiss::IndexIVFFastScan::range_search_dispatch_implem idx_t n @@ -1203,7 +1222,7 @@ - + @@ -1215,6 +1234,7 @@ void faiss::IndexIVFFastScan::search_implem_1 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_1 + faiss::IndexIVFFastScan::search_implem_1 idx_t n @@ -1254,7 +1274,7 @@ - + @@ -1266,6 +1286,7 @@ void faiss::IndexIVFFastScan::search_implem_2 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_2 + faiss::IndexIVFFastScan::search_implem_2 idx_t n @@ -1305,13 +1326,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_10 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_10 + faiss::IndexIVFFastScan::search_implem_10 idx_t n @@ -1351,13 +1373,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_12 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_12 + faiss::IndexIVFFastScan::search_implem_12 idx_t n @@ -1397,13 +1420,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, int impl, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_14 + faiss::IndexIVFFastScan::search_implem_14 idx_t n @@ -1447,13 +1471,14 @@ - + void void faiss::IndexIVFFastScan::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFFastScan::reconstruct_from_offset reconstruct_from_offset int64_t @@ -1475,40 +1500,98 @@ - + - + CodePacker * - CodePacker* faiss::IndexIVFFastScan::get_CodePacker + CodePacker * faiss::IndexIVFFastScan::get_CodePacker () const override get_CodePacker - get_CodePacker + faiss::IndexIVFFastScan::get_CodePacker + get_CodePacker - + void void faiss::IndexIVFFastScan::reconstruct_orig_invlists () reconstruct_orig_invlists + faiss::IndexIVFFastScan::reconstruct_orig_invlists - + + + + void + void faiss::IndexIVFFastScan::sa_decode + (idx_t n, const uint8_t *bytes, float *x) const override + sa_decode + faiss::IndexIVFFastScan::sa_decode + sa_decode + + idx_t + n + + + const uint8_t * + bytes + + + float * + x + + + + +Decode a set of vectors. +NOTE: The codes in the IndexFastScan object are non-contiguous. But this method requires a contiguous representation. + + +n + + +number of vectors + + + + +bytes + + +input encoded vectors, size n * code_size + + + + +x + + +output vectors, size n * d + + + + + + + + void void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -1525,6 +1608,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -1549,6 +1633,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -1572,6 +1657,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -1621,6 +1707,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -1666,6 +1753,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1781,16 +1869,17 @@ - + InvertedListScanner * - virtual InvertedListScanner* faiss::IndexIVF::get_InvertedListScanner + virtual InvertedListScanner * faiss::IndexIVF::get_InvertedListScanner (bool store_pairs=false, const IDSelector *sel=nullptr) const get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVF::get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -1816,6 +1905,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1839,6 +1929,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1893,6 +1984,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1947,6 +2039,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -2002,6 +2095,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -2068,6 +2162,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -2089,6 +2184,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -2108,6 +2204,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -2132,6 +2229,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -2162,6 +2260,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -2179,6 +2278,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -2193,6 +2293,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -2222,6 +2323,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -2239,6 +2341,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -2262,6 +2365,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -2277,6 +2381,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -2293,7 +2398,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -2331,6 +2436,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -2397,6 +2503,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -2450,6 +2557,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -2505,6 +2613,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2567,15 +2676,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2591,6 +2701,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2621,6 +2732,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2635,6 +2747,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2656,6 +2769,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2668,13 +2782,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2688,6 +2803,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2696,7 +2812,7 @@ - + @@ -2705,15 +2821,9 @@ Implementations (implem): 0: auto-select implementation (default) 1: orig's search, re-implemented 2: orig's search, re-ordered by invlist 10: optimizer int16 search, collect results in heap, no qbs 11: idem, collect results in reservoir 12: optimizer int16 search, collect results in heap, uses qbs 13: idem, collect results in reservoir - - - - - - - - - + + + @@ -2729,44 +2839,46 @@ - - - - - - - - precomputed_table - - - pq - - - cp - - - clustering_index - quantizer + + + + + + + + tab + + + + + + + + - - + + + + + + @@ -2776,61 +2888,75 @@ - direct_map + invlists - invlists + direct_map - - - - - + + fine_quantizer + + orig_invlists - - - - - - - - - - - - - - - - + + + + + + + pq + + + precomputed_table + + + + + + + + + + + clustering_index + quantizer + + + cp + + - - - - assign_index + cp + + assign_index + + + + + - + faiss::IndexIVFPQFastScanadd faiss::IndexIVFPQFastScanadd_core @@ -2857,9 +2983,10 @@ faiss::IndexIVFPQFastScandistance_t faiss::IndexIVFPQFastScanencode_listno faiss::IndexIVFPQFastScanencode_vectors - faiss::IndexIVFPQFastScanget_CodePacker - faiss::IndexIVFPQFastScanget_distance_computer - faiss::IndexIVFPQFastScanget_InvertedListScanner + faiss::IndexIVFPQFastScanfine_quantizer + faiss::IndexIVFPQFastScanget_CodePacker + faiss::IndexIVFPQFastScanget_distance_computer + faiss::IndexIVFPQFastScanget_InvertedListScanner faiss::IndexIVFPQFastScanget_list_size faiss::IndexIVFPQFastScanimplem faiss::IndexIVFPQFastScanIndex @@ -2872,7 +2999,7 @@ faiss::IndexIVFPQFastScanIndexIVFPQFastScan faiss::IndexIVFPQFastScanIndexIVFPQFastScan faiss::IndexIVFPQFastScaninit_code_packer - faiss::IndexIVFPQFastScaninit_fastscan + faiss::IndexIVFPQFastScaninit_fastscan faiss::IndexIVFPQFastScaninvlists faiss::IndexIVFPQFastScanis_trained faiss::IndexIVFPQFastScanksub @@ -2914,7 +3041,7 @@ faiss::IndexIVFPQFastScanreplace_invlists faiss::IndexIVFPQFastScanreset faiss::IndexIVFPQFastScansa_code_size - faiss::IndexIVFPQFastScansa_decode + faiss::IndexIVFPQFastScansa_decode faiss::IndexIVFPQFastScansa_encode faiss::IndexIVFPQFastScansearch faiss::IndexIVFPQFastScansearch_and_reconstruct diff --git a/xml/structfaiss_1_1IndexIVFPQR.xml b/xml/structfaiss_1_1IndexIVFPQR.xml index d8f924f235..2df13c65b4 100644 --- a/xml/structfaiss_1_1IndexIVFPQR.xml +++ b/xml/structfaiss_1_1IndexIVFPQR.xml @@ -1,15 +1,16 @@ - + faiss::IndexIVFPQR faiss::IndexIVFPQ IndexIVFPQR.h - + ProductQuantizer ProductQuantizer faiss::IndexIVFPQR::refine_pq refine_pq + faiss::IndexIVFPQR::refine_pq 3rd level quantizer @@ -24,6 +25,7 @@ std::vector<uint8_t> faiss::IndexIVFPQR::refine_codes refine_codes + faiss::IndexIVFPQR::refine_codes corresponding codes @@ -38,6 +40,7 @@ float faiss::IndexIVFPQR::k_factor k_factor + faiss::IndexIVFPQR::k_factor factor between k requested in search and the k requested from the IVFPQ @@ -52,6 +55,7 @@ ProductQuantizer faiss::IndexIVFPQ::pq pq + faiss::IndexIVFPQ::pq produces the codes @@ -66,6 +70,7 @@ bool faiss::IndexIVFPQ::do_polysemous_training do_polysemous_training + faiss::IndexIVFPQ::do_polysemous_training reorder PQ centroids after training? @@ -80,6 +85,7 @@ PolysemousTraining* faiss::IndexIVFPQ::polysemous_training polysemous_training + faiss::IndexIVFPQ::polysemous_training if NULL, use default @@ -94,6 +100,7 @@ size_t faiss::IndexIVFPQ::scan_table_threshold scan_table_threshold + faiss::IndexIVFPQ::scan_table_threshold use table computation or on-the-fly? @@ -108,6 +115,7 @@ int faiss::IndexIVFPQ::polysemous_ht polysemous_ht + faiss::IndexIVFPQ::polysemous_ht Hamming thresh for polysemous filtering. @@ -122,6 +130,7 @@ int faiss::IndexIVFPQ::use_precomputed_table use_precomputed_table + faiss::IndexIVFPQ::use_precomputed_table @@ -136,6 +145,7 @@ AlignedTable<float> faiss::IndexIVFPQ::precomputed_table precomputed_table + faiss::IndexIVFPQ::precomputed_table @@ -150,6 +160,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -165,6 +176,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -179,6 +191,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -194,6 +207,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -211,6 +225,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -225,6 +240,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -239,6 +255,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -254,6 +271,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -268,6 +286,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -282,6 +301,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -296,6 +316,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -310,6 +331,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -324,6 +346,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -338,6 +361,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -353,6 +377,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -368,6 +393,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -383,6 +409,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -398,6 +425,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -413,6 +441,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -428,6 +457,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -442,6 +472,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -452,13 +483,14 @@ - - + + faiss::IndexIVFPQR::IndexIVFPQR (Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits_per_idx, size_t M_refine, size_t nbits_per_idx_refine) IndexIVFPQR + faiss::IndexIVFPQR::IndexIVFPQR Index * quantizer @@ -500,6 +532,7 @@ void faiss::IndexIVFPQR::reset () override reset + faiss::IndexIVFPQR::reset reset removes all elements from the database. @@ -515,6 +548,7 @@ size_t faiss::IndexIVFPQR::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVFPQR::remove_ids remove_ids const IDSelector & @@ -534,6 +568,7 @@ void faiss::IndexIVFPQR::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFPQR::train_encoder train_encoder idx_t @@ -561,6 +596,7 @@ idx_t faiss::IndexIVFPQR::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFPQR::train_encoder_num_vectors train_encoder_num_vectors @@ -576,6 +612,7 @@ void faiss::IndexIVFPQR::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVFPQR::add_with_ids add_with_ids idx_t @@ -603,6 +640,7 @@ void faiss::IndexIVFPQR::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) override add_core + faiss::IndexIVFPQR::add_core add_core idx_t @@ -639,6 +677,7 @@ void faiss::IndexIVFPQR::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFPQR::reconstruct_from_offset reconstruct_from_offset int64_t @@ -667,6 +706,7 @@ void faiss::IndexIVFPQR::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVFPQR::merge_from merge_from Index & @@ -690,6 +730,7 @@ void faiss::IndexIVFPQR::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVFPQR::search_preassigned search_preassigned idx_t @@ -821,6 +862,7 @@ faiss::IndexIVFPQR::IndexIVFPQR () IndexIVFPQR + faiss::IndexIVFPQR::IndexIVFPQR @@ -834,6 +876,7 @@ void faiss::IndexIVFPQ::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFPQ::encode_vectors encode_vectors idx_t @@ -896,6 +939,7 @@ void faiss::IndexIVFPQ::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexIVFPQ::sa_decode sa_decode idx_t @@ -949,6 +993,7 @@ void faiss::IndexIVFPQ::add_core_o (idx_t n, const float *x, const idx_t *xids, float *residuals_2, const idx_t *precomputed_idx=nullptr, void *inverted_list_context=nullptr) add_core_o + faiss::IndexIVFPQ::add_core_o idx_t n @@ -993,6 +1038,7 @@ size_t faiss::IndexIVFPQ::find_duplicates (idx_t *ids, size_t *lims) const find_duplicates + faiss::IndexIVFPQ::find_duplicates idx_t * ids @@ -1036,6 +1082,7 @@ void faiss::IndexIVFPQ::encode (idx_t key, const float *x, uint8_t *code) const encode + faiss::IndexIVFPQ::encode idx_t key @@ -1061,6 +1108,7 @@ void faiss::IndexIVFPQ::encode_multiple (size_t n, idx_t *keys, const float *x, uint8_t *codes, bool compute_keys=false) const encode_multiple + faiss::IndexIVFPQ::encode_multiple size_t n @@ -1138,6 +1186,7 @@ void faiss::IndexIVFPQ::decode_multiple (size_t n, const idx_t *keys, const uint8_t *xcodes, float *x) const decode_multiple + faiss::IndexIVFPQ::decode_multiple size_t n @@ -1163,12 +1212,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFPQ::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFPQ::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFPQ::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -1192,6 +1242,7 @@ void faiss::IndexIVFPQ::precompute_table () precompute_table + faiss::IndexIVFPQ::precompute_table build precomputed table @@ -1206,6 +1257,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -1230,6 +1282,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -1253,6 +1306,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -1298,6 +1352,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1418,6 +1473,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1460,6 +1516,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1533,6 +1590,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1556,6 +1614,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1610,6 +1669,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1664,6 +1724,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1719,6 +1780,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1785,6 +1847,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1799,12 +1862,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1818,6 +1882,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1848,6 +1913,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1865,6 +1931,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1879,6 +1946,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1908,6 +1976,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1925,6 +1994,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1948,6 +2018,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1963,6 +2034,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1979,7 +2051,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -2017,6 +2089,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -2083,6 +2156,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -2136,6 +2210,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -2191,6 +2266,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2253,15 +2329,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2277,6 +2354,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2307,6 +2385,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2321,6 +2400,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2342,6 +2422,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2354,13 +2435,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2374,6 +2456,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2382,16 +2465,16 @@ - + Index with an additional level of PQ refinement - - - + + + @@ -2401,44 +2484,52 @@ + + + + + + - - - - - - - - - - - - - - cp - - - clustering_index - quantizer + + + + + + + + tab + + + + + + + + - - + + + + + + @@ -2448,15 +2539,17 @@ - direct_map + invlists - invlists + direct_map - - - + + + + + @@ -2464,67 +2557,64 @@ - polysemous_training + pq - precomputed_table - - - pq + polysemous_training - - - - - - - - - - - - - - - - - + + precomputed_table - - - - - - - - - + refine_pq - - - - + + + + + + + + + clustering_index + quantizer + + + cp - + + + + + + + - - - - assign_index + cp + + assign_index + + + + + + + + + @@ -2557,9 +2647,9 @@ faiss::IndexIVFPQRencode_multiple faiss::IndexIVFPQRencode_vectors faiss::IndexIVFPQRfind_duplicates - faiss::IndexIVFPQRget_CodePacker - faiss::IndexIVFPQRget_distance_computer - faiss::IndexIVFPQRget_InvertedListScanner + faiss::IndexIVFPQRget_CodePacker + faiss::IndexIVFPQRget_distance_computer + faiss::IndexIVFPQRget_InvertedListScanner faiss::IndexIVFPQRget_list_size faiss::IndexIVFPQRIndex faiss::IndexIVFPQRIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFPQStats.xml b/xml/structfaiss_1_1IndexIVFPQStats.xml index 6ce277a9bd..74337fb82e 100644 --- a/xml/structfaiss_1_1IndexIVFPQStats.xml +++ b/xml/structfaiss_1_1IndexIVFPQStats.xml @@ -1,14 +1,15 @@ - + faiss::IndexIVFPQStats IndexIVFPQ.h - + size_t size_t faiss::IndexIVFPQStats::nrefine nrefine + faiss::IndexIVFPQStats::nrefine nb of refines (IVFPQR) @@ -23,6 +24,7 @@ size_t faiss::IndexIVFPQStats::n_hamming_pass n_hamming_pass + faiss::IndexIVFPQStats::n_hamming_pass nb of passed Hamming distance tests (for polysemous) @@ -37,6 +39,7 @@ size_t faiss::IndexIVFPQStats::search_cycles search_cycles + faiss::IndexIVFPQStats::search_cycles @@ -50,6 +53,7 @@ size_t faiss::IndexIVFPQStats::refine_cycles refine_cycles + faiss::IndexIVFPQStats::refine_cycles only for IVFPQR @@ -59,13 +63,14 @@ - - + + faiss::IndexIVFPQStats::IndexIVFPQStats () IndexIVFPQStats + faiss::IndexIVFPQStats::IndexIVFPQStats @@ -79,6 +84,7 @@ void faiss::IndexIVFPQStats::reset () reset + faiss::IndexIVFPQStats::reset @@ -87,11 +93,11 @@ - + -statistics are robust to internal threading, but not if IndexIVFPQ::search_preassigned is called by multiple threads +statistics are robust to internal threading, but not if IndexIVFPQ::search_preassigned is called by multiple threads diff --git a/xml/structfaiss_1_1IndexIVFProductLocalSearchQuantizer.xml b/xml/structfaiss_1_1IndexIVFProductLocalSearchQuantizer.xml index 44ad61cb6d..e17adb6e98 100644 --- a/xml/structfaiss_1_1IndexIVFProductLocalSearchQuantizer.xml +++ b/xml/structfaiss_1_1IndexIVFProductLocalSearchQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexIVFProductLocalSearchQuantizer faiss::IndexIVFAdditiveQuantizer IndexIVFAdditiveQuantizer.h - + ProductLocalSearchQuantizer ProductLocalSearchQuantizer faiss::IndexIVFProductLocalSearchQuantizer::plsq plsq + faiss::IndexIVFProductLocalSearchQuantizer::plsq The product local search quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizer::aq aq + faiss::IndexIVFAdditiveQuantizer::aq @@ -37,6 +39,7 @@ int faiss::IndexIVFAdditiveQuantizer::use_precomputed_table use_precomputed_table + faiss::IndexIVFAdditiveQuantizer::use_precomputed_table = 0 @@ -51,6 +54,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -66,6 +70,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -80,6 +85,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -95,6 +101,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -112,6 +119,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -126,6 +134,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -140,6 +149,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -155,6 +165,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -169,6 +180,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -183,6 +195,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -197,6 +210,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -211,6 +225,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -225,6 +240,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -239,6 +255,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -254,6 +271,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -269,6 +287,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -284,6 +303,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -299,6 +319,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -314,6 +335,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -329,6 +351,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -343,6 +366,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -353,13 +377,14 @@ - - + + faiss::IndexIVFProductLocalSearchQuantizer::IndexIVFProductLocalSearchQuantizer (Index *quantizer, size_t d, size_t nlist, size_t nsplits, size_t Msub, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexIVFProductLocalSearchQuantizer + faiss::IndexIVFProductLocalSearchQuantizer::IndexIVFProductLocalSearchQuantizer Index * quantizer @@ -442,6 +467,7 @@ faiss::IndexIVFProductLocalSearchQuantizer::IndexIVFProductLocalSearchQuantizer () IndexIVFProductLocalSearchQuantizer + faiss::IndexIVFProductLocalSearchQuantizer::IndexIVFProductLocalSearchQuantizer @@ -455,6 +481,7 @@ virtual faiss::IndexIVFProductLocalSearchQuantizer::~IndexIVFProductLocalSearchQuantizer () ~IndexIVFProductLocalSearchQuantizer + faiss::IndexIVFProductLocalSearchQuantizer::~IndexIVFProductLocalSearchQuantizer @@ -468,6 +495,7 @@ void faiss::IndexIVFAdditiveQuantizer::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizer::train_encoder train_encoder idx_t @@ -496,6 +524,7 @@ idx_t faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors train_encoder_num_vectors @@ -511,6 +540,7 @@ void faiss::IndexIVFAdditiveQuantizer::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizer::encode_vectors encode_vectors idx_t @@ -568,12 +598,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -597,6 +628,7 @@ void faiss::IndexIVFAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *codes, float *x) const override sa_decode + faiss::IndexIVFAdditiveQuantizer::sa_decode sa_decode idx_t @@ -650,6 +682,7 @@ void faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset reconstruct_from_offset int64_t @@ -678,6 +711,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -694,6 +728,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -718,6 +753,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -741,6 +777,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -771,6 +808,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -820,6 +858,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -865,6 +904,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -999,6 +1039,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1119,6 +1160,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1161,6 +1203,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1234,6 +1277,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1257,6 +1301,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1311,6 +1356,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1365,6 +1411,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1420,6 +1467,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1486,6 +1534,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1507,6 +1556,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1526,6 +1576,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1545,12 +1596,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1564,6 +1616,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1594,6 +1647,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1611,6 +1665,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1625,6 +1680,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1654,6 +1710,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1671,6 +1728,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1694,6 +1752,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1709,6 +1768,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1725,7 +1785,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1763,6 +1823,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1829,6 +1890,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1882,6 +1944,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1937,6 +2000,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1999,15 +2063,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2023,6 +2088,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2053,6 +2119,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2067,6 +2134,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2088,6 +2156,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2100,13 +2169,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizer::Search_type_t @@ -2120,6 +2190,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2133,6 +2204,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2141,22 +2213,36 @@ - + IndexIVF based on a product local search quantizer. Stored vectors are approximated by product local search quantization codes. + + + + + + + + + + + + - - - + + + + + @@ -2164,26 +2250,71 @@ - - - - + + + + + + + + + + - + + qnorm + + + + + + + + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + invlists + + + direct_map - - @@ -2193,21 +2324,12 @@ aq - - - - - cp - - - clustering_index - quantizer + + + + - - - - @@ -2217,18 +2339,19 @@ plsq - - - - - - - - - direct_map + + + + + + + + + clustering_index + quantizer - - invlists + + cp @@ -2237,67 +2360,16 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - qnorm - - - - - - - - - - - - - - @@ -2324,9 +2396,9 @@ faiss::IndexIVFProductLocalSearchQuantizerdistance_t faiss::IndexIVFProductLocalSearchQuantizerencode_listno faiss::IndexIVFProductLocalSearchQuantizerencode_vectors - faiss::IndexIVFProductLocalSearchQuantizerget_CodePacker - faiss::IndexIVFProductLocalSearchQuantizerget_distance_computer - faiss::IndexIVFProductLocalSearchQuantizerget_InvertedListScanner + faiss::IndexIVFProductLocalSearchQuantizerget_CodePacker + faiss::IndexIVFProductLocalSearchQuantizerget_distance_computer + faiss::IndexIVFProductLocalSearchQuantizerget_InvertedListScanner faiss::IndexIVFProductLocalSearchQuantizerget_list_size faiss::IndexIVFProductLocalSearchQuantizerIndex faiss::IndexIVFProductLocalSearchQuantizerIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFProductLocalSearchQuantizerFastScan.xml b/xml/structfaiss_1_1IndexIVFProductLocalSearchQuantizerFastScan.xml index 9fbf299fcb..7fe0e71488 100644 --- a/xml/structfaiss_1_1IndexIVFProductLocalSearchQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexIVFProductLocalSearchQuantizerFastScan.xml @@ -1,27 +1,29 @@ - + faiss::IndexIVFProductLocalSearchQuantizerFastScan faiss::IndexIVFAdditiveQuantizerFastScan - + ProductLocalSearchQuantizer ProductLocalSearchQuantizer faiss::IndexIVFProductLocalSearchQuantizerFastScan::plsq plsq + faiss::IndexIVFProductLocalSearchQuantizerFastScan::plsq - + AdditiveQuantizer * AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizerFastScan::aq aq + faiss::IndexIVFAdditiveQuantizerFastScan::aq @@ -35,6 +37,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm = false @@ -49,6 +52,7 @@ int faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale = 1 @@ -63,6 +67,7 @@ size_t faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points @@ -76,71 +81,77 @@ int faiss::IndexIVFFastScan::bbs bbs + faiss::IndexIVFFastScan::bbs - + size_t size_t faiss::IndexIVFFastScan::M M + faiss::IndexIVFFastScan::M - + size_t size_t faiss::IndexIVFFastScan::nbits nbits + faiss::IndexIVFFastScan::nbits - + size_t size_t faiss::IndexIVFFastScan::ksub ksub + faiss::IndexIVFFastScan::ksub - + size_t size_t faiss::IndexIVFFastScan::M2 M2 + faiss::IndexIVFFastScan::M2 - + int int faiss::IndexIVFFastScan::implem implem + faiss::IndexIVFFastScan::implem = 0 @@ -148,13 +159,14 @@ - + int int faiss::IndexIVFFastScan::skip skip + faiss::IndexIVFFastScan::skip = 0 @@ -162,13 +174,14 @@ - + int int faiss::IndexIVFFastScan::qbs qbs + faiss::IndexIVFFastScan::qbs = 0 @@ -176,13 +189,14 @@ - + size_t size_t faiss::IndexIVFFastScan::qbs2 qbs2 + faiss::IndexIVFFastScan::qbs2 = 0 @@ -190,13 +204,29 @@ - + + + + Quantizer * + Quantizer* faiss::IndexIVFFastScan::fine_quantizer + + fine_quantizer + faiss::IndexIVFFastScan::fine_quantizer + = nullptr + + + + + + + InvertedLists * InvertedLists* faiss::IndexIVFFastScan::orig_invlists orig_invlists + faiss::IndexIVFFastScan::orig_invlists = nullptr orig's inverted lists (for debugging) @@ -205,13 +235,14 @@ - + InvertedLists * InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -227,6 +258,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -241,6 +273,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -256,6 +289,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -273,6 +307,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -287,6 +322,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -301,6 +337,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -316,6 +353,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -330,6 +368,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -344,6 +383,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -358,6 +398,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -372,6 +413,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -386,6 +428,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -400,6 +443,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -415,6 +459,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -430,6 +475,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -445,6 +491,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -460,6 +507,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -475,6 +523,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -490,6 +539,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -504,6 +554,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -514,13 +565,14 @@ - - + + faiss::IndexIVFProductLocalSearchQuantizerFastScan::IndexIVFProductLocalSearchQuantizerFastScan (Index *quantizer, size_t d, size_t nlist, size_t nsplits, size_t Msub, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_norm_lsq2x4, int bbs=32) IndexIVFProductLocalSearchQuantizerFastScan + faiss::IndexIVFProductLocalSearchQuantizerFastScan::IndexIVFProductLocalSearchQuantizerFastScan Index * quantizer @@ -566,26 +618,28 @@ - + faiss::IndexIVFProductLocalSearchQuantizerFastScan::IndexIVFProductLocalSearchQuantizerFastScan () IndexIVFProductLocalSearchQuantizerFastScan + faiss::IndexIVFProductLocalSearchQuantizerFastScan::IndexIVFProductLocalSearchQuantizerFastScan - + void void faiss::IndexIVFAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, size_t nlist, MetricType metric, int bbs) init + faiss::IndexIVFAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -615,6 +669,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder train_encoder idx_t @@ -643,6 +698,7 @@ idx_t faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors train_encoder_num_vectors @@ -658,6 +714,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -679,6 +736,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listno=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors encode_vectors idx_t @@ -715,6 +773,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVFAdditiveQuantizerFastScan::search search idx_t @@ -755,6 +814,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d () const override lookup_table_is_3d + faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d lookup_table_is_3d @@ -769,6 +829,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< float > &dis_tables, AlignedTable< float > &biases) const override compute_LUT + faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT compute_LUT size_t @@ -798,64 +859,16 @@ - - void - void faiss::IndexIVFAdditiveQuantizerFastScan::sa_decode - (idx_t n, const uint8_t *bytes, float *x) const override - sa_decode - sa_decode - - idx_t - n - - - const uint8_t * - bytes - - - float * - x - - - - -decode a set of vectors - - -n - - -number of vectors - - - - -bytes - - -input encoded vectors, size n * sa_code_size() - - - - -x - - -output vectors, size n * d - - - - - - - - - - + void void faiss::IndexIVFFastScan::init_fastscan - (size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) + (Quantizer *fine_quantizer, size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) init_fastscan + faiss::IndexIVFFastScan::init_fastscan + + Quantizer * + fine_quantizer + size_t M @@ -877,31 +890,34 @@ bbs +called by implementations - + void void faiss::IndexIVFFastScan::init_code_packer () init_code_packer + faiss::IndexIVFFastScan::init_code_packer - + void void faiss::IndexIVFFastScan::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVFFastScan::add_with_ids add_with_ids idx_t @@ -922,13 +938,14 @@ - + void void faiss::IndexIVFFastScan::compute_LUT_uint8 (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< uint8_t > &dis_tables, AlignedTable< uint16_t > &biases, float *normalizers) const compute_LUT_uint8 + faiss::IndexIVFFastScan::compute_LUT_uint8 size_t n @@ -959,13 +976,14 @@ - + void void faiss::IndexIVFFastScan::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVFFastScan::search_preassigned search_preassigned idx_t @@ -1090,13 +1108,14 @@ - + void void faiss::IndexIVFFastScan::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVFFastScan::range_search range_search idx_t @@ -1161,13 +1180,14 @@ - + void void faiss::IndexIVFFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_dispatch_implem + faiss::IndexIVFFastScan::search_dispatch_implem idx_t n @@ -1207,13 +1227,14 @@ - + void void faiss::IndexIVFFastScan::range_search_dispatch_implem (idx_t n, const float *x, float radius, RangeSearchResult &rres, const CoarseQuantized &cq_in, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const range_search_dispatch_implem + faiss::IndexIVFFastScan::range_search_dispatch_implem idx_t n @@ -1249,7 +1270,7 @@ - + @@ -1261,6 +1282,7 @@ void faiss::IndexIVFFastScan::search_implem_1 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_1 + faiss::IndexIVFFastScan::search_implem_1 idx_t n @@ -1300,7 +1322,7 @@ - + @@ -1312,6 +1334,7 @@ void faiss::IndexIVFFastScan::search_implem_2 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_2 + faiss::IndexIVFFastScan::search_implem_2 idx_t n @@ -1351,13 +1374,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_10 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_10 + faiss::IndexIVFFastScan::search_implem_10 idx_t n @@ -1397,13 +1421,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_12 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_12 + faiss::IndexIVFFastScan::search_implem_12 idx_t n @@ -1443,13 +1468,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, int impl, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_14 + faiss::IndexIVFFastScan::search_implem_14 idx_t n @@ -1493,13 +1519,14 @@ - + void void faiss::IndexIVFFastScan::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFFastScan::reconstruct_from_offset reconstruct_from_offset int64_t @@ -1521,40 +1548,98 @@ - + - + CodePacker * - CodePacker* faiss::IndexIVFFastScan::get_CodePacker + CodePacker * faiss::IndexIVFFastScan::get_CodePacker () const override get_CodePacker - get_CodePacker + faiss::IndexIVFFastScan::get_CodePacker + get_CodePacker - + void void faiss::IndexIVFFastScan::reconstruct_orig_invlists () reconstruct_orig_invlists + faiss::IndexIVFFastScan::reconstruct_orig_invlists - + + + + void + void faiss::IndexIVFFastScan::sa_decode + (idx_t n, const uint8_t *bytes, float *x) const override + sa_decode + faiss::IndexIVFFastScan::sa_decode + sa_decode + + idx_t + n + + + const uint8_t * + bytes + + + float * + x + + + + +Decode a set of vectors. +NOTE: The codes in the IndexFastScan object are non-contiguous. But this method requires a contiguous representation. + + +n + + +number of vectors + + + + +bytes + + +input encoded vectors, size n * code_size + + + + +x + + +output vectors, size n * d + + + + + + + + void void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -1571,6 +1656,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -1595,6 +1681,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -1618,6 +1705,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -1667,6 +1755,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -1712,6 +1801,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1827,16 +1917,17 @@ - + InvertedListScanner * - virtual InvertedListScanner* faiss::IndexIVF::get_InvertedListScanner + virtual InvertedListScanner * faiss::IndexIVF::get_InvertedListScanner (bool store_pairs=false, const IDSelector *sel=nullptr) const get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVF::get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -1862,6 +1953,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1885,6 +1977,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1939,6 +2032,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1993,6 +2087,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -2048,6 +2143,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -2114,6 +2210,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -2135,6 +2232,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -2154,6 +2252,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -2178,6 +2277,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -2208,6 +2308,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -2225,6 +2326,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -2239,6 +2341,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -2268,6 +2371,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -2285,6 +2389,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -2308,6 +2413,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -2323,6 +2429,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -2339,7 +2446,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -2377,6 +2484,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -2443,6 +2551,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -2496,6 +2605,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -2551,6 +2661,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2613,15 +2724,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2637,6 +2749,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2667,6 +2780,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2681,6 +2795,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2702,6 +2817,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2714,13 +2830,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t @@ -2734,6 +2851,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2747,6 +2865,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2755,15 +2874,15 @@ - + - - - + + + @@ -2785,9 +2904,11 @@ - - - + + + + + @@ -2795,28 +2916,56 @@ - - - - - - - - - - cp + + + + + + + - - clustering_index - quantizer + + qnorm + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2826,10 +2975,10 @@ - direct_map + invlists - invlists + direct_map @@ -2837,57 +2986,28 @@ - + aq - - - - - - - - - - - - orig_invlists - - - - - - - - - - - - + + fine_quantizer - - - - - + + orig_invlists - - - - + + + + - - - - @@ -2898,36 +3018,38 @@ - - + + - - - - + + + + + clustering_index + quantizer - - qnorm + + cp - - - - - - - - + + + + - - - - + + + + + + + + - + faiss::IndexIVFProductLocalSearchQuantizerFastScanadd faiss::IndexIVFProductLocalSearchQuantizerFastScanadd_core @@ -2956,9 +3078,10 @@ faiss::IndexIVFProductLocalSearchQuantizerFastScanencode_listno faiss::IndexIVFProductLocalSearchQuantizerFastScanencode_vectors faiss::IndexIVFProductLocalSearchQuantizerFastScanestimate_norm_scale - faiss::IndexIVFProductLocalSearchQuantizerFastScanget_CodePacker - faiss::IndexIVFProductLocalSearchQuantizerFastScanget_distance_computer - faiss::IndexIVFProductLocalSearchQuantizerFastScanget_InvertedListScanner + faiss::IndexIVFProductLocalSearchQuantizerFastScanfine_quantizer + faiss::IndexIVFProductLocalSearchQuantizerFastScanget_CodePacker + faiss::IndexIVFProductLocalSearchQuantizerFastScanget_distance_computer + faiss::IndexIVFProductLocalSearchQuantizerFastScanget_InvertedListScanner faiss::IndexIVFProductLocalSearchQuantizerFastScanget_list_size faiss::IndexIVFProductLocalSearchQuantizerFastScanimplem faiss::IndexIVFProductLocalSearchQuantizerFastScanIndex @@ -2974,7 +3097,7 @@ faiss::IndexIVFProductLocalSearchQuantizerFastScanIndexIVFProductLocalSearchQuantizerFastScan faiss::IndexIVFProductLocalSearchQuantizerFastScaninit faiss::IndexIVFProductLocalSearchQuantizerFastScaninit_code_packer - faiss::IndexIVFProductLocalSearchQuantizerFastScaninit_fastscan + faiss::IndexIVFProductLocalSearchQuantizerFastScaninit_fastscan faiss::IndexIVFProductLocalSearchQuantizerFastScaninvlists faiss::IndexIVFProductLocalSearchQuantizerFastScanis_trained faiss::IndexIVFProductLocalSearchQuantizerFastScanksub @@ -3017,7 +3140,7 @@ faiss::IndexIVFProductLocalSearchQuantizerFastScanrescale_norm faiss::IndexIVFProductLocalSearchQuantizerFastScanreset faiss::IndexIVFProductLocalSearchQuantizerFastScansa_code_size - faiss::IndexIVFProductLocalSearchQuantizerFastScansa_decode + faiss::IndexIVFProductLocalSearchQuantizerFastScansa_decode faiss::IndexIVFProductLocalSearchQuantizerFastScansa_encode faiss::IndexIVFProductLocalSearchQuantizerFastScansearch faiss::IndexIVFProductLocalSearchQuantizerFastScansearch_and_reconstruct diff --git a/xml/structfaiss_1_1IndexIVFProductResidualQuantizer.xml b/xml/structfaiss_1_1IndexIVFProductResidualQuantizer.xml index 016a68e9b4..5317929369 100644 --- a/xml/structfaiss_1_1IndexIVFProductResidualQuantizer.xml +++ b/xml/structfaiss_1_1IndexIVFProductResidualQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexIVFProductResidualQuantizer faiss::IndexIVFAdditiveQuantizer IndexIVFAdditiveQuantizer.h - + ProductResidualQuantizer ProductResidualQuantizer faiss::IndexIVFProductResidualQuantizer::prq prq + faiss::IndexIVFProductResidualQuantizer::prq The product residual quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizer::aq aq + faiss::IndexIVFAdditiveQuantizer::aq @@ -37,6 +39,7 @@ int faiss::IndexIVFAdditiveQuantizer::use_precomputed_table use_precomputed_table + faiss::IndexIVFAdditiveQuantizer::use_precomputed_table = 0 @@ -51,6 +54,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -66,6 +70,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -80,6 +85,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -95,6 +101,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -112,6 +119,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -126,6 +134,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -140,6 +149,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -155,6 +165,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -169,6 +180,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -183,6 +195,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -197,6 +210,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -211,6 +225,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -225,6 +240,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -239,6 +255,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -254,6 +271,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -269,6 +287,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -284,6 +303,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -299,6 +319,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -314,6 +335,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -329,6 +351,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -343,6 +366,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -353,13 +377,14 @@ - - + + faiss::IndexIVFProductResidualQuantizer::IndexIVFProductResidualQuantizer (Index *quantizer, size_t d, size_t nlist, size_t nsplits, size_t Msub, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexIVFProductResidualQuantizer + faiss::IndexIVFProductResidualQuantizer::IndexIVFProductResidualQuantizer Index * quantizer @@ -442,6 +467,7 @@ faiss::IndexIVFProductResidualQuantizer::IndexIVFProductResidualQuantizer () IndexIVFProductResidualQuantizer + faiss::IndexIVFProductResidualQuantizer::IndexIVFProductResidualQuantizer @@ -455,6 +481,7 @@ virtual faiss::IndexIVFProductResidualQuantizer::~IndexIVFProductResidualQuantizer () ~IndexIVFProductResidualQuantizer + faiss::IndexIVFProductResidualQuantizer::~IndexIVFProductResidualQuantizer @@ -468,6 +495,7 @@ void faiss::IndexIVFAdditiveQuantizer::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizer::train_encoder train_encoder idx_t @@ -496,6 +524,7 @@ idx_t faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors train_encoder_num_vectors @@ -511,6 +540,7 @@ void faiss::IndexIVFAdditiveQuantizer::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizer::encode_vectors encode_vectors idx_t @@ -568,12 +598,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -597,6 +628,7 @@ void faiss::IndexIVFAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *codes, float *x) const override sa_decode + faiss::IndexIVFAdditiveQuantizer::sa_decode sa_decode idx_t @@ -650,6 +682,7 @@ void faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset reconstruct_from_offset int64_t @@ -678,6 +711,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -694,6 +728,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -718,6 +753,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -741,6 +777,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -771,6 +808,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -820,6 +858,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -865,6 +904,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -999,6 +1039,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1119,6 +1160,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1161,6 +1203,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1234,6 +1277,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1257,6 +1301,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1311,6 +1356,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1365,6 +1411,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1420,6 +1467,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1486,6 +1534,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1507,6 +1556,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1526,6 +1576,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1545,12 +1596,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1564,6 +1616,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1594,6 +1647,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1611,6 +1665,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1625,6 +1680,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1654,6 +1710,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1671,6 +1728,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1694,6 +1752,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1709,6 +1768,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1725,7 +1785,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1763,6 +1823,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1829,6 +1890,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1882,6 +1944,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1937,6 +2000,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1999,15 +2063,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2023,6 +2088,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2053,6 +2119,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2067,6 +2134,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2088,6 +2156,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2100,13 +2169,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizer::Search_type_t @@ -2120,6 +2190,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2133,6 +2204,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2141,22 +2213,16 @@ - + IndexIVF based on a product residual quantizer. Stored vectors are approximated by product residual quantization codes. - - - - - - - - - + + + @@ -2166,14 +2232,10 @@ - - - - - - - - + + + + @@ -2182,56 +2244,39 @@ - - - - - - - - - aq + + + + - - cp - - - clustering_index - quantizer - - - - - - - - - - - - - - direct_map - - - invlists + + + + + + - - - - - + + qnorm + + + + + + + + @@ -2244,19 +2289,46 @@ + + + + + + - - - + + + + + + + + + invlists + + + direct_map + - - - + + + + + + + aq + + + + + + + @@ -2267,13 +2339,25 @@ prq - - - - + + + + + + + + + clustering_index + quantizer - - qnorm + + cp + + + + + + @@ -2286,18 +2370,6 @@ - - - - - - - - - - - - @@ -2324,9 +2396,9 @@ faiss::IndexIVFProductResidualQuantizerdistance_t faiss::IndexIVFProductResidualQuantizerencode_listno faiss::IndexIVFProductResidualQuantizerencode_vectors - faiss::IndexIVFProductResidualQuantizerget_CodePacker - faiss::IndexIVFProductResidualQuantizerget_distance_computer - faiss::IndexIVFProductResidualQuantizerget_InvertedListScanner + faiss::IndexIVFProductResidualQuantizerget_CodePacker + faiss::IndexIVFProductResidualQuantizerget_distance_computer + faiss::IndexIVFProductResidualQuantizerget_InvertedListScanner faiss::IndexIVFProductResidualQuantizerget_list_size faiss::IndexIVFProductResidualQuantizerIndex faiss::IndexIVFProductResidualQuantizerIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFProductResidualQuantizerFastScan.xml b/xml/structfaiss_1_1IndexIVFProductResidualQuantizerFastScan.xml index 0849576fed..9091df24f1 100644 --- a/xml/structfaiss_1_1IndexIVFProductResidualQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexIVFProductResidualQuantizerFastScan.xml @@ -1,27 +1,29 @@ - + faiss::IndexIVFProductResidualQuantizerFastScan faiss::IndexIVFAdditiveQuantizerFastScan - + ProductResidualQuantizer ProductResidualQuantizer faiss::IndexIVFProductResidualQuantizerFastScan::prq prq + faiss::IndexIVFProductResidualQuantizerFastScan::prq - + AdditiveQuantizer * AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizerFastScan::aq aq + faiss::IndexIVFAdditiveQuantizerFastScan::aq @@ -35,6 +37,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm = false @@ -49,6 +52,7 @@ int faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale = 1 @@ -63,6 +67,7 @@ size_t faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points @@ -76,71 +81,77 @@ int faiss::IndexIVFFastScan::bbs bbs + faiss::IndexIVFFastScan::bbs - + size_t size_t faiss::IndexIVFFastScan::M M + faiss::IndexIVFFastScan::M - + size_t size_t faiss::IndexIVFFastScan::nbits nbits + faiss::IndexIVFFastScan::nbits - + size_t size_t faiss::IndexIVFFastScan::ksub ksub + faiss::IndexIVFFastScan::ksub - + size_t size_t faiss::IndexIVFFastScan::M2 M2 + faiss::IndexIVFFastScan::M2 - + int int faiss::IndexIVFFastScan::implem implem + faiss::IndexIVFFastScan::implem = 0 @@ -148,13 +159,14 @@ - + int int faiss::IndexIVFFastScan::skip skip + faiss::IndexIVFFastScan::skip = 0 @@ -162,13 +174,14 @@ - + int int faiss::IndexIVFFastScan::qbs qbs + faiss::IndexIVFFastScan::qbs = 0 @@ -176,13 +189,14 @@ - + size_t size_t faiss::IndexIVFFastScan::qbs2 qbs2 + faiss::IndexIVFFastScan::qbs2 = 0 @@ -190,13 +204,29 @@ - + + + + Quantizer * + Quantizer* faiss::IndexIVFFastScan::fine_quantizer + + fine_quantizer + faiss::IndexIVFFastScan::fine_quantizer + = nullptr + + + + + + + InvertedLists * InvertedLists* faiss::IndexIVFFastScan::orig_invlists orig_invlists + faiss::IndexIVFFastScan::orig_invlists = nullptr orig's inverted lists (for debugging) @@ -205,13 +235,14 @@ - + InvertedLists * InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -227,6 +258,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -241,6 +273,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -256,6 +289,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -273,6 +307,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -287,6 +322,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -301,6 +337,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -316,6 +353,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -330,6 +368,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -344,6 +383,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -358,6 +398,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -372,6 +413,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -386,6 +428,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -400,6 +443,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -415,6 +459,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -430,6 +475,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -445,6 +491,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -460,6 +507,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -475,6 +523,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -490,6 +539,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -504,6 +554,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -514,13 +565,14 @@ - - + + faiss::IndexIVFProductResidualQuantizerFastScan::IndexIVFProductResidualQuantizerFastScan (Index *quantizer, size_t d, size_t nlist, size_t nsplits, size_t Msub, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_norm_lsq2x4, int bbs=32) IndexIVFProductResidualQuantizerFastScan + faiss::IndexIVFProductResidualQuantizerFastScan::IndexIVFProductResidualQuantizerFastScan Index * quantizer @@ -566,26 +618,28 @@ - + faiss::IndexIVFProductResidualQuantizerFastScan::IndexIVFProductResidualQuantizerFastScan () IndexIVFProductResidualQuantizerFastScan + faiss::IndexIVFProductResidualQuantizerFastScan::IndexIVFProductResidualQuantizerFastScan - + void void faiss::IndexIVFAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, size_t nlist, MetricType metric, int bbs) init + faiss::IndexIVFAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -615,6 +669,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder train_encoder idx_t @@ -643,6 +698,7 @@ idx_t faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors train_encoder_num_vectors @@ -658,6 +714,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -679,6 +736,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listno=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors encode_vectors idx_t @@ -715,6 +773,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVFAdditiveQuantizerFastScan::search search idx_t @@ -755,6 +814,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d () const override lookup_table_is_3d + faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d lookup_table_is_3d @@ -769,6 +829,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< float > &dis_tables, AlignedTable< float > &biases) const override compute_LUT + faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT compute_LUT size_t @@ -798,64 +859,16 @@ - - void - void faiss::IndexIVFAdditiveQuantizerFastScan::sa_decode - (idx_t n, const uint8_t *bytes, float *x) const override - sa_decode - sa_decode - - idx_t - n - - - const uint8_t * - bytes - - - float * - x - - - - -decode a set of vectors - - -n - - -number of vectors - - - - -bytes - - -input encoded vectors, size n * sa_code_size() - - - - -x - - -output vectors, size n * d - - - - - - - - - - + void void faiss::IndexIVFFastScan::init_fastscan - (size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) + (Quantizer *fine_quantizer, size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) init_fastscan + faiss::IndexIVFFastScan::init_fastscan + + Quantizer * + fine_quantizer + size_t M @@ -877,31 +890,34 @@ bbs +called by implementations - + void void faiss::IndexIVFFastScan::init_code_packer () init_code_packer + faiss::IndexIVFFastScan::init_code_packer - + void void faiss::IndexIVFFastScan::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVFFastScan::add_with_ids add_with_ids idx_t @@ -922,13 +938,14 @@ - + void void faiss::IndexIVFFastScan::compute_LUT_uint8 (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< uint8_t > &dis_tables, AlignedTable< uint16_t > &biases, float *normalizers) const compute_LUT_uint8 + faiss::IndexIVFFastScan::compute_LUT_uint8 size_t n @@ -959,13 +976,14 @@ - + void void faiss::IndexIVFFastScan::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVFFastScan::search_preassigned search_preassigned idx_t @@ -1090,13 +1108,14 @@ - + void void faiss::IndexIVFFastScan::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVFFastScan::range_search range_search idx_t @@ -1161,13 +1180,14 @@ - + void void faiss::IndexIVFFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_dispatch_implem + faiss::IndexIVFFastScan::search_dispatch_implem idx_t n @@ -1207,13 +1227,14 @@ - + void void faiss::IndexIVFFastScan::range_search_dispatch_implem (idx_t n, const float *x, float radius, RangeSearchResult &rres, const CoarseQuantized &cq_in, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const range_search_dispatch_implem + faiss::IndexIVFFastScan::range_search_dispatch_implem idx_t n @@ -1249,7 +1270,7 @@ - + @@ -1261,6 +1282,7 @@ void faiss::IndexIVFFastScan::search_implem_1 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_1 + faiss::IndexIVFFastScan::search_implem_1 idx_t n @@ -1300,7 +1322,7 @@ - + @@ -1312,6 +1334,7 @@ void faiss::IndexIVFFastScan::search_implem_2 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_2 + faiss::IndexIVFFastScan::search_implem_2 idx_t n @@ -1351,13 +1374,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_10 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_10 + faiss::IndexIVFFastScan::search_implem_10 idx_t n @@ -1397,13 +1421,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_12 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_12 + faiss::IndexIVFFastScan::search_implem_12 idx_t n @@ -1443,13 +1468,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, int impl, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_14 + faiss::IndexIVFFastScan::search_implem_14 idx_t n @@ -1493,13 +1519,14 @@ - + void void faiss::IndexIVFFastScan::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFFastScan::reconstruct_from_offset reconstruct_from_offset int64_t @@ -1521,40 +1548,98 @@ - + - + CodePacker * - CodePacker* faiss::IndexIVFFastScan::get_CodePacker + CodePacker * faiss::IndexIVFFastScan::get_CodePacker () const override get_CodePacker - get_CodePacker + faiss::IndexIVFFastScan::get_CodePacker + get_CodePacker - + void void faiss::IndexIVFFastScan::reconstruct_orig_invlists () reconstruct_orig_invlists + faiss::IndexIVFFastScan::reconstruct_orig_invlists - + + + + void + void faiss::IndexIVFFastScan::sa_decode + (idx_t n, const uint8_t *bytes, float *x) const override + sa_decode + faiss::IndexIVFFastScan::sa_decode + sa_decode + + idx_t + n + + + const uint8_t * + bytes + + + float * + x + + + + +Decode a set of vectors. +NOTE: The codes in the IndexFastScan object are non-contiguous. But this method requires a contiguous representation. + + +n + + +number of vectors + + + + +bytes + + +input encoded vectors, size n * code_size + + + + +x + + +output vectors, size n * d + + + + + + + + void void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -1571,6 +1656,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -1595,6 +1681,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -1618,6 +1705,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -1667,6 +1755,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -1712,6 +1801,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1827,16 +1917,17 @@ - + InvertedListScanner * - virtual InvertedListScanner* faiss::IndexIVF::get_InvertedListScanner + virtual InvertedListScanner * faiss::IndexIVF::get_InvertedListScanner (bool store_pairs=false, const IDSelector *sel=nullptr) const get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVF::get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -1862,6 +1953,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1885,6 +1977,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1939,6 +2032,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1993,6 +2087,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -2048,6 +2143,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -2114,6 +2210,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -2135,6 +2232,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -2154,6 +2252,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -2178,6 +2277,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -2208,6 +2308,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -2225,6 +2326,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -2239,6 +2341,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -2268,6 +2371,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -2285,6 +2389,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -2308,6 +2413,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -2323,6 +2429,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -2339,7 +2446,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -2377,6 +2484,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -2443,6 +2551,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -2496,6 +2605,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -2551,6 +2661,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2613,15 +2724,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2637,6 +2749,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2667,6 +2780,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2681,6 +2795,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2702,6 +2817,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2714,13 +2830,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t @@ -2734,6 +2851,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2747,6 +2865,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2755,21 +2874,15 @@ - + - - - - - - - - - + + + @@ -2791,41 +2904,68 @@ - - - - - - - - prq - - - cp + + + + + + + - - clustering_index - quantizer + + qnorm + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2835,10 +2975,10 @@ - direct_map + invlists - invlists + direct_map @@ -2846,62 +2986,56 @@ - + aq - - - - - - - - - - - + + fine_quantizer + + orig_invlists - - - - + + + + - - - - + + + + - - - - - + + prq - - - - - - + + - - - - + + + + + clustering_index + quantizer - - qnorm + + cp + + + + + + @@ -2910,24 +3044,12 @@ - + - - - - - - - - - - - - - + faiss::IndexIVFProductResidualQuantizerFastScanadd faiss::IndexIVFProductResidualQuantizerFastScanadd_core @@ -2956,9 +3078,10 @@ faiss::IndexIVFProductResidualQuantizerFastScanencode_listno faiss::IndexIVFProductResidualQuantizerFastScanencode_vectors faiss::IndexIVFProductResidualQuantizerFastScanestimate_norm_scale - faiss::IndexIVFProductResidualQuantizerFastScanget_CodePacker - faiss::IndexIVFProductResidualQuantizerFastScanget_distance_computer - faiss::IndexIVFProductResidualQuantizerFastScanget_InvertedListScanner + faiss::IndexIVFProductResidualQuantizerFastScanfine_quantizer + faiss::IndexIVFProductResidualQuantizerFastScanget_CodePacker + faiss::IndexIVFProductResidualQuantizerFastScanget_distance_computer + faiss::IndexIVFProductResidualQuantizerFastScanget_InvertedListScanner faiss::IndexIVFProductResidualQuantizerFastScanget_list_size faiss::IndexIVFProductResidualQuantizerFastScanimplem faiss::IndexIVFProductResidualQuantizerFastScanIndex @@ -2974,7 +3097,7 @@ faiss::IndexIVFProductResidualQuantizerFastScanIndexIVFProductResidualQuantizerFastScan faiss::IndexIVFProductResidualQuantizerFastScaninit faiss::IndexIVFProductResidualQuantizerFastScaninit_code_packer - faiss::IndexIVFProductResidualQuantizerFastScaninit_fastscan + faiss::IndexIVFProductResidualQuantizerFastScaninit_fastscan faiss::IndexIVFProductResidualQuantizerFastScaninvlists faiss::IndexIVFProductResidualQuantizerFastScanis_trained faiss::IndexIVFProductResidualQuantizerFastScanksub @@ -3017,7 +3140,7 @@ faiss::IndexIVFProductResidualQuantizerFastScanrescale_norm faiss::IndexIVFProductResidualQuantizerFastScanreset faiss::IndexIVFProductResidualQuantizerFastScansa_code_size - faiss::IndexIVFProductResidualQuantizerFastScansa_decode + faiss::IndexIVFProductResidualQuantizerFastScansa_decode faiss::IndexIVFProductResidualQuantizerFastScansa_encode faiss::IndexIVFProductResidualQuantizerFastScansearch faiss::IndexIVFProductResidualQuantizerFastScansearch_and_reconstruct diff --git a/xml/structfaiss_1_1IndexIVFResidualQuantizer.xml b/xml/structfaiss_1_1IndexIVFResidualQuantizer.xml index 958fa9ad09..a23a3acbe8 100644 --- a/xml/structfaiss_1_1IndexIVFResidualQuantizer.xml +++ b/xml/structfaiss_1_1IndexIVFResidualQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexIVFResidualQuantizer faiss::IndexIVFAdditiveQuantizer IndexIVFAdditiveQuantizer.h - + ResidualQuantizer ResidualQuantizer faiss::IndexIVFResidualQuantizer::rq rq + faiss::IndexIVFResidualQuantizer::rq The residual quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizer::aq aq + faiss::IndexIVFAdditiveQuantizer::aq @@ -37,6 +39,7 @@ int faiss::IndexIVFAdditiveQuantizer::use_precomputed_table use_precomputed_table + faiss::IndexIVFAdditiveQuantizer::use_precomputed_table = 0 @@ -51,6 +54,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -66,6 +70,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -80,6 +85,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -95,6 +101,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -112,6 +119,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -126,6 +134,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -140,6 +149,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -155,6 +165,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -169,6 +180,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -183,6 +195,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -197,6 +210,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -211,6 +225,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -225,6 +240,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -239,6 +255,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -254,6 +271,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -269,6 +287,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -284,6 +303,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -299,6 +319,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -314,6 +335,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -329,6 +351,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -343,6 +366,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -353,13 +377,14 @@ - - + + faiss::IndexIVFResidualQuantizer::IndexIVFResidualQuantizer (Index *quantizer, size_t d, size_t nlist, const std::vector< size_t > &nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexIVFResidualQuantizer + faiss::IndexIVFResidualQuantizer::IndexIVFResidualQuantizer Index * quantizer @@ -426,6 +451,7 @@ faiss::IndexIVFResidualQuantizer::IndexIVFResidualQuantizer (Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexIVFResidualQuantizer + faiss::IndexIVFResidualQuantizer::IndexIVFResidualQuantizer Index * quantizer @@ -469,6 +495,7 @@ faiss::IndexIVFResidualQuantizer::IndexIVFResidualQuantizer () IndexIVFResidualQuantizer + faiss::IndexIVFResidualQuantizer::IndexIVFResidualQuantizer @@ -482,6 +509,7 @@ virtual faiss::IndexIVFResidualQuantizer::~IndexIVFResidualQuantizer () ~IndexIVFResidualQuantizer + faiss::IndexIVFResidualQuantizer::~IndexIVFResidualQuantizer @@ -495,6 +523,7 @@ void faiss::IndexIVFAdditiveQuantizer::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizer::train_encoder train_encoder idx_t @@ -523,6 +552,7 @@ idx_t faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizer::train_encoder_num_vectors train_encoder_num_vectors @@ -538,6 +568,7 @@ void faiss::IndexIVFAdditiveQuantizer::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizer::encode_vectors encode_vectors idx_t @@ -595,12 +626,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFAdditiveQuantizer::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -624,6 +656,7 @@ void faiss::IndexIVFAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *codes, float *x) const override sa_decode + faiss::IndexIVFAdditiveQuantizer::sa_decode sa_decode idx_t @@ -677,6 +710,7 @@ void faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFAdditiveQuantizer::reconstruct_from_offset reconstruct_from_offset int64_t @@ -705,6 +739,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -721,6 +756,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -745,6 +781,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -768,6 +805,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -798,6 +836,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -847,6 +886,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -892,6 +932,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -1026,6 +1067,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1146,6 +1188,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1188,6 +1231,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1261,6 +1305,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1284,6 +1329,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1338,6 +1384,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1392,6 +1439,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1447,6 +1495,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1513,6 +1562,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1534,6 +1584,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1553,6 +1604,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1572,12 +1624,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1591,6 +1644,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1621,6 +1675,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1638,6 +1693,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1652,6 +1708,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1681,6 +1738,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1698,6 +1756,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1721,6 +1780,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1736,6 +1796,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1752,7 +1813,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1790,6 +1851,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1856,6 +1918,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1909,6 +1972,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1964,6 +2028,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2026,15 +2091,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2050,6 +2116,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2080,6 +2147,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2094,6 +2162,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2115,6 +2184,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2127,13 +2197,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizer::Search_type_t @@ -2147,6 +2218,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2160,6 +2232,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2168,28 +2241,16 @@ - + IndexIVF based on a residual quantizer. Stored vectors are approximated by residual quantization codes. - - - - - - - - - - - - - - - + + + @@ -2199,9 +2260,11 @@ - - - + + + + + @@ -2209,81 +2272,39 @@ - - - - - - - - - - rq - - - - - - - - - cp - - - assign_index_factory - - - - - - - - - aq - - - cp - - - clustering_index - quantizer - - - - - - - - - - - - - - direct_map + + + + + + - - invlists + + qnorm - - - - + + + + + + + + @@ -2296,43 +2317,95 @@ + + + + + + - - - + + + + + + + + + invlists + + + direct_map + + + + + + + + + aq + + + + + + + + + + + + + + + rq + - - + + - - - - + + + + + clustering_index + quantizer - - qnorm + + cp + + + + + + + + + + - - - - + + + + - - - - - + + cp + + + assign_index_factory @@ -2361,9 +2434,9 @@ faiss::IndexIVFResidualQuantizerdistance_t faiss::IndexIVFResidualQuantizerencode_listno faiss::IndexIVFResidualQuantizerencode_vectors - faiss::IndexIVFResidualQuantizerget_CodePacker - faiss::IndexIVFResidualQuantizerget_distance_computer - faiss::IndexIVFResidualQuantizerget_InvertedListScanner + faiss::IndexIVFResidualQuantizerget_CodePacker + faiss::IndexIVFResidualQuantizerget_distance_computer + faiss::IndexIVFResidualQuantizerget_InvertedListScanner faiss::IndexIVFResidualQuantizerget_list_size faiss::IndexIVFResidualQuantizerIndex faiss::IndexIVFResidualQuantizerIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFResidualQuantizerFastScan.xml b/xml/structfaiss_1_1IndexIVFResidualQuantizerFastScan.xml index aa492f2648..a2bf35d1cd 100644 --- a/xml/structfaiss_1_1IndexIVFResidualQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexIVFResidualQuantizerFastScan.xml @@ -1,27 +1,29 @@ - + faiss::IndexIVFResidualQuantizerFastScan faiss::IndexIVFAdditiveQuantizerFastScan - + ResidualQuantizer ResidualQuantizer faiss::IndexIVFResidualQuantizerFastScan::rq rq + faiss::IndexIVFResidualQuantizerFastScan::rq - + AdditiveQuantizer * AdditiveQuantizer* faiss::IndexIVFAdditiveQuantizerFastScan::aq aq + faiss::IndexIVFAdditiveQuantizerFastScan::aq @@ -35,6 +37,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexIVFAdditiveQuantizerFastScan::rescale_norm = false @@ -49,6 +52,7 @@ int faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::norm_scale = 1 @@ -63,6 +67,7 @@ size_t faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexIVFAdditiveQuantizerFastScan::max_train_points @@ -76,71 +81,77 @@ int faiss::IndexIVFFastScan::bbs bbs + faiss::IndexIVFFastScan::bbs - + size_t size_t faiss::IndexIVFFastScan::M M + faiss::IndexIVFFastScan::M - + size_t size_t faiss::IndexIVFFastScan::nbits nbits + faiss::IndexIVFFastScan::nbits - + size_t size_t faiss::IndexIVFFastScan::ksub ksub + faiss::IndexIVFFastScan::ksub - + size_t size_t faiss::IndexIVFFastScan::M2 M2 + faiss::IndexIVFFastScan::M2 - + int int faiss::IndexIVFFastScan::implem implem + faiss::IndexIVFFastScan::implem = 0 @@ -148,13 +159,14 @@ - + int int faiss::IndexIVFFastScan::skip skip + faiss::IndexIVFFastScan::skip = 0 @@ -162,13 +174,14 @@ - + int int faiss::IndexIVFFastScan::qbs qbs + faiss::IndexIVFFastScan::qbs = 0 @@ -176,13 +189,14 @@ - + size_t size_t faiss::IndexIVFFastScan::qbs2 qbs2 + faiss::IndexIVFFastScan::qbs2 = 0 @@ -190,13 +204,29 @@ - + + + + Quantizer * + Quantizer* faiss::IndexIVFFastScan::fine_quantizer + + fine_quantizer + faiss::IndexIVFFastScan::fine_quantizer + = nullptr + + + + + + + InvertedLists * InvertedLists* faiss::IndexIVFFastScan::orig_invlists orig_invlists + faiss::IndexIVFFastScan::orig_invlists = nullptr orig's inverted lists (for debugging) @@ -205,13 +235,14 @@ - + InvertedLists * InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -227,6 +258,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -241,6 +273,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -256,6 +289,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -273,6 +307,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -287,6 +322,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -301,6 +337,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -316,6 +353,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -330,6 +368,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -344,6 +383,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -358,6 +398,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -372,6 +413,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -386,6 +428,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -400,6 +443,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -415,6 +459,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -430,6 +475,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -445,6 +491,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -460,6 +507,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -475,6 +523,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -490,6 +539,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -504,6 +554,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -514,13 +565,14 @@ - - + + faiss::IndexIVFResidualQuantizerFastScan::IndexIVFResidualQuantizerFastScan (Index *quantizer, size_t d, size_t nlist, size_t M, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_norm_lsq2x4, int bbs=32) IndexIVFResidualQuantizerFastScan + faiss::IndexIVFResidualQuantizerFastScan::IndexIVFResidualQuantizerFastScan Index * quantizer @@ -562,26 +614,28 @@ - + faiss::IndexIVFResidualQuantizerFastScan::IndexIVFResidualQuantizerFastScan () IndexIVFResidualQuantizerFastScan + faiss::IndexIVFResidualQuantizerFastScan::IndexIVFResidualQuantizerFastScan - + void void faiss::IndexIVFAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, size_t nlist, MetricType metric, int bbs) init + faiss::IndexIVFAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -611,6 +665,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder train_encoder idx_t @@ -639,6 +694,7 @@ idx_t faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::train_encoder_num_vectors train_encoder_num_vectors @@ -654,6 +710,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexIVFAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -675,6 +732,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listno=false) const override encode_vectors + faiss::IndexIVFAdditiveQuantizerFastScan::encode_vectors encode_vectors idx_t @@ -711,6 +769,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVFAdditiveQuantizerFastScan::search search idx_t @@ -751,6 +810,7 @@ bool faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d () const override lookup_table_is_3d + faiss::IndexIVFAdditiveQuantizerFastScan::lookup_table_is_3d lookup_table_is_3d @@ -765,6 +825,7 @@ void faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< float > &dis_tables, AlignedTable< float > &biases) const override compute_LUT + faiss::IndexIVFAdditiveQuantizerFastScan::compute_LUT compute_LUT size_t @@ -794,64 +855,16 @@ - - void - void faiss::IndexIVFAdditiveQuantizerFastScan::sa_decode - (idx_t n, const uint8_t *bytes, float *x) const override - sa_decode - sa_decode - - idx_t - n - - - const uint8_t * - bytes - - - float * - x - - - - -decode a set of vectors - - -n - - -number of vectors - - - - -bytes - - -input encoded vectors, size n * sa_code_size() - - - - -x - - -output vectors, size n * d - - - - - - - - - - + void void faiss::IndexIVFFastScan::init_fastscan - (size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) + (Quantizer *fine_quantizer, size_t M, size_t nbits, size_t nlist, MetricType metric, int bbs) init_fastscan + faiss::IndexIVFFastScan::init_fastscan + + Quantizer * + fine_quantizer + size_t M @@ -873,31 +886,34 @@ bbs +called by implementations - + void void faiss::IndexIVFFastScan::init_code_packer () init_code_packer + faiss::IndexIVFFastScan::init_code_packer - + void void faiss::IndexIVFFastScan::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVFFastScan::add_with_ids add_with_ids idx_t @@ -918,13 +934,14 @@ - + void void faiss::IndexIVFFastScan::compute_LUT_uint8 (size_t n, const float *x, const CoarseQuantized &cq, AlignedTable< uint8_t > &dis_tables, AlignedTable< uint16_t > &biases, float *normalizers) const compute_LUT_uint8 + faiss::IndexIVFFastScan::compute_LUT_uint8 size_t n @@ -955,13 +972,14 @@ - + void void faiss::IndexIVFFastScan::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVFFastScan::search_preassigned search_preassigned idx_t @@ -1086,13 +1104,14 @@ - + void void faiss::IndexIVFFastScan::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVFFastScan::range_search range_search idx_t @@ -1157,13 +1176,14 @@ - + void void faiss::IndexIVFFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_dispatch_implem + faiss::IndexIVFFastScan::search_dispatch_implem idx_t n @@ -1203,13 +1223,14 @@ - + void void faiss::IndexIVFFastScan::range_search_dispatch_implem (idx_t n, const float *x, float radius, RangeSearchResult &rres, const CoarseQuantized &cq_in, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const range_search_dispatch_implem + faiss::IndexIVFFastScan::range_search_dispatch_implem idx_t n @@ -1245,7 +1266,7 @@ - + @@ -1257,6 +1278,7 @@ void faiss::IndexIVFFastScan::search_implem_1 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_1 + faiss::IndexIVFFastScan::search_implem_1 idx_t n @@ -1296,7 +1318,7 @@ - + @@ -1308,6 +1330,7 @@ void faiss::IndexIVFFastScan::search_implem_2 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_2 + faiss::IndexIVFFastScan::search_implem_2 idx_t n @@ -1347,13 +1370,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_10 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_10 + faiss::IndexIVFFastScan::search_implem_10 idx_t n @@ -1393,13 +1417,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_12 (idx_t n, const float *x, SIMDResultHandlerToFloat &handler, const CoarseQuantized &cq, size_t *ndis_out, size_t *nlist_out, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_12 + faiss::IndexIVFFastScan::search_implem_12 idx_t n @@ -1439,13 +1464,14 @@ - + void void faiss::IndexIVFFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const CoarseQuantized &cq, int impl, const NormTableScaler *scaler, const IVFSearchParameters *params=nullptr) const search_implem_14 + faiss::IndexIVFFastScan::search_implem_14 idx_t n @@ -1489,13 +1515,14 @@ - + void void faiss::IndexIVFFastScan::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFFastScan::reconstruct_from_offset reconstruct_from_offset int64_t @@ -1517,40 +1544,98 @@ - + - + CodePacker * - CodePacker* faiss::IndexIVFFastScan::get_CodePacker + CodePacker * faiss::IndexIVFFastScan::get_CodePacker () const override get_CodePacker - get_CodePacker + faiss::IndexIVFFastScan::get_CodePacker + get_CodePacker - + void void faiss::IndexIVFFastScan::reconstruct_orig_invlists () reconstruct_orig_invlists + faiss::IndexIVFFastScan::reconstruct_orig_invlists - + + + + void + void faiss::IndexIVFFastScan::sa_decode + (idx_t n, const uint8_t *bytes, float *x) const override + sa_decode + faiss::IndexIVFFastScan::sa_decode + sa_decode + + idx_t + n + + + const uint8_t * + bytes + + + float * + x + + + + +Decode a set of vectors. +NOTE: The codes in the IndexFastScan object are non-contiguous. But this method requires a contiguous representation. + + +n + + +number of vectors + + + + +bytes + + +input encoded vectors, size n * code_size + + + + +x + + +output vectors, size n * d + + + + + + + + void void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -1567,6 +1652,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -1591,6 +1677,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -1614,6 +1701,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -1663,6 +1751,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -1708,6 +1797,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1823,16 +1913,17 @@ - + InvertedListScanner * - virtual InvertedListScanner* faiss::IndexIVF::get_InvertedListScanner + virtual InvertedListScanner * faiss::IndexIVF::get_InvertedListScanner (bool store_pairs=false, const IDSelector *sel=nullptr) const get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVF::get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -1858,6 +1949,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1881,6 +1973,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1935,6 +2028,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1989,6 +2083,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -2044,6 +2139,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -2110,6 +2206,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -2131,6 +2228,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -2150,6 +2248,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -2174,6 +2273,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -2204,6 +2304,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -2221,6 +2322,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -2235,6 +2337,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -2264,6 +2367,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -2281,6 +2385,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -2304,6 +2409,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -2319,6 +2425,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -2335,7 +2442,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -2373,6 +2480,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -2439,6 +2547,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -2492,6 +2601,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -2547,6 +2657,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2609,15 +2720,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2633,6 +2745,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2663,6 +2776,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2677,6 +2791,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2698,6 +2813,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2710,13 +2826,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexIVFAdditiveQuantizerFastScan::Search_type_t @@ -2730,6 +2847,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2743,6 +2861,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2751,15 +2870,15 @@ - + - - - + + + @@ -2775,62 +2894,74 @@ - - - - - - - - - - - - - - - - + + + + - - - + + + + + + + + + - - cp + + qnorm - - assign_index_factory + + + + + + + + + + + + + + + + + - - - - - cp + + + + - - clustering_index - quantizer + + + + + - - - + + + + + @@ -2840,10 +2971,10 @@ - direct_map + invlists - invlists + direct_map @@ -2851,17 +2982,27 @@ - + aq - - - + + + + + + + fine_quantizer + + + orig_invlists + - - - + + + + + @@ -2872,68 +3013,49 @@ rq - - - - - - - orig_invlists - + + + - - - - + + + + + clustering_index + quantizer - - - - - + + cp - - - - + + + + - - - - - - - + + + - - - - - - qnorm - - - - - - - + + + + - - - - - + + cp + + + assign_index_factory - + faiss::IndexIVFResidualQuantizerFastScanadd faiss::IndexIVFResidualQuantizerFastScanadd_core @@ -2962,9 +3084,10 @@ faiss::IndexIVFResidualQuantizerFastScanencode_listno faiss::IndexIVFResidualQuantizerFastScanencode_vectors faiss::IndexIVFResidualQuantizerFastScanestimate_norm_scale - faiss::IndexIVFResidualQuantizerFastScanget_CodePacker - faiss::IndexIVFResidualQuantizerFastScanget_distance_computer - faiss::IndexIVFResidualQuantizerFastScanget_InvertedListScanner + faiss::IndexIVFResidualQuantizerFastScanfine_quantizer + faiss::IndexIVFResidualQuantizerFastScanget_CodePacker + faiss::IndexIVFResidualQuantizerFastScanget_distance_computer + faiss::IndexIVFResidualQuantizerFastScanget_InvertedListScanner faiss::IndexIVFResidualQuantizerFastScanget_list_size faiss::IndexIVFResidualQuantizerFastScanimplem faiss::IndexIVFResidualQuantizerFastScanIndex @@ -2980,7 +3103,7 @@ faiss::IndexIVFResidualQuantizerFastScanIndexIVFResidualQuantizerFastScan faiss::IndexIVFResidualQuantizerFastScaninit faiss::IndexIVFResidualQuantizerFastScaninit_code_packer - faiss::IndexIVFResidualQuantizerFastScaninit_fastscan + faiss::IndexIVFResidualQuantizerFastScaninit_fastscan faiss::IndexIVFResidualQuantizerFastScaninvlists faiss::IndexIVFResidualQuantizerFastScanis_trained faiss::IndexIVFResidualQuantizerFastScanksub @@ -3023,7 +3146,7 @@ faiss::IndexIVFResidualQuantizerFastScanreset faiss::IndexIVFResidualQuantizerFastScanrq faiss::IndexIVFResidualQuantizerFastScansa_code_size - faiss::IndexIVFResidualQuantizerFastScansa_decode + faiss::IndexIVFResidualQuantizerFastScansa_decode faiss::IndexIVFResidualQuantizerFastScansa_encode faiss::IndexIVFResidualQuantizerFastScansearch faiss::IndexIVFResidualQuantizerFastScansearch_and_reconstruct diff --git a/xml/structfaiss_1_1IndexIVFScalarQuantizer.xml b/xml/structfaiss_1_1IndexIVFScalarQuantizer.xml index 61a656a43e..81fa4a68fc 100644 --- a/xml/structfaiss_1_1IndexIVFScalarQuantizer.xml +++ b/xml/structfaiss_1_1IndexIVFScalarQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexIVFScalarQuantizer faiss::IndexIVF IndexScalarQuantizer.h - + ScalarQuantizer ScalarQuantizer faiss::IndexIVFScalarQuantizer::sq sq + faiss::IndexIVFScalarQuantizer::sq @@ -23,6 +24,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -38,6 +40,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -52,6 +55,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -67,6 +71,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -84,6 +89,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -98,6 +104,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -112,6 +119,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -127,6 +135,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -141,6 +150,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -155,6 +165,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -169,6 +180,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -183,6 +195,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -197,6 +210,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -211,6 +225,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -226,6 +241,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -241,6 +257,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -256,6 +273,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -271,6 +289,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -286,6 +305,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -301,6 +321,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -315,6 +336,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -325,13 +347,14 @@ - - + + faiss::IndexIVFScalarQuantizer::IndexIVFScalarQuantizer (Index *quantizer, size_t d, size_t nlist, ScalarQuantizer::QuantizerType qtype, MetricType metric=METRIC_L2, bool by_residual=true) IndexIVFScalarQuantizer + faiss::IndexIVFScalarQuantizer::IndexIVFScalarQuantizer Index * quantizer @@ -371,6 +394,7 @@ faiss::IndexIVFScalarQuantizer::IndexIVFScalarQuantizer () IndexIVFScalarQuantizer + faiss::IndexIVFScalarQuantizer::IndexIVFScalarQuantizer @@ -384,6 +408,7 @@ void faiss::IndexIVFScalarQuantizer::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFScalarQuantizer::train_encoder train_encoder idx_t @@ -412,6 +437,7 @@ idx_t faiss::IndexIVFScalarQuantizer::train_encoder_num_vectors () const override train_encoder_num_vectors + faiss::IndexIVFScalarQuantizer::train_encoder_num_vectors train_encoder_num_vectors @@ -427,6 +453,7 @@ void faiss::IndexIVFScalarQuantizer::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFScalarQuantizer::encode_vectors encode_vectors idx_t @@ -489,6 +516,7 @@ void faiss::IndexIVFScalarQuantizer::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) override add_core + faiss::IndexIVFScalarQuantizer::add_core add_core idx_t @@ -530,12 +558,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFScalarQuantizer::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFScalarQuantizer::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFScalarQuantizer::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -559,6 +588,7 @@ void faiss::IndexIVFScalarQuantizer::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const override reconstruct_from_offset + faiss::IndexIVFScalarQuantizer::reconstruct_from_offset reconstruct_from_offset int64_t @@ -587,6 +617,7 @@ void faiss::IndexIVFScalarQuantizer::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexIVFScalarQuantizer::sa_decode sa_decode idx_t @@ -640,6 +671,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -656,6 +688,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -680,6 +713,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -703,6 +737,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -733,6 +768,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -778,6 +814,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -912,6 +949,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1032,6 +1070,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1074,6 +1113,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1147,6 +1187,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1170,6 +1211,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1224,6 +1266,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1278,6 +1321,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1333,6 +1377,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1399,6 +1444,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1420,6 +1466,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1439,6 +1486,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1458,12 +1506,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1477,6 +1526,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1507,6 +1557,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1524,6 +1575,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1538,6 +1590,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1567,6 +1620,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1584,6 +1638,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1607,6 +1662,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1622,6 +1678,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1638,7 +1695,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1676,6 +1733,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1742,6 +1800,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1795,6 +1854,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1850,6 +1910,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1912,15 +1973,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1936,6 +1998,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -1966,6 +2029,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -1980,6 +2044,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2001,6 +2066,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2013,13 +2079,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -2033,6 +2100,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -2041,22 +2109,16 @@ - + An IVF implementation where the components of the residuals are encoded with a scalar quantizer. All distance computations are asymmetric, so the encoded vectors are decoded and approximate distances are computed. - - - - - - - - - + + + @@ -2066,47 +2128,35 @@ - - - - - - - - - - + + + + - - cp - - - clustering_index - quantizer - - - - - - - - sq - + + + + + - - + + + + + + @@ -2116,32 +2166,50 @@ - direct_map + invlists - invlists + direct_map - - - + + + + + - - - + + + + + + + sq + - - + + + + + + + + clustering_index + quantizer + + + cp + - - - - + + + + @@ -2169,9 +2237,9 @@ faiss::IndexIVFScalarQuantizerdistance_t faiss::IndexIVFScalarQuantizerencode_listno faiss::IndexIVFScalarQuantizerencode_vectors - faiss::IndexIVFScalarQuantizerget_CodePacker - faiss::IndexIVFScalarQuantizerget_distance_computer - faiss::IndexIVFScalarQuantizerget_InvertedListScanner + faiss::IndexIVFScalarQuantizerget_CodePacker + faiss::IndexIVFScalarQuantizerget_distance_computer + faiss::IndexIVFScalarQuantizerget_InvertedListScanner faiss::IndexIVFScalarQuantizerget_list_size faiss::IndexIVFScalarQuantizerIndex faiss::IndexIVFScalarQuantizerIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFSpectralHash.xml b/xml/structfaiss_1_1IndexIVFSpectralHash.xml index 55dd81a52c..b54b6effc5 100644 --- a/xml/structfaiss_1_1IndexIVFSpectralHash.xml +++ b/xml/structfaiss_1_1IndexIVFSpectralHash.xml @@ -1,13 +1,14 @@ - + faiss::IndexIVFSpectralHash faiss::IndexIVF IndexIVFSpectralHash.h - + ThresholdType + faiss::IndexIVFSpectralHash::ThresholdType Thresh_global @@ -53,6 +54,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -66,6 +68,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -74,13 +77,14 @@ - - + + VectorTransform * VectorTransform* faiss::IndexIVFSpectralHash::vt vt + faiss::IndexIVFSpectralHash::vt = nullptr transformation from d to nbit dim @@ -96,6 +100,7 @@ bool faiss::IndexIVFSpectralHash::own_fields own_fields + faiss::IndexIVFSpectralHash::own_fields = true own the vt @@ -111,6 +116,7 @@ int faiss::IndexIVFSpectralHash::nbit nbit + faiss::IndexIVFSpectralHash::nbit = 0 nb of bits of the binary signature @@ -126,6 +132,7 @@ float faiss::IndexIVFSpectralHash::period period + faiss::IndexIVFSpectralHash::period = 0 interval size for 0s and 1s @@ -141,6 +148,7 @@ ThresholdType faiss::IndexIVFSpectralHash::threshold_type threshold_type + faiss::IndexIVFSpectralHash::threshold_type = Thresh_global @@ -155,6 +163,7 @@ std::vector<float> faiss::IndexIVFSpectralHash::trained trained + faiss::IndexIVFSpectralHash::trained @@ -169,6 +178,7 @@ InvertedLists* faiss::IndexIVF::invlists invlists + faiss::IndexIVF::invlists = nullptr Access to the actual data. @@ -184,6 +194,7 @@ bool faiss::IndexIVF::own_invlists own_invlists + faiss::IndexIVF::own_invlists = false @@ -198,6 +209,7 @@ size_t faiss::IndexIVF::code_size code_size + faiss::IndexIVF::code_size = 0 code size per vector in bytes @@ -213,6 +225,7 @@ int faiss::IndexIVF::parallel_mode parallel_mode + faiss::IndexIVF::parallel_mode = 0 @@ -230,6 +243,7 @@ const int faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT PARALLEL_MODE_NO_HEAP_INIT + faiss::IndexIVF::PARALLEL_MODE_NO_HEAP_INIT = 1024 @@ -244,6 +258,7 @@ DirectMap faiss::IndexIVF::direct_map direct_map + faiss::IndexIVF::direct_map @@ -258,6 +273,7 @@ bool faiss::IndexIVF::by_residual by_residual + faiss::IndexIVF::by_residual = true @@ -273,6 +289,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -287,6 +304,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -301,6 +319,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -315,6 +334,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -329,6 +349,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -343,6 +364,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -357,6 +379,7 @@ size_t faiss::IndexIVFInterface::nprobe nprobe + faiss::IndexIVFInterface::nprobe = 1 number of probes at query time @@ -372,6 +395,7 @@ size_t faiss::IndexIVFInterface::max_codes max_codes + faiss::IndexIVFInterface::max_codes = 0 max nb of codes to visit to do a query @@ -387,6 +411,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -402,6 +427,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -417,6 +443,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -432,6 +459,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -446,6 +474,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -456,13 +485,14 @@ - - + + faiss::IndexIVFSpectralHash::IndexIVFSpectralHash (Index *quantizer, size_t d, size_t nlist, int nbit, float period) IndexIVFSpectralHash + faiss::IndexIVFSpectralHash::IndexIVFSpectralHash Index * quantizer @@ -496,6 +526,7 @@ faiss::IndexIVFSpectralHash::IndexIVFSpectralHash () IndexIVFSpectralHash + faiss::IndexIVFSpectralHash::IndexIVFSpectralHash @@ -509,6 +540,7 @@ void faiss::IndexIVFSpectralHash::train_encoder (idx_t n, const float *x, const idx_t *assign) override train_encoder + faiss::IndexIVFSpectralHash::train_encoder train_encoder idx_t @@ -537,6 +569,7 @@ void faiss::IndexIVFSpectralHash::encode_vectors (idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes, bool include_listnos=false) const override encode_vectors + faiss::IndexIVFSpectralHash::encode_vectors encode_vectors idx_t @@ -594,12 +627,13 @@ - + InvertedListScanner * - InvertedListScanner* faiss::IndexIVFSpectralHash::get_InvertedListScanner + InvertedListScanner * faiss::IndexIVFSpectralHash::get_InvertedListScanner (bool store_pairs, const IDSelector *sel) const override get_InvertedListScanner - get_InvertedListScanner + faiss::IndexIVFSpectralHash::get_InvertedListScanner + get_InvertedListScanner bool store_pairs @@ -623,6 +657,7 @@ void faiss::IndexIVFSpectralHash::replace_vt (VectorTransform *vt, bool own=false) replace_vt + faiss::IndexIVFSpectralHash::replace_vt VectorTransform * vt @@ -646,6 +681,7 @@ void faiss::IndexIVFSpectralHash::replace_vt (IndexPreTransform *index, bool own=false) replace_vt + faiss::IndexIVFSpectralHash::replace_vt IndexPreTransform * index @@ -669,6 +705,7 @@ faiss::IndexIVFSpectralHash::~IndexIVFSpectralHash () override ~IndexIVFSpectralHash + faiss::IndexIVFSpectralHash::~IndexIVFSpectralHash @@ -682,6 +719,7 @@ void faiss::IndexIVF::reset () override reset + faiss::IndexIVF::reset reset reset @@ -698,6 +736,7 @@ void faiss::IndexIVF::train (idx_t n, const float *x) override train + faiss::IndexIVF::train train train @@ -722,6 +761,7 @@ void faiss::IndexIVF::add (idx_t n, const float *x) override add + faiss::IndexIVF::add add idx_t @@ -745,6 +785,7 @@ void faiss::IndexIVF::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexIVF::add_with_ids add_with_ids add_with_ids add_with_ids @@ -775,6 +816,7 @@ virtual void faiss::IndexIVF::add_core (idx_t n, const float *x, const idx_t *xids, const idx_t *precomputed_idx, void *inverted_list_context=nullptr) add_core + faiss::IndexIVF::add_core add_core add_core add_core @@ -824,6 +866,7 @@ void faiss::IndexIVF::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) override add_sa_codes + faiss::IndexIVF::add_sa_codes add_sa_codes idx_t @@ -869,6 +912,7 @@ virtual idx_t faiss::IndexIVF::train_encoder_num_vectors () const train_encoder_num_vectors + faiss::IndexIVF::train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors train_encoder_num_vectors @@ -889,6 +933,7 @@ void faiss::IndexIVF::search_preassigned (idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override search_preassigned + faiss::IndexIVF::search_preassigned search_preassigned search_preassigned search_preassigned @@ -1023,6 +1068,7 @@ void faiss::IndexIVF::range_search_preassigned (idx_t nx, const float *x, float radius, const idx_t *keys, const float *coarse_dis, RangeSearchResult *result, bool store_pairs=false, const IVFSearchParameters *params=nullptr, IndexIVFStats *stats=nullptr) const override range_search_preassigned + faiss::IndexIVF::range_search_preassigned range_search_preassigned idx_t @@ -1143,6 +1189,7 @@ void faiss::IndexIVF::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexIVF::search search search search @@ -1185,6 +1232,7 @@ void faiss::IndexIVF::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexIVF::range_search range_search range_search range_search @@ -1258,6 +1306,7 @@ void faiss::IndexIVF::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexIVF::reconstruct reconstruct idx_t @@ -1281,6 +1330,7 @@ virtual void faiss::IndexIVF::update_vectors (int nv, const idx_t *idx, const float *v) update_vectors + faiss::IndexIVF::update_vectors update_vectors int @@ -1335,6 +1385,7 @@ void faiss::IndexIVF::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexIVF::reconstruct_n reconstruct_n idx_t @@ -1389,6 +1440,7 @@ void faiss::IndexIVF::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexIVF::search_and_reconstruct search_and_reconstruct idx_t @@ -1444,6 +1496,7 @@ void faiss::IndexIVF::search_and_return_codes (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, uint8_t *recons, bool include_listno=false, const SearchParameters *params=nullptr) const search_and_return_codes + faiss::IndexIVF::search_and_return_codes idx_t n @@ -1510,6 +1563,7 @@ virtual void faiss::IndexIVF::reconstruct_from_offset (int64_t list_no, int64_t offset, float *recons) const reconstruct_from_offset + faiss::IndexIVF::reconstruct_from_offset reconstruct_from_offset reconstruct_from_offset reconstruct_from_offset @@ -1544,6 +1598,7 @@ size_t faiss::IndexIVF::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexIVF::remove_ids remove_ids remove_ids remove_ids @@ -1565,6 +1620,7 @@ void faiss::IndexIVF::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexIVF::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1584,6 +1640,7 @@ virtual void faiss::IndexIVF::merge_from (Index &otherIndex, idx_t add_id) override merge_from + faiss::IndexIVF::merge_from merge_from merge_from @@ -1603,12 +1660,13 @@ - + CodePacker * - virtual CodePacker* faiss::IndexIVF::get_CodePacker + virtual CodePacker * faiss::IndexIVF::get_CodePacker () const get_CodePacker - get_CodePacker + faiss::IndexIVF::get_CodePacker + get_CodePacker @@ -1622,6 +1680,7 @@ virtual void faiss::IndexIVF::copy_subset_to (IndexIVF &other, InvertedLists::subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::IndexIVF::copy_subset_to IndexIVF & other @@ -1652,6 +1711,7 @@ size_t faiss::IndexIVF::get_list_size (size_t list_no) const get_list_size + faiss::IndexIVF::get_list_size size_t list_no @@ -1669,6 +1729,7 @@ bool faiss::IndexIVF::check_ids_sorted () const check_ids_sorted + faiss::IndexIVF::check_ids_sorted are the ids sorted? @@ -1683,6 +1744,7 @@ void faiss::IndexIVF::make_direct_map (bool new_maintain_direct_map=true) make_direct_map + faiss::IndexIVF::make_direct_map bool new_maintain_direct_map @@ -1712,6 +1774,7 @@ void faiss::IndexIVF::set_direct_map_type (DirectMap::Type type) set_direct_map_type + faiss::IndexIVF::set_direct_map_type DirectMap::Type type @@ -1729,6 +1792,7 @@ void faiss::IndexIVF::replace_invlists (InvertedLists *il, bool own=false) replace_invlists + faiss::IndexIVF::replace_invlists InvertedLists * il @@ -1752,6 +1816,7 @@ size_t faiss::IndexIVF::sa_code_size () const override sa_code_size + faiss::IndexIVF::sa_code_size sa_code_size @@ -1767,6 +1832,7 @@ void faiss::IndexIVF::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexIVF::sa_encode sa_encode idx_t @@ -1783,7 +1849,7 @@ -encode a set of vectors sa_encode will call encode_vector with include_listno=true +encode a set of vectors sa_encode will call encode_vectors with include_listno=true n @@ -1821,6 +1887,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1887,6 +1954,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1940,6 +2008,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1995,6 +2064,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -2057,15 +2127,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -2081,14 +2152,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -2153,6 +2224,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -2183,6 +2255,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -2197,6 +2270,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -2218,6 +2292,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -2230,7 +2305,7 @@ - + @@ -2238,15 +2313,9 @@ Each coordinate is subtracted from a value determined by threshold_type, and split into intervals of size period. Half of the interval is a 0 bit, the other half a 1. - - - - - - - - - + + + @@ -2256,45 +2325,35 @@ - - - - - - - - - - - - vt - - - cp - - - clustering_index - quantizer - + + + + + + - - + + + + + + @@ -2304,30 +2363,46 @@ - direct_map + invlists - invlists + direct_map - - - - - - - - - - - - + + + + + + + vt + + + + + + + + + + + clustering_index + quantizer + + + cp + + + + + + @@ -2353,9 +2428,9 @@ faiss::IndexIVFSpectralHashdistance_t faiss::IndexIVFSpectralHashencode_listno faiss::IndexIVFSpectralHashencode_vectors - faiss::IndexIVFSpectralHashget_CodePacker - faiss::IndexIVFSpectralHashget_distance_computer - faiss::IndexIVFSpectralHashget_InvertedListScanner + faiss::IndexIVFSpectralHashget_CodePacker + faiss::IndexIVFSpectralHashget_distance_computer + faiss::IndexIVFSpectralHashget_InvertedListScanner faiss::IndexIVFSpectralHashget_list_size faiss::IndexIVFSpectralHashIndex faiss::IndexIVFSpectralHashIndexIVF diff --git a/xml/structfaiss_1_1IndexIVFStats.xml b/xml/structfaiss_1_1IndexIVFStats.xml index 8f04c86b67..d319552f95 100644 --- a/xml/structfaiss_1_1IndexIVFStats.xml +++ b/xml/structfaiss_1_1IndexIVFStats.xml @@ -1,13 +1,14 @@ - + faiss::IndexIVFStats - + size_t size_t faiss::IndexIVFStats::nq nq + faiss::IndexIVFStats::nq @@ -21,6 +22,7 @@ size_t faiss::IndexIVFStats::nlist nlist + faiss::IndexIVFStats::nlist @@ -34,6 +36,7 @@ size_t faiss::IndexIVFStats::ndis ndis + faiss::IndexIVFStats::ndis @@ -47,6 +50,7 @@ size_t faiss::IndexIVFStats::nheap_updates nheap_updates + faiss::IndexIVFStats::nheap_updates @@ -60,6 +64,7 @@ double faiss::IndexIVFStats::quantization_time quantization_time + faiss::IndexIVFStats::quantization_time @@ -73,6 +78,7 @@ double faiss::IndexIVFStats::search_time search_time + faiss::IndexIVFStats::search_time @@ -81,13 +87,14 @@ - - + + faiss::IndexIVFStats::IndexIVFStats () IndexIVFStats + faiss::IndexIVFStats::IndexIVFStats @@ -101,6 +108,7 @@ void faiss::IndexIVFStats::reset () reset + faiss::IndexIVFStats::reset @@ -114,6 +122,7 @@ void faiss::IndexIVFStats::add (const IndexIVFStats &other) add + faiss::IndexIVFStats::add const IndexIVFStats & other @@ -126,7 +135,7 @@ - + diff --git a/xml/structfaiss_1_1IndexLSH.xml b/xml/structfaiss_1_1IndexLSH.xml index e40ae7621e..812a322271 100644 --- a/xml/structfaiss_1_1IndexLSH.xml +++ b/xml/structfaiss_1_1IndexLSH.xml @@ -1,15 +1,16 @@ - + faiss::IndexLSH faiss::IndexFlatCodes IndexLSH.h - + int int faiss::IndexLSH::nbits nbits + faiss::IndexLSH::nbits nb of bits per vector @@ -24,6 +25,7 @@ bool faiss::IndexLSH::rotate_data rotate_data + faiss::IndexLSH::rotate_data whether to apply a random rotation to input @@ -38,6 +40,7 @@ bool faiss::IndexLSH::train_thresholds train_thresholds + faiss::IndexLSH::train_thresholds whether we train thresholds or use 0 @@ -52,6 +55,7 @@ RandomRotationMatrix faiss::IndexLSH::rrot rrot + faiss::IndexLSH::rrot optional random rotation @@ -66,6 +70,7 @@ std::vector<float> faiss::IndexLSH::thresholds thresholds + faiss::IndexLSH::thresholds thresholds to compare with @@ -80,6 +85,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -93,6 +99,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -107,6 +114,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -121,6 +129,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -135,6 +144,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -149,6 +159,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -163,6 +174,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -177,6 +189,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -186,13 +199,14 @@ - - + + faiss::IndexLSH::IndexLSH (idx_t d, int nbits, bool rotate_data=true, bool train_thresholds=false) IndexLSH + faiss::IndexLSH::IndexLSH idx_t d @@ -219,11 +233,12 @@ - + const float * - const float* faiss::IndexLSH::apply_preprocess + const float * faiss::IndexLSH::apply_preprocess (idx_t n, const float *x) const apply_preprocess + faiss::IndexLSH::apply_preprocess idx_t n @@ -258,6 +273,7 @@ void faiss::IndexLSH::train (idx_t n, const float *x) override train + faiss::IndexLSH::train train idx_t @@ -299,6 +315,7 @@ void faiss::IndexLSH::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexLSH::search search idx_t @@ -339,6 +356,7 @@ void faiss::IndexLSH::transfer_thresholds (LinearTransform *vt) transfer_thresholds + faiss::IndexLSH::transfer_thresholds LinearTransform * vt @@ -357,6 +375,7 @@ faiss::IndexLSH::~IndexLSH () override ~IndexLSH + faiss::IndexLSH::~IndexLSH @@ -370,6 +389,7 @@ faiss::IndexLSH::IndexLSH () IndexLSH + faiss::IndexLSH::IndexLSH @@ -383,6 +403,7 @@ void faiss::IndexLSH::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexLSH::sa_encode sa_encode idx_t @@ -436,6 +457,7 @@ void faiss::IndexLSH::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexLSH::sa_decode sa_decode idx_t @@ -489,6 +511,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -512,6 +535,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -527,6 +551,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -580,6 +605,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -621,6 +647,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -637,6 +664,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -651,16 +679,17 @@ - + FlatCodesDistanceComputer * - virtual FlatCodesDistanceComputer* faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + virtual FlatCodesDistanceComputer * faiss::IndexFlatCodes::get_FlatCodesDistanceComputer () const get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -671,12 +700,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -692,6 +722,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -758,11 +789,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -776,6 +808,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -795,6 +828,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -819,6 +853,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -864,6 +899,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -881,6 +917,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -940,6 +977,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1006,6 +1044,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1059,6 +1098,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1156,6 +1196,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1211,6 +1252,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1273,13 +1315,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1293,6 +1336,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1301,19 +1345,31 @@ - + The sign of each vector component is put in a binary signature + + + + + + + + + + + + @@ -1324,18 +1380,6 @@ - - - - - - - - - - - - @@ -1345,21 +1389,21 @@ rrot + + + + + + - - - - - - - - - + + + @@ -1367,7 +1411,7 @@ faiss::IndexLSHadd faiss::IndexLSHadd_sa_codes faiss::IndexLSHadd_with_ids - faiss::IndexLSHapply_preprocess + faiss::IndexLSHapply_preprocess faiss::IndexLSHassign faiss::IndexLSHcheck_compatible_for_merge faiss::IndexLSHcode_size @@ -1377,9 +1421,9 @@ faiss::IndexLSHcompute_residual_n faiss::IndexLSHd faiss::IndexLSHdistance_t - faiss::IndexLSHget_CodePacker - faiss::IndexLSHget_distance_computer - faiss::IndexLSHget_FlatCodesDistanceComputer + faiss::IndexLSHget_CodePacker + faiss::IndexLSHget_distance_computer + faiss::IndexLSHget_FlatCodesDistanceComputer faiss::IndexLSHIndex faiss::IndexLSHIndexFlatCodes faiss::IndexLSHIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexLattice.xml b/xml/structfaiss_1_1IndexLattice.xml index 4d50db35b7..4f27fad38e 100644 --- a/xml/structfaiss_1_1IndexLattice.xml +++ b/xml/structfaiss_1_1IndexLattice.xml @@ -1,15 +1,16 @@ - + faiss::IndexLattice faiss::IndexFlatCodes IndexLattice.h - + int int faiss::IndexLattice::nsq nsq + faiss::IndexLattice::nsq number of sub-vectors @@ -24,6 +25,7 @@ size_t faiss::IndexLattice::dsq dsq + faiss::IndexLattice::dsq dimension of sub-vectors @@ -38,6 +40,7 @@ ZnSphereCodecAlt faiss::IndexLattice::zn_sphere_codec zn_sphere_codec + faiss::IndexLattice::zn_sphere_codec the lattice quantizer @@ -52,6 +55,7 @@ int faiss::IndexLattice::scale_nbit scale_nbit + faiss::IndexLattice::scale_nbit nb bits used to encode the scale, per subvector @@ -66,6 +70,7 @@ int faiss::IndexLattice::lattice_nbit lattice_nbit + faiss::IndexLattice::lattice_nbit @@ -79,6 +84,7 @@ std::vector<float> faiss::IndexLattice::trained trained + faiss::IndexLattice::trained mins and maxes of the vector norms, per subquantizer @@ -93,6 +99,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -106,6 +113,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -120,6 +128,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -134,6 +143,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -148,6 +158,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -162,6 +173,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -176,6 +188,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -190,6 +203,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -199,13 +213,14 @@ - - + + faiss::IndexLattice::IndexLattice (idx_t d, int nsq, int scale_nbit, int r2) IndexLattice + faiss::IndexLattice::IndexLattice idx_t d @@ -235,6 +250,7 @@ void faiss::IndexLattice::train (idx_t n, const float *x) override train + faiss::IndexLattice::train train idx_t @@ -276,6 +292,7 @@ size_t faiss::IndexLattice::sa_code_size () const override sa_code_size + faiss::IndexLattice::sa_code_size sa_code_size @@ -291,6 +308,7 @@ void faiss::IndexLattice::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexLattice::sa_encode sa_encode idx_t @@ -344,6 +362,7 @@ void faiss::IndexLattice::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexLattice::sa_decode sa_decode idx_t @@ -397,6 +416,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -420,6 +440,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -435,6 +456,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -488,6 +510,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -529,6 +552,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -543,16 +567,17 @@ - + FlatCodesDistanceComputer * - virtual FlatCodesDistanceComputer* faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + virtual FlatCodesDistanceComputer * faiss::IndexFlatCodes::get_FlatCodesDistanceComputer () const get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -563,12 +588,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -584,6 +610,7 @@ void faiss::IndexFlatCodes::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFlatCodes::search search search search @@ -627,6 +654,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -693,11 +721,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -711,6 +740,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -730,6 +760,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -754,6 +785,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -799,6 +831,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -816,6 +849,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -875,6 +909,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -941,6 +976,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -994,6 +1030,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1091,6 +1128,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1146,6 +1184,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1208,13 +1247,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1228,6 +1268,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1236,19 +1277,35 @@ - + Index that encodes a vector with a series of Zn lattice quantizers + + + + + + + + + + + + + + + + @@ -1259,23 +1316,6 @@ - - - - - - - - - znc_rec - - - - - - - - @@ -1285,10 +1325,6 @@ zn_sphere_codec - - - - @@ -1297,20 +1333,25 @@ + + + + + + + znc_rec + + + + + + + + - - - - - - - - - - @@ -1327,9 +1368,9 @@ faiss::IndexLatticed faiss::IndexLatticedistance_t faiss::IndexLatticedsq - faiss::IndexLatticeget_CodePacker - faiss::IndexLatticeget_distance_computer - faiss::IndexLatticeget_FlatCodesDistanceComputer + faiss::IndexLatticeget_CodePacker + faiss::IndexLatticeget_distance_computer + faiss::IndexLatticeget_FlatCodesDistanceComputer faiss::IndexLatticeIndex faiss::IndexLatticeIndexFlatCodes faiss::IndexLatticeIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexLocalSearchQuantizer.xml b/xml/structfaiss_1_1IndexLocalSearchQuantizer.xml index 349cf87e51..f3c5ec7753 100644 --- a/xml/structfaiss_1_1IndexLocalSearchQuantizer.xml +++ b/xml/structfaiss_1_1IndexLocalSearchQuantizer.xml @@ -1,14 +1,15 @@ - + faiss::IndexLocalSearchQuantizer faiss::IndexAdditiveQuantizer - + LocalSearchQuantizer LocalSearchQuantizer faiss::IndexLocalSearchQuantizer::lsq lsq + faiss::IndexLocalSearchQuantizer::lsq @@ -22,6 +23,7 @@ AdditiveQuantizer* faiss::IndexAdditiveQuantizer::aq aq + faiss::IndexAdditiveQuantizer::aq @@ -35,6 +37,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -48,6 +51,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -62,6 +66,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -76,6 +81,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -90,6 +96,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -104,6 +111,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -118,6 +126,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -132,6 +141,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -141,13 +151,14 @@ - - + + faiss::IndexLocalSearchQuantizer::IndexLocalSearchQuantizer (int d, size_t M, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexLocalSearchQuantizer + faiss::IndexLocalSearchQuantizer::IndexLocalSearchQuantizer int d @@ -216,6 +227,7 @@ faiss::IndexLocalSearchQuantizer::IndexLocalSearchQuantizer () IndexLocalSearchQuantizer + faiss::IndexLocalSearchQuantizer::IndexLocalSearchQuantizer @@ -229,6 +241,7 @@ void faiss::IndexLocalSearchQuantizer::train (idx_t n, const float *x) override train + faiss::IndexLocalSearchQuantizer::train train idx_t @@ -270,6 +283,7 @@ void faiss::IndexAdditiveQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizer::search search idx_t @@ -353,6 +367,7 @@ void faiss::IndexAdditiveQuantizer::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexAdditiveQuantizer::sa_encode sa_encode idx_t @@ -406,6 +421,7 @@ void faiss::IndexAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizer::sa_decode sa_decode idx_t @@ -454,12 +470,13 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -475,6 +492,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -498,6 +516,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -513,6 +532,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -566,6 +586,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -607,6 +628,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -623,6 +645,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -637,12 +660,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -658,6 +682,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -724,11 +749,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -742,6 +768,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -761,6 +788,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -785,6 +813,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -830,6 +859,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -847,6 +877,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -906,6 +937,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -972,6 +1004,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1025,6 +1058,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1122,6 +1156,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1177,6 +1212,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1239,13 +1275,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizer::Search_type_t @@ -1259,6 +1296,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1272,6 +1310,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1280,17 +1319,15 @@ - + - - - - - + + + @@ -1298,38 +1335,40 @@ - - - - - - - - lsq + + + + + + + + + + qnorm - - - + + + - - - - + + + + - - icm_encoder_factory + + aq @@ -1344,13 +1383,10 @@ - - - - - - - aq + + + + @@ -1359,28 +1395,31 @@ - - - + + + + + + + lsq + - - - - + + + + - - qnorm + + icm_encoder_factory - - - - - + + + @@ -1398,9 +1437,9 @@ faiss::IndexLocalSearchQuantizercompute_residual_n faiss::IndexLocalSearchQuantizerd faiss::IndexLocalSearchQuantizerdistance_t - faiss::IndexLocalSearchQuantizerget_CodePacker - faiss::IndexLocalSearchQuantizerget_distance_computer - faiss::IndexLocalSearchQuantizerget_FlatCodesDistanceComputer + faiss::IndexLocalSearchQuantizerget_CodePacker + faiss::IndexLocalSearchQuantizerget_distance_computer + faiss::IndexLocalSearchQuantizerget_FlatCodesDistanceComputer faiss::IndexLocalSearchQuantizerIndex faiss::IndexLocalSearchQuantizerIndexAdditiveQuantizer faiss::IndexLocalSearchQuantizerIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexLocalSearchQuantizerFastScan.xml b/xml/structfaiss_1_1IndexLocalSearchQuantizerFastScan.xml index 0cb6436069..60f31c9790 100644 --- a/xml/structfaiss_1_1IndexLocalSearchQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexLocalSearchQuantizerFastScan.xml @@ -1,15 +1,16 @@ - + faiss::IndexLocalSearchQuantizerFastScan faiss::IndexAdditiveQuantizerFastScan IndexAdditiveQuantizerFastScan.h - + LocalSearchQuantizer LocalSearchQuantizer faiss::IndexLocalSearchQuantizerFastScan::lsq lsq + faiss::IndexLocalSearchQuantizerFastScan::lsq @@ -23,6 +24,7 @@ AdditiveQuantizer* faiss::IndexAdditiveQuantizerFastScan::aq aq + faiss::IndexAdditiveQuantizerFastScan::aq @@ -36,6 +38,7 @@ bool faiss::IndexAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexAdditiveQuantizerFastScan::rescale_norm = true @@ -50,6 +53,7 @@ int faiss::IndexAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexAdditiveQuantizerFastScan::norm_scale = 1 @@ -64,6 +68,7 @@ size_t faiss::IndexAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexAdditiveQuantizerFastScan::max_train_points = 0 @@ -78,6 +83,7 @@ int faiss::IndexFastScan::implem implem + faiss::IndexFastScan::implem = 0 @@ -92,6 +98,7 @@ int faiss::IndexFastScan::skip skip + faiss::IndexFastScan::skip = 0 @@ -106,6 +113,7 @@ int faiss::IndexFastScan::bbs bbs + faiss::IndexFastScan::bbs @@ -119,6 +127,7 @@ int faiss::IndexFastScan::qbs qbs + faiss::IndexFastScan::qbs = 0 @@ -133,6 +142,7 @@ size_t faiss::IndexFastScan::M M + faiss::IndexFastScan::M @@ -146,6 +156,7 @@ size_t faiss::IndexFastScan::nbits nbits + faiss::IndexFastScan::nbits @@ -159,6 +170,7 @@ size_t faiss::IndexFastScan::ksub ksub + faiss::IndexFastScan::ksub @@ -172,6 +184,7 @@ size_t faiss::IndexFastScan::code_size code_size + faiss::IndexFastScan::code_size @@ -185,6 +198,7 @@ size_t faiss::IndexFastScan::ntotal2 ntotal2 + faiss::IndexFastScan::ntotal2 @@ -198,6 +212,7 @@ size_t faiss::IndexFastScan::M2 M2 + faiss::IndexFastScan::M2 @@ -211,6 +226,7 @@ AlignedTable<uint8_t> faiss::IndexFastScan::codes codes + faiss::IndexFastScan::codes @@ -224,6 +240,7 @@ const uint8_t* faiss::IndexFastScan::orig_codes orig_codes + faiss::IndexFastScan::orig_codes = nullptr @@ -238,6 +255,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -252,6 +270,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -266,6 +285,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -280,6 +300,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -294,6 +315,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -308,6 +330,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -317,13 +340,14 @@ - - + + faiss::IndexLocalSearchQuantizerFastScan::IndexLocalSearchQuantizerFastScan (int d, size_t M, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_norm_lsq2x4, int bbs=32) IndexLocalSearchQuantizerFastScan + faiss::IndexLocalSearchQuantizerFastScan::IndexLocalSearchQuantizerFastScan int d @@ -413,6 +437,7 @@ faiss::IndexLocalSearchQuantizerFastScan::IndexLocalSearchQuantizerFastScan () IndexLocalSearchQuantizerFastScan + faiss::IndexLocalSearchQuantizerFastScan::IndexLocalSearchQuantizerFastScan @@ -426,6 +451,7 @@ void faiss::IndexAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, MetricType metric=METRIC_L2, int bbs=32) init + faiss::IndexAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -453,6 +479,7 @@ void faiss::IndexAdditiveQuantizerFastScan::train (idx_t n, const float *x) override train + faiss::IndexAdditiveQuantizerFastScan::train train idx_t @@ -494,6 +521,7 @@ void faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -515,6 +543,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_codes (uint8_t *codes, idx_t n, const float *x) const override compute_codes + faiss::IndexAdditiveQuantizerFastScan::compute_codes compute_codes uint8_t * @@ -541,6 +570,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT (float *lut, idx_t n, const float *x) const override compute_float_LUT + faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT compute_float_LUT float * @@ -567,6 +597,7 @@ void faiss::IndexAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizerFastScan::search search idx_t @@ -650,6 +681,7 @@ void faiss::IndexAdditiveQuantizerFastScan::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizerFastScan::sa_decode sa_decode idx_t @@ -704,6 +736,7 @@ void faiss::IndexFastScan::init_fastscan (int d, size_t M, size_t nbits, MetricType metric, int bbs) init_fastscan + faiss::IndexFastScan::init_fastscan int d @@ -737,6 +770,7 @@ void faiss::IndexFastScan::reset () override reset + faiss::IndexFastScan::reset reset removes all elements from the database. @@ -752,6 +786,7 @@ void faiss::IndexFastScan::add (idx_t n, const float *x) override add + faiss::IndexFastScan::add add idx_t @@ -793,6 +828,7 @@ void faiss::IndexFastScan::compute_quantized_LUT (idx_t n, const float *x, uint8_t *lut, float *normalizers) const compute_quantized_LUT + faiss::IndexFastScan::compute_quantized_LUT idx_t n @@ -829,6 +865,7 @@ void faiss::IndexFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_dispatch_implem + faiss::IndexFastScan::search_dispatch_implem idx_t n @@ -871,6 +908,7 @@ void faiss::IndexFastScan::search_implem_234 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_implem_234 + faiss::IndexFastScan::search_implem_234 idx_t n @@ -913,6 +951,7 @@ void faiss::IndexFastScan::search_implem_12 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_12 + faiss::IndexFastScan::search_implem_12 idx_t n @@ -959,6 +998,7 @@ void faiss::IndexFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_14 + faiss::IndexFastScan::search_implem_14 idx_t n @@ -1000,6 +1040,7 @@ void faiss::IndexFastScan::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFastScan::reconstruct reconstruct idx_t @@ -1041,6 +1082,7 @@ size_t faiss::IndexFastScan::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFastScan::remove_ids remove_ids const IDSelector & @@ -1055,11 +1097,12 @@ - + CodePacker * - CodePacker* faiss::IndexFastScan::get_CodePacker + CodePacker * faiss::IndexFastScan::get_CodePacker () const get_CodePacker + faiss::IndexFastScan::get_CodePacker @@ -1073,6 +1116,7 @@ void faiss::IndexFastScan::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFastScan::merge_from merge_from Index & @@ -1097,6 +1141,7 @@ void faiss::IndexFastScan::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFastScan::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1111,11 +1156,82 @@ + + size_t + size_t faiss::IndexFastScan::sa_code_size + () const override + sa_code_size + faiss::IndexFastScan::sa_code_size + sa_code_size + +standalone codes interface (but the codes are flattened) + + + + + + + + + void + void faiss::IndexFastScan::sa_encode + (idx_t n, const float *x, uint8_t *bytes) const override + sa_encode + faiss::IndexFastScan::sa_encode + sa_encode + + idx_t + n + + + const float * + x + + + uint8_t * + bytes + + + + +encode a set of vectors + + +n + + +number of vectors + + + + +x + + +input vectors, size n * d + + + + +bytes + + +output encoded vectors, size n * sa_code_size() + + + + + + + + + void virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -1175,6 +1291,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1253,6 +1370,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1319,6 +1437,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1372,6 +1491,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1429,6 +1549,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1526,6 +1647,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1581,6 +1703,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1643,15 +1766,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1662,97 +1786,12 @@ - - size_t - virtual size_t faiss::Index::sa_code_size - () const - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - - - -size of the produced codes in bytes - - - - - - - void - virtual void faiss::Index::sa_encode - (idx_t n, const float *x, uint8_t *bytes) const - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - - idx_t - n - - - const float * - x - - - uint8_t * - bytes - - - - -encode a set of vectors - - -n - - -number of vectors - - - - -x - - -input vectors, size n * d - - - - -bytes - - -output encoded vectors, size n * sa_code_size() - - - - - - - - - void virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1794,13 +1833,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizerFastScan::Search_type_t @@ -1814,6 +1854,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1827,6 +1868,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1835,13 +1877,23 @@ - + Index based on a local search quantizer. Stored vectors are approximated by local search quantization codes. Can also be used as a codec + + + + + + + + + + @@ -1854,6 +1906,28 @@ + + + + + + + tab + + + + + + + + + + + + + qnorm + + @@ -1863,45 +1937,41 @@ + + aq + - - - - - - - - - - - - - - + + + + - - icm_encoder_factory + + codes - + - + - + - + - - - + + + - - codes + + + + + @@ -1909,47 +1979,26 @@ - + lsq - - - - - - - - - - - - - - - - - aq - - - - - + + + - - qnorm + + icm_encoder_factory - + - - - - - + + + @@ -1972,8 +2021,8 @@ faiss::IndexLocalSearchQuantizerFastScand faiss::IndexLocalSearchQuantizerFastScandistance_t faiss::IndexLocalSearchQuantizerFastScanestimate_norm_scale - faiss::IndexLocalSearchQuantizerFastScanget_CodePacker - faiss::IndexLocalSearchQuantizerFastScanget_distance_computer + faiss::IndexLocalSearchQuantizerFastScanget_CodePacker + faiss::IndexLocalSearchQuantizerFastScanget_distance_computer faiss::IndexLocalSearchQuantizerFastScanimplem faiss::IndexLocalSearchQuantizerFastScanIndex faiss::IndexLocalSearchQuantizerFastScanIndexAdditiveQuantizerFastScan @@ -2006,9 +2055,9 @@ faiss::IndexLocalSearchQuantizerFastScanremove_ids faiss::IndexLocalSearchQuantizerFastScanrescale_norm faiss::IndexLocalSearchQuantizerFastScanreset - faiss::IndexLocalSearchQuantizerFastScansa_code_size + faiss::IndexLocalSearchQuantizerFastScansa_code_size faiss::IndexLocalSearchQuantizerFastScansa_decode - faiss::IndexLocalSearchQuantizerFastScansa_encode + faiss::IndexLocalSearchQuantizerFastScansa_encode faiss::IndexLocalSearchQuantizerFastScansearch faiss::IndexLocalSearchQuantizerFastScansearch_and_reconstruct faiss::IndexLocalSearchQuantizerFastScansearch_dispatch_implem diff --git a/xml/structfaiss_1_1IndexNNDescent.xml b/xml/structfaiss_1_1IndexNNDescent.xml index 9cc865fe25..4b06702375 100644 --- a/xml/structfaiss_1_1IndexNNDescent.xml +++ b/xml/structfaiss_1_1IndexNNDescent.xml @@ -1,16 +1,17 @@ - + faiss::IndexNNDescent faiss::Index faiss::IndexNNDescentFlat IndexNNDescent.h - + NNDescent::storage_idx_t using faiss::IndexNNDescent::storage_idx_t = NNDescent::storage_idx_t storage_idx_t + faiss::IndexNNDescent::storage_idx_t @@ -24,6 +25,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -37,6 +39,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -45,13 +48,14 @@ - - + + NNDescent NNDescent faiss::IndexNNDescent::nndescent nndescent + faiss::IndexNNDescent::nndescent Faiss results are 64-bit. @@ -66,6 +70,7 @@ bool faiss::IndexNNDescent::own_fields own_fields + faiss::IndexNNDescent::own_fields @@ -79,6 +84,7 @@ Index* faiss::IndexNNDescent::storage storage + faiss::IndexNNDescent::storage @@ -92,6 +98,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -106,6 +113,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -120,6 +128,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -134,6 +143,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -148,6 +158,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -162,6 +173,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -171,13 +183,14 @@ - - + + faiss::IndexNNDescent::IndexNNDescent (int d=0, int K=32, MetricType metric=METRIC_L2) IndexNNDescent + faiss::IndexNNDescent::IndexNNDescent int d @@ -206,6 +219,7 @@ faiss::IndexNNDescent::IndexNNDescent (Index *storage, int K=32) IndexNNDescent + faiss::IndexNNDescent::IndexNNDescent Index * storage @@ -228,6 +242,7 @@ faiss::IndexNNDescent::~IndexNNDescent () override ~IndexNNDescent + faiss::IndexNNDescent::~IndexNNDescent @@ -241,6 +256,7 @@ void faiss::IndexNNDescent::add (idx_t n, const float *x) override add + faiss::IndexNNDescent::add add idx_t @@ -282,6 +298,7 @@ void faiss::IndexNNDescent::train (idx_t n, const float *x) override train + faiss::IndexNNDescent::train train idx_t @@ -305,6 +322,7 @@ void faiss::IndexNNDescent::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexNNDescent::search search idx_t @@ -345,6 +363,7 @@ void faiss::IndexNNDescent::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexNNDescent::reconstruct reconstruct idx_t @@ -386,6 +405,7 @@ void faiss::IndexNNDescent::reset () override reset + faiss::IndexNNDescent::reset reset removes all elements from the database. @@ -401,6 +421,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -460,6 +481,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -538,6 +560,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -604,6 +627,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -628,6 +652,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -681,6 +706,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -738,6 +764,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -835,6 +862,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -890,6 +918,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -952,15 +981,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -976,6 +1006,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -997,8 +1029,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1062,14 +1096,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1134,6 +1168,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1162,6 +1197,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1184,6 +1220,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1225,23 +1262,23 @@ - + The NNDescent index is a normal random-access index with an NNDescent link structure built on top + + + + - - - - @@ -1250,25 +1287,25 @@ - - - + + + - - storage - nndescent + + storage + - - - + + + @@ -1283,7 +1320,7 @@ faiss::IndexNNDescentcompute_residual_n faiss::IndexNNDescentd faiss::IndexNNDescentdistance_t - faiss::IndexNNDescentget_distance_computer + faiss::IndexNNDescentget_distance_computer faiss::IndexNNDescentIndex faiss::IndexNNDescentIndexNNDescent faiss::IndexNNDescentIndexNNDescent diff --git a/xml/structfaiss_1_1IndexNNDescentFlat.xml b/xml/structfaiss_1_1IndexNNDescentFlat.xml index 64c020eca5..2f0f591137 100644 --- a/xml/structfaiss_1_1IndexNNDescentFlat.xml +++ b/xml/structfaiss_1_1IndexNNDescentFlat.xml @@ -1,15 +1,16 @@ - + faiss::IndexNNDescentFlat faiss::IndexNNDescent IndexNNDescent.h - + faiss::IndexNNDescentFlat::IndexNNDescentFlat () IndexNNDescentFlat + faiss::IndexNNDescentFlat::IndexNNDescentFlat @@ -23,6 +24,7 @@ faiss::IndexNNDescentFlat::IndexNNDescentFlat (int d, int K, MetricType metric=METRIC_L2) IndexNNDescentFlat + faiss::IndexNNDescentFlat::IndexNNDescentFlat int d @@ -49,6 +51,7 @@ void faiss::IndexNNDescent::add (idx_t n, const float *x) override add + faiss::IndexNNDescent::add add idx_t @@ -90,6 +93,7 @@ void faiss::IndexNNDescent::train (idx_t n, const float *x) override train + faiss::IndexNNDescent::train train idx_t @@ -113,6 +117,7 @@ void faiss::IndexNNDescent::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexNNDescent::search search idx_t @@ -153,6 +158,7 @@ void faiss::IndexNNDescent::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexNNDescent::reconstruct reconstruct idx_t @@ -194,6 +200,7 @@ void faiss::IndexNNDescent::reset () override reset + faiss::IndexNNDescent::reset reset removes all elements from the database. @@ -209,6 +216,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -268,6 +276,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -346,6 +355,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -412,6 +422,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -436,6 +447,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -489,6 +501,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -546,6 +559,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -643,6 +657,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -698,6 +713,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -760,15 +776,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -784,6 +801,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -805,8 +824,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -870,14 +891,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -942,6 +963,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -970,6 +992,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -992,6 +1015,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1033,13 +1057,14 @@ - - + + NNDescent::storage_idx_t using faiss::IndexNNDescent::storage_idx_t = NNDescent::storage_idx_t storage_idx_t + faiss::IndexNNDescent::storage_idx_t @@ -1053,6 +1078,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1066,6 +1092,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1074,13 +1101,14 @@ - - + + NNDescent NNDescent faiss::IndexNNDescent::nndescent nndescent + faiss::IndexNNDescent::nndescent Faiss results are 64-bit. @@ -1095,6 +1123,7 @@ bool faiss::IndexNNDescent::own_fields own_fields + faiss::IndexNNDescent::own_fields @@ -1108,6 +1137,7 @@ Index* faiss::IndexNNDescent::storage storage + faiss::IndexNNDescent::storage @@ -1121,6 +1151,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1135,6 +1166,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1149,6 +1181,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1163,6 +1196,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1177,6 +1211,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1191,6 +1226,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1200,23 +1236,23 @@ - + Flat index topped with with a NNDescent structure to access elements more efficiently. + + + + - - - - @@ -1225,25 +1261,21 @@ - - - + + + - - storage - nndescent - - - - + + storage + @@ -1251,6 +1283,10 @@ + + + + @@ -1264,7 +1300,7 @@ faiss::IndexNNDescentFlatcompute_residual_n faiss::IndexNNDescentFlatd faiss::IndexNNDescentFlatdistance_t - faiss::IndexNNDescentFlatget_distance_computer + faiss::IndexNNDescentFlatget_distance_computer faiss::IndexNNDescentFlatIndex faiss::IndexNNDescentFlatIndexNNDescent faiss::IndexNNDescentFlatIndexNNDescent diff --git a/xml/structfaiss_1_1IndexNSG.xml b/xml/structfaiss_1_1IndexNSG.xml index 260cad671f..4d0476ce8d 100644 --- a/xml/structfaiss_1_1IndexNSG.xml +++ b/xml/structfaiss_1_1IndexNSG.xml @@ -1,5 +1,5 @@ - + faiss::IndexNSG faiss::Index @@ -7,12 +7,13 @@ faiss::IndexNSGPQ faiss::IndexNSGSQ IndexNSG.h - + NSG NSG faiss::IndexNSG::nsg nsg + faiss::IndexNSG::nsg the link structure @@ -27,6 +28,7 @@ bool faiss::IndexNSG::own_fields own_fields + faiss::IndexNSG::own_fields = false the sequential storage @@ -42,6 +44,7 @@ Index* faiss::IndexNSG::storage storage + faiss::IndexNSG::storage = nullptr @@ -56,6 +59,7 @@ bool faiss::IndexNSG::is_built is_built + faiss::IndexNSG::is_built = false the index is built or not @@ -71,6 +75,7 @@ int faiss::IndexNSG::GK GK + faiss::IndexNSG::GK = 64 K of KNN graph for building. @@ -86,6 +91,7 @@ char faiss::IndexNSG::build_type build_type + faiss::IndexNSG::build_type = 0 @@ -105,6 +111,7 @@ int faiss::IndexNSG::nndescent_S nndescent_S + faiss::IndexNSG::nndescent_S = 10 parameters for nndescent @@ -120,6 +127,7 @@ int faiss::IndexNSG::nndescent_R nndescent_R + faiss::IndexNSG::nndescent_R = 100 @@ -134,6 +142,7 @@ int faiss::IndexNSG::nndescent_L nndescent_L + faiss::IndexNSG::nndescent_L @@ -147,6 +156,7 @@ int faiss::IndexNSG::nndescent_iter nndescent_iter + faiss::IndexNSG::nndescent_iter = 10 @@ -161,6 +171,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -175,6 +186,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -189,6 +201,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -203,6 +216,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -217,6 +231,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -231,6 +246,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -240,13 +256,14 @@ - - + + faiss::IndexNSG::IndexNSG (int d=0, int R=32, MetricType metric=METRIC_L2) IndexNSG + faiss::IndexNSG::IndexNSG int d @@ -275,6 +292,7 @@ faiss::IndexNSG::IndexNSG (Index *storage, int R=32) IndexNSG + faiss::IndexNSG::IndexNSG Index * storage @@ -297,6 +315,7 @@ faiss::IndexNSG::~IndexNSG () override ~IndexNSG + faiss::IndexNSG::~IndexNSG @@ -310,6 +329,7 @@ void faiss::IndexNSG::build (idx_t n, const float *x, idx_t *knn_graph, int GK) build + faiss::IndexNSG::build idx_t n @@ -339,6 +359,7 @@ void faiss::IndexNSG::add (idx_t n, const float *x) override add + faiss::IndexNSG::add add idx_t @@ -380,6 +401,7 @@ void faiss::IndexNSG::train (idx_t n, const float *x) override train + faiss::IndexNSG::train train train @@ -404,6 +426,7 @@ void faiss::IndexNSG::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexNSG::search search idx_t @@ -444,6 +467,7 @@ void faiss::IndexNSG::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexNSG::reconstruct reconstruct idx_t @@ -485,6 +509,7 @@ void faiss::IndexNSG::reset () override reset + faiss::IndexNSG::reset reset removes all elements from the database. @@ -500,6 +525,7 @@ void faiss::IndexNSG::check_knn_graph (const idx_t *knn_graph, idx_t n, int K) const check_knn_graph + faiss::IndexNSG::check_knn_graph const idx_t * knn_graph @@ -525,6 +551,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -584,6 +611,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -662,6 +690,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -728,6 +757,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -752,6 +782,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -805,6 +836,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -862,6 +894,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -959,6 +992,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1014,6 +1048,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1076,15 +1111,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1100,6 +1136,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1121,8 +1159,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1186,14 +1226,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1258,6 +1298,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1286,6 +1327,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1308,6 +1350,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1349,13 +1392,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1369,6 +1413,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1377,25 +1422,13 @@ - + The NSG index is a normal random-access index with a NSG link structure built on top - - - - - - - - - - - - @@ -1412,19 +1445,20 @@ - - - - + + + + - - - - - rng + + + + + + @@ -1441,6 +1475,17 @@ storage + + + + + rng + + + + + + @@ -1457,7 +1502,7 @@ faiss::IndexNSGcompute_residual_n faiss::IndexNSGd faiss::IndexNSGdistance_t - faiss::IndexNSGget_distance_computer + faiss::IndexNSGget_distance_computer faiss::IndexNSGGK faiss::IndexNSGIndex faiss::IndexNSGIndexNSG diff --git a/xml/structfaiss_1_1IndexNSGFlat.xml b/xml/structfaiss_1_1IndexNSGFlat.xml index 131deeda0f..9e392f8172 100644 --- a/xml/structfaiss_1_1IndexNSGFlat.xml +++ b/xml/structfaiss_1_1IndexNSGFlat.xml @@ -1,15 +1,16 @@ - + faiss::IndexNSGFlat faiss::IndexNSG IndexNSG.h - + faiss::IndexNSGFlat::IndexNSGFlat () IndexNSGFlat + faiss::IndexNSGFlat::IndexNSGFlat @@ -23,6 +24,7 @@ faiss::IndexNSGFlat::IndexNSGFlat (int d, int R, MetricType metric=METRIC_L2) IndexNSGFlat + faiss::IndexNSGFlat::IndexNSGFlat int d @@ -49,6 +51,7 @@ void faiss::IndexNSG::build (idx_t n, const float *x, idx_t *knn_graph, int GK) build + faiss::IndexNSG::build idx_t n @@ -78,6 +81,7 @@ void faiss::IndexNSG::add (idx_t n, const float *x) override add + faiss::IndexNSG::add add idx_t @@ -119,6 +123,7 @@ void faiss::IndexNSG::train (idx_t n, const float *x) override train + faiss::IndexNSG::train train train @@ -143,6 +148,7 @@ void faiss::IndexNSG::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexNSG::search search idx_t @@ -183,6 +189,7 @@ void faiss::IndexNSG::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexNSG::reconstruct reconstruct idx_t @@ -224,6 +231,7 @@ void faiss::IndexNSG::reset () override reset + faiss::IndexNSG::reset reset removes all elements from the database. @@ -239,6 +247,7 @@ void faiss::IndexNSG::check_knn_graph (const idx_t *knn_graph, idx_t n, int K) const check_knn_graph + faiss::IndexNSG::check_knn_graph const idx_t * knn_graph @@ -264,6 +273,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -323,6 +333,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -401,6 +412,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -467,6 +479,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -491,6 +504,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -544,6 +558,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -601,6 +616,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -698,6 +714,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -753,6 +770,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -815,15 +833,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -839,6 +858,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -860,8 +881,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -925,14 +948,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -997,6 +1020,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1025,6 +1049,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1047,6 +1072,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1088,13 +1114,14 @@ - - + + NSG NSG faiss::IndexNSG::nsg nsg + faiss::IndexNSG::nsg the link structure @@ -1109,6 +1136,7 @@ bool faiss::IndexNSG::own_fields own_fields + faiss::IndexNSG::own_fields = false the sequential storage @@ -1124,6 +1152,7 @@ Index* faiss::IndexNSG::storage storage + faiss::IndexNSG::storage = nullptr @@ -1138,6 +1167,7 @@ bool faiss::IndexNSG::is_built is_built + faiss::IndexNSG::is_built = false the index is built or not @@ -1153,6 +1183,7 @@ int faiss::IndexNSG::GK GK + faiss::IndexNSG::GK = 64 K of KNN graph for building. @@ -1168,6 +1199,7 @@ char faiss::IndexNSG::build_type build_type + faiss::IndexNSG::build_type = 0 @@ -1187,6 +1219,7 @@ int faiss::IndexNSG::nndescent_S nndescent_S + faiss::IndexNSG::nndescent_S = 10 parameters for nndescent @@ -1202,6 +1235,7 @@ int faiss::IndexNSG::nndescent_R nndescent_R + faiss::IndexNSG::nndescent_R = 100 @@ -1216,6 +1250,7 @@ int faiss::IndexNSG::nndescent_L nndescent_L + faiss::IndexNSG::nndescent_L @@ -1229,6 +1264,7 @@ int faiss::IndexNSG::nndescent_iter nndescent_iter + faiss::IndexNSG::nndescent_iter = 10 @@ -1243,6 +1279,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1257,6 +1294,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1271,6 +1309,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1285,6 +1324,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1299,6 +1339,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1313,6 +1354,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1322,13 +1364,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1342,6 +1385,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1350,7 +1394,7 @@ - + @@ -1375,17 +1419,6 @@ - - - - - - - - - rng - - @@ -1408,6 +1441,17 @@ + + + + + rng + + + + + + @@ -1424,7 +1468,7 @@ faiss::IndexNSGFlatcompute_residual_n faiss::IndexNSGFlatd faiss::IndexNSGFlatdistance_t - faiss::IndexNSGFlatget_distance_computer + faiss::IndexNSGFlatget_distance_computer faiss::IndexNSGFlatGK faiss::IndexNSGFlatIndex faiss::IndexNSGFlatIndexNSG diff --git a/xml/structfaiss_1_1IndexNSGPQ.xml b/xml/structfaiss_1_1IndexNSGPQ.xml index 203600108f..8f638d0a54 100644 --- a/xml/structfaiss_1_1IndexNSGPQ.xml +++ b/xml/structfaiss_1_1IndexNSGPQ.xml @@ -1,15 +1,16 @@ - + faiss::IndexNSGPQ faiss::IndexNSG IndexNSG.h - + faiss::IndexNSGPQ::IndexNSGPQ () IndexNSGPQ + faiss::IndexNSGPQ::IndexNSGPQ @@ -23,6 +24,7 @@ faiss::IndexNSGPQ::IndexNSGPQ (int d, int pq_m, int M, int pq_nbits=8) IndexNSGPQ + faiss::IndexNSGPQ::IndexNSGPQ int d @@ -53,6 +55,7 @@ void faiss::IndexNSGPQ::train (idx_t n, const float *x) override train + faiss::IndexNSGPQ::train train idx_t @@ -76,6 +79,7 @@ void faiss::IndexNSG::build (idx_t n, const float *x, idx_t *knn_graph, int GK) build + faiss::IndexNSG::build idx_t n @@ -105,6 +109,7 @@ void faiss::IndexNSG::add (idx_t n, const float *x) override add + faiss::IndexNSG::add add idx_t @@ -146,6 +151,7 @@ void faiss::IndexNSG::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexNSG::search search idx_t @@ -186,6 +192,7 @@ void faiss::IndexNSG::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexNSG::reconstruct reconstruct idx_t @@ -227,6 +234,7 @@ void faiss::IndexNSG::reset () override reset + faiss::IndexNSG::reset reset removes all elements from the database. @@ -242,6 +250,7 @@ void faiss::IndexNSG::check_knn_graph (const idx_t *knn_graph, idx_t n, int K) const check_knn_graph + faiss::IndexNSG::check_knn_graph const idx_t * knn_graph @@ -267,6 +276,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -326,6 +336,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -404,6 +415,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -470,6 +482,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -494,6 +507,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -547,6 +561,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -604,6 +619,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -701,6 +717,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -756,6 +773,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -818,15 +836,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -842,6 +861,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -863,8 +884,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -928,14 +951,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1000,6 +1023,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1028,6 +1052,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1050,6 +1075,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1091,13 +1117,14 @@ - - + + NSG NSG faiss::IndexNSG::nsg nsg + faiss::IndexNSG::nsg the link structure @@ -1112,6 +1139,7 @@ bool faiss::IndexNSG::own_fields own_fields + faiss::IndexNSG::own_fields = false the sequential storage @@ -1127,6 +1155,7 @@ Index* faiss::IndexNSG::storage storage + faiss::IndexNSG::storage = nullptr @@ -1141,6 +1170,7 @@ bool faiss::IndexNSG::is_built is_built + faiss::IndexNSG::is_built = false the index is built or not @@ -1156,6 +1186,7 @@ int faiss::IndexNSG::GK GK + faiss::IndexNSG::GK = 64 K of KNN graph for building. @@ -1171,6 +1202,7 @@ char faiss::IndexNSG::build_type build_type + faiss::IndexNSG::build_type = 0 @@ -1190,6 +1222,7 @@ int faiss::IndexNSG::nndescent_S nndescent_S + faiss::IndexNSG::nndescent_S = 10 parameters for nndescent @@ -1205,6 +1238,7 @@ int faiss::IndexNSG::nndescent_R nndescent_R + faiss::IndexNSG::nndescent_R = 100 @@ -1219,6 +1253,7 @@ int faiss::IndexNSG::nndescent_L nndescent_L + faiss::IndexNSG::nndescent_L @@ -1232,6 +1267,7 @@ int faiss::IndexNSG::nndescent_iter nndescent_iter + faiss::IndexNSG::nndescent_iter = 10 @@ -1246,6 +1282,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1260,6 +1297,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1274,6 +1312,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1288,6 +1327,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1302,6 +1342,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1316,6 +1357,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1325,13 +1367,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1345,6 +1388,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1353,19 +1397,13 @@ - + PQ index topped with with a NSG structure to access elements more efficiently. - - - - - - @@ -1376,25 +1414,14 @@ - - - - - - - - - - - rng - - + + @@ -1411,6 +1438,23 @@ storage + + + + + + + + + + + rng + + + + + + @@ -1427,7 +1471,7 @@ faiss::IndexNSGPQcompute_residual_n faiss::IndexNSGPQd faiss::IndexNSGPQdistance_t - faiss::IndexNSGPQget_distance_computer + faiss::IndexNSGPQget_distance_computer faiss::IndexNSGPQGK faiss::IndexNSGPQIndex faiss::IndexNSGPQIndexNSG diff --git a/xml/structfaiss_1_1IndexNSGSQ.xml b/xml/structfaiss_1_1IndexNSGSQ.xml index 83a9442808..2e4b892271 100644 --- a/xml/structfaiss_1_1IndexNSGSQ.xml +++ b/xml/structfaiss_1_1IndexNSGSQ.xml @@ -1,15 +1,16 @@ - + faiss::IndexNSGSQ faiss::IndexNSG IndexNSG.h - + faiss::IndexNSGSQ::IndexNSGSQ () IndexNSGSQ + faiss::IndexNSGSQ::IndexNSGSQ @@ -23,6 +24,7 @@ faiss::IndexNSGSQ::IndexNSGSQ (int d, ScalarQuantizer::QuantizerType qtype, int M, MetricType metric=METRIC_L2) IndexNSGSQ + faiss::IndexNSGSQ::IndexNSGSQ int d @@ -53,6 +55,7 @@ void faiss::IndexNSG::build (idx_t n, const float *x, idx_t *knn_graph, int GK) build + faiss::IndexNSG::build idx_t n @@ -82,6 +85,7 @@ void faiss::IndexNSG::add (idx_t n, const float *x) override add + faiss::IndexNSG::add add idx_t @@ -123,6 +127,7 @@ void faiss::IndexNSG::train (idx_t n, const float *x) override train + faiss::IndexNSG::train train train @@ -147,6 +152,7 @@ void faiss::IndexNSG::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexNSG::search search idx_t @@ -187,6 +193,7 @@ void faiss::IndexNSG::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexNSG::reconstruct reconstruct idx_t @@ -228,6 +235,7 @@ void faiss::IndexNSG::reset () override reset + faiss::IndexNSG::reset reset removes all elements from the database. @@ -243,6 +251,7 @@ void faiss::IndexNSG::check_knn_graph (const idx_t *knn_graph, idx_t n, int K) const check_knn_graph + faiss::IndexNSG::check_knn_graph const idx_t * knn_graph @@ -268,6 +277,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -327,6 +337,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -405,6 +416,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -471,6 +483,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -495,6 +508,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -548,6 +562,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -605,6 +620,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -702,6 +718,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -757,6 +774,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -819,15 +837,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -843,6 +862,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -864,8 +885,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -929,14 +952,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1001,6 +1024,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1029,6 +1053,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1051,6 +1076,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1092,13 +1118,14 @@ - - + + NSG NSG faiss::IndexNSG::nsg nsg + faiss::IndexNSG::nsg the link structure @@ -1113,6 +1140,7 @@ bool faiss::IndexNSG::own_fields own_fields + faiss::IndexNSG::own_fields = false the sequential storage @@ -1128,6 +1156,7 @@ Index* faiss::IndexNSG::storage storage + faiss::IndexNSG::storage = nullptr @@ -1142,6 +1171,7 @@ bool faiss::IndexNSG::is_built is_built + faiss::IndexNSG::is_built = false the index is built or not @@ -1157,6 +1187,7 @@ int faiss::IndexNSG::GK GK + faiss::IndexNSG::GK = 64 K of KNN graph for building. @@ -1172,6 +1203,7 @@ char faiss::IndexNSG::build_type build_type + faiss::IndexNSG::build_type = 0 @@ -1191,6 +1223,7 @@ int faiss::IndexNSG::nndescent_S nndescent_S + faiss::IndexNSG::nndescent_S = 10 parameters for nndescent @@ -1206,6 +1239,7 @@ int faiss::IndexNSG::nndescent_R nndescent_R + faiss::IndexNSG::nndescent_R = 100 @@ -1220,6 +1254,7 @@ int faiss::IndexNSG::nndescent_L nndescent_L + faiss::IndexNSG::nndescent_L @@ -1233,6 +1268,7 @@ int faiss::IndexNSG::nndescent_iter nndescent_iter + faiss::IndexNSG::nndescent_iter = 10 @@ -1247,6 +1283,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1261,6 +1298,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1275,6 +1313,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1289,6 +1328,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1303,6 +1343,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1317,6 +1358,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1326,13 +1368,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1346,6 +1389,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1354,19 +1398,13 @@ - + SQ index topped with with a NSG structure to access elements more efficiently. - - - - - - @@ -1377,25 +1415,14 @@ - - - - - - - - - - - rng - - + + @@ -1412,6 +1439,23 @@ storage + + + + + + + + + + + rng + + + + + + @@ -1428,7 +1472,7 @@ faiss::IndexNSGSQcompute_residual_n faiss::IndexNSGSQd faiss::IndexNSGSQdistance_t - faiss::IndexNSGSQget_distance_computer + faiss::IndexNSGSQget_distance_computer faiss::IndexNSGSQGK faiss::IndexNSGSQIndex faiss::IndexNSGSQIndexNSG diff --git a/xml/structfaiss_1_1IndexNeuralNetCodec.xml b/xml/structfaiss_1_1IndexNeuralNetCodec.xml index c5d57b5c4a..6b03989551 100644 --- a/xml/structfaiss_1_1IndexNeuralNetCodec.xml +++ b/xml/structfaiss_1_1IndexNeuralNetCodec.xml @@ -1,15 +1,16 @@ - + faiss::IndexNeuralNetCodec faiss::IndexFlatCodes faiss::IndexQINCo - + NeuralNetCodec * NeuralNetCodec* faiss::IndexNeuralNetCodec::net net + faiss::IndexNeuralNetCodec::net = nullptr @@ -24,6 +25,7 @@ size_t faiss::IndexNeuralNetCodec::M M + faiss::IndexNeuralNetCodec::M @@ -37,6 +39,7 @@ size_t faiss::IndexNeuralNetCodec::nbits nbits + faiss::IndexNeuralNetCodec::nbits @@ -50,6 +53,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -63,6 +67,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -77,6 +82,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -91,6 +97,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -105,6 +112,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -119,6 +127,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -133,6 +142,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -147,6 +157,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -156,13 +167,14 @@ - - + + faiss::IndexNeuralNetCodec::IndexNeuralNetCodec (int d=0, int M=0, int nbits=0, MetricType metric=METRIC_L2) IndexNeuralNetCodec + faiss::IndexNeuralNetCodec::IndexNeuralNetCodec int d @@ -196,6 +208,7 @@ void faiss::IndexNeuralNetCodec::train (idx_t n, const float *x) override train + faiss::IndexNeuralNetCodec::train train idx_t @@ -237,6 +250,7 @@ void faiss::IndexNeuralNetCodec::sa_encode (idx_t n, const float *x, uint8_t *codes) const override sa_encode + faiss::IndexNeuralNetCodec::sa_encode sa_encode idx_t @@ -290,6 +304,7 @@ void faiss::IndexNeuralNetCodec::sa_decode (idx_t n, const uint8_t *codes, float *x) const override sa_decode + faiss::IndexNeuralNetCodec::sa_decode sa_decode idx_t @@ -343,6 +358,7 @@ faiss::IndexNeuralNetCodec::~IndexNeuralNetCodec () ~IndexNeuralNetCodec + faiss::IndexNeuralNetCodec::~IndexNeuralNetCodec @@ -356,6 +372,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -379,6 +396,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -394,6 +412,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -447,6 +466,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -488,6 +508,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -504,6 +525,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -518,16 +540,17 @@ - + FlatCodesDistanceComputer * - virtual FlatCodesDistanceComputer* faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + virtual FlatCodesDistanceComputer * faiss::IndexFlatCodes::get_FlatCodesDistanceComputer () const get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -538,12 +561,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -559,6 +583,7 @@ void faiss::IndexFlatCodes::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFlatCodes::search search search search @@ -602,6 +627,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -668,11 +694,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -686,6 +713,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -705,6 +733,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -729,6 +758,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -774,6 +804,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -791,6 +822,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -850,6 +882,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -916,6 +949,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -969,6 +1003,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1066,6 +1101,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1121,6 +1157,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1183,13 +1220,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1203,6 +1241,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1211,36 +1250,46 @@ - + + + + + + + + + + + - - - - + + + + + + - - @@ -1250,20 +1299,10 @@ net - - - - - - - - - - @@ -1279,9 +1318,9 @@ faiss::IndexNeuralNetCodeccompute_residual_n faiss::IndexNeuralNetCodecd faiss::IndexNeuralNetCodecdistance_t - faiss::IndexNeuralNetCodecget_CodePacker - faiss::IndexNeuralNetCodecget_distance_computer - faiss::IndexNeuralNetCodecget_FlatCodesDistanceComputer + faiss::IndexNeuralNetCodecget_CodePacker + faiss::IndexNeuralNetCodecget_distance_computer + faiss::IndexNeuralNetCodecget_FlatCodesDistanceComputer faiss::IndexNeuralNetCodecIndex faiss::IndexNeuralNetCodecIndexFlatCodes faiss::IndexNeuralNetCodecIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexPQ.xml b/xml/structfaiss_1_1IndexPQ.xml index 6d806d40a9..bff8b4c5f0 100644 --- a/xml/structfaiss_1_1IndexPQ.xml +++ b/xml/structfaiss_1_1IndexPQ.xml @@ -1,13 +1,14 @@ - + faiss::IndexPQ faiss::IndexFlatCodes IndexPQ.h - + Search_type_t + faiss::IndexPQ::Search_type_t ST_PQ @@ -70,6 +71,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -83,6 +85,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -91,13 +94,14 @@ - - + + ProductQuantizer ProductQuantizer faiss::IndexPQ::pq pq + faiss::IndexPQ::pq The product quantizer used to encode the vectors. @@ -112,6 +116,7 @@ bool faiss::IndexPQ::do_polysemous_training do_polysemous_training + faiss::IndexPQ::do_polysemous_training false = standard PQ @@ -126,6 +131,7 @@ PolysemousTraining faiss::IndexPQ::polysemous_training polysemous_training + faiss::IndexPQ::polysemous_training parameters used for the polysemous training @@ -140,6 +146,7 @@ Search_type_t faiss::IndexPQ::search_type search_type + faiss::IndexPQ::search_type @@ -153,6 +160,7 @@ bool faiss::IndexPQ::encode_signs encode_signs + faiss::IndexPQ::encode_signs @@ -166,6 +174,7 @@ int faiss::IndexPQ::polysemous_ht polysemous_ht + faiss::IndexPQ::polysemous_ht Hamming threshold used for polysemy. @@ -180,6 +189,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -193,6 +203,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -207,6 +218,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -221,6 +233,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -235,6 +248,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -249,6 +263,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -263,6 +278,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -277,6 +293,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -286,13 +303,14 @@ - - + + faiss::IndexPQ::IndexPQ (int d, size_t M, size_t nbits, MetricType metric=METRIC_L2) IndexPQ + faiss::IndexPQ::IndexPQ int d @@ -350,6 +368,7 @@ faiss::IndexPQ::IndexPQ () IndexPQ + faiss::IndexPQ::IndexPQ @@ -363,6 +382,7 @@ void faiss::IndexPQ::train (idx_t n, const float *x) override train + faiss::IndexPQ::train train idx_t @@ -404,6 +424,7 @@ void faiss::IndexPQ::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexPQ::search search idx_t @@ -444,6 +465,7 @@ void faiss::IndexPQ::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexPQ::sa_encode sa_encode idx_t @@ -497,6 +519,7 @@ void faiss::IndexPQ::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexPQ::sa_decode sa_decode idx_t @@ -545,12 +568,13 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexPQ::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexPQ::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexPQ::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -566,6 +590,7 @@ void faiss::IndexPQ::search_core_polysemous (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int polysemous_ht, bool generalized_hamming) const search_core_polysemous + faiss::IndexPQ::search_core_polysemous idx_t n @@ -607,6 +632,7 @@ void faiss::IndexPQ::hamming_distance_histogram (idx_t n, const float *x, idx_t nb, const float *xb, int64_t *dist_histogram) hamming_distance_histogram + faiss::IndexPQ::hamming_distance_histogram idx_t n @@ -650,6 +676,7 @@ void faiss::IndexPQ::hamming_distance_table (idx_t n, const float *x, int32_t *dis) const hamming_distance_table + faiss::IndexPQ::hamming_distance_table idx_t n @@ -702,6 +729,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -725,6 +753,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -740,6 +769,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -793,6 +823,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -834,6 +865,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -850,6 +882,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -864,12 +897,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -885,6 +919,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -951,11 +986,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -969,6 +1005,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -988,6 +1025,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -1012,6 +1050,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -1057,6 +1096,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -1074,6 +1114,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -1133,6 +1174,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1199,6 +1241,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1252,6 +1295,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1349,6 +1393,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1404,6 +1449,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1466,19 +1512,35 @@ - + Index based on a product quantizer. Stored vectors are approximated by PQ codes. + + + + + + + + + + + + + + + + @@ -1489,59 +1551,43 @@ - - - - - - - polysemous_training - - pq - - - - - - - - - - - - - + + polysemous_training - - - - - - - + + + - + - + + + + cp assign_index - - cp - + + + + + + + + @@ -1560,9 +1606,9 @@ faiss::IndexPQdistance_t faiss::IndexPQdo_polysemous_training faiss::IndexPQencode_signs - faiss::IndexPQget_CodePacker - faiss::IndexPQget_distance_computer - faiss::IndexPQget_FlatCodesDistanceComputer + faiss::IndexPQget_CodePacker + faiss::IndexPQget_distance_computer + faiss::IndexPQget_FlatCodesDistanceComputer faiss::IndexPQhamming_distance_histogram faiss::IndexPQhamming_distance_table faiss::IndexPQIndex diff --git a/xml/structfaiss_1_1IndexPQFastScan.xml b/xml/structfaiss_1_1IndexPQFastScan.xml index 2bcf67677e..71a2103a41 100644 --- a/xml/structfaiss_1_1IndexPQFastScan.xml +++ b/xml/structfaiss_1_1IndexPQFastScan.xml @@ -1,15 +1,16 @@ - + faiss::IndexPQFastScan faiss::IndexFastScan IndexPQFastScan.h - + ProductQuantizer ProductQuantizer faiss::IndexPQFastScan::pq pq + faiss::IndexPQFastScan::pq @@ -23,6 +24,7 @@ int faiss::IndexFastScan::implem implem + faiss::IndexFastScan::implem = 0 @@ -37,6 +39,7 @@ int faiss::IndexFastScan::skip skip + faiss::IndexFastScan::skip = 0 @@ -51,6 +54,7 @@ int faiss::IndexFastScan::bbs bbs + faiss::IndexFastScan::bbs @@ -64,6 +68,7 @@ int faiss::IndexFastScan::qbs qbs + faiss::IndexFastScan::qbs = 0 @@ -78,6 +83,7 @@ size_t faiss::IndexFastScan::M M + faiss::IndexFastScan::M @@ -91,6 +97,7 @@ size_t faiss::IndexFastScan::nbits nbits + faiss::IndexFastScan::nbits @@ -104,6 +111,7 @@ size_t faiss::IndexFastScan::ksub ksub + faiss::IndexFastScan::ksub @@ -117,6 +125,7 @@ size_t faiss::IndexFastScan::code_size code_size + faiss::IndexFastScan::code_size @@ -130,6 +139,7 @@ size_t faiss::IndexFastScan::ntotal2 ntotal2 + faiss::IndexFastScan::ntotal2 @@ -143,6 +153,7 @@ size_t faiss::IndexFastScan::M2 M2 + faiss::IndexFastScan::M2 @@ -156,6 +167,7 @@ AlignedTable<uint8_t> faiss::IndexFastScan::codes codes + faiss::IndexFastScan::codes @@ -169,6 +181,7 @@ const uint8_t* faiss::IndexFastScan::orig_codes orig_codes + faiss::IndexFastScan::orig_codes = nullptr @@ -183,6 +196,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -197,6 +211,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -211,6 +226,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -225,6 +241,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -239,6 +256,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -253,6 +271,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -262,13 +281,14 @@ - - + + faiss::IndexPQFastScan::IndexPQFastScan (int d, size_t M, size_t nbits, MetricType metric=METRIC_L2, int bbs=32) IndexPQFastScan + faiss::IndexPQFastScan::IndexPQFastScan int d @@ -304,6 +324,7 @@ faiss::IndexPQFastScan::IndexPQFastScan ()=default IndexPQFastScan + faiss::IndexPQFastScan::IndexPQFastScan @@ -317,6 +338,7 @@ faiss::IndexPQFastScan::IndexPQFastScan (const IndexPQ &orig, int bbs=32) IndexPQFastScan + faiss::IndexPQFastScan::IndexPQFastScan const IndexPQ & orig @@ -340,6 +362,7 @@ void faiss::IndexPQFastScan::train (idx_t n, const float *x) override train + faiss::IndexPQFastScan::train train idx_t @@ -381,6 +404,7 @@ void faiss::IndexPQFastScan::compute_codes (uint8_t *codes, idx_t n, const float *x) const override compute_codes + faiss::IndexPQFastScan::compute_codes compute_codes uint8_t * @@ -407,6 +431,7 @@ void faiss::IndexPQFastScan::compute_float_LUT (float *lut, idx_t n, const float *x) const override compute_float_LUT + faiss::IndexPQFastScan::compute_float_LUT compute_float_LUT float * @@ -433,6 +458,7 @@ void faiss::IndexPQFastScan::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexPQFastScan::sa_decode sa_decode idx_t @@ -449,8 +475,7 @@ -Decode a set of vectors. -NOTE: The codes in the IndexPQFastScan object are non-contiguous. But this method requires a contiguous representation. +decode a set of vectors n @@ -464,7 +489,7 @@ bytes -input encoded vectors, size n * code_size +input encoded vectors, size n * sa_code_size() @@ -480,13 +505,14 @@ - + void void faiss::IndexFastScan::init_fastscan (int d, size_t M, size_t nbits, MetricType metric, int bbs) init_fastscan + faiss::IndexFastScan::init_fastscan int d @@ -520,6 +546,7 @@ void faiss::IndexFastScan::reset () override reset + faiss::IndexFastScan::reset reset removes all elements from the database. @@ -535,6 +562,7 @@ void faiss::IndexFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFastScan::search search idx_t @@ -618,6 +646,7 @@ void faiss::IndexFastScan::add (idx_t n, const float *x) override add + faiss::IndexFastScan::add add idx_t @@ -659,6 +688,7 @@ void faiss::IndexFastScan::compute_quantized_LUT (idx_t n, const float *x, uint8_t *lut, float *normalizers) const compute_quantized_LUT + faiss::IndexFastScan::compute_quantized_LUT idx_t n @@ -695,6 +725,7 @@ void faiss::IndexFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_dispatch_implem + faiss::IndexFastScan::search_dispatch_implem idx_t n @@ -737,6 +768,7 @@ void faiss::IndexFastScan::search_implem_234 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_implem_234 + faiss::IndexFastScan::search_implem_234 idx_t n @@ -779,6 +811,7 @@ void faiss::IndexFastScan::search_implem_12 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_12 + faiss::IndexFastScan::search_implem_12 idx_t n @@ -825,6 +858,7 @@ void faiss::IndexFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_14 + faiss::IndexFastScan::search_implem_14 idx_t n @@ -866,6 +900,7 @@ void faiss::IndexFastScan::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFastScan::reconstruct reconstruct idx_t @@ -907,6 +942,7 @@ size_t faiss::IndexFastScan::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFastScan::remove_ids remove_ids const IDSelector & @@ -921,11 +957,12 @@ - + CodePacker * - CodePacker* faiss::IndexFastScan::get_CodePacker + CodePacker * faiss::IndexFastScan::get_CodePacker () const get_CodePacker + faiss::IndexFastScan::get_CodePacker @@ -939,6 +976,7 @@ void faiss::IndexFastScan::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFastScan::merge_from merge_from Index & @@ -963,6 +1001,7 @@ void faiss::IndexFastScan::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFastScan::check_compatible_for_merge check_compatible_for_merge const Index & @@ -977,11 +1016,82 @@ + + size_t + size_t faiss::IndexFastScan::sa_code_size + () const override + sa_code_size + faiss::IndexFastScan::sa_code_size + sa_code_size + +standalone codes interface (but the codes are flattened) + + + + + + + + + void + void faiss::IndexFastScan::sa_encode + (idx_t n, const float *x, uint8_t *bytes) const override + sa_encode + faiss::IndexFastScan::sa_encode + sa_encode + + idx_t + n + + + const float * + x + + + uint8_t * + bytes + + + + +encode a set of vectors + + +n + + +number of vectors + + + + +x + + +input vectors, size n * d + + + + +bytes + + +output encoded vectors, size n * sa_code_size() + + + + + + + + + void virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -1041,6 +1151,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1119,6 +1230,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1185,6 +1297,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1238,6 +1351,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1295,6 +1409,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1392,6 +1507,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1447,6 +1563,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1509,15 +1626,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1528,97 +1646,12 @@ - - size_t - virtual size_t faiss::Index::sa_code_size - () const - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - - - -size of the produced codes in bytes - - - - - - - void - virtual void faiss::Index::sa_encode - (idx_t n, const float *x, uint8_t *bytes) const - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - - idx_t - n - - - const float * - x - - - uint8_t * - bytes - - - - -encode a set of vectors - - -n - - -number of vectors - - - - -x - - -input vectors, size n * d - - - - -bytes - - -output encoded vectors, size n * sa_code_size() - - - - - - - - - void virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1660,13 +1693,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1680,6 +1714,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1688,7 +1723,7 @@ - + @@ -1697,16 +1732,16 @@ Implementations: 12: blocked loop with internal loop on Q with qbs 13: same with reservoir accumulator to store results 14: no qbs with heap accumulator 15: no qbs with reservoir accumulator + + + + - - - - @@ -1718,11 +1753,22 @@ + + tab + - + + + + + + + + + @@ -1732,37 +1778,33 @@ codes - - - - - - - - - + pq - + - + + + + cp assign_index - - cp - + + + + - + faiss::IndexPQFastScanadd faiss::IndexPQFastScanadd_sa_codes @@ -1780,8 +1822,8 @@ faiss::IndexPQFastScancompute_residual_n faiss::IndexPQFastScand faiss::IndexPQFastScandistance_t - faiss::IndexPQFastScanget_CodePacker - faiss::IndexPQFastScanget_distance_computer + faiss::IndexPQFastScanget_CodePacker + faiss::IndexPQFastScanget_distance_computer faiss::IndexPQFastScanimplem faiss::IndexPQFastScanIndex faiss::IndexPQFastScanIndexFastScan @@ -1808,9 +1850,9 @@ faiss::IndexPQFastScanreconstruct_n faiss::IndexPQFastScanremove_ids faiss::IndexPQFastScanreset - faiss::IndexPQFastScansa_code_size + faiss::IndexPQFastScansa_code_size faiss::IndexPQFastScansa_decode - faiss::IndexPQFastScansa_encode + faiss::IndexPQFastScansa_encode faiss::IndexPQFastScansearch faiss::IndexPQFastScansearch_and_reconstruct faiss::IndexPQFastScansearch_dispatch_implem diff --git a/xml/structfaiss_1_1IndexPQStats.xml b/xml/structfaiss_1_1IndexPQStats.xml index 808c15e026..43e85e30e9 100644 --- a/xml/structfaiss_1_1IndexPQStats.xml +++ b/xml/structfaiss_1_1IndexPQStats.xml @@ -1,14 +1,15 @@ - + faiss::IndexPQStats IndexPQ.h - + size_t size_t faiss::IndexPQStats::nq nq + faiss::IndexPQStats::nq @@ -22,6 +23,7 @@ size_t faiss::IndexPQStats::ncode ncode + faiss::IndexPQStats::ncode @@ -35,6 +37,7 @@ size_t faiss::IndexPQStats::n_hamming_pass n_hamming_pass + faiss::IndexPQStats::n_hamming_pass @@ -43,13 +46,14 @@ - - + + faiss::IndexPQStats::IndexPQStats () IndexPQStats + faiss::IndexPQStats::IndexPQStats @@ -63,6 +67,7 @@ void faiss::IndexPQStats::reset () reset + faiss::IndexPQStats::reset @@ -71,7 +76,7 @@ - + diff --git a/xml/structfaiss_1_1IndexPreTransform.xml b/xml/structfaiss_1_1IndexPreTransform.xml index e0e295e5cb..4f763779f3 100644 --- a/xml/structfaiss_1_1IndexPreTransform.xml +++ b/xml/structfaiss_1_1IndexPreTransform.xml @@ -1,15 +1,16 @@ - + faiss::IndexPreTransform faiss::Index IndexPreTransform.h - + std::vector< VectorTransform * > std::vector<VectorTransform*> faiss::IndexPreTransform::chain chain + faiss::IndexPreTransform::chain @@ -23,6 +24,7 @@ Index* faiss::IndexPreTransform::index index + faiss::IndexPreTransform::index ! chain of transforms @@ -37,6 +39,7 @@ bool faiss::IndexPreTransform::own_fields own_fields + faiss::IndexPreTransform::own_fields ! the sub-index @@ -51,6 +54,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -65,6 +69,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -79,6 +84,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -93,6 +99,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -107,6 +114,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -121,6 +129,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -130,13 +139,14 @@ - - + + faiss::IndexPreTransform::IndexPreTransform (Index *index) IndexPreTransform + faiss::IndexPreTransform::IndexPreTransform Index * index @@ -155,6 +165,7 @@ faiss::IndexPreTransform::IndexPreTransform () IndexPreTransform + faiss::IndexPreTransform::IndexPreTransform @@ -168,6 +179,7 @@ faiss::IndexPreTransform::IndexPreTransform (VectorTransform *ltrans, Index *index) IndexPreTransform + faiss::IndexPreTransform::IndexPreTransform VectorTransform * ltrans @@ -190,6 +202,7 @@ void faiss::IndexPreTransform::prepend_transform (VectorTransform *ltrans) prepend_transform + faiss::IndexPreTransform::prepend_transform VectorTransform * ltrans @@ -207,6 +220,7 @@ void faiss::IndexPreTransform::train (idx_t n, const float *x) override train + faiss::IndexPreTransform::train train idx_t @@ -248,6 +262,7 @@ void faiss::IndexPreTransform::add (idx_t n, const float *x) override add + faiss::IndexPreTransform::add add idx_t @@ -289,6 +304,7 @@ void faiss::IndexPreTransform::add_with_ids (idx_t n, const float *x, const idx_t *xids) override add_with_ids + faiss::IndexPreTransform::add_with_ids add_with_ids idx_t @@ -343,6 +359,7 @@ void faiss::IndexPreTransform::reset () override reset + faiss::IndexPreTransform::reset reset removes all elements from the database. @@ -358,6 +375,7 @@ size_t faiss::IndexPreTransform::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexPreTransform::remove_ids remove_ids const IDSelector & @@ -377,6 +395,7 @@ void faiss::IndexPreTransform::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexPreTransform::search search idx_t @@ -460,6 +479,7 @@ void faiss::IndexPreTransform::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexPreTransform::range_search range_search idx_t @@ -531,6 +551,7 @@ void faiss::IndexPreTransform::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexPreTransform::reconstruct reconstruct idx_t @@ -572,6 +593,7 @@ void faiss::IndexPreTransform::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexPreTransform::reconstruct_n reconstruct_n idx_t @@ -625,6 +647,7 @@ void faiss::IndexPreTransform::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::IndexPreTransform::search_and_reconstruct search_and_reconstruct idx_t @@ -715,11 +738,12 @@ - + const float * - const float* faiss::IndexPreTransform::apply_chain + const float * faiss::IndexPreTransform::apply_chain (idx_t n, const float *x) const apply_chain + faiss::IndexPreTransform::apply_chain idx_t n @@ -742,6 +766,7 @@ void faiss::IndexPreTransform::reverse_chain (idx_t n, const float *xt, float *x) const reverse_chain + faiss::IndexPreTransform::reverse_chain idx_t n @@ -763,12 +788,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexPreTransform::get_distance_computer + DistanceComputer * faiss::IndexPreTransform::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexPreTransform::get_distance_computer + get_distance_computer @@ -784,6 +810,7 @@ size_t faiss::IndexPreTransform::sa_code_size () const override sa_code_size + faiss::IndexPreTransform::sa_code_size sa_code_size @@ -799,6 +826,7 @@ void faiss::IndexPreTransform::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexPreTransform::sa_encode sa_encode idx_t @@ -852,6 +880,7 @@ void faiss::IndexPreTransform::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexPreTransform::sa_decode sa_decode idx_t @@ -905,6 +934,7 @@ void faiss::IndexPreTransform::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexPreTransform::merge_from merge_from Index & @@ -929,6 +959,7 @@ void faiss::IndexPreTransform::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexPreTransform::check_compatible_for_merge check_compatible_for_merge const Index & @@ -948,6 +979,7 @@ faiss::IndexPreTransform::~IndexPreTransform () override ~IndexPreTransform + faiss::IndexPreTransform::~IndexPreTransform @@ -961,6 +993,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1027,6 +1060,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1080,6 +1114,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1135,6 +1170,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1202,6 +1238,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1243,13 +1280,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1263,6 +1301,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1271,25 +1310,29 @@ - + Index that applies a LinearTransform transform on vectors before handing them over to a sub-index + + + + + + - - @@ -1299,17 +1342,13 @@ index - - - - faiss::IndexPreTransformadd faiss::IndexPreTransformadd_sa_codes faiss::IndexPreTransformadd_with_ids - faiss::IndexPreTransformapply_chain + faiss::IndexPreTransformapply_chain faiss::IndexPreTransformassign faiss::IndexPreTransformchain faiss::IndexPreTransformcheck_compatible_for_merge @@ -1318,7 +1357,7 @@ faiss::IndexPreTransformcompute_residual_n faiss::IndexPreTransformd faiss::IndexPreTransformdistance_t - faiss::IndexPreTransformget_distance_computer + faiss::IndexPreTransformget_distance_computer faiss::IndexPreTransformindex faiss::IndexPreTransformIndex faiss::IndexPreTransformIndexPreTransform diff --git a/xml/structfaiss_1_1IndexProductLocalSearchQuantizer.xml b/xml/structfaiss_1_1IndexProductLocalSearchQuantizer.xml index 21ab2b2653..71254eb336 100644 --- a/xml/structfaiss_1_1IndexProductLocalSearchQuantizer.xml +++ b/xml/structfaiss_1_1IndexProductLocalSearchQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexProductLocalSearchQuantizer faiss::IndexAdditiveQuantizer IndexAdditiveQuantizer.h - + ProductLocalSearchQuantizer ProductLocalSearchQuantizer faiss::IndexProductLocalSearchQuantizer::plsq plsq + faiss::IndexProductLocalSearchQuantizer::plsq The product local search quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexAdditiveQuantizer::aq aq + faiss::IndexAdditiveQuantizer::aq @@ -37,6 +39,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -50,6 +53,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -64,6 +68,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -78,6 +83,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -92,6 +98,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -106,6 +113,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -120,6 +128,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -134,6 +143,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -143,13 +153,14 @@ - - + + faiss::IndexProductLocalSearchQuantizer::IndexProductLocalSearchQuantizer (int d, size_t nsplits, size_t Msub, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexProductLocalSearchQuantizer + faiss::IndexProductLocalSearchQuantizer::IndexProductLocalSearchQuantizer int d @@ -232,6 +243,7 @@ faiss::IndexProductLocalSearchQuantizer::IndexProductLocalSearchQuantizer () IndexProductLocalSearchQuantizer + faiss::IndexProductLocalSearchQuantizer::IndexProductLocalSearchQuantizer @@ -245,6 +257,7 @@ void faiss::IndexProductLocalSearchQuantizer::train (idx_t n, const float *x) override train + faiss::IndexProductLocalSearchQuantizer::train train idx_t @@ -286,6 +299,7 @@ void faiss::IndexAdditiveQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizer::search search idx_t @@ -369,6 +383,7 @@ void faiss::IndexAdditiveQuantizer::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexAdditiveQuantizer::sa_encode sa_encode idx_t @@ -422,6 +437,7 @@ void faiss::IndexAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizer::sa_decode sa_decode idx_t @@ -470,12 +486,13 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -491,6 +508,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -514,6 +532,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -529,6 +548,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -582,6 +602,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -623,6 +644,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -639,6 +661,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -653,12 +676,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -674,6 +698,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -740,11 +765,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -758,6 +784,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -777,6 +804,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -801,6 +829,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -846,6 +875,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -863,6 +893,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -922,6 +953,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -988,6 +1020,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1041,6 +1074,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1138,6 +1172,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1193,6 +1228,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1255,13 +1291,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizer::Search_type_t @@ -1275,6 +1312,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1288,6 +1326,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1296,23 +1335,23 @@ - + Index based on a product local search quantizer. + + + + - - - - @@ -1327,16 +1366,26 @@ - - - - + + + + + + + qnorm - - - - + + + + + + + + + + + aq @@ -1351,13 +1400,10 @@ - - - - - - - aq + + + + @@ -1366,29 +1412,6 @@ - - - - - - - - - - - qnorm - - - - - - - - - - - - @@ -1398,6 +1421,22 @@ plsq + + + + + + + + + + + + + + + + @@ -1414,9 +1453,9 @@ faiss::IndexProductLocalSearchQuantizercompute_residual_n faiss::IndexProductLocalSearchQuantizerd faiss::IndexProductLocalSearchQuantizerdistance_t - faiss::IndexProductLocalSearchQuantizerget_CodePacker - faiss::IndexProductLocalSearchQuantizerget_distance_computer - faiss::IndexProductLocalSearchQuantizerget_FlatCodesDistanceComputer + faiss::IndexProductLocalSearchQuantizerget_CodePacker + faiss::IndexProductLocalSearchQuantizerget_distance_computer + faiss::IndexProductLocalSearchQuantizerget_FlatCodesDistanceComputer faiss::IndexProductLocalSearchQuantizerIndex faiss::IndexProductLocalSearchQuantizerIndexAdditiveQuantizer faiss::IndexProductLocalSearchQuantizerIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexProductLocalSearchQuantizerFastScan.xml b/xml/structfaiss_1_1IndexProductLocalSearchQuantizerFastScan.xml index f24aaee18d..c8bd4dcef6 100644 --- a/xml/structfaiss_1_1IndexProductLocalSearchQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexProductLocalSearchQuantizerFastScan.xml @@ -1,15 +1,16 @@ - + faiss::IndexProductLocalSearchQuantizerFastScan faiss::IndexAdditiveQuantizerFastScan IndexAdditiveQuantizerFastScan.h - + ProductLocalSearchQuantizer ProductLocalSearchQuantizer faiss::IndexProductLocalSearchQuantizerFastScan::plsq plsq + faiss::IndexProductLocalSearchQuantizerFastScan::plsq The product local search quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexAdditiveQuantizerFastScan::aq aq + faiss::IndexAdditiveQuantizerFastScan::aq @@ -37,6 +39,7 @@ bool faiss::IndexAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexAdditiveQuantizerFastScan::rescale_norm = true @@ -51,6 +54,7 @@ int faiss::IndexAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexAdditiveQuantizerFastScan::norm_scale = 1 @@ -65,6 +69,7 @@ size_t faiss::IndexAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexAdditiveQuantizerFastScan::max_train_points = 0 @@ -79,6 +84,7 @@ int faiss::IndexFastScan::implem implem + faiss::IndexFastScan::implem = 0 @@ -93,6 +99,7 @@ int faiss::IndexFastScan::skip skip + faiss::IndexFastScan::skip = 0 @@ -107,6 +114,7 @@ int faiss::IndexFastScan::bbs bbs + faiss::IndexFastScan::bbs @@ -120,6 +128,7 @@ int faiss::IndexFastScan::qbs qbs + faiss::IndexFastScan::qbs = 0 @@ -134,6 +143,7 @@ size_t faiss::IndexFastScan::M M + faiss::IndexFastScan::M @@ -147,6 +157,7 @@ size_t faiss::IndexFastScan::nbits nbits + faiss::IndexFastScan::nbits @@ -160,6 +171,7 @@ size_t faiss::IndexFastScan::ksub ksub + faiss::IndexFastScan::ksub @@ -173,6 +185,7 @@ size_t faiss::IndexFastScan::code_size code_size + faiss::IndexFastScan::code_size @@ -186,6 +199,7 @@ size_t faiss::IndexFastScan::ntotal2 ntotal2 + faiss::IndexFastScan::ntotal2 @@ -199,6 +213,7 @@ size_t faiss::IndexFastScan::M2 M2 + faiss::IndexFastScan::M2 @@ -212,6 +227,7 @@ AlignedTable<uint8_t> faiss::IndexFastScan::codes codes + faiss::IndexFastScan::codes @@ -225,6 +241,7 @@ const uint8_t* faiss::IndexFastScan::orig_codes orig_codes + faiss::IndexFastScan::orig_codes = nullptr @@ -239,6 +256,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -253,6 +271,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -267,6 +286,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -281,6 +301,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -295,6 +316,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -309,6 +331,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -318,13 +341,14 @@ - - + + faiss::IndexProductLocalSearchQuantizerFastScan::IndexProductLocalSearchQuantizerFastScan (int d, size_t nsplits, size_t Msub, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_norm_rq2x4, int bbs=32) IndexProductLocalSearchQuantizerFastScan + faiss::IndexProductLocalSearchQuantizerFastScan::IndexProductLocalSearchQuantizerFastScan int d @@ -428,6 +452,7 @@ faiss::IndexProductLocalSearchQuantizerFastScan::IndexProductLocalSearchQuantizerFastScan () IndexProductLocalSearchQuantizerFastScan + faiss::IndexProductLocalSearchQuantizerFastScan::IndexProductLocalSearchQuantizerFastScan @@ -441,6 +466,7 @@ void faiss::IndexAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, MetricType metric=METRIC_L2, int bbs=32) init + faiss::IndexAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -468,6 +494,7 @@ void faiss::IndexAdditiveQuantizerFastScan::train (idx_t n, const float *x) override train + faiss::IndexAdditiveQuantizerFastScan::train train idx_t @@ -509,6 +536,7 @@ void faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -530,6 +558,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_codes (uint8_t *codes, idx_t n, const float *x) const override compute_codes + faiss::IndexAdditiveQuantizerFastScan::compute_codes compute_codes uint8_t * @@ -556,6 +585,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT (float *lut, idx_t n, const float *x) const override compute_float_LUT + faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT compute_float_LUT float * @@ -582,6 +612,7 @@ void faiss::IndexAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizerFastScan::search search idx_t @@ -665,6 +696,7 @@ void faiss::IndexAdditiveQuantizerFastScan::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizerFastScan::sa_decode sa_decode idx_t @@ -719,6 +751,7 @@ void faiss::IndexFastScan::init_fastscan (int d, size_t M, size_t nbits, MetricType metric, int bbs) init_fastscan + faiss::IndexFastScan::init_fastscan int d @@ -752,6 +785,7 @@ void faiss::IndexFastScan::reset () override reset + faiss::IndexFastScan::reset reset removes all elements from the database. @@ -767,6 +801,7 @@ void faiss::IndexFastScan::add (idx_t n, const float *x) override add + faiss::IndexFastScan::add add idx_t @@ -808,6 +843,7 @@ void faiss::IndexFastScan::compute_quantized_LUT (idx_t n, const float *x, uint8_t *lut, float *normalizers) const compute_quantized_LUT + faiss::IndexFastScan::compute_quantized_LUT idx_t n @@ -844,6 +880,7 @@ void faiss::IndexFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_dispatch_implem + faiss::IndexFastScan::search_dispatch_implem idx_t n @@ -886,6 +923,7 @@ void faiss::IndexFastScan::search_implem_234 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_implem_234 + faiss::IndexFastScan::search_implem_234 idx_t n @@ -928,6 +966,7 @@ void faiss::IndexFastScan::search_implem_12 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_12 + faiss::IndexFastScan::search_implem_12 idx_t n @@ -974,6 +1013,7 @@ void faiss::IndexFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_14 + faiss::IndexFastScan::search_implem_14 idx_t n @@ -1015,6 +1055,7 @@ void faiss::IndexFastScan::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFastScan::reconstruct reconstruct idx_t @@ -1056,6 +1097,7 @@ size_t faiss::IndexFastScan::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFastScan::remove_ids remove_ids const IDSelector & @@ -1070,11 +1112,12 @@ - + CodePacker * - CodePacker* faiss::IndexFastScan::get_CodePacker + CodePacker * faiss::IndexFastScan::get_CodePacker () const get_CodePacker + faiss::IndexFastScan::get_CodePacker @@ -1088,6 +1131,7 @@ void faiss::IndexFastScan::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFastScan::merge_from merge_from Index & @@ -1112,6 +1156,7 @@ void faiss::IndexFastScan::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFastScan::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1126,11 +1171,82 @@ + + size_t + size_t faiss::IndexFastScan::sa_code_size + () const override + sa_code_size + faiss::IndexFastScan::sa_code_size + sa_code_size + +standalone codes interface (but the codes are flattened) + + + + + + + + + void + void faiss::IndexFastScan::sa_encode + (idx_t n, const float *x, uint8_t *bytes) const override + sa_encode + faiss::IndexFastScan::sa_encode + sa_encode + + idx_t + n + + + const float * + x + + + uint8_t * + bytes + + + + +encode a set of vectors + + +n + + +number of vectors + + + + +x + + +input vectors, size n * d + + + + +bytes + + +output encoded vectors, size n * sa_code_size() + + + + + + + + + void virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -1190,6 +1306,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1268,6 +1385,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1334,6 +1452,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1387,6 +1506,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1444,6 +1564,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1541,6 +1662,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1596,6 +1718,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1658,15 +1781,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1677,97 +1801,12 @@ - - size_t - virtual size_t faiss::Index::sa_code_size - () const - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - - - -size of the produced codes in bytes - - - - - - - void - virtual void faiss::Index::sa_encode - (idx_t n, const float *x, uint8_t *bytes) const - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - - idx_t - n - - - const float * - x - - - uint8_t * - bytes - - - - -encode a set of vectors - - -n - - -number of vectors - - - - -x - - -input vectors, size n * d - - - - -bytes - - -output encoded vectors, size n * sa_code_size() - - - - - - - - - void virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1809,13 +1848,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizerFastScan::Search_type_t @@ -1829,6 +1869,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1842,6 +1883,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1850,25 +1892,13 @@ - + Index based on a product local search quantizer. Stored vectors are approximated by product local search quantization codes. Can also be used as a codec - - - - - - - - - - - - @@ -1879,16 +1909,10 @@ - - - - - - - - - - + + + + @@ -1896,26 +1920,40 @@ - - plsq - - - - - + + + + + + + tab - - - - + + + + + + + + + + + qnorm - - - - + + + + + + + + + + + aq @@ -1927,44 +1965,55 @@ codes + + + + + + - - + + - - - + + + + + - - - - + + + + - - aq + + + + + + + + plsq - - - + + + - - qnorm + + + + + - + - - - - - - @@ -1986,8 +2035,8 @@ faiss::IndexProductLocalSearchQuantizerFastScand faiss::IndexProductLocalSearchQuantizerFastScandistance_t faiss::IndexProductLocalSearchQuantizerFastScanestimate_norm_scale - faiss::IndexProductLocalSearchQuantizerFastScanget_CodePacker - faiss::IndexProductLocalSearchQuantizerFastScanget_distance_computer + faiss::IndexProductLocalSearchQuantizerFastScanget_CodePacker + faiss::IndexProductLocalSearchQuantizerFastScanget_distance_computer faiss::IndexProductLocalSearchQuantizerFastScanimplem faiss::IndexProductLocalSearchQuantizerFastScanIndex faiss::IndexProductLocalSearchQuantizerFastScanIndexAdditiveQuantizerFastScan @@ -2020,9 +2069,9 @@ faiss::IndexProductLocalSearchQuantizerFastScanremove_ids faiss::IndexProductLocalSearchQuantizerFastScanrescale_norm faiss::IndexProductLocalSearchQuantizerFastScanreset - faiss::IndexProductLocalSearchQuantizerFastScansa_code_size + faiss::IndexProductLocalSearchQuantizerFastScansa_code_size faiss::IndexProductLocalSearchQuantizerFastScansa_decode - faiss::IndexProductLocalSearchQuantizerFastScansa_encode + faiss::IndexProductLocalSearchQuantizerFastScansa_encode faiss::IndexProductLocalSearchQuantizerFastScansearch faiss::IndexProductLocalSearchQuantizerFastScansearch_and_reconstruct faiss::IndexProductLocalSearchQuantizerFastScansearch_dispatch_implem diff --git a/xml/structfaiss_1_1IndexProductResidualQuantizer.xml b/xml/structfaiss_1_1IndexProductResidualQuantizer.xml index 63307c8395..04540c7a71 100644 --- a/xml/structfaiss_1_1IndexProductResidualQuantizer.xml +++ b/xml/structfaiss_1_1IndexProductResidualQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexProductResidualQuantizer faiss::IndexAdditiveQuantizer IndexAdditiveQuantizer.h - + ProductResidualQuantizer ProductResidualQuantizer faiss::IndexProductResidualQuantizer::prq prq + faiss::IndexProductResidualQuantizer::prq The product residual quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexAdditiveQuantizer::aq aq + faiss::IndexAdditiveQuantizer::aq @@ -37,6 +39,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -50,6 +53,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -64,6 +68,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -78,6 +83,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -92,6 +98,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -106,6 +113,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -120,6 +128,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -134,6 +143,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -143,13 +153,14 @@ - - + + faiss::IndexProductResidualQuantizer::IndexProductResidualQuantizer (int d, size_t nsplits, size_t Msub, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexProductResidualQuantizer + faiss::IndexProductResidualQuantizer::IndexProductResidualQuantizer int d @@ -232,6 +243,7 @@ faiss::IndexProductResidualQuantizer::IndexProductResidualQuantizer () IndexProductResidualQuantizer + faiss::IndexProductResidualQuantizer::IndexProductResidualQuantizer @@ -245,6 +257,7 @@ void faiss::IndexProductResidualQuantizer::train (idx_t n, const float *x) override train + faiss::IndexProductResidualQuantizer::train train idx_t @@ -286,6 +299,7 @@ void faiss::IndexAdditiveQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizer::search search idx_t @@ -369,6 +383,7 @@ void faiss::IndexAdditiveQuantizer::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexAdditiveQuantizer::sa_encode sa_encode idx_t @@ -422,6 +437,7 @@ void faiss::IndexAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizer::sa_decode sa_decode idx_t @@ -470,12 +486,13 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -491,6 +508,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -514,6 +532,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -529,6 +548,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -582,6 +602,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -623,6 +644,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -639,6 +661,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -653,12 +676,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -674,6 +698,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -740,11 +765,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -758,6 +784,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -777,6 +804,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -801,6 +829,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -846,6 +875,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -863,6 +893,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -922,6 +953,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -988,6 +1020,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1041,6 +1074,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1138,6 +1172,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1193,6 +1228,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1255,13 +1291,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizer::Search_type_t @@ -1275,6 +1312,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1288,6 +1326,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1296,18 +1335,16 @@ - + Index based on a product residual quantizer. - - - - - + + + @@ -1315,31 +1352,40 @@ - - - - - - - - prq + + + + + + + + + + qnorm - - - - + + + + + + + + + + + aq @@ -1354,13 +1400,10 @@ - - - - - - - aq + + + + @@ -1369,17 +1412,19 @@ - - - - - - - - + + + + - - qnorm + + prq + + + + + + @@ -1392,12 +1437,6 @@ - - - - - - @@ -1414,9 +1453,9 @@ faiss::IndexProductResidualQuantizercompute_residual_n faiss::IndexProductResidualQuantizerd faiss::IndexProductResidualQuantizerdistance_t - faiss::IndexProductResidualQuantizerget_CodePacker - faiss::IndexProductResidualQuantizerget_distance_computer - faiss::IndexProductResidualQuantizerget_FlatCodesDistanceComputer + faiss::IndexProductResidualQuantizerget_CodePacker + faiss::IndexProductResidualQuantizerget_distance_computer + faiss::IndexProductResidualQuantizerget_FlatCodesDistanceComputer faiss::IndexProductResidualQuantizerIndex faiss::IndexProductResidualQuantizerIndexAdditiveQuantizer faiss::IndexProductResidualQuantizerIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexProductResidualQuantizerFastScan.xml b/xml/structfaiss_1_1IndexProductResidualQuantizerFastScan.xml index dd077e3fc0..0a9886613c 100644 --- a/xml/structfaiss_1_1IndexProductResidualQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexProductResidualQuantizerFastScan.xml @@ -1,15 +1,16 @@ - + faiss::IndexProductResidualQuantizerFastScan faiss::IndexAdditiveQuantizerFastScan IndexAdditiveQuantizerFastScan.h - + ProductResidualQuantizer ProductResidualQuantizer faiss::IndexProductResidualQuantizerFastScan::prq prq + faiss::IndexProductResidualQuantizerFastScan::prq The product residual quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexAdditiveQuantizerFastScan::aq aq + faiss::IndexAdditiveQuantizerFastScan::aq @@ -37,6 +39,7 @@ bool faiss::IndexAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexAdditiveQuantizerFastScan::rescale_norm = true @@ -51,6 +54,7 @@ int faiss::IndexAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexAdditiveQuantizerFastScan::norm_scale = 1 @@ -65,6 +69,7 @@ size_t faiss::IndexAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexAdditiveQuantizerFastScan::max_train_points = 0 @@ -79,6 +84,7 @@ int faiss::IndexFastScan::implem implem + faiss::IndexFastScan::implem = 0 @@ -93,6 +99,7 @@ int faiss::IndexFastScan::skip skip + faiss::IndexFastScan::skip = 0 @@ -107,6 +114,7 @@ int faiss::IndexFastScan::bbs bbs + faiss::IndexFastScan::bbs @@ -120,6 +128,7 @@ int faiss::IndexFastScan::qbs qbs + faiss::IndexFastScan::qbs = 0 @@ -134,6 +143,7 @@ size_t faiss::IndexFastScan::M M + faiss::IndexFastScan::M @@ -147,6 +157,7 @@ size_t faiss::IndexFastScan::nbits nbits + faiss::IndexFastScan::nbits @@ -160,6 +171,7 @@ size_t faiss::IndexFastScan::ksub ksub + faiss::IndexFastScan::ksub @@ -173,6 +185,7 @@ size_t faiss::IndexFastScan::code_size code_size + faiss::IndexFastScan::code_size @@ -186,6 +199,7 @@ size_t faiss::IndexFastScan::ntotal2 ntotal2 + faiss::IndexFastScan::ntotal2 @@ -199,6 +213,7 @@ size_t faiss::IndexFastScan::M2 M2 + faiss::IndexFastScan::M2 @@ -212,6 +227,7 @@ AlignedTable<uint8_t> faiss::IndexFastScan::codes codes + faiss::IndexFastScan::codes @@ -225,6 +241,7 @@ const uint8_t* faiss::IndexFastScan::orig_codes orig_codes + faiss::IndexFastScan::orig_codes = nullptr @@ -239,6 +256,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -253,6 +271,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -267,6 +286,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -281,6 +301,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -295,6 +316,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -309,6 +331,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -318,13 +341,14 @@ - - + + faiss::IndexProductResidualQuantizerFastScan::IndexProductResidualQuantizerFastScan (int d, size_t nsplits, size_t Msub, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_norm_rq2x4, int bbs=32) IndexProductResidualQuantizerFastScan + faiss::IndexProductResidualQuantizerFastScan::IndexProductResidualQuantizerFastScan int d @@ -428,6 +452,7 @@ faiss::IndexProductResidualQuantizerFastScan::IndexProductResidualQuantizerFastScan () IndexProductResidualQuantizerFastScan + faiss::IndexProductResidualQuantizerFastScan::IndexProductResidualQuantizerFastScan @@ -441,6 +466,7 @@ void faiss::IndexAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, MetricType metric=METRIC_L2, int bbs=32) init + faiss::IndexAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -468,6 +494,7 @@ void faiss::IndexAdditiveQuantizerFastScan::train (idx_t n, const float *x) override train + faiss::IndexAdditiveQuantizerFastScan::train train idx_t @@ -509,6 +536,7 @@ void faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -530,6 +558,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_codes (uint8_t *codes, idx_t n, const float *x) const override compute_codes + faiss::IndexAdditiveQuantizerFastScan::compute_codes compute_codes uint8_t * @@ -556,6 +585,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT (float *lut, idx_t n, const float *x) const override compute_float_LUT + faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT compute_float_LUT float * @@ -582,6 +612,7 @@ void faiss::IndexAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizerFastScan::search search idx_t @@ -665,6 +696,7 @@ void faiss::IndexAdditiveQuantizerFastScan::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizerFastScan::sa_decode sa_decode idx_t @@ -719,6 +751,7 @@ void faiss::IndexFastScan::init_fastscan (int d, size_t M, size_t nbits, MetricType metric, int bbs) init_fastscan + faiss::IndexFastScan::init_fastscan int d @@ -752,6 +785,7 @@ void faiss::IndexFastScan::reset () override reset + faiss::IndexFastScan::reset reset removes all elements from the database. @@ -767,6 +801,7 @@ void faiss::IndexFastScan::add (idx_t n, const float *x) override add + faiss::IndexFastScan::add add idx_t @@ -808,6 +843,7 @@ void faiss::IndexFastScan::compute_quantized_LUT (idx_t n, const float *x, uint8_t *lut, float *normalizers) const compute_quantized_LUT + faiss::IndexFastScan::compute_quantized_LUT idx_t n @@ -844,6 +880,7 @@ void faiss::IndexFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_dispatch_implem + faiss::IndexFastScan::search_dispatch_implem idx_t n @@ -886,6 +923,7 @@ void faiss::IndexFastScan::search_implem_234 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_implem_234 + faiss::IndexFastScan::search_implem_234 idx_t n @@ -928,6 +966,7 @@ void faiss::IndexFastScan::search_implem_12 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_12 + faiss::IndexFastScan::search_implem_12 idx_t n @@ -974,6 +1013,7 @@ void faiss::IndexFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_14 + faiss::IndexFastScan::search_implem_14 idx_t n @@ -1015,6 +1055,7 @@ void faiss::IndexFastScan::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFastScan::reconstruct reconstruct idx_t @@ -1056,6 +1097,7 @@ size_t faiss::IndexFastScan::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFastScan::remove_ids remove_ids const IDSelector & @@ -1070,11 +1112,12 @@ - + CodePacker * - CodePacker* faiss::IndexFastScan::get_CodePacker + CodePacker * faiss::IndexFastScan::get_CodePacker () const get_CodePacker + faiss::IndexFastScan::get_CodePacker @@ -1088,6 +1131,7 @@ void faiss::IndexFastScan::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFastScan::merge_from merge_from Index & @@ -1112,6 +1156,7 @@ void faiss::IndexFastScan::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFastScan::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1126,11 +1171,82 @@ + + size_t + size_t faiss::IndexFastScan::sa_code_size + () const override + sa_code_size + faiss::IndexFastScan::sa_code_size + sa_code_size + +standalone codes interface (but the codes are flattened) + + + + + + + + + void + void faiss::IndexFastScan::sa_encode + (idx_t n, const float *x, uint8_t *bytes) const override + sa_encode + faiss::IndexFastScan::sa_encode + sa_encode + + idx_t + n + + + const float * + x + + + uint8_t * + bytes + + + + +encode a set of vectors + + +n + + +number of vectors + + + + +x + + +input vectors, size n * d + + + + +bytes + + +output encoded vectors, size n * sa_code_size() + + + + + + + + + void virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -1190,6 +1306,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1268,6 +1385,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1334,6 +1452,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1387,6 +1506,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1444,6 +1564,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1541,6 +1662,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1596,6 +1718,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1658,15 +1781,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1677,97 +1801,12 @@ - - size_t - virtual size_t faiss::Index::sa_code_size - () const - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - - - -size of the produced codes in bytes - - - - - - - void - virtual void faiss::Index::sa_encode - (idx_t n, const float *x, uint8_t *bytes) const - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - - idx_t - n - - - const float * - x - - - uint8_t * - bytes - - - - -encode a set of vectors - - -n - - -number of vectors - - - - -x - - -input vectors, size n * d - - - - -bytes - - -output encoded vectors, size n * sa_code_size() - - - - - - - - - void virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1809,13 +1848,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizerFastScan::Search_type_t @@ -1829,6 +1869,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1842,6 +1883,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1850,25 +1892,13 @@ - + Index based on a product residual quantizer. Stored vectors are approximated by product residual quantization codes. Can also be used as a codec - - - - - - - - - - - - @@ -1879,37 +1909,51 @@ - - - - - + + + + + - - prq - - - - - + + + + + + + tab - - - - + + + + + + + + + + + qnorm - - - - + + + + + + + + + + + aq @@ -1921,50 +1965,55 @@ codes + + + + + + - - + + - - - + + + + + - - - - + + + + - - aq + + + + + + + + prq - - - + + + - - qnorm - - + - + - + - - - - - - @@ -1986,8 +2035,8 @@ faiss::IndexProductResidualQuantizerFastScand faiss::IndexProductResidualQuantizerFastScandistance_t faiss::IndexProductResidualQuantizerFastScanestimate_norm_scale - faiss::IndexProductResidualQuantizerFastScanget_CodePacker - faiss::IndexProductResidualQuantizerFastScanget_distance_computer + faiss::IndexProductResidualQuantizerFastScanget_CodePacker + faiss::IndexProductResidualQuantizerFastScanget_distance_computer faiss::IndexProductResidualQuantizerFastScanimplem faiss::IndexProductResidualQuantizerFastScanIndex faiss::IndexProductResidualQuantizerFastScanIndexAdditiveQuantizerFastScan @@ -2020,9 +2069,9 @@ faiss::IndexProductResidualQuantizerFastScanremove_ids faiss::IndexProductResidualQuantizerFastScanrescale_norm faiss::IndexProductResidualQuantizerFastScanreset - faiss::IndexProductResidualQuantizerFastScansa_code_size + faiss::IndexProductResidualQuantizerFastScansa_code_size faiss::IndexProductResidualQuantizerFastScansa_decode - faiss::IndexProductResidualQuantizerFastScansa_encode + faiss::IndexProductResidualQuantizerFastScansa_encode faiss::IndexProductResidualQuantizerFastScansearch faiss::IndexProductResidualQuantizerFastScansearch_and_reconstruct faiss::IndexProductResidualQuantizerFastScansearch_dispatch_implem diff --git a/xml/structfaiss_1_1IndexQINCo.xml b/xml/structfaiss_1_1IndexQINCo.xml index 713335ee75..ff6841f020 100644 --- a/xml/structfaiss_1_1IndexQINCo.xml +++ b/xml/structfaiss_1_1IndexQINCo.xml @@ -1,14 +1,15 @@ - + faiss::IndexQINCo faiss::IndexNeuralNetCodec - + QINCo QINCo faiss::IndexQINCo::qinco qinco + faiss::IndexQINCo::qinco @@ -22,6 +23,7 @@ NeuralNetCodec* faiss::IndexNeuralNetCodec::net net + faiss::IndexNeuralNetCodec::net = nullptr @@ -36,6 +38,7 @@ size_t faiss::IndexNeuralNetCodec::M M + faiss::IndexNeuralNetCodec::M @@ -49,6 +52,7 @@ size_t faiss::IndexNeuralNetCodec::nbits nbits + faiss::IndexNeuralNetCodec::nbits @@ -62,6 +66,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -75,6 +80,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -89,6 +95,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -103,6 +110,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -117,6 +125,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -131,6 +140,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -145,6 +155,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -159,6 +170,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -168,13 +180,14 @@ - - + + faiss::IndexQINCo::IndexQINCo (int d, int M, int nbits, int L, int h, MetricType metric=METRIC_L2) IndexQINCo + faiss::IndexQINCo::IndexQINCo int d @@ -213,6 +226,7 @@ faiss::IndexQINCo::~IndexQINCo () ~IndexQINCo + faiss::IndexQINCo::~IndexQINCo @@ -226,6 +240,7 @@ void faiss::IndexNeuralNetCodec::train (idx_t n, const float *x) override train + faiss::IndexNeuralNetCodec::train train idx_t @@ -267,6 +282,7 @@ void faiss::IndexNeuralNetCodec::sa_encode (idx_t n, const float *x, uint8_t *codes) const override sa_encode + faiss::IndexNeuralNetCodec::sa_encode sa_encode idx_t @@ -320,6 +336,7 @@ void faiss::IndexNeuralNetCodec::sa_decode (idx_t n, const uint8_t *codes, float *x) const override sa_decode + faiss::IndexNeuralNetCodec::sa_decode sa_decode idx_t @@ -373,6 +390,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -396,6 +414,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -411,6 +430,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -464,6 +484,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -505,6 +526,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -521,6 +543,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -535,16 +558,17 @@ - + FlatCodesDistanceComputer * - virtual FlatCodesDistanceComputer* faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + virtual FlatCodesDistanceComputer * faiss::IndexFlatCodes::get_FlatCodesDistanceComputer () const get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexFlatCodes::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -555,12 +579,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -576,6 +601,7 @@ void faiss::IndexFlatCodes::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexFlatCodes::search search search search @@ -619,6 +645,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -685,11 +712,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -703,6 +731,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -722,6 +751,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -746,6 +776,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -791,6 +822,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -808,6 +840,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -867,6 +900,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -933,6 +967,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -986,6 +1021,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1083,6 +1119,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1138,6 +1175,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1200,13 +1238,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1220,6 +1259,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1228,36 +1268,46 @@ - + + + + + + + + + + + - - - - + + + + + + - - @@ -1267,19 +1317,6 @@ net - - - - - - - codebook0 - - - - - - @@ -1289,19 +1326,22 @@ qinco - - - - - - - - + + + + + + codebook0 + + + + + @@ -1318,9 +1358,9 @@ faiss::IndexQINCocompute_residual_n faiss::IndexQINCod faiss::IndexQINCodistance_t - faiss::IndexQINCoget_CodePacker - faiss::IndexQINCoget_distance_computer - faiss::IndexQINCoget_FlatCodesDistanceComputer + faiss::IndexQINCoget_CodePacker + faiss::IndexQINCoget_distance_computer + faiss::IndexQINCoget_FlatCodesDistanceComputer faiss::IndexQINCoIndex faiss::IndexQINCoIndexFlatCodes faiss::IndexQINCoIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexRandom.xml b/xml/structfaiss_1_1IndexRandom.xml index e21bacd5ad..0ce7ee5728 100644 --- a/xml/structfaiss_1_1IndexRandom.xml +++ b/xml/structfaiss_1_1IndexRandom.xml @@ -1,15 +1,16 @@ - + faiss::IndexRandom faiss::Index MetaIndexes.h - + int64_t int64_t faiss::IndexRandom::seed seed + faiss::IndexRandom::seed @@ -23,6 +24,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -37,6 +39,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -51,6 +54,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -65,6 +69,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -79,6 +84,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -93,6 +99,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -102,13 +109,14 @@ - - + + faiss::IndexRandom::IndexRandom (idx_t d, idx_t ntotal=0, int64_t seed=1234, MetricType mt=METRIC_L2) IndexRandom + faiss::IndexRandom::IndexRandom idx_t d @@ -141,6 +149,7 @@ void faiss::IndexRandom::add (idx_t n, const float *x) override add + faiss::IndexRandom::add add idx_t @@ -182,6 +191,7 @@ void faiss::IndexRandom::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexRandom::search search idx_t @@ -265,6 +275,7 @@ void faiss::IndexRandom::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexRandom::reconstruct reconstruct idx_t @@ -306,6 +317,7 @@ void faiss::IndexRandom::reset () override reset + faiss::IndexRandom::reset reset removes all elements from the database. @@ -321,6 +333,7 @@ faiss::IndexRandom::~IndexRandom () override ~IndexRandom + faiss::IndexRandom::~IndexRandom @@ -334,6 +347,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -407,6 +421,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -466,6 +481,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -544,6 +560,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -610,6 +627,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -634,6 +652,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -687,6 +706,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -744,6 +764,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -841,6 +862,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -896,6 +918,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -958,15 +981,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -982,6 +1006,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1003,8 +1029,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1068,14 +1096,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1140,6 +1168,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1168,6 +1197,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1190,6 +1220,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1231,13 +1262,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1251,6 +1283,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1259,7 +1292,7 @@ - + @@ -1301,7 +1334,7 @@ faiss::IndexRandomcompute_residual_n faiss::IndexRandomd faiss::IndexRandomdistance_t - faiss::IndexRandomget_distance_computer + faiss::IndexRandomget_distance_computer faiss::IndexRandomIndex faiss::IndexRandomIndexRandom faiss::IndexRandomis_trained diff --git a/xml/structfaiss_1_1IndexRefine.xml b/xml/structfaiss_1_1IndexRefine.xml index 0371852449..579b393673 100644 --- a/xml/structfaiss_1_1IndexRefine.xml +++ b/xml/structfaiss_1_1IndexRefine.xml @@ -1,16 +1,17 @@ - + faiss::IndexRefine faiss::Index faiss::IndexRefineFlat IndexRefine.h - + Index * Index* faiss::IndexRefine::base_index base_index + faiss::IndexRefine::base_index faster index to pre-select the vectors that should be filtered @@ -25,6 +26,7 @@ Index* faiss::IndexRefine::refine_index refine_index + faiss::IndexRefine::refine_index refinement index @@ -39,6 +41,7 @@ bool faiss::IndexRefine::own_fields own_fields + faiss::IndexRefine::own_fields should the base index be deallocated? @@ -53,6 +56,7 @@ bool faiss::IndexRefine::own_refine_index own_refine_index + faiss::IndexRefine::own_refine_index same with the refinement index @@ -67,6 +71,7 @@ float faiss::IndexRefine::k_factor k_factor + faiss::IndexRefine::k_factor = 1 @@ -82,6 +87,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -96,6 +102,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -110,6 +117,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -124,6 +132,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -138,6 +147,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -152,6 +162,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -161,13 +172,14 @@ - - + + faiss::IndexRefine::IndexRefine (Index *base_index, Index *refine_index) IndexRefine + faiss::IndexRefine::IndexRefine Index * base_index @@ -190,6 +202,7 @@ faiss::IndexRefine::IndexRefine () IndexRefine + faiss::IndexRefine::IndexRefine @@ -203,6 +216,7 @@ void faiss::IndexRefine::train (idx_t n, const float *x) override train + faiss::IndexRefine::train train idx_t @@ -244,6 +258,7 @@ void faiss::IndexRefine::add (idx_t n, const float *x) override add + faiss::IndexRefine::add add idx_t @@ -285,6 +300,7 @@ void faiss::IndexRefine::reset () override reset + faiss::IndexRefine::reset reset removes all elements from the database. @@ -300,6 +316,7 @@ void faiss::IndexRefine::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexRefine::search search search @@ -384,6 +401,7 @@ void faiss::IndexRefine::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexRefine::range_search range_search idx_t @@ -455,6 +473,7 @@ void faiss::IndexRefine::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexRefine::reconstruct reconstruct idx_t @@ -496,6 +515,7 @@ size_t faiss::IndexRefine::sa_code_size () const override sa_code_size + faiss::IndexRefine::sa_code_size sa_code_size @@ -511,6 +531,7 @@ void faiss::IndexRefine::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexRefine::sa_encode sa_encode idx_t @@ -564,6 +585,7 @@ void faiss::IndexRefine::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexRefine::sa_decode sa_decode idx_t @@ -591,6 +613,7 @@ faiss::IndexRefine::~IndexRefine () override ~IndexRefine + faiss::IndexRefine::~IndexRefine @@ -604,6 +627,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -663,6 +687,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -729,6 +754,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -753,6 +779,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -806,6 +833,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -863,6 +891,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -960,6 +989,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1015,6 +1045,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1077,15 +1108,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1101,6 +1133,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1129,6 +1162,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1151,6 +1185,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1192,13 +1227,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1212,6 +1248,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1220,18 +1257,16 @@ - + Index that queries in a base_index (a fast one) and refines the results with an exact search, hopefully improving the results. - - - - - + + + @@ -1239,12 +1274,18 @@ + + + + + + + + - - @@ -1255,10 +1296,6 @@ refine_index - - - - @@ -1273,7 +1310,7 @@ faiss::IndexRefinecompute_residual_n faiss::IndexRefined faiss::IndexRefinedistance_t - faiss::IndexRefineget_distance_computer + faiss::IndexRefineget_distance_computer faiss::IndexRefineIndex faiss::IndexRefineIndexRefine faiss::IndexRefineIndexRefine diff --git a/xml/structfaiss_1_1IndexRefineFlat.xml b/xml/structfaiss_1_1IndexRefineFlat.xml index 99f291dba7..cdf36930ec 100644 --- a/xml/structfaiss_1_1IndexRefineFlat.xml +++ b/xml/structfaiss_1_1IndexRefineFlat.xml @@ -1,15 +1,16 @@ - + faiss::IndexRefineFlat faiss::IndexRefine IndexRefine.h - + faiss::IndexRefineFlat::IndexRefineFlat (Index *base_index) IndexRefineFlat + faiss::IndexRefineFlat::IndexRefineFlat Index * base_index @@ -27,6 +28,7 @@ faiss::IndexRefineFlat::IndexRefineFlat (Index *base_index, const float *xb) IndexRefineFlat + faiss::IndexRefineFlat::IndexRefineFlat Index * base_index @@ -48,6 +50,7 @@ faiss::IndexRefineFlat::IndexRefineFlat () IndexRefineFlat + faiss::IndexRefineFlat::IndexRefineFlat @@ -61,6 +64,7 @@ void faiss::IndexRefineFlat::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexRefineFlat::search search idx_t @@ -144,6 +148,7 @@ void faiss::IndexRefine::train (idx_t n, const float *x) override train + faiss::IndexRefine::train train idx_t @@ -185,6 +190,7 @@ void faiss::IndexRefine::add (idx_t n, const float *x) override add + faiss::IndexRefine::add add idx_t @@ -226,6 +232,7 @@ void faiss::IndexRefine::reset () override reset + faiss::IndexRefine::reset reset removes all elements from the database. @@ -241,6 +248,7 @@ void faiss::IndexRefine::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexRefine::range_search range_search idx_t @@ -312,6 +320,7 @@ void faiss::IndexRefine::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexRefine::reconstruct reconstruct idx_t @@ -353,6 +362,7 @@ size_t faiss::IndexRefine::sa_code_size () const override sa_code_size + faiss::IndexRefine::sa_code_size sa_code_size @@ -368,6 +378,7 @@ void faiss::IndexRefine::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexRefine::sa_encode sa_encode idx_t @@ -421,6 +432,7 @@ void faiss::IndexRefine::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexRefine::sa_decode sa_decode idx_t @@ -448,6 +460,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -507,6 +520,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -573,6 +587,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -597,6 +612,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -650,6 +666,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -707,6 +724,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -804,6 +822,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -859,6 +878,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -921,15 +941,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -945,6 +966,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -973,6 +995,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -995,6 +1018,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1036,13 +1060,14 @@ - - + + Index * Index* faiss::IndexRefine::base_index base_index + faiss::IndexRefine::base_index faster index to pre-select the vectors that should be filtered @@ -1057,6 +1082,7 @@ Index* faiss::IndexRefine::refine_index refine_index + faiss::IndexRefine::refine_index refinement index @@ -1071,6 +1097,7 @@ bool faiss::IndexRefine::own_fields own_fields + faiss::IndexRefine::own_fields should the base index be deallocated? @@ -1085,6 +1112,7 @@ bool faiss::IndexRefine::own_refine_index own_refine_index + faiss::IndexRefine::own_refine_index same with the refinement index @@ -1099,6 +1127,7 @@ float faiss::IndexRefine::k_factor k_factor + faiss::IndexRefine::k_factor = 1 @@ -1114,6 +1143,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1128,6 +1158,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1142,6 +1173,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1156,6 +1188,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1170,6 +1203,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1184,6 +1218,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1193,13 +1228,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1213,6 +1249,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1221,18 +1258,16 @@ - + Version where the refinement index is an IndexFlat. It has one additional constructor that takes a table of elements to add to the flat refinement index - - - - - + + + @@ -1240,18 +1275,18 @@ - - - - - - + + + + + + @@ -1262,9 +1297,11 @@ refine_index - - - + + + + + @@ -1280,7 +1317,7 @@ faiss::IndexRefineFlatcompute_residual_n faiss::IndexRefineFlatd faiss::IndexRefineFlatdistance_t - faiss::IndexRefineFlatget_distance_computer + faiss::IndexRefineFlatget_distance_computer faiss::IndexRefineFlatIndex faiss::IndexRefineFlatIndexRefine faiss::IndexRefineFlatIndexRefine diff --git a/xml/structfaiss_1_1IndexRefineSearchParameters.xml b/xml/structfaiss_1_1IndexRefineSearchParameters.xml index d5f52d3405..8833c59c8f 100644 --- a/xml/structfaiss_1_1IndexRefineSearchParameters.xml +++ b/xml/structfaiss_1_1IndexRefineSearchParameters.xml @@ -1,14 +1,15 @@ - + faiss::IndexRefineSearchParameters faiss::SearchParameters - + float float faiss::IndexRefineSearchParameters::k_factor k_factor + faiss::IndexRefineSearchParameters::k_factor = 1 @@ -23,6 +24,7 @@ SearchParameters* faiss::IndexRefineSearchParameters::base_index_params base_index_params + faiss::IndexRefineSearchParameters::base_index_params = nullptr @@ -37,6 +39,7 @@ IDSelector* faiss::SearchParameters::sel sel + faiss::SearchParameters::sel = nullptr if non-null, only these IDs will be considered during search. @@ -47,13 +50,14 @@ - - + + virtual faiss::IndexRefineSearchParameters::~IndexRefineSearchParameters ()=default ~IndexRefineSearchParameters + faiss::IndexRefineSearchParameters::~IndexRefineSearchParameters @@ -62,7 +66,7 @@ - + @@ -80,6 +84,10 @@ + + + + @@ -96,10 +104,6 @@ sel - - - - diff --git a/xml/structfaiss_1_1IndexResidualQuantizer.xml b/xml/structfaiss_1_1IndexResidualQuantizer.xml index aba8f46171..e7e0c4080f 100644 --- a/xml/structfaiss_1_1IndexResidualQuantizer.xml +++ b/xml/structfaiss_1_1IndexResidualQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexResidualQuantizer faiss::IndexAdditiveQuantizer IndexAdditiveQuantizer.h - + ResidualQuantizer ResidualQuantizer faiss::IndexResidualQuantizer::rq rq + faiss::IndexResidualQuantizer::rq The residual quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexAdditiveQuantizer::aq aq + faiss::IndexAdditiveQuantizer::aq @@ -37,6 +39,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -50,6 +53,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -64,6 +68,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -78,6 +83,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -92,6 +98,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -106,6 +113,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -120,6 +128,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -134,6 +143,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -143,13 +153,14 @@ - - + + faiss::IndexResidualQuantizer::IndexResidualQuantizer (int d, size_t M, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexResidualQuantizer + faiss::IndexResidualQuantizer::IndexResidualQuantizer int d @@ -218,6 +229,7 @@ faiss::IndexResidualQuantizer::IndexResidualQuantizer (int d, const std::vector< size_t > &nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_decompress) IndexResidualQuantizer + faiss::IndexResidualQuantizer::IndexResidualQuantizer int d @@ -249,6 +261,7 @@ faiss::IndexResidualQuantizer::IndexResidualQuantizer () IndexResidualQuantizer + faiss::IndexResidualQuantizer::IndexResidualQuantizer @@ -262,6 +275,7 @@ void faiss::IndexResidualQuantizer::train (idx_t n, const float *x) override train + faiss::IndexResidualQuantizer::train train idx_t @@ -303,6 +317,7 @@ void faiss::IndexAdditiveQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizer::search search idx_t @@ -386,6 +401,7 @@ void faiss::IndexAdditiveQuantizer::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexAdditiveQuantizer::sa_encode sa_encode idx_t @@ -439,6 +455,7 @@ void faiss::IndexAdditiveQuantizer::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizer::sa_decode sa_decode idx_t @@ -487,12 +504,13 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexAdditiveQuantizer::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -508,6 +526,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -531,6 +550,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -546,6 +566,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -599,6 +620,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -640,6 +662,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -656,6 +679,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -670,12 +694,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -691,6 +716,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -757,11 +783,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -775,6 +802,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -794,6 +822,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -818,6 +847,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -863,6 +893,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -880,6 +911,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -939,6 +971,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1005,6 +1038,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1058,6 +1092,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1155,6 +1190,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1210,6 +1246,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1272,13 +1309,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizer::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizer::Search_type_t @@ -1292,6 +1330,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1305,6 +1344,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1313,18 +1353,16 @@ - + Index based on a residual quantizer. Stored vectors are approximated by residual quantization codes. Can also be used as a codec - - - - - + + + @@ -1332,53 +1370,46 @@ - - - - - - - - - - - - - - - - - - - cp - - - assign_index_factory - - - - rq - - - - + + + + + + + + + qnorm + + + + + + + + + + + + aq + + @@ -1391,13 +1422,10 @@ - - - - - - - aq + + + + @@ -1406,27 +1434,39 @@ - - - - - - - - + + + + - - qnorm + + rq + + + + + + + + + + - - - - + + + + + + + cp + + + assign_index_factory @@ -1445,9 +1485,9 @@ faiss::IndexResidualQuantizercompute_residual_n faiss::IndexResidualQuantizerd faiss::IndexResidualQuantizerdistance_t - faiss::IndexResidualQuantizerget_CodePacker - faiss::IndexResidualQuantizerget_distance_computer - faiss::IndexResidualQuantizerget_FlatCodesDistanceComputer + faiss::IndexResidualQuantizerget_CodePacker + faiss::IndexResidualQuantizerget_distance_computer + faiss::IndexResidualQuantizerget_FlatCodesDistanceComputer faiss::IndexResidualQuantizerIndex faiss::IndexResidualQuantizerIndexAdditiveQuantizer faiss::IndexResidualQuantizerIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexResidualQuantizerFastScan.xml b/xml/structfaiss_1_1IndexResidualQuantizerFastScan.xml index 4a16658402..d19cd82750 100644 --- a/xml/structfaiss_1_1IndexResidualQuantizerFastScan.xml +++ b/xml/structfaiss_1_1IndexResidualQuantizerFastScan.xml @@ -1,15 +1,16 @@ - + faiss::IndexResidualQuantizerFastScan faiss::IndexAdditiveQuantizerFastScan IndexAdditiveQuantizerFastScan.h - + ResidualQuantizer ResidualQuantizer faiss::IndexResidualQuantizerFastScan::rq rq + faiss::IndexResidualQuantizerFastScan::rq The residual quantizer used to encode the vectors. @@ -24,6 +25,7 @@ AdditiveQuantizer* faiss::IndexAdditiveQuantizerFastScan::aq aq + faiss::IndexAdditiveQuantizerFastScan::aq @@ -37,6 +39,7 @@ bool faiss::IndexAdditiveQuantizerFastScan::rescale_norm rescale_norm + faiss::IndexAdditiveQuantizerFastScan::rescale_norm = true @@ -51,6 +54,7 @@ int faiss::IndexAdditiveQuantizerFastScan::norm_scale norm_scale + faiss::IndexAdditiveQuantizerFastScan::norm_scale = 1 @@ -65,6 +69,7 @@ size_t faiss::IndexAdditiveQuantizerFastScan::max_train_points max_train_points + faiss::IndexAdditiveQuantizerFastScan::max_train_points = 0 @@ -79,6 +84,7 @@ int faiss::IndexFastScan::implem implem + faiss::IndexFastScan::implem = 0 @@ -93,6 +99,7 @@ int faiss::IndexFastScan::skip skip + faiss::IndexFastScan::skip = 0 @@ -107,6 +114,7 @@ int faiss::IndexFastScan::bbs bbs + faiss::IndexFastScan::bbs @@ -120,6 +128,7 @@ int faiss::IndexFastScan::qbs qbs + faiss::IndexFastScan::qbs = 0 @@ -134,6 +143,7 @@ size_t faiss::IndexFastScan::M M + faiss::IndexFastScan::M @@ -147,6 +157,7 @@ size_t faiss::IndexFastScan::nbits nbits + faiss::IndexFastScan::nbits @@ -160,6 +171,7 @@ size_t faiss::IndexFastScan::ksub ksub + faiss::IndexFastScan::ksub @@ -173,6 +185,7 @@ size_t faiss::IndexFastScan::code_size code_size + faiss::IndexFastScan::code_size @@ -186,6 +199,7 @@ size_t faiss::IndexFastScan::ntotal2 ntotal2 + faiss::IndexFastScan::ntotal2 @@ -199,6 +213,7 @@ size_t faiss::IndexFastScan::M2 M2 + faiss::IndexFastScan::M2 @@ -212,6 +227,7 @@ AlignedTable<uint8_t> faiss::IndexFastScan::codes codes + faiss::IndexFastScan::codes @@ -225,6 +241,7 @@ const uint8_t* faiss::IndexFastScan::orig_codes orig_codes + faiss::IndexFastScan::orig_codes = nullptr @@ -239,6 +256,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -253,6 +271,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -267,6 +286,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -281,6 +301,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -295,6 +316,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -309,6 +331,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -318,13 +341,14 @@ - - + + faiss::IndexResidualQuantizerFastScan::IndexResidualQuantizerFastScan (int d, size_t M, size_t nbits, MetricType metric=METRIC_L2, Search_type_t search_type=AdditiveQuantizer::ST_norm_rq2x4, int bbs=32) IndexResidualQuantizerFastScan + faiss::IndexResidualQuantizerFastScan::IndexResidualQuantizerFastScan int d @@ -414,6 +438,7 @@ faiss::IndexResidualQuantizerFastScan::IndexResidualQuantizerFastScan () IndexResidualQuantizerFastScan + faiss::IndexResidualQuantizerFastScan::IndexResidualQuantizerFastScan @@ -427,6 +452,7 @@ void faiss::IndexAdditiveQuantizerFastScan::init (AdditiveQuantizer *aq, MetricType metric=METRIC_L2, int bbs=32) init + faiss::IndexAdditiveQuantizerFastScan::init AdditiveQuantizer * aq @@ -454,6 +480,7 @@ void faiss::IndexAdditiveQuantizerFastScan::train (idx_t n, const float *x) override train + faiss::IndexAdditiveQuantizerFastScan::train train idx_t @@ -495,6 +522,7 @@ void faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale (idx_t n, const float *x) estimate_norm_scale + faiss::IndexAdditiveQuantizerFastScan::estimate_norm_scale idx_t n @@ -516,6 +544,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_codes (uint8_t *codes, idx_t n, const float *x) const override compute_codes + faiss::IndexAdditiveQuantizerFastScan::compute_codes compute_codes uint8_t * @@ -542,6 +571,7 @@ void faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT (float *lut, idx_t n, const float *x) const override compute_float_LUT + faiss::IndexAdditiveQuantizerFastScan::compute_float_LUT compute_float_LUT float * @@ -568,6 +598,7 @@ void faiss::IndexAdditiveQuantizerFastScan::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexAdditiveQuantizerFastScan::search search idx_t @@ -651,6 +682,7 @@ void faiss::IndexAdditiveQuantizerFastScan::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexAdditiveQuantizerFastScan::sa_decode sa_decode idx_t @@ -705,6 +737,7 @@ void faiss::IndexFastScan::init_fastscan (int d, size_t M, size_t nbits, MetricType metric, int bbs) init_fastscan + faiss::IndexFastScan::init_fastscan int d @@ -738,6 +771,7 @@ void faiss::IndexFastScan::reset () override reset + faiss::IndexFastScan::reset reset removes all elements from the database. @@ -753,6 +787,7 @@ void faiss::IndexFastScan::add (idx_t n, const float *x) override add + faiss::IndexFastScan::add add idx_t @@ -794,6 +829,7 @@ void faiss::IndexFastScan::compute_quantized_LUT (idx_t n, const float *x, uint8_t *lut, float *normalizers) const compute_quantized_LUT + faiss::IndexFastScan::compute_quantized_LUT idx_t n @@ -830,6 +866,7 @@ void faiss::IndexFastScan::search_dispatch_implem (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_dispatch_implem + faiss::IndexFastScan::search_dispatch_implem idx_t n @@ -872,6 +909,7 @@ void faiss::IndexFastScan::search_implem_234 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const NormTableScaler *scaler) const search_implem_234 + faiss::IndexFastScan::search_implem_234 idx_t n @@ -914,6 +952,7 @@ void faiss::IndexFastScan::search_implem_12 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_12 + faiss::IndexFastScan::search_implem_12 idx_t n @@ -960,6 +999,7 @@ void faiss::IndexFastScan::search_implem_14 (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, int impl, const NormTableScaler *scaler) const search_implem_14 + faiss::IndexFastScan::search_implem_14 idx_t n @@ -1001,6 +1041,7 @@ void faiss::IndexFastScan::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFastScan::reconstruct reconstruct idx_t @@ -1042,6 +1083,7 @@ size_t faiss::IndexFastScan::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFastScan::remove_ids remove_ids const IDSelector & @@ -1056,11 +1098,12 @@ - + CodePacker * - CodePacker* faiss::IndexFastScan::get_CodePacker + CodePacker * faiss::IndexFastScan::get_CodePacker () const get_CodePacker + faiss::IndexFastScan::get_CodePacker @@ -1074,6 +1117,7 @@ void faiss::IndexFastScan::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFastScan::merge_from merge_from Index & @@ -1098,6 +1142,7 @@ void faiss::IndexFastScan::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFastScan::check_compatible_for_merge check_compatible_for_merge const Index & @@ -1112,11 +1157,82 @@ + + size_t + size_t faiss::IndexFastScan::sa_code_size + () const override + sa_code_size + faiss::IndexFastScan::sa_code_size + sa_code_size + +standalone codes interface (but the codes are flattened) + + + + + + + + + void + void faiss::IndexFastScan::sa_encode + (idx_t n, const float *x, uint8_t *bytes) const override + sa_encode + faiss::IndexFastScan::sa_encode + sa_encode + + idx_t + n + + + const float * + x + + + uint8_t * + bytes + + + + +encode a set of vectors + + +n + + +number of vectors + + + + +x + + +input vectors, size n * d + + + + +bytes + + +output encoded vectors, size n * sa_code_size() + + + + + + + + + void virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -1176,6 +1292,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -1254,6 +1371,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -1320,6 +1438,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -1373,6 +1492,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -1430,6 +1550,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1527,6 +1648,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1582,6 +1704,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1644,15 +1767,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1663,97 +1787,12 @@ - - size_t - virtual size_t faiss::Index::sa_code_size - () const - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - sa_code_size - - - -size of the produced codes in bytes - - - - - - - void - virtual void faiss::Index::sa_encode - (idx_t n, const float *x, uint8_t *bytes) const - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - sa_encode - - idx_t - n - - - const float * - x - - - uint8_t * - bytes - - - - -encode a set of vectors - - -n - - -number of vectors - - - - -x - - -input vectors, size n * d - - - - -bytes - - -output encoded vectors, size n * sa_code_size() - - - - - - - - - void virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1795,13 +1834,14 @@ - - + + AdditiveQuantizer::Search_type_t using faiss::IndexAdditiveQuantizerFastScan::Search_type_t = AdditiveQuantizer::Search_type_t Search_type_t + faiss::IndexAdditiveQuantizerFastScan::Search_type_t @@ -1815,6 +1855,7 @@ using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1828,6 +1869,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1836,13 +1878,23 @@ - + Index based on a residual quantizer. Stored vectors are approximated by residual quantization codes. Can also be used as a codec + + + + + + + + + + @@ -1855,6 +1907,32 @@ + + + + + + + tab + + + + + + + + + + + + + qnorm + + + + + + @@ -1864,58 +1942,41 @@ - - - - - - - + + aq - - - - - - - - - - - cp + + + + - - assign_index_factory + + codes - - - - - - - - - + - + - + - + - - - + + + - - codes + + + + + @@ -1923,46 +1984,34 @@ - + rq - - - - + + + + - - - + + + - - - - - - - aq - + + + - - - + + + - - qnorm + + cp - - - - - - - - - + + assign_index_factory @@ -1986,8 +2035,8 @@ faiss::IndexResidualQuantizerFastScand faiss::IndexResidualQuantizerFastScandistance_t faiss::IndexResidualQuantizerFastScanestimate_norm_scale - faiss::IndexResidualQuantizerFastScanget_CodePacker - faiss::IndexResidualQuantizerFastScanget_distance_computer + faiss::IndexResidualQuantizerFastScanget_CodePacker + faiss::IndexResidualQuantizerFastScanget_distance_computer faiss::IndexResidualQuantizerFastScanimplem faiss::IndexResidualQuantizerFastScanIndex faiss::IndexResidualQuantizerFastScanIndexAdditiveQuantizerFastScan @@ -2020,9 +2069,9 @@ faiss::IndexResidualQuantizerFastScanrescale_norm faiss::IndexResidualQuantizerFastScanreset faiss::IndexResidualQuantizerFastScanrq - faiss::IndexResidualQuantizerFastScansa_code_size + faiss::IndexResidualQuantizerFastScansa_code_size faiss::IndexResidualQuantizerFastScansa_decode - faiss::IndexResidualQuantizerFastScansa_encode + faiss::IndexResidualQuantizerFastScansa_encode faiss::IndexResidualQuantizerFastScansearch faiss::IndexResidualQuantizerFastScansearch_and_reconstruct faiss::IndexResidualQuantizerFastScansearch_dispatch_implem diff --git a/xml/structfaiss_1_1IndexRowwiseMinMax.xml b/xml/structfaiss_1_1IndexRowwiseMinMax.xml index 18c1709aee..3a0b6e2cb1 100644 --- a/xml/structfaiss_1_1IndexRowwiseMinMax.xml +++ b/xml/structfaiss_1_1IndexRowwiseMinMax.xml @@ -1,15 +1,16 @@ - + faiss::IndexRowwiseMinMax faiss::IndexRowwiseMinMaxBase IndexRowwiseMinMax.h - + faiss::IndexRowwiseMinMax::IndexRowwiseMinMax (Index *index) IndexRowwiseMinMax + faiss::IndexRowwiseMinMax::IndexRowwiseMinMax Index * index @@ -27,6 +28,7 @@ faiss::IndexRowwiseMinMax::IndexRowwiseMinMax () IndexRowwiseMinMax + faiss::IndexRowwiseMinMax::IndexRowwiseMinMax @@ -40,6 +42,7 @@ void faiss::IndexRowwiseMinMax::train (idx_t n, const float *x) override train + faiss::IndexRowwiseMinMax::train train idx_t @@ -81,6 +84,7 @@ void faiss::IndexRowwiseMinMax::train_inplace (idx_t n, float *x) override train_inplace + faiss::IndexRowwiseMinMax::train_inplace train_inplace idx_t @@ -103,6 +107,7 @@ size_t faiss::IndexRowwiseMinMax::sa_code_size () const override sa_code_size + faiss::IndexRowwiseMinMax::sa_code_size sa_code_size @@ -118,6 +123,7 @@ void faiss::IndexRowwiseMinMax::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexRowwiseMinMax::sa_encode sa_encode idx_t @@ -171,6 +177,7 @@ void faiss::IndexRowwiseMinMax::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexRowwiseMinMax::sa_decode sa_decode idx_t @@ -224,6 +231,7 @@ void faiss::IndexRowwiseMinMaxBase::add (idx_t n, const float *x) override add + faiss::IndexRowwiseMinMaxBase::add add idx_t @@ -265,6 +273,7 @@ void faiss::IndexRowwiseMinMaxBase::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexRowwiseMinMaxBase::search search idx_t @@ -348,6 +357,7 @@ void faiss::IndexRowwiseMinMaxBase::reset () override reset + faiss::IndexRowwiseMinMaxBase::reset reset removes all elements from the database. @@ -363,6 +373,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -422,6 +433,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -500,6 +512,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -566,6 +579,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -590,6 +604,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -643,6 +658,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -696,6 +712,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -753,6 +770,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -850,6 +868,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -905,6 +924,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -967,15 +987,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -991,6 +1012,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1019,6 +1041,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1041,6 +1064,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1082,13 +1106,14 @@ - - + + Index * Index* faiss::IndexRowwiseMinMaxBase::index index + faiss::IndexRowwiseMinMaxBase::index sub-index @@ -1103,6 +1128,7 @@ bool faiss::IndexRowwiseMinMaxBase::own_fields own_fields + faiss::IndexRowwiseMinMaxBase::own_fields whether the subindex needs to be freed in the destructor. @@ -1117,6 +1143,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1131,6 +1158,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1145,6 +1173,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1159,6 +1188,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1173,6 +1203,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1187,6 +1218,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1196,13 +1228,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1216,6 +1249,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1224,23 +1258,23 @@ - + Stores scaling coefficients as fp32 values. + + + + - - - - @@ -1249,16 +1283,16 @@ + + + + - - - - @@ -1281,7 +1315,7 @@ faiss::IndexRowwiseMinMaxcompute_residual_n faiss::IndexRowwiseMinMaxd faiss::IndexRowwiseMinMaxdistance_t - faiss::IndexRowwiseMinMaxget_distance_computer + faiss::IndexRowwiseMinMaxget_distance_computer faiss::IndexRowwiseMinMaxindex faiss::IndexRowwiseMinMaxIndex faiss::IndexRowwiseMinMaxIndexRowwiseMinMax diff --git a/xml/structfaiss_1_1IndexRowwiseMinMaxBase.xml b/xml/structfaiss_1_1IndexRowwiseMinMaxBase.xml index 355c24aa45..a739201551 100644 --- a/xml/structfaiss_1_1IndexRowwiseMinMaxBase.xml +++ b/xml/structfaiss_1_1IndexRowwiseMinMaxBase.xml @@ -1,17 +1,18 @@ - + faiss::IndexRowwiseMinMaxBase faiss::Index faiss::IndexRowwiseMinMax faiss::IndexRowwiseMinMaxFP16 IndexRowwiseMinMax.h - + Index * Index* faiss::IndexRowwiseMinMaxBase::index index + faiss::IndexRowwiseMinMaxBase::index sub-index @@ -26,6 +27,7 @@ bool faiss::IndexRowwiseMinMaxBase::own_fields own_fields + faiss::IndexRowwiseMinMaxBase::own_fields whether the subindex needs to be freed in the destructor. @@ -40,6 +42,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -54,6 +57,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -68,6 +72,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -82,6 +87,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -96,6 +102,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -110,6 +117,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -119,13 +127,14 @@ - - + + faiss::IndexRowwiseMinMaxBase::IndexRowwiseMinMaxBase (Index *index) IndexRowwiseMinMaxBase + faiss::IndexRowwiseMinMaxBase::IndexRowwiseMinMaxBase Index * index @@ -143,6 +152,7 @@ faiss::IndexRowwiseMinMaxBase::IndexRowwiseMinMaxBase () IndexRowwiseMinMaxBase + faiss::IndexRowwiseMinMaxBase::IndexRowwiseMinMaxBase @@ -156,6 +166,7 @@ faiss::IndexRowwiseMinMaxBase::~IndexRowwiseMinMaxBase () override ~IndexRowwiseMinMaxBase + faiss::IndexRowwiseMinMaxBase::~IndexRowwiseMinMaxBase @@ -169,6 +180,7 @@ void faiss::IndexRowwiseMinMaxBase::add (idx_t n, const float *x) override add + faiss::IndexRowwiseMinMaxBase::add add idx_t @@ -210,6 +222,7 @@ void faiss::IndexRowwiseMinMaxBase::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexRowwiseMinMaxBase::search search idx_t @@ -293,6 +306,7 @@ void faiss::IndexRowwiseMinMaxBase::reset () override reset + faiss::IndexRowwiseMinMaxBase::reset reset removes all elements from the database. @@ -308,6 +322,7 @@ virtual void faiss::IndexRowwiseMinMaxBase::train_inplace (idx_t n, float *x)=0 train_inplace + faiss::IndexRowwiseMinMaxBase::train_inplace train_inplace train_inplace @@ -331,6 +346,7 @@ virtual void faiss::Index::train (idx_t n, const float *x) train + faiss::Index::train train train train @@ -404,6 +420,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -463,6 +480,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -541,6 +559,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -607,6 +626,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -631,6 +651,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -684,6 +705,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -737,6 +759,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -794,6 +817,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -891,6 +915,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -946,6 +971,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1008,15 +1034,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1032,6 +1059,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1053,8 +1082,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1118,14 +1149,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1190,6 +1221,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1218,6 +1250,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1240,6 +1273,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1281,13 +1315,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1301,6 +1336,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1309,14 +1345,14 @@ - + Provides base functions for rowwise normalizing indices. Index wrapper that performs rowwise normalization to [0,1], preserving the coefficients. This is a vector codec index only. Basically, this index performs a rowwise scaling to [0,1] of every row in an input dataset before calling subindex::train() and subindex::sa_encode(). sa_encode() call stores the scaling coefficients (scaler and minv) in the very beginning of every output code. The format: [scaler][minv][subindex::sa_encode() output] The de-scaling in sa_decode() is done using: output_rescaled = scaler * output + minv -An additional ::train_inplace() function is provided in order to do an inplace scaling before calling subindex::train() and, thus, avoiding the cloning of the input dataset, but modifying the input dataset because of the scaling and the scaling back. It is up to user to call this function instead of ::train() +An additional train_inplace() function is provided in order to do an inplace scaling before calling subindex::train() and, thus, avoiding the cloning of the input dataset, but modifying the input dataset because of the scaling and the scaling back. It is up to user to call this function instead of train() Derived classes provide different data types for scaling coefficients. Currently, versions with fp16 and fp32 scaling coefficients are available. fp16 version adds 4 extra bytes per encoded vector fp32 version adds 8 extra bytes per encoded vector @@ -1324,19 +1360,13 @@ - - - - - - - - - + + + @@ -1346,6 +1376,12 @@ + + + + + + @@ -1374,7 +1410,7 @@ faiss::IndexRowwiseMinMaxBasecompute_residual_n faiss::IndexRowwiseMinMaxBased faiss::IndexRowwiseMinMaxBasedistance_t - faiss::IndexRowwiseMinMaxBaseget_distance_computer + faiss::IndexRowwiseMinMaxBaseget_distance_computer faiss::IndexRowwiseMinMaxBaseIndex faiss::IndexRowwiseMinMaxBaseindex faiss::IndexRowwiseMinMaxBaseIndexRowwiseMinMaxBase diff --git a/xml/structfaiss_1_1IndexRowwiseMinMaxFP16.xml b/xml/structfaiss_1_1IndexRowwiseMinMaxFP16.xml index bd7c0b4787..e5d987cd06 100644 --- a/xml/structfaiss_1_1IndexRowwiseMinMaxFP16.xml +++ b/xml/structfaiss_1_1IndexRowwiseMinMaxFP16.xml @@ -1,15 +1,16 @@ - + faiss::IndexRowwiseMinMaxFP16 faiss::IndexRowwiseMinMaxBase IndexRowwiseMinMax.h - + faiss::IndexRowwiseMinMaxFP16::IndexRowwiseMinMaxFP16 (Index *index) IndexRowwiseMinMaxFP16 + faiss::IndexRowwiseMinMaxFP16::IndexRowwiseMinMaxFP16 Index * index @@ -27,6 +28,7 @@ faiss::IndexRowwiseMinMaxFP16::IndexRowwiseMinMaxFP16 () IndexRowwiseMinMaxFP16 + faiss::IndexRowwiseMinMaxFP16::IndexRowwiseMinMaxFP16 @@ -40,6 +42,7 @@ void faiss::IndexRowwiseMinMaxFP16::train (idx_t n, const float *x) override train + faiss::IndexRowwiseMinMaxFP16::train train idx_t @@ -81,6 +84,7 @@ void faiss::IndexRowwiseMinMaxFP16::train_inplace (idx_t n, float *x) override train_inplace + faiss::IndexRowwiseMinMaxFP16::train_inplace train_inplace idx_t @@ -103,6 +107,7 @@ size_t faiss::IndexRowwiseMinMaxFP16::sa_code_size () const override sa_code_size + faiss::IndexRowwiseMinMaxFP16::sa_code_size sa_code_size @@ -118,6 +123,7 @@ void faiss::IndexRowwiseMinMaxFP16::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexRowwiseMinMaxFP16::sa_encode sa_encode idx_t @@ -171,6 +177,7 @@ void faiss::IndexRowwiseMinMaxFP16::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexRowwiseMinMaxFP16::sa_decode sa_decode idx_t @@ -224,6 +231,7 @@ void faiss::IndexRowwiseMinMaxBase::add (idx_t n, const float *x) override add + faiss::IndexRowwiseMinMaxBase::add add idx_t @@ -265,6 +273,7 @@ void faiss::IndexRowwiseMinMaxBase::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexRowwiseMinMaxBase::search search idx_t @@ -348,6 +357,7 @@ void faiss::IndexRowwiseMinMaxBase::reset () override reset + faiss::IndexRowwiseMinMaxBase::reset reset removes all elements from the database. @@ -363,6 +373,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -422,6 +433,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -500,6 +512,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -566,6 +579,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -590,6 +604,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -643,6 +658,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -696,6 +712,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -753,6 +770,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -850,6 +868,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -905,6 +924,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -967,15 +987,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -991,6 +1012,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1019,6 +1041,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1041,6 +1064,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1082,13 +1106,14 @@ - - + + Index * Index* faiss::IndexRowwiseMinMaxBase::index index + faiss::IndexRowwiseMinMaxBase::index sub-index @@ -1103,6 +1128,7 @@ bool faiss::IndexRowwiseMinMaxBase::own_fields own_fields + faiss::IndexRowwiseMinMaxBase::own_fields whether the subindex needs to be freed in the destructor. @@ -1117,6 +1143,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -1131,6 +1158,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1145,6 +1173,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1159,6 +1188,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1173,6 +1203,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1187,6 +1218,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1196,13 +1228,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1216,6 +1249,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1224,7 +1258,7 @@ - + Stores scaling coefficients as fp16 values. @@ -1235,30 +1269,24 @@ - - - - - - - - - - - - + + + + + + @@ -1268,6 +1296,12 @@ index + + + + + + @@ -1281,7 +1315,7 @@ faiss::IndexRowwiseMinMaxFP16compute_residual_n faiss::IndexRowwiseMinMaxFP16d faiss::IndexRowwiseMinMaxFP16distance_t - faiss::IndexRowwiseMinMaxFP16get_distance_computer + faiss::IndexRowwiseMinMaxFP16get_distance_computer faiss::IndexRowwiseMinMaxFP16index faiss::IndexRowwiseMinMaxFP16Index faiss::IndexRowwiseMinMaxFP16IndexRowwiseMinMaxBase diff --git a/xml/structfaiss_1_1IndexScalarQuantizer.xml b/xml/structfaiss_1_1IndexScalarQuantizer.xml index c9ae0fd77a..08f42daec7 100644 --- a/xml/structfaiss_1_1IndexScalarQuantizer.xml +++ b/xml/structfaiss_1_1IndexScalarQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::IndexScalarQuantizer faiss::IndexFlatCodes IndexScalarQuantizer.h - + ScalarQuantizer ScalarQuantizer faiss::IndexScalarQuantizer::sq sq + faiss::IndexScalarQuantizer::sq Used to encode the vectors. @@ -24,6 +25,7 @@ size_t faiss::IndexFlatCodes::code_size code_size + faiss::IndexFlatCodes::code_size @@ -37,6 +39,7 @@ std::vector<uint8_t> faiss::IndexFlatCodes::codes codes + faiss::IndexFlatCodes::codes encoded dataset, size ntotal * code_size @@ -51,6 +54,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -65,6 +69,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -79,6 +84,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -93,6 +99,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -107,6 +114,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -121,6 +129,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -130,13 +139,14 @@ - - + + faiss::IndexScalarQuantizer::IndexScalarQuantizer (int d, ScalarQuantizer::QuantizerType qtype, MetricType metric=METRIC_L2) IndexScalarQuantizer + faiss::IndexScalarQuantizer::IndexScalarQuantizer int d @@ -190,6 +200,7 @@ faiss::IndexScalarQuantizer::IndexScalarQuantizer () IndexScalarQuantizer + faiss::IndexScalarQuantizer::IndexScalarQuantizer @@ -203,6 +214,7 @@ void faiss::IndexScalarQuantizer::train (idx_t n, const float *x) override train + faiss::IndexScalarQuantizer::train train idx_t @@ -244,6 +256,7 @@ void faiss::IndexScalarQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexScalarQuantizer::search search idx_t @@ -279,12 +292,13 @@ - + FlatCodesDistanceComputer * - FlatCodesDistanceComputer* faiss::IndexScalarQuantizer::get_FlatCodesDistanceComputer + FlatCodesDistanceComputer * faiss::IndexScalarQuantizer::get_FlatCodesDistanceComputer () const override get_FlatCodesDistanceComputer - get_FlatCodesDistanceComputer + faiss::IndexScalarQuantizer::get_FlatCodesDistanceComputer + get_FlatCodesDistanceComputer @@ -300,6 +314,7 @@ void faiss::IndexScalarQuantizer::sa_encode (idx_t n, const float *x, uint8_t *bytes) const override sa_encode + faiss::IndexScalarQuantizer::sa_encode sa_encode idx_t @@ -353,6 +368,7 @@ void faiss::IndexScalarQuantizer::sa_decode (idx_t n, const uint8_t *bytes, float *x) const override sa_decode + faiss::IndexScalarQuantizer::sa_decode sa_decode idx_t @@ -406,6 +422,7 @@ void faiss::IndexFlatCodes::add (idx_t n, const float *x) override add + faiss::IndexFlatCodes::add add idx_t @@ -429,6 +446,7 @@ void faiss::IndexFlatCodes::reset () override reset + faiss::IndexFlatCodes::reset reset removes all elements from the database. @@ -444,6 +462,7 @@ void faiss::IndexFlatCodes::reconstruct_n (idx_t i0, idx_t ni, float *recons) const override reconstruct_n + faiss::IndexFlatCodes::reconstruct_n reconstruct_n idx_t @@ -497,6 +516,7 @@ void faiss::IndexFlatCodes::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::IndexFlatCodes::reconstruct reconstruct idx_t @@ -538,6 +558,7 @@ size_t faiss::IndexFlatCodes::sa_code_size () const override sa_code_size + faiss::IndexFlatCodes::sa_code_size sa_code_size sa_code_size @@ -554,6 +575,7 @@ size_t faiss::IndexFlatCodes::remove_ids (const IDSelector &sel) override remove_ids + faiss::IndexFlatCodes::remove_ids remove_ids const IDSelector & @@ -568,12 +590,13 @@ - + DistanceComputer * - DistanceComputer* faiss::IndexFlatCodes::get_distance_computer + DistanceComputer * faiss::IndexFlatCodes::get_distance_computer () const override get_distance_computer - get_distance_computer + faiss::IndexFlatCodes::get_distance_computer + get_distance_computer @@ -589,6 +612,7 @@ void faiss::IndexFlatCodes::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const override range_search + faiss::IndexFlatCodes::range_search range_search idx_t @@ -655,11 +679,12 @@ - + CodePacker * - CodePacker* faiss::IndexFlatCodes::get_CodePacker + CodePacker * faiss::IndexFlatCodes::get_CodePacker () const get_CodePacker + faiss::IndexFlatCodes::get_CodePacker @@ -673,6 +698,7 @@ void faiss::IndexFlatCodes::check_compatible_for_merge (const Index &otherIndex) const override check_compatible_for_merge + faiss::IndexFlatCodes::check_compatible_for_merge check_compatible_for_merge const Index & @@ -692,6 +718,7 @@ virtual void faiss::IndexFlatCodes::merge_from (Index &otherIndex, idx_t add_id=0) override merge_from + faiss::IndexFlatCodes::merge_from merge_from Index & @@ -716,6 +743,7 @@ virtual void faiss::IndexFlatCodes::add_sa_codes (idx_t n, const uint8_t *x, const idx_t *xids) override add_sa_codes + faiss::IndexFlatCodes::add_sa_codes add_sa_codes idx_t @@ -761,6 +789,7 @@ void faiss::IndexFlatCodes::permute_entries (const idx_t *perm) permute_entries + faiss::IndexFlatCodes::permute_entries const idx_t * perm @@ -778,6 +807,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -837,6 +867,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -903,6 +934,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -956,6 +988,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -1053,6 +1086,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -1108,6 +1142,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1170,13 +1205,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1190,6 +1226,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1198,19 +1235,31 @@ - + Flat index built on a scalar quantizer. + + + + + + + + + + + + @@ -1221,14 +1270,6 @@ - - - - - - - - @@ -1238,18 +1279,14 @@ sq - - - - - - - - + + + + @@ -1267,9 +1304,9 @@ faiss::IndexScalarQuantizercompute_residual_n faiss::IndexScalarQuantizerd faiss::IndexScalarQuantizerdistance_t - faiss::IndexScalarQuantizerget_CodePacker - faiss::IndexScalarQuantizerget_distance_computer - faiss::IndexScalarQuantizerget_FlatCodesDistanceComputer + faiss::IndexScalarQuantizerget_CodePacker + faiss::IndexScalarQuantizerget_distance_computer + faiss::IndexScalarQuantizerget_FlatCodesDistanceComputer faiss::IndexScalarQuantizerIndex faiss::IndexScalarQuantizerIndexFlatCodes faiss::IndexScalarQuantizerIndexFlatCodes diff --git a/xml/structfaiss_1_1IndexShardsIVF.xml b/xml/structfaiss_1_1IndexShardsIVF.xml index 6d1afc1045..0265459868 100644 --- a/xml/structfaiss_1_1IndexShardsIVF.xml +++ b/xml/structfaiss_1_1IndexShardsIVF.xml @@ -1,16 +1,17 @@ - + faiss::IndexShardsIVF faiss::IndexShardsTemplate< Index > faiss::Level1Quantizer IndexShardsIVF.h - + faiss::IndexShardsIVF::IndexShardsIVF (Index *quantizer, size_t nlist, bool threaded=false, bool successive_ids=true) IndexShardsIVF + faiss::IndexShardsIVF::IndexShardsIVF Index * quantizer @@ -42,6 +43,7 @@ void faiss::IndexShardsIVF::addIndex (Index *index) override addIndex + faiss::IndexShardsIVF::addIndex Index * index @@ -59,6 +61,7 @@ void faiss::IndexShardsIVF::add_with_ids (idx_t n, const component_t *x, const idx_t *xids) override add_with_ids + faiss::IndexShardsIVF::add_with_ids idx_t n @@ -84,6 +87,7 @@ void faiss::IndexShardsIVF::train (idx_t n, const component_t *x) override train + faiss::IndexShardsIVF::train idx_t n @@ -105,6 +109,7 @@ void faiss::IndexShardsIVF::search (idx_t n, const component_t *x, idx_t k, distance_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexShardsIVF::search idx_t n @@ -143,6 +148,7 @@ void faiss::IndexShardsTemplate< IndexT >::add_shard (IndexT *index) add_shard + faiss::IndexShardsTemplate::add_shard IndexT * index @@ -161,6 +167,7 @@ void faiss::IndexShardsTemplate< IndexT >::remove_shard (IndexT *index) remove_shard + faiss::IndexShardsTemplate::remove_shard IndexT * index @@ -179,6 +186,7 @@ void faiss::IndexShardsTemplate< IndexT >::add (idx_t n, const component_t *x) override add + faiss::IndexShardsTemplate::add idx_t n @@ -201,6 +209,7 @@ virtual void faiss::IndexShardsTemplate< IndexT >::syncWithSubIndexes () syncWithSubIndexes + faiss::IndexShardsTemplate::syncWithSubIndexes @@ -215,6 +224,7 @@ void faiss::ThreadedIndex< IndexT >::addIndex (IndexT *index) addIndex + faiss::ThreadedIndex::addIndex IndexT * index @@ -233,6 +243,7 @@ void faiss::ThreadedIndex< IndexT >::removeIndex (IndexT *index) removeIndex + faiss::ThreadedIndex::removeIndex IndexT * index @@ -251,6 +262,7 @@ void faiss::ThreadedIndex< IndexT >::runOnIndex (std::function< void(int, IndexT *)> f) runOnIndex + faiss::ThreadedIndex::runOnIndex std::function< void(int, IndexT *)> f @@ -269,6 +281,7 @@ void faiss::ThreadedIndex< IndexT >::runOnIndex (std::function< void(int, const IndexT *)> f) const runOnIndex + faiss::ThreadedIndex::runOnIndex std::function< void(int, const IndexT *)> f @@ -286,6 +299,7 @@ void faiss::ThreadedIndex< IndexT >::reset () override reset + faiss::ThreadedIndex::reset @@ -300,6 +314,7 @@ int faiss::ThreadedIndex< IndexT >::count () const count + faiss::ThreadedIndex::count Returns the number of sub-indices. @@ -309,11 +324,12 @@ - + IndexT * - IndexT* faiss::ThreadedIndex< IndexT >::at + IndexT * faiss::ThreadedIndex< IndexT >::at (size_t i) at + faiss::ThreadedIndex::at size_t i @@ -327,11 +343,12 @@ - + const IndexT * - const IndexT* faiss::ThreadedIndex< IndexT >::at + const IndexT * faiss::ThreadedIndex< IndexT >::at (size_t i) const at + faiss::ThreadedIndex::at size_t i @@ -350,6 +367,7 @@ void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -380,6 +398,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -394,6 +413,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -415,6 +435,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -427,13 +448,14 @@ - - + + typename IndexT::component_t using faiss::IndexShardsTemplate< IndexT >::component_t = typename IndexT::component_t component_t + faiss::IndexShardsTemplate::component_t @@ -447,6 +469,7 @@ using faiss::IndexShardsTemplate< IndexT >::distance_t = typename IndexT::distance_t distance_t + faiss::IndexShardsTemplate::distance_t @@ -455,13 +478,14 @@ - - + + bool bool faiss::IndexShardsTemplate< IndexT >::successive_ids successive_ids + faiss::IndexShardsTemplate::successive_ids @@ -475,6 +499,7 @@ bool faiss::ThreadedIndex< IndexT >::own_indices own_indices + faiss::ThreadedIndex::own_indices = false Whether or not we are responsible for deleting our contained indices. @@ -490,6 +515,7 @@ Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -505,6 +531,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -520,6 +547,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -535,6 +563,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -550,6 +579,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -564,6 +594,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -574,13 +605,14 @@ - - + + void void faiss::IndexShardsTemplate< IndexT >::onAfterAddIndex (IndexT *index) override onAfterAddIndex + faiss::IndexShardsTemplate::onAfterAddIndex onAfterAddIndex IndexT * @@ -600,6 +632,7 @@ void faiss::IndexShardsTemplate< IndexT >::onAfterRemoveIndex (IndexT *index) override onAfterRemoveIndex + faiss::IndexShardsTemplate::onAfterRemoveIndex onAfterRemoveIndex IndexT * @@ -614,13 +647,14 @@ - - + + std::vector< std::pair< IndexT *, std::unique_ptr< WorkerThread > > > std::vector<std::pair<IndexT*, std::unique_ptr<WorkerThread> > > faiss::ThreadedIndex< IndexT >::indices_ indices_ + faiss::ThreadedIndex::indices_ Collection of Index instances, with their managing worker thread if any. @@ -635,6 +669,7 @@ bool faiss::ThreadedIndex< IndexT >::isThreaded_ isThreaded_ + faiss::ThreadedIndex::isThreaded_ Is this index multi-threaded? @@ -644,15 +679,16 @@ - - - + + + void void faiss::ThreadedIndex< IndexT >::waitAndHandleFutures - (std::vector< std::future< bool >> &v) + (std::vector< std::future< bool > > &v) waitAndHandleFutures + faiss::ThreadedIndex::waitAndHandleFutures - std::vector< std::future< bool >> & + std::vector< std::future< bool > > & v @@ -663,13 +699,22 @@ - + IndexShards with a common coarse quantizer. All the indexes added should be IndexIVFInterface indexes so that the search_precomputed can be called. + + + + + + + + + @@ -678,27 +723,35 @@ + + + + - - - - - - - + + - - + + + + + + + + + + + @@ -707,38 +760,21 @@ - - - - - - - cp - - clustering_index quantizer + + cp + - - - - - - - - - - - - - - - + + + + @@ -749,8 +785,8 @@ faiss::IndexShardsIVFadd_with_ids faiss::IndexShardsIVFaddIndex faiss::IndexShardsIVFaddIndex - faiss::IndexShardsIVFat - faiss::IndexShardsIVFat + faiss::IndexShardsIVFat + faiss::IndexShardsIVFat faiss::IndexShardsIVFclustering_index faiss::IndexShardsIVFcoarse_code_size faiss::IndexShardsIVFcomponent_t @@ -786,7 +822,7 @@ faiss::IndexShardsIVFThreadedIndex faiss::IndexShardsIVFtrain faiss::IndexShardsIVFtrain_q1 - faiss::IndexShardsIVFwaitAndHandleFutures + faiss::IndexShardsIVFwaitAndHandleFutures faiss::IndexShardsIVF~Level1Quantizer faiss::IndexShardsIVF~ThreadedIndex diff --git a/xml/structfaiss_1_1IndexShardsTemplate.xml b/xml/structfaiss_1_1IndexShardsTemplate.xml index 1ff531308a..a6a17210c0 100644 --- a/xml/structfaiss_1_1IndexShardsTemplate.xml +++ b/xml/structfaiss_1_1IndexShardsTemplate.xml @@ -1,5 +1,5 @@ - + faiss::IndexShardsTemplate faiss::ThreadedIndex< IndexT > @@ -10,12 +10,13 @@ typename IndexT - + typename IndexT::component_t using faiss::IndexShardsTemplate< IndexT >::component_t = typename IndexT::component_t component_t + faiss::IndexShardsTemplate::component_t @@ -29,6 +30,7 @@ using faiss::IndexShardsTemplate< IndexT >::distance_t = typename IndexT::distance_t distance_t + faiss::IndexShardsTemplate::distance_t @@ -37,13 +39,14 @@ - - + + bool bool faiss::IndexShardsTemplate< IndexT >::successive_ids successive_ids + faiss::IndexShardsTemplate::successive_ids @@ -57,6 +60,7 @@ bool faiss::ThreadedIndex< IndexT >::own_indices own_indices + faiss::ThreadedIndex::own_indices = false Whether or not we are responsible for deleting our contained indices. @@ -67,13 +71,14 @@ - - + + faiss::IndexShardsTemplate< IndexT >::IndexShardsTemplate (bool threaded=false, bool successive_ids=true) IndexShardsTemplate + faiss::IndexShardsTemplate::IndexShardsTemplate bool threaded @@ -116,6 +121,7 @@ faiss::IndexShardsTemplate< IndexT >::IndexShardsTemplate (idx_t d, bool threaded=false, bool successive_ids=true) IndexShardsTemplate + faiss::IndexShardsTemplate::IndexShardsTemplate idx_t d @@ -161,6 +167,7 @@ faiss::IndexShardsTemplate< IndexT >::IndexShardsTemplate (int d, bool threaded=false, bool successive_ids=true) IndexShardsTemplate + faiss::IndexShardsTemplate::IndexShardsTemplate int d @@ -189,6 +196,7 @@ void faiss::IndexShardsTemplate< IndexT >::add_shard (IndexT *index) add_shard + faiss::IndexShardsTemplate::add_shard IndexT * index @@ -207,6 +215,7 @@ void faiss::IndexShardsTemplate< IndexT >::remove_shard (IndexT *index) remove_shard + faiss::IndexShardsTemplate::remove_shard IndexT * index @@ -225,6 +234,7 @@ void faiss::IndexShardsTemplate< IndexT >::add (idx_t n, const component_t *x) override add + faiss::IndexShardsTemplate::add idx_t n @@ -247,6 +257,7 @@ void faiss::IndexShardsTemplate< IndexT >::add_with_ids (idx_t n, const component_t *x, const idx_t *xids) override add_with_ids + faiss::IndexShardsTemplate::add_with_ids idx_t n @@ -279,6 +290,7 @@ void faiss::IndexShardsTemplate< IndexT >::search (idx_t n, const component_t *x, idx_t k, distance_t *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexShardsTemplate::search idx_t n @@ -317,6 +329,7 @@ void faiss::IndexShardsTemplate< IndexT >::train (idx_t n, const component_t *x) override train + faiss::IndexShardsTemplate::train idx_t n @@ -338,6 +351,7 @@ virtual void faiss::IndexShardsTemplate< IndexT >::syncWithSubIndexes () syncWithSubIndexes + faiss::IndexShardsTemplate::syncWithSubIndexes @@ -352,6 +366,7 @@ void faiss::ThreadedIndex< IndexT >::addIndex (IndexT *index) addIndex + faiss::ThreadedIndex::addIndex IndexT * index @@ -370,6 +385,7 @@ void faiss::ThreadedIndex< IndexT >::removeIndex (IndexT *index) removeIndex + faiss::ThreadedIndex::removeIndex IndexT * index @@ -388,6 +404,7 @@ void faiss::ThreadedIndex< IndexT >::runOnIndex (std::function< void(int, IndexT *)> f) runOnIndex + faiss::ThreadedIndex::runOnIndex std::function< void(int, IndexT *)> f @@ -406,6 +423,7 @@ void faiss::ThreadedIndex< IndexT >::runOnIndex (std::function< void(int, const IndexT *)> f) const runOnIndex + faiss::ThreadedIndex::runOnIndex std::function< void(int, const IndexT *)> f @@ -423,6 +441,7 @@ void faiss::ThreadedIndex< IndexT >::reset () override reset + faiss::ThreadedIndex::reset @@ -437,6 +456,7 @@ int faiss::ThreadedIndex< IndexT >::count () const count + faiss::ThreadedIndex::count Returns the number of sub-indices. @@ -446,11 +466,12 @@ - + IndexT * - IndexT* faiss::ThreadedIndex< IndexT >::at + IndexT * faiss::ThreadedIndex< IndexT >::at (size_t i) at + faiss::ThreadedIndex::at size_t i @@ -464,11 +485,12 @@ - + const IndexT * - const IndexT* faiss::ThreadedIndex< IndexT >::at + const IndexT * faiss::ThreadedIndex< IndexT >::at (size_t i) const at + faiss::ThreadedIndex::at size_t i @@ -482,13 +504,14 @@ - - + + void void faiss::IndexShardsTemplate< IndexT >::onAfterAddIndex (IndexT *index) override onAfterAddIndex + faiss::IndexShardsTemplate::onAfterAddIndex onAfterAddIndex IndexT * @@ -508,6 +531,7 @@ void faiss::IndexShardsTemplate< IndexT >::onAfterRemoveIndex (IndexT *index) override onAfterRemoveIndex + faiss::IndexShardsTemplate::onAfterRemoveIndex onAfterRemoveIndex IndexT * @@ -522,13 +546,14 @@ - - + + std::vector< std::pair< IndexT *, std::unique_ptr< WorkerThread > > > std::vector<std::pair<IndexT*, std::unique_ptr<WorkerThread> > > faiss::ThreadedIndex< IndexT >::indices_ indices_ + faiss::ThreadedIndex::indices_ Collection of Index instances, with their managing worker thread if any. @@ -543,6 +568,7 @@ bool faiss::ThreadedIndex< IndexT >::isThreaded_ isThreaded_ + faiss::ThreadedIndex::isThreaded_ Is this index multi-threaded? @@ -552,15 +578,16 @@ - - - + + + void void faiss::ThreadedIndex< IndexT >::waitAndHandleFutures - (std::vector< std::future< bool >> &v) + (std::vector< std::future< bool > > &v) waitAndHandleFutures + faiss::ThreadedIndex::waitAndHandleFutures - std::vector< std::future< bool >> & + std::vector< std::future< bool > > & v @@ -571,18 +598,15 @@ - + Index that concatenates the results from several sub-indexes - - - - - + + @@ -590,17 +614,23 @@ + + + + + + + + - - @@ -613,9 +643,6 @@ - - - @@ -623,8 +650,8 @@ faiss::IndexShardsTemplateadd_shard faiss::IndexShardsTemplateadd_with_ids faiss::IndexShardsTemplateaddIndex - faiss::IndexShardsTemplateat - faiss::IndexShardsTemplateat + faiss::IndexShardsTemplateat + faiss::IndexShardsTemplateat faiss::IndexShardsTemplatecomponent_t faiss::IndexShardsTemplatecount faiss::IndexShardsTemplatedistance_t @@ -647,7 +674,7 @@ faiss::IndexShardsTemplateThreadedIndex faiss::IndexShardsTemplateThreadedIndex faiss::IndexShardsTemplatetrain - faiss::IndexShardsTemplatewaitAndHandleFutures + faiss::IndexShardsTemplatewaitAndHandleFutures faiss::IndexShardsTemplate~ThreadedIndex diff --git a/xml/structfaiss_1_1IndexSplitVectors.xml b/xml/structfaiss_1_1IndexSplitVectors.xml index 1403c31452..0f8a6d93db 100644 --- a/xml/structfaiss_1_1IndexSplitVectors.xml +++ b/xml/structfaiss_1_1IndexSplitVectors.xml @@ -1,15 +1,16 @@ - + faiss::IndexSplitVectors faiss::Index MetaIndexes.h - + bool bool faiss::IndexSplitVectors::own_fields own_fields + faiss::IndexSplitVectors::own_fields @@ -23,6 +24,7 @@ bool faiss::IndexSplitVectors::threaded threaded + faiss::IndexSplitVectors::threaded @@ -36,6 +38,7 @@ std::vector<Index*> faiss::IndexSplitVectors::sub_indexes sub_indexes + faiss::IndexSplitVectors::sub_indexes @@ -49,6 +52,7 @@ idx_t faiss::IndexSplitVectors::sum_d sum_d + faiss::IndexSplitVectors::sum_d @@ -62,6 +66,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -76,6 +81,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -90,6 +96,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -104,6 +111,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -118,6 +126,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -132,6 +141,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -141,13 +151,14 @@ - - + + faiss::IndexSplitVectors::IndexSplitVectors (idx_t d, bool threaded=false) IndexSplitVectors + faiss::IndexSplitVectors::IndexSplitVectors idx_t d @@ -171,6 +182,7 @@ void faiss::IndexSplitVectors::add_sub_index (Index *) add_sub_index + faiss::IndexSplitVectors::add_sub_index Index * @@ -187,6 +199,7 @@ void faiss::IndexSplitVectors::sync_with_sub_indexes () sync_with_sub_indexes + faiss::IndexSplitVectors::sync_with_sub_indexes @@ -200,6 +213,7 @@ void faiss::IndexSplitVectors::add (idx_t n, const float *x) override add + faiss::IndexSplitVectors::add add idx_t @@ -241,6 +255,7 @@ void faiss::IndexSplitVectors::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::IndexSplitVectors::search search idx_t @@ -324,6 +339,7 @@ void faiss::IndexSplitVectors::train (idx_t n, const float *x) override train + faiss::IndexSplitVectors::train train idx_t @@ -365,6 +381,7 @@ void faiss::IndexSplitVectors::reset () override reset + faiss::IndexSplitVectors::reset reset removes all elements from the database. @@ -380,6 +397,7 @@ faiss::IndexSplitVectors::~IndexSplitVectors () override ~IndexSplitVectors + faiss::IndexSplitVectors::~IndexSplitVectors @@ -393,6 +411,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -452,6 +471,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -530,6 +550,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -596,6 +617,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -620,6 +642,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -673,6 +696,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -726,6 +750,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -783,6 +808,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -880,6 +906,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -935,6 +962,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -997,15 +1025,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1021,6 +1050,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1042,8 +1073,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1107,14 +1140,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1179,6 +1212,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1207,6 +1241,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1229,6 +1264,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1270,13 +1306,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1290,6 +1327,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1298,35 +1336,35 @@ - + splits input vectors in segments and assigns each segment to a sub-index used to distribute a MultiIndexQuantizer + + + + + + - - - - - - @@ -1341,7 +1379,7 @@ faiss::IndexSplitVectorscompute_residual_n faiss::IndexSplitVectorsd faiss::IndexSplitVectorsdistance_t - faiss::IndexSplitVectorsget_distance_computer + faiss::IndexSplitVectorsget_distance_computer faiss::IndexSplitVectorsIndex faiss::IndexSplitVectorsIndexSplitVectors faiss::IndexSplitVectorsis_trained diff --git a/xml/structfaiss_1_1InterruptCallback.xml b/xml/structfaiss_1_1InterruptCallback.xml index 8ebbde63a8..1a9033d43e 100644 --- a/xml/structfaiss_1_1InterruptCallback.xml +++ b/xml/structfaiss_1_1InterruptCallback.xml @@ -1,14 +1,15 @@ - + faiss::InterruptCallback faiss::TimeoutCallback - + std::mutex std::mutex faiss::InterruptCallback::lock lock + faiss::InterruptCallback::lock @@ -22,6 +23,7 @@ std::unique_ptr<InterruptCallback> faiss::InterruptCallback::instance instance + faiss::InterruptCallback::instance @@ -30,13 +32,14 @@ - - + + bool virtual bool faiss::InterruptCallback::want_interrupt ()=0 want_interrupt + faiss::InterruptCallback::want_interrupt want_interrupt @@ -51,6 +54,7 @@ virtual faiss::InterruptCallback::~InterruptCallback () ~InterruptCallback + faiss::InterruptCallback::~InterruptCallback @@ -59,13 +63,14 @@ - - + + void static void faiss::InterruptCallback::clear_instance () clear_instance + faiss::InterruptCallback::clear_instance @@ -79,6 +84,7 @@ static void faiss::InterruptCallback::check () check + faiss::InterruptCallback::check @@ -97,6 +103,7 @@ static bool faiss::InterruptCallback::is_interrupted () is_interrupted + faiss::InterruptCallback::is_interrupted @@ -111,6 +118,7 @@ static size_t faiss::InterruptCallback::get_period_hint (size_t flops) get_period_hint + faiss::InterruptCallback::get_period_hint size_t flops @@ -124,22 +132,22 @@ - + + + + + - - - - diff --git a/xml/structfaiss_1_1IntersectionCriterion.xml b/xml/structfaiss_1_1IntersectionCriterion.xml index 4be139c4c2..63cea19011 100644 --- a/xml/structfaiss_1_1IntersectionCriterion.xml +++ b/xml/structfaiss_1_1IntersectionCriterion.xml @@ -1,14 +1,15 @@ - + faiss::IntersectionCriterion faiss::AutoTuneCriterion - + idx_t idx_t faiss::IntersectionCriterion::R R + faiss::IntersectionCriterion::R @@ -22,6 +23,7 @@ idx_t faiss::AutoTuneCriterion::nq nq + faiss::AutoTuneCriterion::nq nb of queries this criterion is evaluated on @@ -36,6 +38,7 @@ idx_t faiss::AutoTuneCriterion::nnn nnn + faiss::AutoTuneCriterion::nnn nb of NNs that the query should request @@ -50,6 +53,7 @@ idx_t faiss::AutoTuneCriterion::gt_nnn gt_nnn + faiss::AutoTuneCriterion::gt_nnn nb of GT NNs required to evaluate criterion @@ -64,6 +68,7 @@ std::vector<float> faiss::AutoTuneCriterion::gt_D gt_D + faiss::AutoTuneCriterion::gt_D Ground-truth distances (size nq * gt_nnn) @@ -78,6 +83,7 @@ std::vector<idx_t> faiss::AutoTuneCriterion::gt_I gt_I + faiss::AutoTuneCriterion::gt_I Ground-truth indexes (size nq * gt_nnn) @@ -87,13 +93,14 @@ - - + + faiss::IntersectionCriterion::IntersectionCriterion (idx_t nq, idx_t R) IntersectionCriterion + faiss::IntersectionCriterion::IntersectionCriterion idx_t nq @@ -115,6 +122,7 @@ double faiss::IntersectionCriterion::evaluate (const float *D, const idx_t *I) const override evaluate + faiss::IntersectionCriterion::evaluate evaluate const float * @@ -158,6 +166,7 @@ faiss::IntersectionCriterion::~IntersectionCriterion () override ~IntersectionCriterion + faiss::IntersectionCriterion::~IntersectionCriterion @@ -171,6 +180,7 @@ void faiss::AutoTuneCriterion::set_groundtruth (int gt_nnn, const float *gt_D_in, const idx_t *gt_I_in) set_groundtruth + faiss::AutoTuneCriterion::set_groundtruth int gt_nnn @@ -210,34 +220,34 @@ - + + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1InvertedListScanner.xml b/xml/structfaiss_1_1InvertedListScanner.xml index b3dc8603eb..49579fc605 100644 --- a/xml/structfaiss_1_1InvertedListScanner.xml +++ b/xml/structfaiss_1_1InvertedListScanner.xml @@ -1,14 +1,15 @@ - + faiss::InvertedListScanner IndexIVF.h - + idx_t idx_t faiss::InvertedListScanner::list_no list_no + faiss::InvertedListScanner::list_no = -1 remember current list @@ -24,6 +25,7 @@ bool faiss::InvertedListScanner::keep_max keep_max + faiss::InvertedListScanner::keep_max = false @@ -39,6 +41,7 @@ bool faiss::InvertedListScanner::store_pairs store_pairs + faiss::InvertedListScanner::store_pairs store positions in invlists rather than labels @@ -53,6 +56,7 @@ const IDSelector* faiss::InvertedListScanner::sel sel + faiss::InvertedListScanner::sel search in this subset of ids @@ -67,6 +71,7 @@ size_t faiss::InvertedListScanner::code_size code_size + faiss::InvertedListScanner::code_size = 0 used in default implementation of scan_codes @@ -77,13 +82,14 @@ - - + + faiss::InvertedListScanner::InvertedListScanner (bool store_pairs=false, const IDSelector *sel=nullptr) InvertedListScanner + faiss::InvertedListScanner::InvertedListScanner bool store_pairs @@ -107,6 +113,7 @@ virtual void faiss::InvertedListScanner::set_query (const float *query_vector)=0 set_query + faiss::InvertedListScanner::set_query const float * query_vector @@ -125,6 +132,7 @@ virtual void faiss::InvertedListScanner::set_list (idx_t list_no, float coarse_dis)=0 set_list + faiss::InvertedListScanner::set_list idx_t list_no @@ -147,6 +155,7 @@ virtual float faiss::InvertedListScanner::distance_to_code (const uint8_t *code) const =0 distance_to_code + faiss::InvertedListScanner::distance_to_code const uint8_t * code @@ -165,6 +174,7 @@ virtual size_t faiss::InvertedListScanner::scan_codes (size_t n, const uint8_t *codes, const idx_t *ids, float *distances, idx_t *labels, size_t k) const scan_codes + faiss::InvertedListScanner::scan_codes size_t n @@ -255,6 +265,7 @@ virtual size_t faiss::InvertedListScanner::iterate_codes (InvertedListsIterator *iterator, float *distances, idx_t *labels, size_t k, size_t &list_size) const iterate_codes + faiss::InvertedListScanner::iterate_codes InvertedListsIterator * iterator @@ -288,6 +299,7 @@ virtual void faiss::InvertedListScanner::scan_codes_range (size_t n, const uint8_t *codes, const idx_t *ids, float radius, RangeQueryResult &result) const scan_codes_range + faiss::InvertedListScanner::scan_codes_range size_t n @@ -323,6 +335,7 @@ virtual void faiss::InvertedListScanner::iterate_codes_range (InvertedListsIterator *iterator, float radius, RangeQueryResult &result, size_t &list_size) const iterate_codes_range + faiss::InvertedListScanner::iterate_codes_range InvertedListsIterator * iterator @@ -352,6 +365,7 @@ virtual faiss::InvertedListScanner::~InvertedListScanner () ~InvertedListScanner + faiss::InvertedListScanner::~InvertedListScanner @@ -360,13 +374,17 @@ - + Object that handles a query. The inverted lists to scan are provided externally. The object has a lot of state, but distance_to_code and scan_codes can be called in multiple threads + + + + @@ -374,10 +392,6 @@ sel - - - - diff --git a/xml/structfaiss_1_1InvertedLists.xml b/xml/structfaiss_1_1InvertedLists.xml index 10a0f0dac6..62180efec4 100644 --- a/xml/structfaiss_1_1InvertedLists.xml +++ b/xml/structfaiss_1_1InvertedLists.xml @@ -1,5 +1,5 @@ - + faiss::InvertedLists faiss::ArrayInvertedLists @@ -9,10 +9,11 @@ InvertedLists.h faiss::InvertedLists::ScopedCodes faiss::InvertedLists::ScopedIds - + int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -63,13 +64,14 @@ - - + + size_t size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -84,6 +86,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -98,6 +101,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -108,13 +112,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -125,13 +130,14 @@ - - + + faiss::InvertedLists::InvertedLists (size_t nlist, size_t code_size) InvertedLists + faiss::InvertedLists::InvertedLists size_t nlist @@ -153,6 +159,7 @@ virtual faiss::InvertedLists::~InvertedLists () ~InvertedLists + faiss::InvertedLists::~InvertedLists @@ -166,6 +173,7 @@ virtual size_t faiss::InvertedLists::list_size (size_t list_no) const =0 list_size + faiss::InvertedLists::list_size list_size list_size list_size @@ -187,19 +195,20 @@ - + const uint8_t * - virtual const uint8_t* faiss::InvertedLists::get_codes + virtual const uint8_t * faiss::InvertedLists::get_codes (size_t list_no) const =0 get_codes - get_codes - get_codes - get_codes - get_codes - get_codes - get_codes - get_codes - get_codes + faiss::InvertedLists::get_codes + get_codes + get_codes + get_codes + get_codes + get_codes + get_codes + get_codes + get_codes size_t list_no @@ -216,19 +225,20 @@ - + const idx_t * - virtual const idx_t* faiss::InvertedLists::get_ids + virtual const idx_t * faiss::InvertedLists::get_ids (size_t list_no) const =0 get_ids - get_ids - get_ids - get_ids - get_ids - get_ids - get_ids - get_ids - get_ids + faiss::InvertedLists::get_ids + get_ids + get_ids + get_ids + get_ids + get_ids + get_ids + get_ids + get_ids size_t list_no @@ -250,6 +260,7 @@ virtual void faiss::InvertedLists::release_codes (size_t list_no, const uint8_t *codes) const release_codes + faiss::InvertedLists::release_codes release_codes release_codes release_codes @@ -277,6 +288,7 @@ virtual void faiss::InvertedLists::release_ids (size_t list_no, const idx_t *ids) const release_ids + faiss::InvertedLists::release_ids release_ids release_ids release_ids @@ -304,6 +316,7 @@ virtual idx_t faiss::InvertedLists::get_single_id (size_t list_no, size_t offset) const get_single_id + faiss::InvertedLists::get_single_id get_single_id get_single_id get_single_id @@ -328,16 +341,17 @@ - + const uint8_t * - virtual const uint8_t* faiss::InvertedLists::get_single_code + virtual const uint8_t * faiss::InvertedLists::get_single_code (size_t list_no, size_t offset) const get_single_code - get_single_code - get_single_code - get_single_code - get_single_code - get_single_code + faiss::InvertedLists::get_single_code + get_single_code + get_single_code + get_single_code + get_single_code + get_single_code size_t list_no @@ -362,6 +376,7 @@ virtual void faiss::InvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const prefetch_lists + faiss::InvertedLists::prefetch_lists prefetch_lists prefetch_lists prefetch_lists @@ -390,6 +405,7 @@ virtual bool faiss::InvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const is_empty + faiss::InvertedLists::is_empty is_empty size_t @@ -409,11 +425,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -437,6 +454,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -468,6 +486,7 @@ virtual size_t faiss::InvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code)=0 add_entries + faiss::InvertedLists::add_entries add_entries add_entries add_entries @@ -501,6 +520,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -530,6 +550,7 @@ virtual void faiss::InvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code)=0 update_entries + faiss::InvertedLists::update_entries update_entries update_entries update_entries @@ -567,6 +588,7 @@ virtual void faiss::InvertedLists::resize (size_t list_no, size_t new_size)=0 resize + faiss::InvertedLists::resize resize resize resize @@ -592,6 +614,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -605,6 +628,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -627,6 +651,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -659,6 +684,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -673,6 +699,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -687,6 +714,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -696,7 +724,7 @@ - + @@ -708,9 +736,17 @@ - - - + + + + + + + + + + + @@ -718,15 +754,19 @@ + + + + - - - + + + @@ -736,6 +776,12 @@ + + + + + + @@ -748,24 +794,6 @@ - - - - - - - - - - - - - - - - - - @@ -774,10 +802,10 @@ faiss::InvertedListscode_size faiss::InvertedListscompute_ntotal faiss::InvertedListscopy_subset_to - faiss::InvertedListsget_codes - faiss::InvertedListsget_ids - faiss::InvertedListsget_iterator - faiss::InvertedListsget_single_code + faiss::InvertedListsget_codes + faiss::InvertedListsget_ids + faiss::InvertedListsget_iterator + faiss::InvertedListsget_single_code faiss::InvertedListsget_single_id faiss::InvertedListsimbalance_factor faiss::InvertedListsINVALID_CODE_SIZE diff --git a/xml/structfaiss_1_1InvertedListsIOHook.xml b/xml/structfaiss_1_1InvertedListsIOHook.xml index 5749e02a8e..352172e809 100644 --- a/xml/structfaiss_1_1InvertedListsIOHook.xml +++ b/xml/structfaiss_1_1InvertedListsIOHook.xml @@ -1,16 +1,17 @@ - + faiss::InvertedListsIOHook faiss::BlockInvertedListsIOHook faiss::OnDiskInvertedListsIOHook InvertedListsIOHook.h - + const std::string const std::string faiss::InvertedListsIOHook::key key + faiss::InvertedListsIOHook::key string version of the fourcc @@ -25,6 +26,7 @@ const std::string faiss::InvertedListsIOHook::classname classname + faiss::InvertedListsIOHook::classname typeid.name @@ -34,13 +36,14 @@ - - + + faiss::InvertedListsIOHook::InvertedListsIOHook (const std::string &key, const std::string &classname) InvertedListsIOHook + faiss::InvertedListsIOHook::InvertedListsIOHook const std::string & key @@ -62,6 +65,7 @@ virtual void faiss::InvertedListsIOHook::write (const InvertedLists *ils, IOWriter *f) const =0 write + faiss::InvertedListsIOHook::write write write @@ -81,13 +85,14 @@ - + InvertedLists * - virtual InvertedLists* faiss::InvertedListsIOHook::read + virtual InvertedLists * faiss::InvertedListsIOHook::read (IOReader *f, int io_flags) const =0 read - read - read + faiss::InvertedListsIOHook::read + read + read IOReader * f @@ -105,12 +110,13 @@ - + InvertedLists * - virtual InvertedLists* faiss::InvertedListsIOHook::read_ArrayInvertedLists + virtual InvertedLists * faiss::InvertedListsIOHook::read_ArrayInvertedLists (IOReader *f, int io_flags, size_t nlist, size_t code_size, const std::vector< size_t > &sizes) const read_ArrayInvertedLists - read_ArrayInvertedLists + faiss::InvertedListsIOHook::read_ArrayInvertedLists + read_ArrayInvertedLists IOReader * f @@ -146,6 +152,7 @@ virtual faiss::InvertedListsIOHook::~InvertedListsIOHook () ~InvertedListsIOHook + faiss::InvertedListsIOHook::~InvertedListsIOHook @@ -154,13 +161,14 @@ - - + + void static void faiss::InvertedListsIOHook::add_callback (InvertedListsIOHook *) add_callback + faiss::InvertedListsIOHook::add_callback InvertedListsIOHook * @@ -177,6 +185,7 @@ static void faiss::InvertedListsIOHook::print_callbacks () print_callbacks + faiss::InvertedListsIOHook::print_callbacks @@ -185,11 +194,12 @@ - + InvertedListsIOHook * - static InvertedListsIOHook* faiss::InvertedListsIOHook::lookup + static InvertedListsIOHook * faiss::InvertedListsIOHook::lookup (int h) lookup + faiss::InvertedListsIOHook::lookup int h @@ -202,11 +212,12 @@ - + InvertedListsIOHook * - static InvertedListsIOHook* faiss::InvertedListsIOHook::lookup_classname + static InvertedListsIOHook * faiss::InvertedListsIOHook::lookup_classname (const std::string &classname) lookup_classname + faiss::InvertedListsIOHook::lookup_classname const std::string & classname @@ -219,7 +230,7 @@ - + @@ -255,11 +266,11 @@ faiss::InvertedListsIOHookclassname faiss::InvertedListsIOHookInvertedListsIOHook faiss::InvertedListsIOHookkey - faiss::InvertedListsIOHooklookup - faiss::InvertedListsIOHooklookup_classname + faiss::InvertedListsIOHooklookup + faiss::InvertedListsIOHooklookup_classname faiss::InvertedListsIOHookprint_callbacks - faiss::InvertedListsIOHookread - faiss::InvertedListsIOHookread_ArrayInvertedLists + faiss::InvertedListsIOHookread + faiss::InvertedListsIOHookread_ArrayInvertedLists faiss::InvertedListsIOHookwrite faiss::InvertedListsIOHook~InvertedListsIOHook diff --git a/xml/structfaiss_1_1InvertedListsIterator.xml b/xml/structfaiss_1_1InvertedListsIterator.xml index 423710faf6..46356dffcc 100644 --- a/xml/structfaiss_1_1InvertedListsIterator.xml +++ b/xml/structfaiss_1_1InvertedListsIterator.xml @@ -1,13 +1,14 @@ - + faiss::InvertedListsIterator - + virtual faiss::InvertedListsIterator::~InvertedListsIterator () ~InvertedListsIterator + faiss::InvertedListsIterator::~InvertedListsIterator @@ -21,6 +22,7 @@ virtual bool faiss::InvertedListsIterator::is_available () const =0 is_available + faiss::InvertedListsIterator::is_available @@ -34,6 +36,7 @@ virtual void faiss::InvertedListsIterator::next ()=0 next + faiss::InvertedListsIterator::next @@ -42,11 +45,12 @@ - + std::pair< idx_t, const uint8_t * > - virtual std::pair<idx_t, const uint8_t*> faiss::InvertedListsIterator::get_id_and_codes + virtual std::pair< idx_t, const uint8_t * > faiss::InvertedListsIterator::get_id_and_codes ()=0 get_id_and_codes + faiss::InvertedListsIterator::get_id_and_codes @@ -55,14 +59,14 @@ - + - faiss::InvertedListsIteratorget_id_and_codes + faiss::InvertedListsIteratorget_id_and_codes faiss::InvertedListsIteratoris_available faiss::InvertedListsIteratornext faiss::InvertedListsIterator~InvertedListsIterator diff --git a/xml/structfaiss_1_1InvertedLists_1_1ScopedCodes.xml b/xml/structfaiss_1_1InvertedLists_1_1ScopedCodes.xml index c623ad3779..8b1472bb05 100644 --- a/xml/structfaiss_1_1InvertedLists_1_1ScopedCodes.xml +++ b/xml/structfaiss_1_1InvertedLists_1_1ScopedCodes.xml @@ -1,13 +1,14 @@ - + faiss::InvertedLists::ScopedCodes - + const InvertedLists * const InvertedLists* faiss::InvertedLists::ScopedCodes::il il + faiss::InvertedLists::ScopedCodes::il @@ -21,6 +22,7 @@ const uint8_t* faiss::InvertedLists::ScopedCodes::codes codes + faiss::InvertedLists::ScopedCodes::codes @@ -34,6 +36,7 @@ size_t faiss::InvertedLists::ScopedCodes::list_no list_no + faiss::InvertedLists::ScopedCodes::list_no @@ -42,13 +45,14 @@ - - + + faiss::InvertedLists::ScopedCodes::ScopedCodes (const InvertedLists *il, size_t list_no) ScopedCodes + faiss::InvertedLists::ScopedCodes::ScopedCodes const InvertedLists * il @@ -70,6 +74,7 @@ faiss::InvertedLists::ScopedCodes::ScopedCodes (const InvertedLists *il, size_t list_no, size_t offset) ScopedCodes + faiss::InvertedLists::ScopedCodes::ScopedCodes const InvertedLists * il @@ -90,11 +95,12 @@ - + const uint8_t * - const uint8_t* faiss::InvertedLists::ScopedCodes::get + const uint8_t * faiss::InvertedLists::ScopedCodes::get () get + faiss::InvertedLists::ScopedCodes::get @@ -108,6 +114,7 @@ faiss::InvertedLists::ScopedCodes::~ScopedCodes () ~ScopedCodes + faiss::InvertedLists::ScopedCodes::~ScopedCodes @@ -116,7 +123,7 @@ - + @@ -137,7 +144,7 @@ faiss::InvertedLists::ScopedCodescodes - faiss::InvertedLists::ScopedCodesget + faiss::InvertedLists::ScopedCodesget faiss::InvertedLists::ScopedCodesil faiss::InvertedLists::ScopedCodeslist_no faiss::InvertedLists::ScopedCodesScopedCodes diff --git a/xml/structfaiss_1_1InvertedLists_1_1ScopedIds.xml b/xml/structfaiss_1_1InvertedLists_1_1ScopedIds.xml index d75b19b952..7e5e2952c5 100644 --- a/xml/structfaiss_1_1InvertedLists_1_1ScopedIds.xml +++ b/xml/structfaiss_1_1InvertedLists_1_1ScopedIds.xml @@ -1,13 +1,14 @@ - + faiss::InvertedLists::ScopedIds - + const InvertedLists * const InvertedLists* faiss::InvertedLists::ScopedIds::il il + faiss::InvertedLists::ScopedIds::il @@ -21,6 +22,7 @@ const idx_t* faiss::InvertedLists::ScopedIds::ids ids + faiss::InvertedLists::ScopedIds::ids @@ -34,6 +36,7 @@ size_t faiss::InvertedLists::ScopedIds::list_no list_no + faiss::InvertedLists::ScopedIds::list_no @@ -42,13 +45,14 @@ - - + + faiss::InvertedLists::ScopedIds::ScopedIds (const InvertedLists *il, size_t list_no) ScopedIds + faiss::InvertedLists::ScopedIds::ScopedIds const InvertedLists * il @@ -65,11 +69,12 @@ - + const idx_t * - const idx_t* faiss::InvertedLists::ScopedIds::get + const idx_t * faiss::InvertedLists::ScopedIds::get () get + faiss::InvertedLists::ScopedIds::get @@ -83,6 +88,7 @@ idx_t faiss::InvertedLists::ScopedIds::operator[] (size_t i) const operator[] + faiss::InvertedLists::ScopedIds::operator[] size_t i @@ -100,6 +106,7 @@ faiss::InvertedLists::ScopedIds::~ScopedIds () ~ScopedIds + faiss::InvertedLists::ScopedIds::~ScopedIds @@ -108,7 +115,7 @@ - + @@ -128,7 +135,7 @@ - faiss::InvertedLists::ScopedIdsget + faiss::InvertedLists::ScopedIdsget faiss::InvertedLists::ScopedIdsids faiss::InvertedLists::ScopedIdsil faiss::InvertedLists::ScopedIdslist_no diff --git a/xml/structfaiss_1_1Level1Quantizer.xml b/xml/structfaiss_1_1Level1Quantizer.xml index 3602d1aea3..6120999c76 100644 --- a/xml/structfaiss_1_1Level1Quantizer.xml +++ b/xml/structfaiss_1_1Level1Quantizer.xml @@ -1,16 +1,17 @@ - + faiss::Level1Quantizer faiss::IndexIVFInterface faiss::IndexShardsIVF IndexIVF.h - + Index * Index* faiss::Level1Quantizer::quantizer quantizer + faiss::Level1Quantizer::quantizer = nullptr quantizer that maps vectors to inverted lists @@ -26,6 +27,7 @@ size_t faiss::Level1Quantizer::nlist nlist + faiss::Level1Quantizer::nlist = 0 number of inverted lists @@ -41,6 +43,7 @@ char faiss::Level1Quantizer::quantizer_trains_alone quantizer_trains_alone + faiss::Level1Quantizer::quantizer_trains_alone = 0 @@ -56,6 +59,7 @@ bool faiss::Level1Quantizer::own_fields own_fields + faiss::Level1Quantizer::own_fields = false whether object owns the quantizer @@ -71,6 +75,7 @@ ClusteringParameters faiss::Level1Quantizer::cp cp + faiss::Level1Quantizer::cp @@ -85,6 +90,7 @@ Index* faiss::Level1Quantizer::clustering_index clustering_index + faiss::Level1Quantizer::clustering_index = nullptr to override index used during clustering @@ -95,13 +101,14 @@ - - + + void void faiss::Level1Quantizer::train_q1 (size_t n, const float *x, bool verbose, MetricType metric_type) train_q1 + faiss::Level1Quantizer::train_q1 size_t n @@ -132,6 +139,7 @@ size_t faiss::Level1Quantizer::coarse_code_size () const coarse_code_size + faiss::Level1Quantizer::coarse_code_size compute the number of bytes required to store list ids @@ -146,6 +154,7 @@ void faiss::Level1Quantizer::encode_listno (idx_t list_no, uint8_t *code) const encode_listno + faiss::Level1Quantizer::encode_listno idx_t list_no @@ -167,6 +176,7 @@ idx_t faiss::Level1Quantizer::decode_listno (const uint8_t *code) const decode_listno + faiss::Level1Quantizer::decode_listno const uint8_t * code @@ -184,6 +194,7 @@ faiss::Level1Quantizer::Level1Quantizer (Index *quantizer, size_t nlist) Level1Quantizer + faiss::Level1Quantizer::Level1Quantizer Index * quantizer @@ -205,6 +216,7 @@ faiss::Level1Quantizer::Level1Quantizer () Level1Quantizer + faiss::Level1Quantizer::Level1Quantizer @@ -218,6 +230,7 @@ faiss::Level1Quantizer::~Level1Quantizer () ~Level1Quantizer + faiss::Level1Quantizer::~Level1Quantizer @@ -226,7 +239,7 @@ - + @@ -234,34 +247,46 @@ The class isolates the fields that are independent of the storage of the lists (especially training) - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + + + + + + + + + + + + + @@ -270,9 +295,15 @@ - - - + + + + + + + + + @@ -282,20 +313,10 @@ - - - - - - - - - - - - - - + + + + @@ -304,22 +325,28 @@ - - - - + + + + - - - - + + + + - - - - + + + + + + + + + + @@ -328,86 +355,72 @@ - - - + + + - - - - - - - - - - - - - - - + + + - - - - + + + + - - - - - + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + + + + + + + + + - cp - - clustering_index quantizer - - - - - - - - + + cp + diff --git a/xml/structfaiss_1_1LinearTransform.xml b/xml/structfaiss_1_1LinearTransform.xml index a376f2cb1b..143ff9f2b1 100644 --- a/xml/structfaiss_1_1LinearTransform.xml +++ b/xml/structfaiss_1_1LinearTransform.xml @@ -1,5 +1,5 @@ - + faiss::LinearTransform faiss::VectorTransform @@ -8,12 +8,13 @@ faiss::PCAMatrix faiss::RandomRotationMatrix VectorTransform.h - + bool bool faiss::LinearTransform::have_bias have_bias + faiss::LinearTransform::have_bias @@ -27,6 +28,7 @@ bool faiss::LinearTransform::is_orthonormal is_orthonormal + faiss::LinearTransform::is_orthonormal ! whether to use the bias term @@ -42,6 +44,7 @@ std::vector<float> faiss::LinearTransform::A A + faiss::LinearTransform::A Transformation matrix, size d_out * d_in. @@ -56,6 +59,7 @@ std::vector<float> faiss::LinearTransform::b b + faiss::LinearTransform::b bias vector, size d_out @@ -70,6 +74,7 @@ bool faiss::LinearTransform::verbose verbose + faiss::LinearTransform::verbose @@ -83,6 +88,7 @@ int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -96,6 +102,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -110,6 +117,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -119,13 +127,14 @@ - - + + faiss::LinearTransform::LinearTransform (int d_in=0, int d_out=0, bool have_bias=false) LinearTransform + faiss::LinearTransform::LinearTransform int d_in @@ -155,6 +164,7 @@ void faiss::LinearTransform::apply_noalloc (idx_t n, const float *x, float *xt) const override apply_noalloc + faiss::LinearTransform::apply_noalloc apply_noalloc idx_t @@ -182,6 +192,7 @@ void faiss::LinearTransform::transform_transpose (idx_t n, const float *y, float *x) const transform_transpose + faiss::LinearTransform::transform_transpose idx_t n @@ -208,6 +219,7 @@ void faiss::LinearTransform::reverse_transform (idx_t n, const float *xt, float *x) const override reverse_transform + faiss::LinearTransform::reverse_transform reverse_transform idx_t @@ -235,6 +247,7 @@ void faiss::LinearTransform::set_is_orthonormal () set_is_orthonormal + faiss::LinearTransform::set_is_orthonormal compute A^T * A to set the is_orthonormal flag @@ -249,6 +262,7 @@ void faiss::LinearTransform::print_if_verbose (const char *name, const std::vector< double > &mat, int n, int d) const print_if_verbose + faiss::LinearTransform::print_if_verbose const char * name @@ -278,6 +292,7 @@ void faiss::LinearTransform::check_identical (const VectorTransform &other) const override check_identical + faiss::LinearTransform::check_identical check_identical const VectorTransform & @@ -296,6 +311,7 @@ faiss::LinearTransform::~LinearTransform () override ~LinearTransform + faiss::LinearTransform::~LinearTransform @@ -309,6 +325,7 @@ virtual void faiss::VectorTransform::train (idx_t n, const float *x) train + faiss::VectorTransform::train train train train @@ -350,11 +367,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -391,35 +409,25 @@ - + Generic linear transformation, with bias term applied on output y = A * x + b - - - - - - - - - - - - - - - - + + + + + + @@ -432,6 +440,16 @@ + + + + + + + + + + @@ -448,7 +466,7 @@ faiss::LinearTransformA - faiss::LinearTransformapply + faiss::LinearTransformapply faiss::LinearTransformapply_noalloc faiss::LinearTransformb faiss::LinearTransformcheck_identical diff --git a/xml/structfaiss_1_1LocalSearchCoarseQuantizer.xml b/xml/structfaiss_1_1LocalSearchCoarseQuantizer.xml index 4865668b6e..4fe12be8e9 100644 --- a/xml/structfaiss_1_1LocalSearchCoarseQuantizer.xml +++ b/xml/structfaiss_1_1LocalSearchCoarseQuantizer.xml @@ -1,14 +1,15 @@ - + faiss::LocalSearchCoarseQuantizer faiss::AdditiveCoarseQuantizer - + LocalSearchQuantizer LocalSearchQuantizer faiss::LocalSearchCoarseQuantizer::lsq lsq + faiss::LocalSearchCoarseQuantizer::lsq The residual quantizer used to encode the vectors. @@ -23,6 +24,7 @@ AdditiveQuantizer* faiss::AdditiveCoarseQuantizer::aq aq + faiss::AdditiveCoarseQuantizer::aq @@ -36,6 +38,7 @@ std::vector<float> faiss::AdditiveCoarseQuantizer::centroid_norms centroid_norms + faiss::AdditiveCoarseQuantizer::centroid_norms norms of centroids, useful for knn-search @@ -50,6 +53,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -64,6 +68,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -78,6 +83,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -92,6 +98,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -106,6 +113,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -120,6 +128,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -129,13 +138,14 @@ - - + + faiss::LocalSearchCoarseQuantizer::LocalSearchCoarseQuantizer (int d, size_t M, size_t nbits, MetricType metric=METRIC_L2) LocalSearchCoarseQuantizer + faiss::LocalSearchCoarseQuantizer::LocalSearchCoarseQuantizer int d @@ -199,6 +209,7 @@ faiss::LocalSearchCoarseQuantizer::LocalSearchCoarseQuantizer () LocalSearchCoarseQuantizer + faiss::LocalSearchCoarseQuantizer::LocalSearchCoarseQuantizer @@ -212,6 +223,7 @@ void faiss::AdditiveCoarseQuantizer::add (idx_t n, const float *x) override add + faiss::AdditiveCoarseQuantizer::add add idx_t @@ -235,6 +247,7 @@ void faiss::AdditiveCoarseQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::AdditiveCoarseQuantizer::search search search @@ -319,6 +332,7 @@ void faiss::AdditiveCoarseQuantizer::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::AdditiveCoarseQuantizer::reconstruct reconstruct idx_t @@ -360,6 +374,7 @@ void faiss::AdditiveCoarseQuantizer::train (idx_t n, const float *x) override train + faiss::AdditiveCoarseQuantizer::train train idx_t @@ -401,6 +416,7 @@ void faiss::AdditiveCoarseQuantizer::reset () override reset + faiss::AdditiveCoarseQuantizer::reset reset N/A. @@ -416,6 +432,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -475,6 +492,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -553,6 +571,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -619,6 +638,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -643,6 +663,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -696,6 +717,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -753,6 +775,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -850,6 +873,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -905,6 +929,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -967,15 +992,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -991,6 +1017,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1012,8 +1040,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1077,14 +1107,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1149,6 +1179,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1177,6 +1208,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1199,6 +1231,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1240,13 +1273,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1260,6 +1294,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1268,43 +1303,52 @@ - + - - - - + + + + + + + + + + + + + + aq + - - - - - - - - - - + + + + - - icm_encoder_factory + + qnorm + + + + @@ -1317,6 +1361,12 @@ + + + + + + @@ -1332,37 +1382,22 @@ lsq - - - - - - - - + + + + - - qnorm + + icm_encoder_factory - - - - - - - - - - - - - aq - + + + @@ -1380,7 +1415,7 @@ faiss::LocalSearchCoarseQuantizercompute_residual_n faiss::LocalSearchCoarseQuantizerd faiss::LocalSearchCoarseQuantizerdistance_t - faiss::LocalSearchCoarseQuantizerget_distance_computer + faiss::LocalSearchCoarseQuantizerget_distance_computer faiss::LocalSearchCoarseQuantizerIndex faiss::LocalSearchCoarseQuantizeris_trained faiss::LocalSearchCoarseQuantizerLocalSearchCoarseQuantizer diff --git a/xml/structfaiss_1_1LocalSearchQuantizer.xml b/xml/structfaiss_1_1LocalSearchQuantizer.xml index 0280f88202..1774db9e5a 100644 --- a/xml/structfaiss_1_1LocalSearchQuantizer.xml +++ b/xml/structfaiss_1_1LocalSearchQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::LocalSearchQuantizer faiss::AdditiveQuantizer LocalSearchQuantizer.h - + size_t size_t faiss::LocalSearchQuantizer::K K + faiss::LocalSearchQuantizer::K number of codes per codebook @@ -24,6 +25,7 @@ size_t faiss::LocalSearchQuantizer::train_iters train_iters + faiss::LocalSearchQuantizer::train_iters = 25 number of iterations in training @@ -39,6 +41,7 @@ size_t faiss::LocalSearchQuantizer::encode_ils_iters encode_ils_iters + faiss::LocalSearchQuantizer::encode_ils_iters = 16 iterations of local search in encoding @@ -54,6 +57,7 @@ size_t faiss::LocalSearchQuantizer::train_ils_iters train_ils_iters + faiss::LocalSearchQuantizer::train_ils_iters = 8 iterations of local search in training @@ -69,6 +73,7 @@ size_t faiss::LocalSearchQuantizer::icm_iters icm_iters + faiss::LocalSearchQuantizer::icm_iters = 4 number of iterations in icm @@ -84,6 +89,7 @@ float faiss::LocalSearchQuantizer::p p + faiss::LocalSearchQuantizer::p = 0.5f temperature factor @@ -99,6 +105,7 @@ float faiss::LocalSearchQuantizer::lambd lambd + faiss::LocalSearchQuantizer::lambd = 1e-2f regularization factor @@ -114,6 +121,7 @@ size_t faiss::LocalSearchQuantizer::chunk_size chunk_size + faiss::LocalSearchQuantizer::chunk_size = 10000 nb of vectors to encode at a time @@ -129,6 +137,7 @@ int faiss::LocalSearchQuantizer::random_seed random_seed + faiss::LocalSearchQuantizer::random_seed = 0x12345 seed for random generator @@ -144,6 +153,7 @@ size_t faiss::LocalSearchQuantizer::nperts nperts + faiss::LocalSearchQuantizer::nperts = 4 number of perturbation in each code @@ -160,6 +170,7 @@ lsq::IcmEncoderFactory* faiss::LocalSearchQuantizer::icm_encoder_factory icm_encoder_factory + faiss::LocalSearchQuantizer::icm_encoder_factory = nullptr @@ -174,6 +185,7 @@ bool faiss::LocalSearchQuantizer::update_codebooks_with_double update_codebooks_with_double + faiss::LocalSearchQuantizer::update_codebooks_with_double = true @@ -188,6 +200,7 @@ size_t faiss::AdditiveQuantizer::M M + faiss::AdditiveQuantizer::M number of codebooks @@ -202,6 +215,7 @@ std::vector<size_t> faiss::AdditiveQuantizer::nbits nbits + faiss::AdditiveQuantizer::nbits bits for each step @@ -216,6 +230,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebooks codebooks + faiss::AdditiveQuantizer::codebooks codebooks @@ -230,6 +245,7 @@ std::vector<uint64_t> faiss::AdditiveQuantizer::codebook_offsets codebook_offsets + faiss::AdditiveQuantizer::codebook_offsets @@ -244,6 +260,7 @@ size_t faiss::AdditiveQuantizer::tot_bits tot_bits + faiss::AdditiveQuantizer::tot_bits = 0 total number of bits (indexes + norms) @@ -259,6 +276,7 @@ size_t faiss::AdditiveQuantizer::norm_bits norm_bits + faiss::AdditiveQuantizer::norm_bits = 0 bits allocated for the norms @@ -274,6 +292,7 @@ size_t faiss::AdditiveQuantizer::total_codebook_size total_codebook_size + faiss::AdditiveQuantizer::total_codebook_size = 0 size of the codebook in vectors @@ -289,6 +308,7 @@ bool faiss::AdditiveQuantizer::only_8bit only_8bit + faiss::AdditiveQuantizer::only_8bit = false are all nbits = 8 (use faster decoder) @@ -304,6 +324,7 @@ bool faiss::AdditiveQuantizer::verbose verbose + faiss::AdditiveQuantizer::verbose = false verbose during training? @@ -319,6 +340,7 @@ bool faiss::AdditiveQuantizer::is_trained is_trained + faiss::AdditiveQuantizer::is_trained = false is trained or not @@ -334,6 +356,7 @@ std::vector<float> faiss::AdditiveQuantizer::norm_tabs norm_tabs + faiss::AdditiveQuantizer::norm_tabs @@ -348,6 +371,7 @@ IndexFlat1D faiss::AdditiveQuantizer::qnorm qnorm + faiss::AdditiveQuantizer::qnorm store and search norms @@ -362,6 +386,7 @@ std::vector<float> faiss::AdditiveQuantizer::centroid_norms centroid_norms + faiss::AdditiveQuantizer::centroid_norms norms of all codebook entries (size total_codebook_size) @@ -376,6 +401,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebook_cross_products codebook_cross_products + faiss::AdditiveQuantizer::codebook_cross_products @@ -390,6 +416,7 @@ size_t faiss::AdditiveQuantizer::max_mem_distances max_mem_distances + faiss::AdditiveQuantizer::max_mem_distances = 5 * (size_t(1) << 30) @@ -405,6 +432,7 @@ Search_type_t faiss::AdditiveQuantizer::search_type search_type + faiss::AdditiveQuantizer::search_type Also determines what's in the codes. @@ -419,6 +447,7 @@ float faiss::AdditiveQuantizer::norm_min norm_min + faiss::AdditiveQuantizer::norm_min = NAN min/max for quantization of norms @@ -434,6 +463,7 @@ float faiss::AdditiveQuantizer::norm_max norm_max + faiss::AdditiveQuantizer::norm_max = NAN @@ -448,6 +478,7 @@ size_t faiss::Quantizer::d d + faiss::Quantizer::d size of the input vectors @@ -462,6 +493,7 @@ size_t faiss::Quantizer::code_size code_size + faiss::Quantizer::code_size bytes per indexed vector @@ -471,13 +503,14 @@ - - + + faiss::LocalSearchQuantizer::LocalSearchQuantizer (size_t d, size_t M, size_t nbits, Search_type_t search_type=ST_decompress) LocalSearchQuantizer + faiss::LocalSearchQuantizer::LocalSearchQuantizer size_t d @@ -508,6 +541,7 @@ faiss::LocalSearchQuantizer::LocalSearchQuantizer () LocalSearchQuantizer + faiss::LocalSearchQuantizer::LocalSearchQuantizer @@ -521,6 +555,7 @@ faiss::LocalSearchQuantizer::~LocalSearchQuantizer () override ~LocalSearchQuantizer + faiss::LocalSearchQuantizer::~LocalSearchQuantizer @@ -534,6 +569,7 @@ void faiss::LocalSearchQuantizer::train (size_t n, const float *x) override train + faiss::LocalSearchQuantizer::train train size_t @@ -567,6 +603,7 @@ void faiss::LocalSearchQuantizer::compute_codes_add_centroids (const float *x, uint8_t *codes, size_t n, const float *centroids=nullptr) const override compute_codes_add_centroids + faiss::LocalSearchQuantizer::compute_codes_add_centroids compute_codes_add_centroids const float * @@ -633,6 +670,7 @@ void faiss::LocalSearchQuantizer::update_codebooks (const float *x, const int32_t *codes, size_t n) update_codebooks + faiss::LocalSearchQuantizer::update_codebooks const float * x @@ -685,6 +723,7 @@ void faiss::LocalSearchQuantizer::icm_encode (int32_t *codes, const float *x, size_t n, size_t ils_iters, std::mt19937 &gen) const icm_encode + faiss::LocalSearchQuantizer::icm_encode int32_t * codes @@ -753,6 +792,7 @@ void faiss::LocalSearchQuantizer::icm_encode_impl (int32_t *codes, const float *x, const float *unaries, std::mt19937 &gen, size_t n, size_t ils_iters, bool verbose) const icm_encode_impl + faiss::LocalSearchQuantizer::icm_encode_impl int32_t * codes @@ -794,6 +834,7 @@ void faiss::LocalSearchQuantizer::icm_encode_step (int32_t *codes, const float *unaries, const float *binaries, size_t n, size_t n_iters) const icm_encode_step + faiss::LocalSearchQuantizer::icm_encode_step int32_t * codes @@ -827,6 +868,7 @@ void faiss::LocalSearchQuantizer::perturb_codes (int32_t *codes, size_t n, std::mt19937 &gen) const perturb_codes + faiss::LocalSearchQuantizer::perturb_codes int32_t * codes @@ -871,6 +913,7 @@ void faiss::LocalSearchQuantizer::perturb_codebooks (float T, const std::vector< float > &stddev, std::mt19937 &gen) perturb_codebooks + faiss::LocalSearchQuantizer::perturb_codebooks float T @@ -915,6 +958,7 @@ void faiss::LocalSearchQuantizer::compute_binary_terms (float *binaries) const compute_binary_terms + faiss::LocalSearchQuantizer::compute_binary_terms float * binaries @@ -943,6 +987,7 @@ void faiss::LocalSearchQuantizer::compute_unary_terms (const float *x, float *unaries, size_t n) const compute_unary_terms + faiss::LocalSearchQuantizer::compute_unary_terms const float * x @@ -995,6 +1040,7 @@ float faiss::LocalSearchQuantizer::evaluate (const int32_t *codes, const float *x, size_t n, float *objs=nullptr) const evaluate + faiss::LocalSearchQuantizer::evaluate const int32_t * codes @@ -1060,6 +1106,7 @@ void faiss::AdditiveQuantizer::compute_codebook_tables () compute_codebook_tables + faiss::AdditiveQuantizer::compute_codebook_tables @@ -1073,6 +1120,7 @@ uint64_t faiss::AdditiveQuantizer::encode_norm (float norm) const encode_norm + faiss::AdditiveQuantizer::encode_norm float norm @@ -1091,6 +1139,7 @@ uint32_t faiss::AdditiveQuantizer::encode_qcint (float x) const encode_qcint + faiss::AdditiveQuantizer::encode_qcint float x @@ -1109,6 +1158,7 @@ float faiss::AdditiveQuantizer::decode_qcint (uint32_t c) const decode_qcint + faiss::AdditiveQuantizer::decode_qcint uint32_t c @@ -1127,6 +1177,7 @@ void faiss::AdditiveQuantizer::set_derived_values () set_derived_values + faiss::AdditiveQuantizer::set_derived_values Train the norm quantizer. @@ -1141,6 +1192,7 @@ void faiss::AdditiveQuantizer::train_norm (size_t n, const float *norms) train_norm + faiss::AdditiveQuantizer::train_norm size_t n @@ -1162,6 +1214,7 @@ void faiss::AdditiveQuantizer::compute_codes (const float *x, uint8_t *codes, size_t n) const override compute_codes + faiss::AdditiveQuantizer::compute_codes compute_codes const float * @@ -1207,6 +1260,7 @@ void faiss::AdditiveQuantizer::pack_codes (size_t n, const int32_t *codes, uint8_t *packed_codes, int64_t ld_codes=-1, const float *norms=nullptr, const float *centroids=nullptr) const pack_codes + faiss::AdditiveQuantizer::pack_codes size_t n @@ -1290,6 +1344,7 @@ void faiss::AdditiveQuantizer::decode (const uint8_t *codes, float *x, size_t n) const override decode + faiss::AdditiveQuantizer::decode decode decode @@ -1336,6 +1391,7 @@ virtual void faiss::AdditiveQuantizer::decode_unpacked (const int32_t *codes, float *x, size_t n, int64_t ld_codes=-1) const decode_unpacked + faiss::AdditiveQuantizer::decode_unpacked decode_unpacked const int32_t * @@ -1398,6 +1454,7 @@ float faiss::AdditiveQuantizer::compute_1_distance_LUT (const uint8_t *codes, const float *LUT) const compute_1_distance_LUT + faiss::AdditiveQuantizer::compute_1_distance_LUT const uint8_t * codes @@ -1419,6 +1476,7 @@ void faiss::AdditiveQuantizer::decode_64bit (idx_t n, float *x) const decode_64bit + faiss::AdditiveQuantizer::decode_64bit idx_t n @@ -1441,6 +1499,7 @@ virtual void faiss::AdditiveQuantizer::compute_LUT (size_t n, const float *xq, float *LUT, float alpha=1.0f, long ld_lut=-1) const compute_LUT + faiss::AdditiveQuantizer::compute_LUT compute_LUT size_t @@ -1512,6 +1571,7 @@ void faiss::AdditiveQuantizer::knn_centroids_inner_product (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels) const knn_centroids_inner_product + faiss::AdditiveQuantizer::knn_centroids_inner_product idx_t n @@ -1546,6 +1606,7 @@ void faiss::AdditiveQuantizer::compute_centroid_norms (float *norms) const compute_centroid_norms + faiss::AdditiveQuantizer::compute_centroid_norms float * norms @@ -1574,6 +1635,7 @@ void faiss::AdditiveQuantizer::knn_centroids_L2 (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels, const float *centroid_norms) const knn_centroids_L2 + faiss::AdditiveQuantizer::knn_centroids_L2 idx_t n @@ -1607,11 +1669,12 @@ - - + + Search_type_t + faiss::AdditiveQuantizer::Search_type_t ST_decompress @@ -1699,7 +1762,7 @@ - + @@ -1710,37 +1773,37 @@ The trained codes are stored in codebooks which is called centroids in PQ and RQ. - - - - - - + + + + + + - - - - - - - - + + + + - - icm_encoder_factory + + qnorm + + + + @@ -1753,34 +1816,34 @@ + + + + + + - - - - - - - - + + + + - - qnorm + + icm_encoder_factory - - - - - + + + diff --git a/xml/structfaiss_1_1MaskedInvertedLists.xml b/xml/structfaiss_1_1MaskedInvertedLists.xml index f33f42e4e0..0c330ccc66 100644 --- a/xml/structfaiss_1_1MaskedInvertedLists.xml +++ b/xml/structfaiss_1_1MaskedInvertedLists.xml @@ -1,15 +1,16 @@ - + faiss::MaskedInvertedLists faiss::ReadOnlyInvertedLists InvertedLists.h - + const InvertedLists * const InvertedLists* faiss::MaskedInvertedLists::il0 il0 + faiss::MaskedInvertedLists::il0 @@ -23,6 +24,7 @@ const InvertedLists* faiss::MaskedInvertedLists::il1 il1 + faiss::MaskedInvertedLists::il1 @@ -36,6 +38,7 @@ size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -50,6 +53,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -64,6 +68,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -74,13 +79,14 @@ - - + + faiss::MaskedInvertedLists::MaskedInvertedLists (const InvertedLists *il0, const InvertedLists *il1) MaskedInvertedLists + faiss::MaskedInvertedLists::MaskedInvertedLists const InvertedLists * il0 @@ -102,6 +108,7 @@ size_t faiss::MaskedInvertedLists::list_size (size_t list_no) const override list_size + faiss::MaskedInvertedLists::list_size list_size size_t @@ -116,12 +123,13 @@ - + const uint8_t * - const uint8_t* faiss::MaskedInvertedLists::get_codes + const uint8_t * faiss::MaskedInvertedLists::get_codes (size_t list_no) const override get_codes - get_codes + faiss::MaskedInvertedLists::get_codes + get_codes size_t list_no @@ -138,12 +146,13 @@ - + const idx_t * - const idx_t* faiss::MaskedInvertedLists::get_ids + const idx_t * faiss::MaskedInvertedLists::get_ids (size_t list_no) const override get_ids - get_ids + faiss::MaskedInvertedLists::get_ids + get_ids size_t list_no @@ -165,6 +174,7 @@ void faiss::MaskedInvertedLists::release_codes (size_t list_no, const uint8_t *codes) const override release_codes + faiss::MaskedInvertedLists::release_codes release_codes size_t @@ -188,6 +198,7 @@ void faiss::MaskedInvertedLists::release_ids (size_t list_no, const idx_t *ids) const override release_ids + faiss::MaskedInvertedLists::release_ids release_ids size_t @@ -211,6 +222,7 @@ idx_t faiss::MaskedInvertedLists::get_single_id (size_t list_no, size_t offset) const override get_single_id + faiss::MaskedInvertedLists::get_single_id get_single_id size_t @@ -231,12 +243,13 @@ - + const uint8_t * - const uint8_t* faiss::MaskedInvertedLists::get_single_code + const uint8_t * faiss::MaskedInvertedLists::get_single_code (size_t list_no, size_t offset) const override get_single_code - get_single_code + faiss::MaskedInvertedLists::get_single_code + get_single_code size_t list_no @@ -261,6 +274,7 @@ void faiss::MaskedInvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const override prefetch_lists + faiss::MaskedInvertedLists::prefetch_lists prefetch_lists const idx_t * @@ -284,6 +298,7 @@ size_t faiss::ReadOnlyInvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override add_entries + faiss::ReadOnlyInvertedLists::add_entries add_entries size_t @@ -314,6 +329,7 @@ void faiss::ReadOnlyInvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override update_entries + faiss::ReadOnlyInvertedLists::update_entries update_entries size_t @@ -348,6 +364,7 @@ void faiss::ReadOnlyInvertedLists::resize (size_t list_no, size_t new_size) override resize + faiss::ReadOnlyInvertedLists::resize resize size_t @@ -370,6 +387,7 @@ virtual bool faiss::InvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const is_empty + faiss::InvertedLists::is_empty is_empty size_t @@ -389,11 +407,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -417,6 +436,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -448,6 +468,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -477,6 +498,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -490,6 +512,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -512,6 +535,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -544,6 +568,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -558,6 +583,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -572,6 +598,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -581,11 +608,12 @@ - - + + int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -636,13 +664,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -653,7 +682,7 @@ - + @@ -707,10 +736,10 @@ faiss::MaskedInvertedListscode_size faiss::MaskedInvertedListscompute_ntotal faiss::MaskedInvertedListscopy_subset_to - faiss::MaskedInvertedListsget_codes - faiss::MaskedInvertedListsget_ids - faiss::MaskedInvertedListsget_iterator - faiss::MaskedInvertedListsget_single_code + faiss::MaskedInvertedListsget_codes + faiss::MaskedInvertedListsget_ids + faiss::MaskedInvertedListsget_iterator + faiss::MaskedInvertedListsget_single_code faiss::MaskedInvertedListsget_single_id faiss::MaskedInvertedListsil0 faiss::MaskedInvertedListsil1 diff --git a/xml/structfaiss_1_1MatrixStats.xml b/xml/structfaiss_1_1MatrixStats.xml index a0aa563ca4..a1370e016f 100644 --- a/xml/structfaiss_1_1MatrixStats.xml +++ b/xml/structfaiss_1_1MatrixStats.xml @@ -1,16 +1,17 @@ - + faiss::MatrixStats MatrixStats.h faiss::MatrixStats::Occurrence faiss::MatrixStats::PerDimStats - + std::string std::string faiss::MatrixStats::comments comments + faiss::MatrixStats::comments @@ -24,6 +25,7 @@ size_t faiss::MatrixStats::n n + faiss::MatrixStats::n = 0 @@ -38,6 +40,7 @@ size_t faiss::MatrixStats::d d + faiss::MatrixStats::d = 0 @@ -52,6 +55,7 @@ size_t faiss::MatrixStats::n_collision n_collision + faiss::MatrixStats::n_collision = 0 @@ -66,6 +70,7 @@ size_t faiss::MatrixStats::n_valid n_valid + faiss::MatrixStats::n_valid = 0 @@ -80,6 +85,7 @@ size_t faiss::MatrixStats::n0 n0 + faiss::MatrixStats::n0 = 0 @@ -94,6 +100,7 @@ double faiss::MatrixStats::min_norm2 min_norm2 + faiss::MatrixStats::min_norm2 = HUGE_VALF @@ -108,6 +115,7 @@ double faiss::MatrixStats::max_norm2 max_norm2 + faiss::MatrixStats::max_norm2 = 0 @@ -122,6 +130,7 @@ uint64_t faiss::MatrixStats::hash_value hash_value + faiss::MatrixStats::hash_value = 0 @@ -136,6 +145,7 @@ std::vector<PerDimStats> faiss::MatrixStats::per_dim_stats per_dim_stats + faiss::MatrixStats::per_dim_stats @@ -149,6 +159,7 @@ std::unordered_map<uint64_t, Occurrence> faiss::MatrixStats::occurrences occurrences + faiss::MatrixStats::occurrences @@ -162,6 +173,7 @@ char* faiss::MatrixStats::buf buf + faiss::MatrixStats::buf @@ -175,6 +187,7 @@ size_t faiss::MatrixStats::nbuf nbuf + faiss::MatrixStats::nbuf @@ -183,13 +196,14 @@ - - + + faiss::MatrixStats::MatrixStats (size_t n, size_t d, const float *x) MatrixStats + faiss::MatrixStats::MatrixStats size_t n @@ -215,6 +229,7 @@ void faiss::MatrixStats::do_comment (const char *fmt,...) do_comment + faiss::MatrixStats::do_comment const char * fmt @@ -230,7 +245,7 @@ - + diff --git a/xml/structfaiss_1_1MatrixStats_1_1Occurrence.xml b/xml/structfaiss_1_1MatrixStats_1_1Occurrence.xml index 25b07d2c54..b47f87b43e 100644 --- a/xml/structfaiss_1_1MatrixStats_1_1Occurrence.xml +++ b/xml/structfaiss_1_1MatrixStats_1_1Occurrence.xml @@ -1,13 +1,14 @@ - + faiss::MatrixStats::Occurrence - + size_t size_t faiss::MatrixStats::Occurrence::first first + faiss::MatrixStats::Occurrence::first @@ -21,6 +22,7 @@ size_t faiss::MatrixStats::Occurrence::count count + faiss::MatrixStats::Occurrence::count @@ -29,7 +31,7 @@ - + diff --git a/xml/structfaiss_1_1MatrixStats_1_1PerDimStats.xml b/xml/structfaiss_1_1MatrixStats_1_1PerDimStats.xml index 22a90f3c17..3713ebe072 100644 --- a/xml/structfaiss_1_1MatrixStats_1_1PerDimStats.xml +++ b/xml/structfaiss_1_1MatrixStats_1_1PerDimStats.xml @@ -1,13 +1,14 @@ - + faiss::MatrixStats::PerDimStats - + size_t size_t faiss::MatrixStats::PerDimStats::n n + faiss::MatrixStats::PerDimStats::n = 0 counts of various special entries @@ -23,6 +24,7 @@ size_t faiss::MatrixStats::PerDimStats::n_nan n_nan + faiss::MatrixStats::PerDimStats::n_nan = 0 @@ -37,6 +39,7 @@ size_t faiss::MatrixStats::PerDimStats::n_inf n_inf + faiss::MatrixStats::PerDimStats::n_inf = 0 @@ -51,6 +54,7 @@ size_t faiss::MatrixStats::PerDimStats::n0 n0 + faiss::MatrixStats::PerDimStats::n0 = 0 @@ -65,6 +69,7 @@ float faiss::MatrixStats::PerDimStats::min min + faiss::MatrixStats::PerDimStats::min = HUGE_VALF to get min/max and stddev values @@ -80,6 +85,7 @@ float faiss::MatrixStats::PerDimStats::max max + faiss::MatrixStats::PerDimStats::max = -HUGE_VALF @@ -94,6 +100,7 @@ double faiss::MatrixStats::PerDimStats::sum sum + faiss::MatrixStats::PerDimStats::sum = 0 @@ -108,6 +115,7 @@ double faiss::MatrixStats::PerDimStats::sum2 sum2 + faiss::MatrixStats::PerDimStats::sum2 = 0 @@ -122,6 +130,7 @@ size_t faiss::MatrixStats::PerDimStats::n_valid n_valid + faiss::MatrixStats::PerDimStats::n_valid = 0 @@ -136,6 +145,7 @@ double faiss::MatrixStats::PerDimStats::mean mean + faiss::MatrixStats::PerDimStats::mean = NAN @@ -150,6 +160,7 @@ double faiss::MatrixStats::PerDimStats::stddev stddev + faiss::MatrixStats::PerDimStats::stddev = NAN @@ -159,13 +170,14 @@ - - + + void void faiss::MatrixStats::PerDimStats::add (float x) add + faiss::MatrixStats::PerDimStats::add float x @@ -183,6 +195,7 @@ void faiss::MatrixStats::PerDimStats::compute_mean_std () compute_mean_std + faiss::MatrixStats::PerDimStats::compute_mean_std @@ -191,7 +204,7 @@ - + diff --git a/xml/structfaiss_1_1MultiIndexQuantizer.xml b/xml/structfaiss_1_1MultiIndexQuantizer.xml index 066296d1fd..7c2ff040ae 100644 --- a/xml/structfaiss_1_1MultiIndexQuantizer.xml +++ b/xml/structfaiss_1_1MultiIndexQuantizer.xml @@ -1,16 +1,17 @@ - + faiss::MultiIndexQuantizer faiss::Index faiss::MultiIndexQuantizer2 IndexPQ.h - + ProductQuantizer ProductQuantizer faiss::MultiIndexQuantizer::pq pq + faiss::MultiIndexQuantizer::pq @@ -24,6 +25,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -38,6 +40,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -52,6 +55,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -66,6 +70,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -80,6 +85,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -94,6 +100,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -103,13 +110,14 @@ - - + + faiss::MultiIndexQuantizer::MultiIndexQuantizer (int d, size_t M, size_t nbits) MultiIndexQuantizer + faiss::MultiIndexQuantizer::MultiIndexQuantizer int d @@ -140,6 +148,7 @@ void faiss::MultiIndexQuantizer::train (idx_t n, const float *x) override train + faiss::MultiIndexQuantizer::train train train @@ -182,6 +191,7 @@ void faiss::MultiIndexQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::MultiIndexQuantizer::search search search @@ -266,6 +276,7 @@ void faiss::MultiIndexQuantizer::add (idx_t n, const float *x) override add + faiss::MultiIndexQuantizer::add add idx_t @@ -289,6 +300,7 @@ void faiss::MultiIndexQuantizer::reset () override reset + faiss::MultiIndexQuantizer::reset reset removes all elements from the database. @@ -304,6 +316,7 @@ faiss::MultiIndexQuantizer::MultiIndexQuantizer () MultiIndexQuantizer + faiss::MultiIndexQuantizer::MultiIndexQuantizer @@ -317,6 +330,7 @@ void faiss::MultiIndexQuantizer::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::MultiIndexQuantizer::reconstruct reconstruct idx_t @@ -358,6 +372,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -417,6 +432,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -495,6 +511,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -561,6 +578,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -585,6 +603,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -638,6 +657,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -695,6 +715,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -792,6 +813,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -847,6 +869,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -909,15 +932,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -933,6 +957,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -954,8 +980,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1019,14 +1047,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1091,6 +1119,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1119,6 +1148,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1141,6 +1171,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1182,13 +1213,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1202,6 +1234,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1210,7 +1243,7 @@ - + @@ -1252,21 +1285,21 @@ pq - - - - - - assign_index - cp + + assign_index + + + + + @@ -1281,7 +1314,7 @@ faiss::MultiIndexQuantizercompute_residual_n faiss::MultiIndexQuantizerd faiss::MultiIndexQuantizerdistance_t - faiss::MultiIndexQuantizerget_distance_computer + faiss::MultiIndexQuantizerget_distance_computer faiss::MultiIndexQuantizerIndex faiss::MultiIndexQuantizeris_trained faiss::MultiIndexQuantizermerge_from diff --git a/xml/structfaiss_1_1MultiIndexQuantizer2.xml b/xml/structfaiss_1_1MultiIndexQuantizer2.xml index 7a5c62cbaa..b1109071b5 100644 --- a/xml/structfaiss_1_1MultiIndexQuantizer2.xml +++ b/xml/structfaiss_1_1MultiIndexQuantizer2.xml @@ -1,15 +1,16 @@ - + faiss::MultiIndexQuantizer2 faiss::MultiIndexQuantizer IndexPQ.h - + std::vector< Index * > std::vector<Index*> faiss::MultiIndexQuantizer2::assign_indexes assign_indexes + faiss::MultiIndexQuantizer2::assign_indexes M Indexes on d / M dimensions. @@ -24,6 +25,7 @@ bool faiss::MultiIndexQuantizer2::own_fields own_fields + faiss::MultiIndexQuantizer2::own_fields @@ -37,6 +39,7 @@ ProductQuantizer faiss::MultiIndexQuantizer::pq pq + faiss::MultiIndexQuantizer::pq @@ -50,6 +53,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -64,6 +68,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -78,6 +83,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -92,6 +98,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -106,6 +113,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -120,6 +128,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -129,13 +138,14 @@ - - + + faiss::MultiIndexQuantizer2::MultiIndexQuantizer2 (int d, size_t M, size_t nbits, Index **indexes) MultiIndexQuantizer2 + faiss::MultiIndexQuantizer2::MultiIndexQuantizer2 int d @@ -165,6 +175,7 @@ faiss::MultiIndexQuantizer2::MultiIndexQuantizer2 (int d, size_t nbits, Index *assign_index_0, Index *assign_index_1) MultiIndexQuantizer2 + faiss::MultiIndexQuantizer2::MultiIndexQuantizer2 int d @@ -194,6 +205,7 @@ void faiss::MultiIndexQuantizer2::train (idx_t n, const float *x) override train + faiss::MultiIndexQuantizer2::train train idx_t @@ -235,6 +247,7 @@ void faiss::MultiIndexQuantizer2::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::MultiIndexQuantizer2::search search idx_t @@ -318,6 +331,7 @@ void faiss::MultiIndexQuantizer::add (idx_t n, const float *x) override add + faiss::MultiIndexQuantizer::add add idx_t @@ -341,6 +355,7 @@ void faiss::MultiIndexQuantizer::reset () override reset + faiss::MultiIndexQuantizer::reset reset removes all elements from the database. @@ -356,6 +371,7 @@ void faiss::MultiIndexQuantizer::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::MultiIndexQuantizer::reconstruct reconstruct idx_t @@ -397,6 +413,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -456,6 +473,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -534,6 +552,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -600,6 +619,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -624,6 +644,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -677,6 +698,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -734,6 +756,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -831,6 +854,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -886,6 +910,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -948,15 +973,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -972,6 +998,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -993,8 +1021,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1058,14 +1088,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1130,6 +1160,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1158,6 +1189,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1180,6 +1212,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1221,13 +1254,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1241,6 +1275,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1249,7 +1284,7 @@ - + @@ -1291,10 +1326,6 @@ pq - - - - @@ -1306,12 +1337,16 @@ - - assign_index - cp + + assign_index + + + + + @@ -1327,7 +1362,7 @@ faiss::MultiIndexQuantizer2compute_residual_n faiss::MultiIndexQuantizer2d faiss::MultiIndexQuantizer2distance_t - faiss::MultiIndexQuantizer2get_distance_computer + faiss::MultiIndexQuantizer2get_distance_computer faiss::MultiIndexQuantizer2Index faiss::MultiIndexQuantizer2is_trained faiss::MultiIndexQuantizer2merge_from diff --git a/xml/structfaiss_1_1NNDescent.xml b/xml/structfaiss_1_1NNDescent.xml index 8034291751..1964812f6b 100644 --- a/xml/structfaiss_1_1NNDescent.xml +++ b/xml/structfaiss_1_1NNDescent.xml @@ -1,13 +1,14 @@ - + faiss::NNDescent - + int using faiss::NNDescent::storage_idx_t = int storage_idx_t + faiss::NNDescent::storage_idx_t @@ -21,6 +22,7 @@ using faiss::NNDescent::KNNGraph = std::vector<nndescent::Nhood> KNNGraph + faiss::NNDescent::KNNGraph @@ -29,13 +31,14 @@ - - + + bool bool faiss::NNDescent::has_built has_built + faiss::NNDescent::has_built = false @@ -50,6 +53,7 @@ int faiss::NNDescent::S S + faiss::NNDescent::S = 10 @@ -64,6 +68,7 @@ int faiss::NNDescent::R R + faiss::NNDescent::R = 100 @@ -78,6 +83,7 @@ int faiss::NNDescent::iter iter + faiss::NNDescent::iter = 10 @@ -92,6 +98,7 @@ int faiss::NNDescent::search_L search_L + faiss::NNDescent::search_L = 0 @@ -106,6 +113,7 @@ int faiss::NNDescent::random_seed random_seed + faiss::NNDescent::random_seed = 2021 @@ -120,6 +128,7 @@ int faiss::NNDescent::K K + faiss::NNDescent::K @@ -133,6 +142,7 @@ int faiss::NNDescent::d d + faiss::NNDescent::d @@ -146,6 +156,7 @@ int faiss::NNDescent::L L + faiss::NNDescent::L @@ -159,6 +170,7 @@ int faiss::NNDescent::ntotal ntotal + faiss::NNDescent::ntotal = 0 @@ -173,6 +185,7 @@ KNNGraph faiss::NNDescent::graph graph + faiss::NNDescent::graph @@ -186,6 +199,7 @@ std::vector<int> faiss::NNDescent::final_graph final_graph + faiss::NNDescent::final_graph @@ -194,13 +208,14 @@ - - + + faiss::NNDescent::NNDescent (const int d, const int K) NNDescent + faiss::NNDescent::NNDescent const int d @@ -222,6 +237,7 @@ faiss::NNDescent::~NNDescent () ~NNDescent + faiss::NNDescent::~NNDescent @@ -235,6 +251,7 @@ void faiss::NNDescent::build (DistanceComputer &qdis, const int n, bool verbose) build + faiss::NNDescent::build DistanceComputer & qdis @@ -260,6 +277,7 @@ void faiss::NNDescent::search (DistanceComputer &qdis, const int topk, idx_t *indices, float *dists, VisitedTable &vt) const search + faiss::NNDescent::search DistanceComputer & qdis @@ -293,6 +311,7 @@ void faiss::NNDescent::reset () reset + faiss::NNDescent::reset @@ -306,6 +325,7 @@ void faiss::NNDescent::init_graph (DistanceComputer &qdis) init_graph + faiss::NNDescent::init_graph DistanceComputer & qdis @@ -324,6 +344,7 @@ void faiss::NNDescent::nndescent (DistanceComputer &qdis, bool verbose) nndescent + faiss::NNDescent::nndescent DistanceComputer & qdis @@ -346,6 +367,7 @@ void faiss::NNDescent::join (DistanceComputer &qdis) join + faiss::NNDescent::join DistanceComputer & qdis @@ -364,6 +386,7 @@ void faiss::NNDescent::update () update + faiss::NNDescent::update Sample new neighbors for each node to peform local join later. @@ -373,11 +396,12 @@ - + void void faiss::NNDescent::generate_eval_set - (DistanceComputer &qdis, std::vector< int > &c, std::vector< std::vector< int >> &v, int N) + (DistanceComputer &qdis, std::vector< int > &c, std::vector< std::vector< int > > &v, int N) generate_eval_set + faiss::NNDescent::generate_eval_set DistanceComputer & qdis @@ -387,7 +411,7 @@ c - std::vector< std::vector< int >> & + std::vector< std::vector< int > > & v @@ -403,17 +427,18 @@ - + float float faiss::NNDescent::eval_recall - (std::vector< int > &ctrl_points, std::vector< std::vector< int >> &acc_eval_set) + (std::vector< int > &ctrl_points, std::vector< std::vector< int > > &acc_eval_set) eval_recall + faiss::NNDescent::eval_recall std::vector< int > & ctrl_points - std::vector< std::vector< int >> & + std::vector< std::vector< int > > & acc_eval_set @@ -425,7 +450,7 @@ - + @@ -434,9 +459,9 @@ faiss::NNDescentbuild faiss::NNDescentd - faiss::NNDescenteval_recall + faiss::NNDescenteval_recall faiss::NNDescentfinal_graph - faiss::NNDescentgenerate_eval_set + faiss::NNDescentgenerate_eval_set faiss::NNDescentgraph faiss::NNDescenthas_built faiss::NNDescentinit_graph diff --git a/xml/structfaiss_1_1NSG.xml b/xml/structfaiss_1_1NSG.xml index a3fbf621fb..d166564abc 100644 --- a/xml/structfaiss_1_1NSG.xml +++ b/xml/structfaiss_1_1NSG.xml @@ -1,13 +1,14 @@ - + faiss::NSG - + int32_t using faiss::NSG::storage_idx_t = int32_t storage_idx_t + faiss::NSG::storage_idx_t internal storage of vectors (32 bits: this is expensive) @@ -22,6 +23,7 @@ using faiss::NSG::Node = nsg::Node Node + faiss::NSG::Node @@ -35,6 +37,7 @@ using faiss::NSG::Neighbor = nsg::Neighbor Neighbor + faiss::NSG::Neighbor @@ -43,13 +46,14 @@ - - + + int int faiss::NSG::ntotal ntotal + faiss::NSG::ntotal = 0 nb of nodes @@ -65,6 +69,7 @@ int faiss::NSG::R R + faiss::NSG::R nb of neighbors per node @@ -79,6 +84,7 @@ int faiss::NSG::L L + faiss::NSG::L length of the search path at construction time @@ -93,6 +99,7 @@ int faiss::NSG::C C + faiss::NSG::C candidate pool size at construction time @@ -107,6 +114,7 @@ int faiss::NSG::search_L search_L + faiss::NSG::search_L = 16 length of the search path @@ -122,6 +130,7 @@ int faiss::NSG::enterpoint enterpoint + faiss::NSG::enterpoint enterpoint @@ -136,6 +145,7 @@ std::shared_ptr<nsg::Graph<int32_t> > faiss::NSG::final_graph final_graph + faiss::NSG::final_graph NSG graph structure. @@ -150,6 +160,7 @@ bool faiss::NSG::is_built is_built + faiss::NSG::is_built = false NSG is built or not. @@ -165,6 +176,7 @@ RandomGenerator faiss::NSG::rng rng + faiss::NSG::rng random generator @@ -174,13 +186,14 @@ - - + + faiss::NSG::NSG (int R=32) NSG + faiss::NSG::NSG int R @@ -199,6 +212,7 @@ void faiss::NSG::build (Index *storage, idx_t n, const nsg::Graph< idx_t > &knn_graph, bool verbose) build + faiss::NSG::build Index * storage @@ -228,6 +242,7 @@ void faiss::NSG::reset () reset + faiss::NSG::reset @@ -241,6 +256,7 @@ void faiss::NSG::search (DistanceComputer &dis, int k, idx_t *I, float *D, VisitedTable &vt) const search + faiss::NSG::search DistanceComputer & dis @@ -274,6 +290,7 @@ void faiss::NSG::init_graph (Index *storage, const nsg::Graph< idx_t > &knn_graph) init_graph + faiss::NSG::init_graph Index * storage @@ -305,6 +322,7 @@ void faiss::NSG::search_on_graph (const nsg::Graph< index_t > &graph, DistanceComputer &dis, VisitedTable &vt, int ep, int pool_size, std::vector< Neighbor > &retset, std::vector< Node > &fullset) const search_on_graph + faiss::NSG::search_on_graph const nsg::Graph< index_t > & graph @@ -346,6 +364,7 @@ void faiss::NSG::add_reverse_links (int q, std::vector< std::mutex > &locks, DistanceComputer &dis, nsg::Graph< Node > &graph) add_reverse_links + faiss::NSG::add_reverse_links int q @@ -375,6 +394,7 @@ void faiss::NSG::sync_prune (int q, std::vector< Node > &pool, DistanceComputer &dis, VisitedTable &vt, const nsg::Graph< idx_t > &knn_graph, nsg::Graph< Node > &graph) sync_prune + faiss::NSG::sync_prune int q @@ -412,6 +432,7 @@ void faiss::NSG::link (Index *storage, const nsg::Graph< idx_t > &knn_graph, nsg::Graph< Node > &graph, bool verbose) link + faiss::NSG::link Index * storage @@ -441,6 +462,7 @@ int faiss::NSG::tree_grow (Index *storage, std::vector< int > &degrees) tree_grow + faiss::NSG::tree_grow Index * storage @@ -462,6 +484,7 @@ int faiss::NSG::dfs (VisitedTable &vt, int root, int cnt) const dfs + faiss::NSG::dfs VisitedTable & vt @@ -487,6 +510,7 @@ int faiss::NSG::attach_unlinked (Index *storage, VisitedTable &vt, VisitedTable &vt2, std::vector< int > &degrees) attach_unlinked + faiss::NSG::attach_unlinked Index * storage @@ -516,6 +540,7 @@ void faiss::NSG::check_graph () const check_graph + faiss::NSG::check_graph @@ -524,16 +549,12 @@ - + - - - - @@ -541,6 +562,10 @@ rng + + + + diff --git a/xml/structfaiss_1_1NegativeDistanceComputer.xml b/xml/structfaiss_1_1NegativeDistanceComputer.xml index b64bc733ea..e6739bd019 100644 --- a/xml/structfaiss_1_1NegativeDistanceComputer.xml +++ b/xml/structfaiss_1_1NegativeDistanceComputer.xml @@ -1,14 +1,15 @@ - + faiss::NegativeDistanceComputer faiss::DistanceComputer - + DistanceComputer * DistanceComputer* faiss::NegativeDistanceComputer::basedis basedis + faiss::NegativeDistanceComputer::basedis owned by this @@ -18,13 +19,14 @@ - - + + faiss::NegativeDistanceComputer::NegativeDistanceComputer (DistanceComputer *basedis) NegativeDistanceComputer + faiss::NegativeDistanceComputer::NegativeDistanceComputer DistanceComputer * basedis @@ -42,6 +44,7 @@ void faiss::NegativeDistanceComputer::set_query (const float *x) override set_query + faiss::NegativeDistanceComputer::set_query set_query const float * @@ -61,6 +64,7 @@ float faiss::NegativeDistanceComputer::operator() (idx_t i) override operator() + faiss::NegativeDistanceComputer::operator() operator() idx_t @@ -80,6 +84,7 @@ void faiss::NegativeDistanceComputer::distances_batch_4 (const idx_t idx0, const idx_t idx1, const idx_t idx2, const idx_t idx3, float &dis0, float &dis1, float &dis2, float &dis3) override distances_batch_4 + faiss::NegativeDistanceComputer::distances_batch_4 distances_batch_4 const idx_t @@ -127,6 +132,7 @@ float faiss::NegativeDistanceComputer::symmetric_dis (idx_t i, idx_t j) override symmetric_dis + faiss::NegativeDistanceComputer::symmetric_dis symmetric_dis idx_t @@ -150,6 +156,7 @@ virtual faiss::NegativeDistanceComputer::~NegativeDistanceComputer () ~NegativeDistanceComputer + faiss::NegativeDistanceComputer::~NegativeDistanceComputer @@ -158,24 +165,28 @@ - + + + + + + + - - @@ -185,10 +196,6 @@ basedis - - - - diff --git a/xml/structfaiss_1_1NeuralNetCodec.xml b/xml/structfaiss_1_1NeuralNetCodec.xml index fb12cf0b1a..c3a1c3d8d7 100644 --- a/xml/structfaiss_1_1NeuralNetCodec.xml +++ b/xml/structfaiss_1_1NeuralNetCodec.xml @@ -1,14 +1,15 @@ - + faiss::NeuralNetCodec faiss::QINCo - + int int faiss::NeuralNetCodec::d d + faiss::NeuralNetCodec::d @@ -22,6 +23,7 @@ int faiss::NeuralNetCodec::M M + faiss::NeuralNetCodec::M @@ -30,13 +32,14 @@ - - + + faiss::NeuralNetCodec::NeuralNetCodec (int d, int M) NeuralNetCodec + faiss::NeuralNetCodec::NeuralNetCodec int d @@ -58,6 +61,7 @@ virtual nn::Tensor2D faiss::NeuralNetCodec::decode (const nn::Int32Tensor2D &codes) const =0 decode + faiss::NeuralNetCodec::decode decode const nn::Int32Tensor2D & @@ -76,6 +80,7 @@ virtual nn::Int32Tensor2D faiss::NeuralNetCodec::encode (const nn::Tensor2D &x) const =0 encode + faiss::NeuralNetCodec::encode encode const nn::Tensor2D & @@ -94,6 +99,7 @@ virtual faiss::NeuralNetCodec::~NeuralNetCodec () ~NeuralNetCodec + faiss::NeuralNetCodec::~NeuralNetCodec @@ -102,22 +108,22 @@ - + + + + + - - - - diff --git a/xml/structfaiss_1_1NormTableScaler.xml b/xml/structfaiss_1_1NormTableScaler.xml index 891af2061d..dc49b129e1 100644 --- a/xml/structfaiss_1_1NormTableScaler.xml +++ b/xml/structfaiss_1_1NormTableScaler.xml @@ -1,14 +1,15 @@ - + faiss::NormTableScaler LookupTableScaler.h - + constexpr int constexpr int faiss::NormTableScaler::nscale nscale + faiss::NormTableScaler::nscale = 2 @@ -18,13 +19,14 @@ - - + + int int faiss::NormTableScaler::scale_int scale_int + faiss::NormTableScaler::scale_int @@ -38,6 +40,7 @@ simd16uint16 faiss::NormTableScaler::scale_simd scale_simd + faiss::NormTableScaler::scale_simd @@ -46,13 +49,14 @@ - - + + faiss::NormTableScaler::NormTableScaler (int scale) NormTableScaler + faiss::NormTableScaler::NormTableScaler int scale @@ -70,6 +74,7 @@ simd32uint8 faiss::NormTableScaler::lookup (const simd32uint8 &lut, const simd32uint8 &c) const lookup + faiss::NormTableScaler::lookup const simd32uint8 & lut @@ -91,6 +96,7 @@ simd16uint16 faiss::NormTableScaler::scale_lo (const simd32uint8 &res) const scale_lo + faiss::NormTableScaler::scale_lo const simd32uint8 & res @@ -108,6 +114,7 @@ simd16uint16 faiss::NormTableScaler::scale_hi (const simd32uint8 &res) const scale_hi + faiss::NormTableScaler::scale_hi const simd32uint8 & res @@ -130,6 +137,7 @@ dist_t faiss::NormTableScaler::scale_one (const dist_t &x) const scale_one + faiss::NormTableScaler::scale_one const dist_t & x @@ -142,7 +150,7 @@ - + @@ -156,10 +164,6 @@ scale_simd - - - - @@ -170,6 +174,10 @@ + + + + diff --git a/xml/structfaiss_1_1NormalizationTransform.xml b/xml/structfaiss_1_1NormalizationTransform.xml index ab0a82e02f..8db1608491 100644 --- a/xml/structfaiss_1_1NormalizationTransform.xml +++ b/xml/structfaiss_1_1NormalizationTransform.xml @@ -1,15 +1,16 @@ - + faiss::NormalizationTransform faiss::VectorTransform VectorTransform.h - + float float faiss::NormalizationTransform::norm norm + faiss::NormalizationTransform::norm @@ -23,6 +24,7 @@ int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -36,6 +38,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -50,6 +53,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -59,13 +63,14 @@ - - + + faiss::NormalizationTransform::NormalizationTransform (int d, float norm=2.0) NormalizationTransform + faiss::NormalizationTransform::NormalizationTransform int d @@ -88,6 +93,7 @@ faiss::NormalizationTransform::NormalizationTransform () NormalizationTransform + faiss::NormalizationTransform::NormalizationTransform @@ -101,6 +107,7 @@ void faiss::NormalizationTransform::apply_noalloc (idx_t n, const float *x, float *xt) const override apply_noalloc + faiss::NormalizationTransform::apply_noalloc apply_noalloc idx_t @@ -153,6 +160,7 @@ void faiss::NormalizationTransform::reverse_transform (idx_t n, const float *xt, float *x) const override reverse_transform + faiss::NormalizationTransform::reverse_transform reverse_transform idx_t @@ -180,6 +188,7 @@ void faiss::NormalizationTransform::check_identical (const VectorTransform &other) const override check_identical + faiss::NormalizationTransform::check_identical check_identical const VectorTransform & @@ -198,6 +207,7 @@ virtual void faiss::VectorTransform::train (idx_t n, const float *x) train + faiss::VectorTransform::train train train train @@ -239,11 +249,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -280,39 +291,39 @@ - + per-vector normalization - - - - - - + + + + + + - faiss::NormalizationTransformapply + faiss::NormalizationTransformapply faiss::NormalizationTransformapply_noalloc faiss::NormalizationTransformcheck_identical faiss::NormalizationTransformd_in diff --git a/xml/structfaiss_1_1OPQMatrix.xml b/xml/structfaiss_1_1OPQMatrix.xml index a1c75d16c8..d601d0c831 100644 --- a/xml/structfaiss_1_1OPQMatrix.xml +++ b/xml/structfaiss_1_1OPQMatrix.xml @@ -1,15 +1,16 @@ - + faiss::OPQMatrix faiss::LinearTransform VectorTransform.h - + int int faiss::OPQMatrix::M M + faiss::OPQMatrix::M nb of subquantizers @@ -24,6 +25,7 @@ int faiss::OPQMatrix::niter niter + faiss::OPQMatrix::niter = 50 Number of outer training iterations. @@ -39,6 +41,7 @@ int faiss::OPQMatrix::niter_pq niter_pq + faiss::OPQMatrix::niter_pq = 4 Number of training iterations for the PQ. @@ -54,6 +57,7 @@ int faiss::OPQMatrix::niter_pq_0 niter_pq_0 + faiss::OPQMatrix::niter_pq_0 = 40 same, for the first outer iteration @@ -69,6 +73,7 @@ size_t faiss::OPQMatrix::max_train_points max_train_points + faiss::OPQMatrix::max_train_points = 256 * 256 if there are too many training points, resample @@ -84,6 +89,7 @@ bool faiss::OPQMatrix::verbose verbose + faiss::OPQMatrix::verbose = false @@ -98,6 +104,7 @@ ProductQuantizer* faiss::OPQMatrix::pq pq + faiss::OPQMatrix::pq = nullptr @@ -113,6 +120,7 @@ bool faiss::LinearTransform::have_bias have_bias + faiss::LinearTransform::have_bias @@ -126,6 +134,7 @@ bool faiss::LinearTransform::is_orthonormal is_orthonormal + faiss::LinearTransform::is_orthonormal ! whether to use the bias term @@ -141,6 +150,7 @@ std::vector<float> faiss::LinearTransform::A A + faiss::LinearTransform::A Transformation matrix, size d_out * d_in. @@ -155,6 +165,7 @@ std::vector<float> faiss::LinearTransform::b b + faiss::LinearTransform::b bias vector, size d_out @@ -169,6 +180,7 @@ int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -182,6 +194,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -196,6 +209,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -205,13 +219,14 @@ - - + + faiss::OPQMatrix::OPQMatrix (int d=0, int M=1, int d2=-1) OPQMatrix + faiss::OPQMatrix::OPQMatrix int d @@ -241,6 +256,7 @@ void faiss::OPQMatrix::train (idx_t n, const float *x) override train + faiss::OPQMatrix::train train idx_t @@ -282,6 +298,7 @@ void faiss::LinearTransform::apply_noalloc (idx_t n, const float *x, float *xt) const override apply_noalloc + faiss::LinearTransform::apply_noalloc apply_noalloc idx_t @@ -309,6 +326,7 @@ void faiss::LinearTransform::transform_transpose (idx_t n, const float *y, float *x) const transform_transpose + faiss::LinearTransform::transform_transpose idx_t n @@ -335,6 +353,7 @@ void faiss::LinearTransform::reverse_transform (idx_t n, const float *xt, float *x) const override reverse_transform + faiss::LinearTransform::reverse_transform reverse_transform idx_t @@ -362,6 +381,7 @@ void faiss::LinearTransform::set_is_orthonormal () set_is_orthonormal + faiss::LinearTransform::set_is_orthonormal compute A^T * A to set the is_orthonormal flag @@ -376,6 +396,7 @@ void faiss::LinearTransform::print_if_verbose (const char *name, const std::vector< double > &mat, int n, int d) const print_if_verbose + faiss::LinearTransform::print_if_verbose const char * name @@ -405,6 +426,7 @@ void faiss::LinearTransform::check_identical (const VectorTransform &other) const override check_identical + faiss::LinearTransform::check_identical check_identical const VectorTransform & @@ -418,11 +440,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -459,7 +482,7 @@ - + @@ -473,36 +496,32 @@ - - - - - - - - - - - - - + + + - + + + + + + + @@ -512,27 +531,31 @@ pq - - - - - assign_index + cp - cp + assign_index + + + + + + + + faiss::OPQMatrixA - faiss::OPQMatrixapply + faiss::OPQMatrixapply faiss::OPQMatrixapply_noalloc faiss::OPQMatrixb faiss::OPQMatrixcheck_identical diff --git a/xml/structfaiss_1_1OnDiskInvertedLists.xml b/xml/structfaiss_1_1OnDiskInvertedLists.xml index 92b1141c74..e0f2165d8c 100644 --- a/xml/structfaiss_1_1OnDiskInvertedLists.xml +++ b/xml/structfaiss_1_1OnDiskInvertedLists.xml @@ -1,16 +1,17 @@ - + faiss::OnDiskInvertedLists faiss::InvertedLists OnDiskInvertedLists.h faiss::OnDiskInvertedLists::Slot - + OnDiskOneList using faiss::OnDiskInvertedLists::List = OnDiskOneList List + faiss::OnDiskInvertedLists::List @@ -22,6 +23,7 @@ int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -72,13 +74,14 @@ - - + + std::vector< List > std::vector<List> faiss::OnDiskInvertedLists::lists lists + faiss::OnDiskInvertedLists::lists @@ -92,6 +95,7 @@ std::list<Slot> faiss::OnDiskInvertedLists::slots slots + faiss::OnDiskInvertedLists::slots @@ -105,6 +109,7 @@ std::string faiss::OnDiskInvertedLists::filename filename + faiss::OnDiskInvertedLists::filename @@ -118,6 +123,7 @@ size_t faiss::OnDiskInvertedLists::totsize totsize + faiss::OnDiskInvertedLists::totsize @@ -131,6 +137,7 @@ uint8_t* faiss::OnDiskInvertedLists::ptr ptr + faiss::OnDiskInvertedLists::ptr @@ -144,6 +151,7 @@ bool faiss::OnDiskInvertedLists::read_only read_only + faiss::OnDiskInvertedLists::read_only @@ -157,6 +165,7 @@ LockLevels* faiss::OnDiskInvertedLists::locks locks + faiss::OnDiskInvertedLists::locks @@ -170,19 +179,21 @@ OngoingPrefetch* faiss::OnDiskInvertedLists::pf pf + faiss::OnDiskInvertedLists::pf - + int int faiss::OnDiskInvertedLists::prefetch_nthread prefetch_nthread + faiss::OnDiskInvertedLists::prefetch_nthread @@ -196,6 +207,7 @@ size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -210,6 +222,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -224,6 +237,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -234,13 +248,14 @@ - - + + faiss::OnDiskInvertedLists::OnDiskInvertedLists (size_t nlist, size_t code_size, const char *filename) OnDiskInvertedLists + faiss::OnDiskInvertedLists::OnDiskInvertedLists size_t nlist @@ -267,6 +282,7 @@ size_t faiss::OnDiskInvertedLists::list_size (size_t list_no) const override list_size + faiss::OnDiskInvertedLists::list_size list_size size_t @@ -281,12 +297,13 @@ - + const uint8_t * - const uint8_t* faiss::OnDiskInvertedLists::get_codes + const uint8_t * faiss::OnDiskInvertedLists::get_codes (size_t list_no) const override get_codes - get_codes + faiss::OnDiskInvertedLists::get_codes + get_codes size_t list_no @@ -303,12 +320,13 @@ - + const idx_t * - const idx_t* faiss::OnDiskInvertedLists::get_ids + const idx_t * faiss::OnDiskInvertedLists::get_ids (size_t list_no) const override get_ids - get_ids + faiss::OnDiskInvertedLists::get_ids + get_ids size_t list_no @@ -330,6 +348,7 @@ size_t faiss::OnDiskInvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override add_entries + faiss::OnDiskInvertedLists::add_entries add_entries size_t @@ -360,6 +379,7 @@ void faiss::OnDiskInvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override update_entries + faiss::OnDiskInvertedLists::update_entries update_entries size_t @@ -394,6 +414,7 @@ void faiss::OnDiskInvertedLists::resize (size_t list_no, size_t new_size) override resize + faiss::OnDiskInvertedLists::resize resize size_t @@ -416,6 +437,7 @@ size_t faiss::OnDiskInvertedLists::merge_from_multiple (const InvertedLists **ils, int n_il, bool shift_ids=false, bool verbose=false) merge_from_multiple + faiss::OnDiskInvertedLists::merge_from_multiple const InvertedLists ** ils @@ -447,6 +469,7 @@ size_t faiss::OnDiskInvertedLists::merge_from_1 (const InvertedLists *il, bool verbose=false) merge_from_1 + faiss::OnDiskInvertedLists::merge_from_1 const InvertedLists * il @@ -470,6 +493,7 @@ void faiss::OnDiskInvertedLists::crop_invlists (size_t l0, size_t l1) crop_invlists + faiss::OnDiskInvertedLists::crop_invlists size_t l0 @@ -492,6 +516,7 @@ void faiss::OnDiskInvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const override prefetch_lists + faiss::OnDiskInvertedLists::prefetch_lists prefetch_lists const idx_t * @@ -515,6 +540,7 @@ faiss::OnDiskInvertedLists::~OnDiskInvertedLists () override ~OnDiskInvertedLists + faiss::OnDiskInvertedLists::~OnDiskInvertedLists @@ -528,6 +554,7 @@ void faiss::OnDiskInvertedLists::do_mmap () do_mmap + faiss::OnDiskInvertedLists::do_mmap @@ -541,6 +568,7 @@ void faiss::OnDiskInvertedLists::update_totsize (size_t new_totsize) update_totsize + faiss::OnDiskInvertedLists::update_totsize size_t new_totsize @@ -558,6 +586,7 @@ void faiss::OnDiskInvertedLists::resize_locked (size_t list_no, size_t new_size) resize_locked + faiss::OnDiskInvertedLists::resize_locked size_t list_no @@ -579,6 +608,7 @@ size_t faiss::OnDiskInvertedLists::allocate_slot (size_t capacity) allocate_slot + faiss::OnDiskInvertedLists::allocate_slot size_t capacity @@ -596,6 +626,7 @@ void faiss::OnDiskInvertedLists::free_slot (size_t offset, size_t capacity) free_slot + faiss::OnDiskInvertedLists::free_slot size_t offset @@ -617,6 +648,7 @@ void faiss::OnDiskInvertedLists::set_all_lists_sizes (const size_t *sizes) set_all_lists_sizes + faiss::OnDiskInvertedLists::set_all_lists_sizes const size_t * sizes @@ -635,6 +667,7 @@ faiss::OnDiskInvertedLists::OnDiskInvertedLists () OnDiskInvertedLists + faiss::OnDiskInvertedLists::OnDiskInvertedLists @@ -648,6 +681,7 @@ virtual void faiss::InvertedLists::release_codes (size_t list_no, const uint8_t *codes) const release_codes + faiss::InvertedLists::release_codes release_codes release_codes release_codes @@ -675,6 +709,7 @@ virtual void faiss::InvertedLists::release_ids (size_t list_no, const idx_t *ids) const release_ids + faiss::InvertedLists::release_ids release_ids release_ids release_ids @@ -702,6 +737,7 @@ virtual idx_t faiss::InvertedLists::get_single_id (size_t list_no, size_t offset) const get_single_id + faiss::InvertedLists::get_single_id get_single_id get_single_id get_single_id @@ -726,16 +762,17 @@ - + const uint8_t * - virtual const uint8_t* faiss::InvertedLists::get_single_code + virtual const uint8_t * faiss::InvertedLists::get_single_code (size_t list_no, size_t offset) const get_single_code - get_single_code - get_single_code - get_single_code - get_single_code - get_single_code + faiss::InvertedLists::get_single_code + get_single_code + get_single_code + get_single_code + get_single_code + get_single_code size_t list_no @@ -760,6 +797,7 @@ virtual bool faiss::InvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const is_empty + faiss::InvertedLists::is_empty is_empty size_t @@ -779,11 +817,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -807,6 +846,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -838,6 +878,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -867,6 +908,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -880,6 +922,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -902,6 +945,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -934,6 +978,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -948,6 +993,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -962,6 +1008,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -971,13 +1018,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -988,7 +1036,7 @@ - + @@ -1046,10 +1094,10 @@ faiss::OnDiskInvertedListsdo_mmap faiss::OnDiskInvertedListsfilename faiss::OnDiskInvertedListsfree_slot - faiss::OnDiskInvertedListsget_codes - faiss::OnDiskInvertedListsget_ids - faiss::OnDiskInvertedListsget_iterator - faiss::OnDiskInvertedListsget_single_code + faiss::OnDiskInvertedListsget_codes + faiss::OnDiskInvertedListsget_ids + faiss::OnDiskInvertedListsget_iterator + faiss::OnDiskInvertedListsget_single_code faiss::OnDiskInvertedListsget_single_id faiss::OnDiskInvertedListsimbalance_factor faiss::OnDiskInvertedListsINVALID_CODE_SIZE diff --git a/xml/structfaiss_1_1OnDiskInvertedListsIOHook.xml b/xml/structfaiss_1_1OnDiskInvertedListsIOHook.xml index 09730c36e7..3638b0a9ef 100644 --- a/xml/structfaiss_1_1OnDiskInvertedListsIOHook.xml +++ b/xml/structfaiss_1_1OnDiskInvertedListsIOHook.xml @@ -1,14 +1,15 @@ - + faiss::OnDiskInvertedListsIOHook faiss::InvertedListsIOHook - + faiss::OnDiskInvertedListsIOHook::OnDiskInvertedListsIOHook () OnDiskInvertedListsIOHook + faiss::OnDiskInvertedListsIOHook::OnDiskInvertedListsIOHook @@ -22,6 +23,7 @@ void faiss::OnDiskInvertedListsIOHook::write (const InvertedLists *ils, IOWriter *f) const override write + faiss::OnDiskInvertedListsIOHook::write write const InvertedLists * @@ -40,12 +42,13 @@ - + InvertedLists * - InvertedLists* faiss::OnDiskInvertedListsIOHook::read + InvertedLists * faiss::OnDiskInvertedListsIOHook::read (IOReader *f, int io_flags) const override read - read + faiss::OnDiskInvertedListsIOHook::read + read IOReader * f @@ -63,12 +66,13 @@ - + InvertedLists * - InvertedLists* faiss::OnDiskInvertedListsIOHook::read_ArrayInvertedLists + InvertedLists * faiss::OnDiskInvertedListsIOHook::read_ArrayInvertedLists (IOReader *f, int io_flags, size_t nlist, size_t code_size, const std::vector< size_t > &sizes) const override read_ArrayInvertedLists - read_ArrayInvertedLists + faiss::OnDiskInvertedListsIOHook::read_ArrayInvertedLists + read_ArrayInvertedLists IOReader * f @@ -99,13 +103,14 @@ - - + + const std::string const std::string faiss::InvertedListsIOHook::key key + faiss::InvertedListsIOHook::key string version of the fourcc @@ -120,6 +125,7 @@ const std::string faiss::InvertedListsIOHook::classname classname + faiss::InvertedListsIOHook::classname typeid.name @@ -129,13 +135,14 @@ - - + + void static void faiss::InvertedListsIOHook::add_callback (InvertedListsIOHook *) add_callback + faiss::InvertedListsIOHook::add_callback InvertedListsIOHook * @@ -152,6 +159,7 @@ static void faiss::InvertedListsIOHook::print_callbacks () print_callbacks + faiss::InvertedListsIOHook::print_callbacks @@ -160,11 +168,12 @@ - + InvertedListsIOHook * - static InvertedListsIOHook* faiss::InvertedListsIOHook::lookup + static InvertedListsIOHook * faiss::InvertedListsIOHook::lookup (int h) lookup + faiss::InvertedListsIOHook::lookup int h @@ -177,11 +186,12 @@ - + InvertedListsIOHook * - static InvertedListsIOHook* faiss::InvertedListsIOHook::lookup_classname + static InvertedListsIOHook * faiss::InvertedListsIOHook::lookup_classname (const std::string &classname) lookup_classname + faiss::InvertedListsIOHook::lookup_classname const std::string & classname @@ -194,7 +204,7 @@ - + @@ -229,12 +239,12 @@ faiss::OnDiskInvertedListsIOHookclassname faiss::OnDiskInvertedListsIOHookInvertedListsIOHook faiss::OnDiskInvertedListsIOHookkey - faiss::OnDiskInvertedListsIOHooklookup - faiss::OnDiskInvertedListsIOHooklookup_classname + faiss::OnDiskInvertedListsIOHooklookup + faiss::OnDiskInvertedListsIOHooklookup_classname faiss::OnDiskInvertedListsIOHookOnDiskInvertedListsIOHook faiss::OnDiskInvertedListsIOHookprint_callbacks - faiss::OnDiskInvertedListsIOHookread - faiss::OnDiskInvertedListsIOHookread_ArrayInvertedLists + faiss::OnDiskInvertedListsIOHookread + faiss::OnDiskInvertedListsIOHookread_ArrayInvertedLists faiss::OnDiskInvertedListsIOHookwrite faiss::OnDiskInvertedListsIOHook~InvertedListsIOHook diff --git a/xml/structfaiss_1_1OnDiskInvertedLists_1_1Slot.xml b/xml/structfaiss_1_1OnDiskInvertedLists_1_1Slot.xml index 7074142fb9..d56ef8c45c 100644 --- a/xml/structfaiss_1_1OnDiskInvertedLists_1_1Slot.xml +++ b/xml/structfaiss_1_1OnDiskInvertedLists_1_1Slot.xml @@ -1,13 +1,14 @@ - + faiss::OnDiskInvertedLists::Slot - + size_t size_t faiss::OnDiskInvertedLists::Slot::offset offset + faiss::OnDiskInvertedLists::Slot::offset @@ -21,6 +22,7 @@ size_t faiss::OnDiskInvertedLists::Slot::capacity capacity + faiss::OnDiskInvertedLists::Slot::capacity @@ -29,13 +31,14 @@ - - + + faiss::OnDiskInvertedLists::Slot::Slot (size_t offset, size_t capacity) Slot + faiss::OnDiskInvertedLists::Slot::Slot size_t offset @@ -57,6 +60,7 @@ faiss::OnDiskInvertedLists::Slot::Slot () Slot + faiss::OnDiskInvertedLists::Slot::Slot @@ -65,7 +69,7 @@ - + diff --git a/xml/structfaiss_1_1OnDiskOneList.xml b/xml/structfaiss_1_1OnDiskOneList.xml index 21380ba7a6..88aff0a49f 100644 --- a/xml/structfaiss_1_1OnDiskOneList.xml +++ b/xml/structfaiss_1_1OnDiskOneList.xml @@ -1,13 +1,14 @@ - + faiss::OnDiskOneList - + size_t size_t faiss::OnDiskOneList::size size + faiss::OnDiskOneList::size @@ -21,6 +22,7 @@ size_t faiss::OnDiskOneList::capacity capacity + faiss::OnDiskOneList::capacity @@ -34,6 +36,7 @@ size_t faiss::OnDiskOneList::offset offset + faiss::OnDiskOneList::offset @@ -42,13 +45,14 @@ - - + + faiss::OnDiskOneList::OnDiskOneList () OnDiskOneList + faiss::OnDiskOneList::OnDiskOneList @@ -57,7 +61,7 @@ - + diff --git a/xml/structfaiss_1_1OneRecallAtRCriterion.xml b/xml/structfaiss_1_1OneRecallAtRCriterion.xml index 6062bf925f..a23a7c99a8 100644 --- a/xml/structfaiss_1_1OneRecallAtRCriterion.xml +++ b/xml/structfaiss_1_1OneRecallAtRCriterion.xml @@ -1,14 +1,15 @@ - + faiss::OneRecallAtRCriterion faiss::AutoTuneCriterion - + idx_t idx_t faiss::OneRecallAtRCriterion::R R + faiss::OneRecallAtRCriterion::R @@ -22,6 +23,7 @@ idx_t faiss::AutoTuneCriterion::nq nq + faiss::AutoTuneCriterion::nq nb of queries this criterion is evaluated on @@ -36,6 +38,7 @@ idx_t faiss::AutoTuneCriterion::nnn nnn + faiss::AutoTuneCriterion::nnn nb of NNs that the query should request @@ -50,6 +53,7 @@ idx_t faiss::AutoTuneCriterion::gt_nnn gt_nnn + faiss::AutoTuneCriterion::gt_nnn nb of GT NNs required to evaluate criterion @@ -64,6 +68,7 @@ std::vector<float> faiss::AutoTuneCriterion::gt_D gt_D + faiss::AutoTuneCriterion::gt_D Ground-truth distances (size nq * gt_nnn) @@ -78,6 +83,7 @@ std::vector<idx_t> faiss::AutoTuneCriterion::gt_I gt_I + faiss::AutoTuneCriterion::gt_I Ground-truth indexes (size nq * gt_nnn) @@ -87,13 +93,14 @@ - - + + faiss::OneRecallAtRCriterion::OneRecallAtRCriterion (idx_t nq, idx_t R) OneRecallAtRCriterion + faiss::OneRecallAtRCriterion::OneRecallAtRCriterion idx_t nq @@ -115,6 +122,7 @@ double faiss::OneRecallAtRCriterion::evaluate (const float *D, const idx_t *I) const override evaluate + faiss::OneRecallAtRCriterion::evaluate evaluate const float * @@ -158,6 +166,7 @@ faiss::OneRecallAtRCriterion::~OneRecallAtRCriterion () override ~OneRecallAtRCriterion + faiss::OneRecallAtRCriterion::~OneRecallAtRCriterion @@ -171,6 +180,7 @@ void faiss::AutoTuneCriterion::set_groundtruth (int gt_nnn, const float *gt_D_in, const idx_t *gt_I_in) set_groundtruth + faiss::AutoTuneCriterion::set_groundtruth int gt_nnn @@ -210,34 +220,34 @@ - + + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1OperatingPoint.xml b/xml/structfaiss_1_1OperatingPoint.xml index 4e0ea6ea9a..05aeb69020 100644 --- a/xml/structfaiss_1_1OperatingPoint.xml +++ b/xml/structfaiss_1_1OperatingPoint.xml @@ -1,14 +1,15 @@ - + faiss::OperatingPoint AutoTune.h - + double double faiss::OperatingPoint::perf perf + faiss::OperatingPoint::perf performance measure (output of a Criterion) @@ -23,6 +24,7 @@ double faiss::OperatingPoint::t t + faiss::OperatingPoint::t corresponding execution time (ms) @@ -37,6 +39,7 @@ std::string faiss::OperatingPoint::key key + faiss::OperatingPoint::key key that identifies this op pt @@ -51,6 +54,7 @@ int64_t faiss::OperatingPoint::cno cno + faiss::OperatingPoint::cno integer identifier @@ -60,7 +64,7 @@ - + diff --git a/xml/structfaiss_1_1OperatingPoints.xml b/xml/structfaiss_1_1OperatingPoints.xml index b24c7ac4d9..61d8b75304 100644 --- a/xml/structfaiss_1_1OperatingPoints.xml +++ b/xml/structfaiss_1_1OperatingPoints.xml @@ -1,13 +1,14 @@ - + faiss::OperatingPoints - + std::vector< OperatingPoint > std::vector<OperatingPoint> faiss::OperatingPoints::all_pts all_pts + faiss::OperatingPoints::all_pts all operating points @@ -22,6 +23,7 @@ std::vector<OperatingPoint> faiss::OperatingPoints::optimal_pts optimal_pts + faiss::OperatingPoints::optimal_pts optimal operating points, sorted by perf @@ -31,13 +33,14 @@ - - + + faiss::OperatingPoints::OperatingPoints () OperatingPoints + faiss::OperatingPoints::OperatingPoints @@ -51,6 +54,7 @@ int faiss::OperatingPoints::merge_with (const OperatingPoints &other, const std::string &prefix="") merge_with + faiss::OperatingPoints::merge_with const OperatingPoints & other @@ -74,6 +78,7 @@ void faiss::OperatingPoints::clear () clear + faiss::OperatingPoints::clear @@ -87,6 +92,7 @@ bool faiss::OperatingPoints::add (double perf, double t, const std::string &key, size_t cno=0) add + faiss::OperatingPoints::add double perf @@ -118,6 +124,7 @@ double faiss::OperatingPoints::t_for_perf (double perf) const t_for_perf + faiss::OperatingPoints::t_for_perf double perf @@ -136,6 +143,7 @@ void faiss::OperatingPoints::display (bool only_optimal=true) const display + faiss::OperatingPoints::display bool only_optimal @@ -155,6 +163,7 @@ void faiss::OperatingPoints::all_to_gnuplot (const char *fname) const all_to_gnuplot + faiss::OperatingPoints::all_to_gnuplot const char * fname @@ -173,6 +182,7 @@ void faiss::OperatingPoints::optimal_to_gnuplot (const char *fname) const optimal_to_gnuplot + faiss::OperatingPoints::optimal_to_gnuplot const char * fname @@ -185,7 +195,7 @@ - + diff --git a/xml/structfaiss_1_1PCAMatrix.xml b/xml/structfaiss_1_1PCAMatrix.xml index d88a30bec0..e79217935b 100644 --- a/xml/structfaiss_1_1PCAMatrix.xml +++ b/xml/structfaiss_1_1PCAMatrix.xml @@ -1,15 +1,16 @@ - + faiss::PCAMatrix faiss::LinearTransform VectorTransform.h - + float float faiss::PCAMatrix::eigen_power eigen_power + faiss::PCAMatrix::eigen_power @@ -25,6 +26,7 @@ float faiss::PCAMatrix::epsilon epsilon + faiss::PCAMatrix::epsilon value added to eigenvalues to avoid division by 0 when whitening @@ -39,6 +41,7 @@ bool faiss::PCAMatrix::random_rotation random_rotation + faiss::PCAMatrix::random_rotation random rotation after PCA @@ -53,6 +56,7 @@ size_t faiss::PCAMatrix::max_points_per_d max_points_per_d + faiss::PCAMatrix::max_points_per_d ratio between # training vectors and dimension @@ -67,6 +71,7 @@ int faiss::PCAMatrix::balanced_bins balanced_bins + faiss::PCAMatrix::balanced_bins try to distribute output eigenvectors in this many bins @@ -81,6 +86,7 @@ std::vector<float> faiss::PCAMatrix::mean mean + faiss::PCAMatrix::mean Mean, size d_in. @@ -95,6 +101,7 @@ std::vector<float> faiss::PCAMatrix::eigenvalues eigenvalues + faiss::PCAMatrix::eigenvalues eigenvalues of covariance matrix (= squared singular values) @@ -109,6 +116,7 @@ std::vector<float> faiss::PCAMatrix::PCAMat PCAMat + faiss::PCAMatrix::PCAMat PCA matrix, size d_in * d_in. @@ -123,6 +131,7 @@ bool faiss::LinearTransform::have_bias have_bias + faiss::LinearTransform::have_bias @@ -136,6 +145,7 @@ bool faiss::LinearTransform::is_orthonormal is_orthonormal + faiss::LinearTransform::is_orthonormal ! whether to use the bias term @@ -151,6 +161,7 @@ std::vector<float> faiss::LinearTransform::A A + faiss::LinearTransform::A Transformation matrix, size d_out * d_in. @@ -165,6 +176,7 @@ std::vector<float> faiss::LinearTransform::b b + faiss::LinearTransform::b bias vector, size d_out @@ -179,6 +191,7 @@ bool faiss::LinearTransform::verbose verbose + faiss::LinearTransform::verbose @@ -192,6 +205,7 @@ int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -205,6 +219,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -219,6 +234,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -228,13 +244,14 @@ - - + + faiss::PCAMatrix::PCAMatrix (int d_in=0, int d_out=0, float eigen_power=0, bool random_rotation=false) PCAMatrix + faiss::PCAMatrix::PCAMatrix int d_in @@ -268,6 +285,7 @@ void faiss::PCAMatrix::train (idx_t n, const float *x) override train + faiss::PCAMatrix::train train idx_t @@ -291,6 +309,7 @@ void faiss::PCAMatrix::copy_from (const PCAMatrix &other) copy_from + faiss::PCAMatrix::copy_from const PCAMatrix & other @@ -309,6 +328,7 @@ void faiss::PCAMatrix::prepare_Ab () prepare_Ab + faiss::PCAMatrix::prepare_Ab called after mean, PCAMat and eigenvalues are computed @@ -323,6 +343,7 @@ void faiss::LinearTransform::apply_noalloc (idx_t n, const float *x, float *xt) const override apply_noalloc + faiss::LinearTransform::apply_noalloc apply_noalloc idx_t @@ -350,6 +371,7 @@ void faiss::LinearTransform::transform_transpose (idx_t n, const float *y, float *x) const transform_transpose + faiss::LinearTransform::transform_transpose idx_t n @@ -376,6 +398,7 @@ void faiss::LinearTransform::reverse_transform (idx_t n, const float *xt, float *x) const override reverse_transform + faiss::LinearTransform::reverse_transform reverse_transform idx_t @@ -403,6 +426,7 @@ void faiss::LinearTransform::set_is_orthonormal () set_is_orthonormal + faiss::LinearTransform::set_is_orthonormal compute A^T * A to set the is_orthonormal flag @@ -417,6 +441,7 @@ void faiss::LinearTransform::print_if_verbose (const char *name, const std::vector< double > &mat, int n, int d) const print_if_verbose + faiss::LinearTransform::print_if_verbose const char * name @@ -446,6 +471,7 @@ void faiss::LinearTransform::check_identical (const VectorTransform &other) const override check_identical + faiss::LinearTransform::check_identical check_identical const VectorTransform & @@ -459,11 +485,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -500,7 +527,7 @@ - + @@ -513,16 +540,16 @@ - - - - + + + + @@ -531,21 +558,21 @@ - - - - + + + + faiss::PCAMatrixA - faiss::PCAMatrixapply + faiss::PCAMatrixapply faiss::PCAMatrixapply_noalloc faiss::PCAMatrixb faiss::PCAMatrixbalanced_bins diff --git a/xml/structfaiss_1_1PQDecoder16.xml b/xml/structfaiss_1_1PQDecoder16.xml index fca66ecccc..70c390437c 100644 --- a/xml/structfaiss_1_1PQDecoder16.xml +++ b/xml/structfaiss_1_1PQDecoder16.xml @@ -1,13 +1,14 @@ - + faiss::PQDecoder16 - + const int const int faiss::PQDecoder16::nbits nbits + faiss::PQDecoder16::nbits = 16 @@ -17,13 +18,14 @@ - - + + const uint16_t * const uint16_t* faiss::PQDecoder16::code code + faiss::PQDecoder16::code @@ -32,13 +34,14 @@ - - + + faiss::PQDecoder16::PQDecoder16 (const uint8_t *code, int nbits) PQDecoder16 + faiss::PQDecoder16::PQDecoder16 const uint8_t * code @@ -60,6 +63,7 @@ uint64_t faiss::PQDecoder16::decode () decode + faiss::PQDecoder16::decode @@ -68,7 +72,7 @@ - + diff --git a/xml/structfaiss_1_1PQDecoder8.xml b/xml/structfaiss_1_1PQDecoder8.xml index e67314ebc2..171963abef 100644 --- a/xml/structfaiss_1_1PQDecoder8.xml +++ b/xml/structfaiss_1_1PQDecoder8.xml @@ -1,13 +1,14 @@ - + faiss::PQDecoder8 - + const int const int faiss::PQDecoder8::nbits nbits + faiss::PQDecoder8::nbits = 8 @@ -17,13 +18,14 @@ - - + + const uint8_t * const uint8_t* faiss::PQDecoder8::code code + faiss::PQDecoder8::code @@ -32,13 +34,14 @@ - - + + faiss::PQDecoder8::PQDecoder8 (const uint8_t *code, int nbits) PQDecoder8 + faiss::PQDecoder8::PQDecoder8 const uint8_t * code @@ -60,6 +63,7 @@ uint64_t faiss::PQDecoder8::decode () decode + faiss::PQDecoder8::decode @@ -68,7 +72,7 @@ - + diff --git a/xml/structfaiss_1_1PQDecoderGeneric.xml b/xml/structfaiss_1_1PQDecoderGeneric.xml index 4e733c0aa4..4c4df8c6ff 100644 --- a/xml/structfaiss_1_1PQDecoderGeneric.xml +++ b/xml/structfaiss_1_1PQDecoderGeneric.xml @@ -1,13 +1,14 @@ - + faiss::PQDecoderGeneric - + const uint8_t * const uint8_t* faiss::PQDecoderGeneric::code code + faiss::PQDecoderGeneric::code @@ -21,6 +22,7 @@ uint8_t faiss::PQDecoderGeneric::offset offset + faiss::PQDecoderGeneric::offset @@ -34,6 +36,7 @@ const int faiss::PQDecoderGeneric::nbits nbits + faiss::PQDecoderGeneric::nbits @@ -47,6 +50,7 @@ const uint64_t faiss::PQDecoderGeneric::mask mask + faiss::PQDecoderGeneric::mask @@ -60,6 +64,7 @@ uint8_t faiss::PQDecoderGeneric::reg reg + faiss::PQDecoderGeneric::reg @@ -68,13 +73,14 @@ - - + + faiss::PQDecoderGeneric::PQDecoderGeneric (const uint8_t *code, int nbits) PQDecoderGeneric + faiss::PQDecoderGeneric::PQDecoderGeneric const uint8_t * code @@ -96,6 +102,7 @@ uint64_t faiss::PQDecoderGeneric::decode () decode + faiss::PQDecoderGeneric::decode @@ -104,7 +111,7 @@ - + diff --git a/xml/structfaiss_1_1PQEncoder16.xml b/xml/structfaiss_1_1PQEncoder16.xml index 1c66b77b44..2462898b5a 100644 --- a/xml/structfaiss_1_1PQEncoder16.xml +++ b/xml/structfaiss_1_1PQEncoder16.xml @@ -1,13 +1,14 @@ - + faiss::PQEncoder16 - + uint16_t * uint16_t* faiss::PQEncoder16::code code + faiss::PQEncoder16::code @@ -16,13 +17,14 @@ - - + + faiss::PQEncoder16::PQEncoder16 (uint8_t *code, int nbits) PQEncoder16 + faiss::PQEncoder16::PQEncoder16 uint8_t * code @@ -44,6 +46,7 @@ void faiss::PQEncoder16::encode (uint64_t x) encode + faiss::PQEncoder16::encode uint64_t x @@ -56,7 +59,7 @@ - + diff --git a/xml/structfaiss_1_1PQEncoder8.xml b/xml/structfaiss_1_1PQEncoder8.xml index affecdeb1d..1e039d584c 100644 --- a/xml/structfaiss_1_1PQEncoder8.xml +++ b/xml/structfaiss_1_1PQEncoder8.xml @@ -1,13 +1,14 @@ - + faiss::PQEncoder8 - + uint8_t * uint8_t* faiss::PQEncoder8::code code + faiss::PQEncoder8::code @@ -16,13 +17,14 @@ - - + + faiss::PQEncoder8::PQEncoder8 (uint8_t *code, int nbits) PQEncoder8 + faiss::PQEncoder8::PQEncoder8 uint8_t * code @@ -44,6 +46,7 @@ void faiss::PQEncoder8::encode (uint64_t x) encode + faiss::PQEncoder8::encode uint64_t x @@ -56,7 +59,7 @@ - + diff --git a/xml/structfaiss_1_1PQEncoderGeneric.xml b/xml/structfaiss_1_1PQEncoderGeneric.xml index 74ea5d5792..4a670f1538 100644 --- a/xml/structfaiss_1_1PQEncoderGeneric.xml +++ b/xml/structfaiss_1_1PQEncoderGeneric.xml @@ -1,13 +1,14 @@ - + faiss::PQEncoderGeneric - + uint8_t * uint8_t* faiss::PQEncoderGeneric::code code + faiss::PQEncoderGeneric::code code for this vector @@ -22,6 +23,7 @@ uint8_t faiss::PQEncoderGeneric::offset offset + faiss::PQEncoderGeneric::offset @@ -35,6 +37,7 @@ const int faiss::PQEncoderGeneric::nbits nbits + faiss::PQEncoderGeneric::nbits number of bits per subquantizer index @@ -49,6 +52,7 @@ uint8_t faiss::PQEncoderGeneric::reg reg + faiss::PQEncoderGeneric::reg @@ -57,13 +61,14 @@ - - + + faiss::PQEncoderGeneric::PQEncoderGeneric (uint8_t *code, int nbits, uint8_t offset=0) PQEncoderGeneric + faiss::PQEncoderGeneric::PQEncoderGeneric uint8_t * code @@ -90,6 +95,7 @@ void faiss::PQEncoderGeneric::encode (uint64_t x) encode + faiss::PQEncoderGeneric::encode uint64_t x @@ -107,6 +113,7 @@ faiss::PQEncoderGeneric::~PQEncoderGeneric () ~PQEncoderGeneric + faiss::PQEncoderGeneric::~PQEncoderGeneric @@ -115,7 +122,7 @@ - + diff --git a/xml/structfaiss_1_1ParameterRange.xml b/xml/structfaiss_1_1ParameterRange.xml index 7015091df8..08b9827a55 100644 --- a/xml/structfaiss_1_1ParameterRange.xml +++ b/xml/structfaiss_1_1ParameterRange.xml @@ -1,14 +1,15 @@ - + faiss::ParameterRange AutoTune.h - + std::string std::string faiss::ParameterRange::name name + faiss::ParameterRange::name @@ -22,6 +23,7 @@ std::vector<double> faiss::ParameterRange::values values + faiss::ParameterRange::values @@ -30,7 +32,7 @@ - + possible values of a parameter, sorted from least to most expensive/accurate diff --git a/xml/structfaiss_1_1ParameterSpace.xml b/xml/structfaiss_1_1ParameterSpace.xml index b5b62efd45..95c834c030 100644 --- a/xml/structfaiss_1_1ParameterSpace.xml +++ b/xml/structfaiss_1_1ParameterSpace.xml @@ -1,15 +1,16 @@ - + faiss::ParameterSpace faiss::gpu::GpuParameterSpace AutoTune.h - + std::vector< ParameterRange > std::vector<ParameterRange> faiss::ParameterSpace::parameter_ranges parameter_ranges + faiss::ParameterSpace::parameter_ranges all tunable parameters @@ -24,6 +25,7 @@ int faiss::ParameterSpace::verbose verbose + faiss::ParameterSpace::verbose verbosity during exploration @@ -38,6 +40,7 @@ int faiss::ParameterSpace::n_experiments n_experiments + faiss::ParameterSpace::n_experiments nb of experiments during optimization (0 = try all combinations) @@ -52,6 +55,7 @@ size_t faiss::ParameterSpace::batchsize batchsize + faiss::ParameterSpace::batchsize maximum number of queries to submit at a time. @@ -66,6 +70,7 @@ bool faiss::ParameterSpace::thread_over_batches thread_over_batches + faiss::ParameterSpace::thread_over_batches @@ -80,6 +85,7 @@ double faiss::ParameterSpace::min_test_duration min_test_duration + faiss::ParameterSpace::min_test_duration @@ -89,13 +95,14 @@ - - + + faiss::ParameterSpace::ParameterSpace () ParameterSpace + faiss::ParameterSpace::ParameterSpace @@ -109,6 +116,7 @@ size_t faiss::ParameterSpace::n_combinations () const n_combinations + faiss::ParameterSpace::n_combinations nb of combinations, = product of values sizes @@ -123,6 +131,7 @@ bool faiss::ParameterSpace::combination_ge (size_t c1, size_t c2) const combination_ge + faiss::ParameterSpace::combination_ge size_t c1 @@ -145,6 +154,7 @@ std::string faiss::ParameterSpace::combination_name (size_t cno) const combination_name + faiss::ParameterSpace::combination_name size_t cno @@ -163,6 +173,7 @@ void faiss::ParameterSpace::display () const display + faiss::ParameterSpace::display print a description on stdout @@ -172,11 +183,12 @@ - + ParameterRange & - ParameterRange& faiss::ParameterSpace::add_range + ParameterRange & faiss::ParameterSpace::add_range (const std::string &name) add_range + faiss::ParameterSpace::add_range const std::string & name @@ -195,6 +207,7 @@ virtual void faiss::ParameterSpace::initialize (const Index *index) initialize + faiss::ParameterSpace::initialize initialize const Index * @@ -214,6 +227,7 @@ void faiss::ParameterSpace::set_index_parameters (Index *index, size_t cno) const set_index_parameters + faiss::ParameterSpace::set_index_parameters Index * index @@ -236,6 +250,7 @@ void faiss::ParameterSpace::set_index_parameters (Index *index, const char *param_string) const set_index_parameters + faiss::ParameterSpace::set_index_parameters Index * index @@ -258,6 +273,7 @@ virtual void faiss::ParameterSpace::set_index_parameter (Index *index, const std::string &name, double val) const set_index_parameter + faiss::ParameterSpace::set_index_parameter set_index_parameter Index * @@ -285,6 +301,7 @@ void faiss::ParameterSpace::update_bounds (size_t cno, const OperatingPoint &op, double *upper_bound_perf, double *lower_bound_t) const update_bounds + faiss::ParameterSpace::update_bounds size_t cno @@ -315,6 +332,7 @@ void faiss::ParameterSpace::explore (Index *index, size_t nq, const float *xq, const AutoTuneCriterion &crit, OperatingPoints *ops) const explore + faiss::ParameterSpace::explore Index * index @@ -382,6 +400,7 @@ virtual faiss::ParameterSpace::~ParameterSpace () ~ParameterSpace + faiss::ParameterSpace::~ParameterSpace @@ -390,7 +409,7 @@ - + @@ -410,7 +429,7 @@ - faiss::ParameterSpaceadd_range + faiss::ParameterSpaceadd_range faiss::ParameterSpacebatchsize faiss::ParameterSpacecombination_ge faiss::ParameterSpacecombination_name diff --git a/xml/structfaiss_1_1PartitionStats.xml b/xml/structfaiss_1_1PartitionStats.xml index 8563ea30fe..6cad944c1a 100644 --- a/xml/structfaiss_1_1PartitionStats.xml +++ b/xml/structfaiss_1_1PartitionStats.xml @@ -1,13 +1,14 @@ - + faiss::PartitionStats - + uint64_t uint64_t faiss::PartitionStats::bissect_cycles bissect_cycles + faiss::PartitionStats::bissect_cycles @@ -21,6 +22,7 @@ uint64_t faiss::PartitionStats::compress_cycles compress_cycles + faiss::PartitionStats::compress_cycles @@ -29,13 +31,14 @@ - - + + faiss::PartitionStats::PartitionStats () PartitionStats + faiss::PartitionStats::PartitionStats @@ -49,6 +52,7 @@ void faiss::PartitionStats::reset () reset + faiss::PartitionStats::reset @@ -57,7 +61,7 @@ - + diff --git a/xml/structfaiss_1_1PermutationObjective.xml b/xml/structfaiss_1_1PermutationObjective.xml index 19b8b84e2c..82f382e660 100644 --- a/xml/structfaiss_1_1PermutationObjective.xml +++ b/xml/structfaiss_1_1PermutationObjective.xml @@ -1,15 +1,16 @@ - + faiss::PermutationObjective faiss::ReproduceDistancesObjective PolysemousTraining.h - + int int faiss::PermutationObjective::n n + faiss::PermutationObjective::n @@ -18,13 +19,14 @@ - - + + double virtual double faiss::PermutationObjective::compute_cost (const int *perm) const =0 compute_cost + faiss::PermutationObjective::compute_cost compute_cost const int * @@ -43,6 +45,7 @@ virtual double faiss::PermutationObjective::cost_update (const int *perm, int iw, int jw) const cost_update + faiss::PermutationObjective::cost_update cost_update const int * @@ -69,6 +72,7 @@ virtual faiss::PermutationObjective::~PermutationObjective () ~PermutationObjective + faiss::PermutationObjective::~PermutationObjective @@ -77,23 +81,23 @@ - + abstract class for the loss function + + + + - - - - diff --git a/xml/structfaiss_1_1PolysemousTraining.xml b/xml/structfaiss_1_1PolysemousTraining.xml index 0819fec3e7..e66c123c42 100644 --- a/xml/structfaiss_1_1PolysemousTraining.xml +++ b/xml/structfaiss_1_1PolysemousTraining.xml @@ -1,13 +1,14 @@ - + faiss::PolysemousTraining faiss::SimulatedAnnealingParameters PolysemousTraining.h - + Optimization_type_t + faiss::PolysemousTraining::Optimization_type_t OT_None @@ -39,13 +40,14 @@ - - + + Optimization_type_t Optimization_type_t faiss::PolysemousTraining::optimization_type optimization_type + faiss::PolysemousTraining::optimization_type @@ -59,6 +61,7 @@ int faiss::PolysemousTraining::ntrain_permutation ntrain_permutation + faiss::PolysemousTraining::ntrain_permutation @@ -73,6 +76,7 @@ double faiss::PolysemousTraining::dis_weight_factor dis_weight_factor + faiss::PolysemousTraining::dis_weight_factor decay of exp that weights distance loss @@ -87,6 +91,7 @@ size_t faiss::PolysemousTraining::max_memory max_memory + faiss::PolysemousTraining::max_memory refuse to train if it would require more than that amount of RAM @@ -101,6 +106,7 @@ std::string faiss::PolysemousTraining::log_pattern log_pattern + faiss::PolysemousTraining::log_pattern @@ -114,6 +120,7 @@ double faiss::SimulatedAnnealingParameters::init_temperature init_temperature + faiss::SimulatedAnnealingParameters::init_temperature = 0.7 @@ -128,6 +135,7 @@ double faiss::SimulatedAnnealingParameters::temperature_decay temperature_decay + faiss::SimulatedAnnealingParameters::temperature_decay = 0.9997893011688015 @@ -142,6 +150,7 @@ int faiss::SimulatedAnnealingParameters::n_iter n_iter + faiss::SimulatedAnnealingParameters::n_iter = 500000 @@ -156,6 +165,7 @@ int faiss::SimulatedAnnealingParameters::n_redo n_redo + faiss::SimulatedAnnealingParameters::n_redo = 2 @@ -170,6 +180,7 @@ int faiss::SimulatedAnnealingParameters::seed seed + faiss::SimulatedAnnealingParameters::seed = 123 @@ -184,6 +195,7 @@ int faiss::SimulatedAnnealingParameters::verbose verbose + faiss::SimulatedAnnealingParameters::verbose = 0 @@ -198,6 +210,7 @@ bool faiss::SimulatedAnnealingParameters::only_bit_flips only_bit_flips + faiss::SimulatedAnnealingParameters::only_bit_flips = false @@ -212,6 +225,7 @@ bool faiss::SimulatedAnnealingParameters::init_random init_random + faiss::SimulatedAnnealingParameters::init_random = false @@ -222,13 +236,14 @@ - - + + faiss::PolysemousTraining::PolysemousTraining () PolysemousTraining + faiss::PolysemousTraining::PolysemousTraining @@ -242,6 +257,7 @@ void faiss::PolysemousTraining::optimize_pq_for_hamming (ProductQuantizer &pq, size_t n, const float *x) const optimize_pq_for_hamming + faiss::PolysemousTraining::optimize_pq_for_hamming ProductQuantizer & pq @@ -268,6 +284,7 @@ void faiss::PolysemousTraining::optimize_ranking (ProductQuantizer &pq, size_t n, const float *x) const optimize_ranking + faiss::PolysemousTraining::optimize_ranking ProductQuantizer & pq @@ -294,6 +311,7 @@ void faiss::PolysemousTraining::optimize_reproduce_distances (ProductQuantizer &pq) const optimize_reproduce_distances + faiss::PolysemousTraining::optimize_reproduce_distances ProductQuantizer & pq @@ -312,6 +330,7 @@ size_t faiss::PolysemousTraining::memory_usage_per_thread (const ProductQuantizer &pq) const memory_usage_per_thread + faiss::PolysemousTraining::memory_usage_per_thread const ProductQuantizer & pq @@ -325,35 +344,35 @@ - + optimizes the order of indices in a ProductQuantizer - - - - - - + + + + + + diff --git a/xml/structfaiss_1_1ProductAdditiveQuantizer.xml b/xml/structfaiss_1_1ProductAdditiveQuantizer.xml index 3b30ff2d5c..ae9197c45a 100644 --- a/xml/structfaiss_1_1ProductAdditiveQuantizer.xml +++ b/xml/structfaiss_1_1ProductAdditiveQuantizer.xml @@ -1,17 +1,18 @@ - + faiss::ProductAdditiveQuantizer faiss::AdditiveQuantizer faiss::ProductLocalSearchQuantizer faiss::ProductResidualQuantizer ProductAdditiveQuantizer.h - + size_t size_t faiss::ProductAdditiveQuantizer::nsplits nsplits + faiss::ProductAdditiveQuantizer::nsplits number of sub-vectors we split a vector into @@ -26,6 +27,7 @@ std::vector<AdditiveQuantizer*> faiss::ProductAdditiveQuantizer::quantizers quantizers + faiss::ProductAdditiveQuantizer::quantizers @@ -39,6 +41,7 @@ size_t faiss::AdditiveQuantizer::M M + faiss::AdditiveQuantizer::M number of codebooks @@ -53,6 +56,7 @@ std::vector<size_t> faiss::AdditiveQuantizer::nbits nbits + faiss::AdditiveQuantizer::nbits bits for each step @@ -67,6 +71,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebooks codebooks + faiss::AdditiveQuantizer::codebooks codebooks @@ -81,6 +86,7 @@ std::vector<uint64_t> faiss::AdditiveQuantizer::codebook_offsets codebook_offsets + faiss::AdditiveQuantizer::codebook_offsets @@ -95,6 +101,7 @@ size_t faiss::AdditiveQuantizer::tot_bits tot_bits + faiss::AdditiveQuantizer::tot_bits = 0 total number of bits (indexes + norms) @@ -110,6 +117,7 @@ size_t faiss::AdditiveQuantizer::norm_bits norm_bits + faiss::AdditiveQuantizer::norm_bits = 0 bits allocated for the norms @@ -125,6 +133,7 @@ size_t faiss::AdditiveQuantizer::total_codebook_size total_codebook_size + faiss::AdditiveQuantizer::total_codebook_size = 0 size of the codebook in vectors @@ -140,6 +149,7 @@ bool faiss::AdditiveQuantizer::only_8bit only_8bit + faiss::AdditiveQuantizer::only_8bit = false are all nbits = 8 (use faster decoder) @@ -155,6 +165,7 @@ bool faiss::AdditiveQuantizer::verbose verbose + faiss::AdditiveQuantizer::verbose = false verbose during training? @@ -170,6 +181,7 @@ bool faiss::AdditiveQuantizer::is_trained is_trained + faiss::AdditiveQuantizer::is_trained = false is trained or not @@ -185,6 +197,7 @@ std::vector<float> faiss::AdditiveQuantizer::norm_tabs norm_tabs + faiss::AdditiveQuantizer::norm_tabs @@ -199,6 +212,7 @@ IndexFlat1D faiss::AdditiveQuantizer::qnorm qnorm + faiss::AdditiveQuantizer::qnorm store and search norms @@ -213,6 +227,7 @@ std::vector<float> faiss::AdditiveQuantizer::centroid_norms centroid_norms + faiss::AdditiveQuantizer::centroid_norms norms of all codebook entries (size total_codebook_size) @@ -227,6 +242,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebook_cross_products codebook_cross_products + faiss::AdditiveQuantizer::codebook_cross_products @@ -241,6 +257,7 @@ size_t faiss::AdditiveQuantizer::max_mem_distances max_mem_distances + faiss::AdditiveQuantizer::max_mem_distances = 5 * (size_t(1) << 30) @@ -256,6 +273,7 @@ Search_type_t faiss::AdditiveQuantizer::search_type search_type + faiss::AdditiveQuantizer::search_type Also determines what's in the codes. @@ -270,6 +288,7 @@ float faiss::AdditiveQuantizer::norm_min norm_min + faiss::AdditiveQuantizer::norm_min = NAN min/max for quantization of norms @@ -285,6 +304,7 @@ float faiss::AdditiveQuantizer::norm_max norm_max + faiss::AdditiveQuantizer::norm_max = NAN @@ -299,6 +319,7 @@ size_t faiss::Quantizer::d d + faiss::Quantizer::d size of the input vectors @@ -313,6 +334,7 @@ size_t faiss::Quantizer::code_size code_size + faiss::Quantizer::code_size bytes per indexed vector @@ -322,13 +344,14 @@ - - + + faiss::ProductAdditiveQuantizer::ProductAdditiveQuantizer (size_t d, const std::vector< AdditiveQuantizer * > &aqs, Search_type_t search_type=ST_decompress) ProductAdditiveQuantizer + faiss::ProductAdditiveQuantizer::ProductAdditiveQuantizer size_t d @@ -383,6 +406,7 @@ faiss::ProductAdditiveQuantizer::ProductAdditiveQuantizer () ProductAdditiveQuantizer + faiss::ProductAdditiveQuantizer::ProductAdditiveQuantizer @@ -396,6 +420,7 @@ virtual faiss::ProductAdditiveQuantizer::~ProductAdditiveQuantizer () ~ProductAdditiveQuantizer + faiss::ProductAdditiveQuantizer::~ProductAdditiveQuantizer @@ -409,6 +434,7 @@ void faiss::ProductAdditiveQuantizer::init (size_t d, const std::vector< AdditiveQuantizer * > &aqs, Search_type_t search_type) init + faiss::ProductAdditiveQuantizer::init size_t d @@ -429,11 +455,12 @@ - + AdditiveQuantizer * - AdditiveQuantizer* faiss::ProductAdditiveQuantizer::subquantizer + AdditiveQuantizer * faiss::ProductAdditiveQuantizer::subquantizer (size_t m) const subquantizer + faiss::ProductAdditiveQuantizer::subquantizer size_t m @@ -452,6 +479,7 @@ void faiss::ProductAdditiveQuantizer::train (size_t n, const float *x) override train + faiss::ProductAdditiveQuantizer::train train size_t @@ -485,6 +513,7 @@ void faiss::ProductAdditiveQuantizer::compute_codes_add_centroids (const float *x, uint8_t *codes, size_t n, const float *centroids=nullptr) const override compute_codes_add_centroids + faiss::ProductAdditiveQuantizer::compute_codes_add_centroids compute_codes_add_centroids const float * @@ -543,6 +572,7 @@ void faiss::ProductAdditiveQuantizer::compute_unpacked_codes (const float *x, int32_t *codes, size_t n, const float *centroids=nullptr) const compute_unpacked_codes + faiss::ProductAdditiveQuantizer::compute_unpacked_codes const float * x @@ -573,6 +603,7 @@ void faiss::ProductAdditiveQuantizer::decode_unpacked (const int32_t *codes, float *x, size_t n, int64_t ld_codes=-1) const override decode_unpacked + faiss::ProductAdditiveQuantizer::decode_unpacked decode_unpacked const int32_t * @@ -623,6 +654,7 @@ void faiss::ProductAdditiveQuantizer::decode (const uint8_t *codes, float *x, size_t n) const override decode + faiss::ProductAdditiveQuantizer::decode decode const uint8_t * @@ -668,6 +700,7 @@ void faiss::ProductAdditiveQuantizer::compute_LUT (size_t n, const float *xq, float *LUT, float alpha=1.0f, long ld_lut=-1) const override compute_LUT + faiss::ProductAdditiveQuantizer::compute_LUT compute_LUT size_t @@ -739,6 +772,7 @@ void faiss::AdditiveQuantizer::compute_codebook_tables () compute_codebook_tables + faiss::AdditiveQuantizer::compute_codebook_tables @@ -752,6 +786,7 @@ uint64_t faiss::AdditiveQuantizer::encode_norm (float norm) const encode_norm + faiss::AdditiveQuantizer::encode_norm float norm @@ -770,6 +805,7 @@ uint32_t faiss::AdditiveQuantizer::encode_qcint (float x) const encode_qcint + faiss::AdditiveQuantizer::encode_qcint float x @@ -788,6 +824,7 @@ float faiss::AdditiveQuantizer::decode_qcint (uint32_t c) const decode_qcint + faiss::AdditiveQuantizer::decode_qcint uint32_t c @@ -806,6 +843,7 @@ void faiss::AdditiveQuantizer::set_derived_values () set_derived_values + faiss::AdditiveQuantizer::set_derived_values Train the norm quantizer. @@ -820,6 +858,7 @@ void faiss::AdditiveQuantizer::train_norm (size_t n, const float *norms) train_norm + faiss::AdditiveQuantizer::train_norm size_t n @@ -841,6 +880,7 @@ void faiss::AdditiveQuantizer::compute_codes (const float *x, uint8_t *codes, size_t n) const override compute_codes + faiss::AdditiveQuantizer::compute_codes compute_codes const float * @@ -886,6 +926,7 @@ void faiss::AdditiveQuantizer::pack_codes (size_t n, const int32_t *codes, uint8_t *packed_codes, int64_t ld_codes=-1, const float *norms=nullptr, const float *centroids=nullptr) const pack_codes + faiss::AdditiveQuantizer::pack_codes size_t n @@ -981,6 +1022,7 @@ float faiss::AdditiveQuantizer::compute_1_distance_LUT (const uint8_t *codes, const float *LUT) const compute_1_distance_LUT + faiss::AdditiveQuantizer::compute_1_distance_LUT const uint8_t * codes @@ -1002,6 +1044,7 @@ void faiss::AdditiveQuantizer::decode_64bit (idx_t n, float *x) const decode_64bit + faiss::AdditiveQuantizer::decode_64bit idx_t n @@ -1024,6 +1067,7 @@ void faiss::AdditiveQuantizer::knn_centroids_inner_product (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels) const knn_centroids_inner_product + faiss::AdditiveQuantizer::knn_centroids_inner_product idx_t n @@ -1058,6 +1102,7 @@ void faiss::AdditiveQuantizer::compute_centroid_norms (float *norms) const compute_centroid_norms + faiss::AdditiveQuantizer::compute_centroid_norms float * norms @@ -1086,6 +1131,7 @@ void faiss::AdditiveQuantizer::knn_centroids_L2 (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels, const float *centroid_norms) const knn_centroids_L2 + faiss::AdditiveQuantizer::knn_centroids_L2 idx_t n @@ -1119,11 +1165,12 @@ - - + + Search_type_t + faiss::AdditiveQuantizer::Search_type_t ST_decompress @@ -1211,7 +1258,7 @@ - + @@ -1219,6 +1266,12 @@ The product additive quantizer is a variant of AQ and PQ. It first splits the vector space into multiple orthogonal sub-spaces just like PQ does. And then it quantizes each sub-space by an independent additive quantizer. + + + + + + @@ -1231,12 +1284,6 @@ - - - - - - @@ -1249,11 +1296,18 @@ - - - - + + + + + + qnorm + + + + + @@ -1267,35 +1321,28 @@ + + + + + + - - - - - - - - - - - qnorm + + + + - - - - - - @@ -1352,7 +1399,7 @@ faiss::ProductAdditiveQuantizerST_norm_qint4 faiss::ProductAdditiveQuantizerST_norm_qint8 faiss::ProductAdditiveQuantizerST_norm_rq2x4 - faiss::ProductAdditiveQuantizersubquantizer + faiss::ProductAdditiveQuantizersubquantizer faiss::ProductAdditiveQuantizertot_bits faiss::ProductAdditiveQuantizertotal_codebook_size faiss::ProductAdditiveQuantizertrain diff --git a/xml/structfaiss_1_1ProductLocalSearchQuantizer.xml b/xml/structfaiss_1_1ProductLocalSearchQuantizer.xml index abe922ab39..4e3eb208be 100644 --- a/xml/structfaiss_1_1ProductLocalSearchQuantizer.xml +++ b/xml/structfaiss_1_1ProductLocalSearchQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::ProductLocalSearchQuantizer faiss::ProductAdditiveQuantizer ProductAdditiveQuantizer.h - + faiss::ProductLocalSearchQuantizer::ProductLocalSearchQuantizer (size_t d, size_t nsplits, size_t Msub, size_t nbits, Search_type_t search_type=ST_decompress) ProductLocalSearchQuantizer + faiss::ProductLocalSearchQuantizer::ProductLocalSearchQuantizer size_t d @@ -87,6 +88,7 @@ faiss::ProductLocalSearchQuantizer::ProductLocalSearchQuantizer () ProductLocalSearchQuantizer + faiss::ProductLocalSearchQuantizer::ProductLocalSearchQuantizer @@ -100,6 +102,7 @@ void faiss::ProductAdditiveQuantizer::init (size_t d, const std::vector< AdditiveQuantizer * > &aqs, Search_type_t search_type) init + faiss::ProductAdditiveQuantizer::init size_t d @@ -120,11 +123,12 @@ - + AdditiveQuantizer * - AdditiveQuantizer* faiss::ProductAdditiveQuantizer::subquantizer + AdditiveQuantizer * faiss::ProductAdditiveQuantizer::subquantizer (size_t m) const subquantizer + faiss::ProductAdditiveQuantizer::subquantizer size_t m @@ -143,6 +147,7 @@ void faiss::ProductAdditiveQuantizer::train (size_t n, const float *x) override train + faiss::ProductAdditiveQuantizer::train train size_t @@ -176,6 +181,7 @@ void faiss::ProductAdditiveQuantizer::compute_codes_add_centroids (const float *x, uint8_t *codes, size_t n, const float *centroids=nullptr) const override compute_codes_add_centroids + faiss::ProductAdditiveQuantizer::compute_codes_add_centroids compute_codes_add_centroids const float * @@ -234,6 +240,7 @@ void faiss::ProductAdditiveQuantizer::compute_unpacked_codes (const float *x, int32_t *codes, size_t n, const float *centroids=nullptr) const compute_unpacked_codes + faiss::ProductAdditiveQuantizer::compute_unpacked_codes const float * x @@ -264,6 +271,7 @@ void faiss::ProductAdditiveQuantizer::decode_unpacked (const int32_t *codes, float *x, size_t n, int64_t ld_codes=-1) const override decode_unpacked + faiss::ProductAdditiveQuantizer::decode_unpacked decode_unpacked const int32_t * @@ -314,6 +322,7 @@ void faiss::ProductAdditiveQuantizer::decode (const uint8_t *codes, float *x, size_t n) const override decode + faiss::ProductAdditiveQuantizer::decode decode const uint8_t * @@ -359,6 +368,7 @@ void faiss::ProductAdditiveQuantizer::compute_LUT (size_t n, const float *xq, float *LUT, float alpha=1.0f, long ld_lut=-1) const override compute_LUT + faiss::ProductAdditiveQuantizer::compute_LUT compute_LUT size_t @@ -430,6 +440,7 @@ void faiss::AdditiveQuantizer::compute_codebook_tables () compute_codebook_tables + faiss::AdditiveQuantizer::compute_codebook_tables @@ -443,6 +454,7 @@ uint64_t faiss::AdditiveQuantizer::encode_norm (float norm) const encode_norm + faiss::AdditiveQuantizer::encode_norm float norm @@ -461,6 +473,7 @@ uint32_t faiss::AdditiveQuantizer::encode_qcint (float x) const encode_qcint + faiss::AdditiveQuantizer::encode_qcint float x @@ -479,6 +492,7 @@ float faiss::AdditiveQuantizer::decode_qcint (uint32_t c) const decode_qcint + faiss::AdditiveQuantizer::decode_qcint uint32_t c @@ -497,6 +511,7 @@ void faiss::AdditiveQuantizer::set_derived_values () set_derived_values + faiss::AdditiveQuantizer::set_derived_values Train the norm quantizer. @@ -511,6 +526,7 @@ void faiss::AdditiveQuantizer::train_norm (size_t n, const float *norms) train_norm + faiss::AdditiveQuantizer::train_norm size_t n @@ -532,6 +548,7 @@ void faiss::AdditiveQuantizer::compute_codes (const float *x, uint8_t *codes, size_t n) const override compute_codes + faiss::AdditiveQuantizer::compute_codes compute_codes const float * @@ -577,6 +594,7 @@ void faiss::AdditiveQuantizer::pack_codes (size_t n, const int32_t *codes, uint8_t *packed_codes, int64_t ld_codes=-1, const float *norms=nullptr, const float *centroids=nullptr) const pack_codes + faiss::AdditiveQuantizer::pack_codes size_t n @@ -672,6 +690,7 @@ float faiss::AdditiveQuantizer::compute_1_distance_LUT (const uint8_t *codes, const float *LUT) const compute_1_distance_LUT + faiss::AdditiveQuantizer::compute_1_distance_LUT const uint8_t * codes @@ -693,6 +712,7 @@ void faiss::AdditiveQuantizer::decode_64bit (idx_t n, float *x) const decode_64bit + faiss::AdditiveQuantizer::decode_64bit idx_t n @@ -715,6 +735,7 @@ void faiss::AdditiveQuantizer::knn_centroids_inner_product (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels) const knn_centroids_inner_product + faiss::AdditiveQuantizer::knn_centroids_inner_product idx_t n @@ -749,6 +770,7 @@ void faiss::AdditiveQuantizer::compute_centroid_norms (float *norms) const compute_centroid_norms + faiss::AdditiveQuantizer::compute_centroid_norms float * norms @@ -777,6 +799,7 @@ void faiss::AdditiveQuantizer::knn_centroids_L2 (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels, const float *centroid_norms) const knn_centroids_L2 + faiss::AdditiveQuantizer::knn_centroids_L2 idx_t n @@ -810,13 +833,14 @@ - - + + size_t size_t faiss::ProductAdditiveQuantizer::nsplits nsplits + faiss::ProductAdditiveQuantizer::nsplits number of sub-vectors we split a vector into @@ -831,6 +855,7 @@ std::vector<AdditiveQuantizer*> faiss::ProductAdditiveQuantizer::quantizers quantizers + faiss::ProductAdditiveQuantizer::quantizers @@ -844,6 +869,7 @@ size_t faiss::AdditiveQuantizer::M M + faiss::AdditiveQuantizer::M number of codebooks @@ -858,6 +884,7 @@ std::vector<size_t> faiss::AdditiveQuantizer::nbits nbits + faiss::AdditiveQuantizer::nbits bits for each step @@ -872,6 +899,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebooks codebooks + faiss::AdditiveQuantizer::codebooks codebooks @@ -886,6 +914,7 @@ std::vector<uint64_t> faiss::AdditiveQuantizer::codebook_offsets codebook_offsets + faiss::AdditiveQuantizer::codebook_offsets @@ -900,6 +929,7 @@ size_t faiss::AdditiveQuantizer::tot_bits tot_bits + faiss::AdditiveQuantizer::tot_bits = 0 total number of bits (indexes + norms) @@ -915,6 +945,7 @@ size_t faiss::AdditiveQuantizer::norm_bits norm_bits + faiss::AdditiveQuantizer::norm_bits = 0 bits allocated for the norms @@ -930,6 +961,7 @@ size_t faiss::AdditiveQuantizer::total_codebook_size total_codebook_size + faiss::AdditiveQuantizer::total_codebook_size = 0 size of the codebook in vectors @@ -945,6 +977,7 @@ bool faiss::AdditiveQuantizer::only_8bit only_8bit + faiss::AdditiveQuantizer::only_8bit = false are all nbits = 8 (use faster decoder) @@ -960,6 +993,7 @@ bool faiss::AdditiveQuantizer::verbose verbose + faiss::AdditiveQuantizer::verbose = false verbose during training? @@ -975,6 +1009,7 @@ bool faiss::AdditiveQuantizer::is_trained is_trained + faiss::AdditiveQuantizer::is_trained = false is trained or not @@ -990,6 +1025,7 @@ std::vector<float> faiss::AdditiveQuantizer::norm_tabs norm_tabs + faiss::AdditiveQuantizer::norm_tabs @@ -1004,6 +1040,7 @@ IndexFlat1D faiss::AdditiveQuantizer::qnorm qnorm + faiss::AdditiveQuantizer::qnorm store and search norms @@ -1018,6 +1055,7 @@ std::vector<float> faiss::AdditiveQuantizer::centroid_norms centroid_norms + faiss::AdditiveQuantizer::centroid_norms norms of all codebook entries (size total_codebook_size) @@ -1032,6 +1070,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebook_cross_products codebook_cross_products + faiss::AdditiveQuantizer::codebook_cross_products @@ -1046,6 +1085,7 @@ size_t faiss::AdditiveQuantizer::max_mem_distances max_mem_distances + faiss::AdditiveQuantizer::max_mem_distances = 5 * (size_t(1) << 30) @@ -1061,6 +1101,7 @@ Search_type_t faiss::AdditiveQuantizer::search_type search_type + faiss::AdditiveQuantizer::search_type Also determines what's in the codes. @@ -1075,6 +1116,7 @@ float faiss::AdditiveQuantizer::norm_min norm_min + faiss::AdditiveQuantizer::norm_min = NAN min/max for quantization of norms @@ -1090,6 +1132,7 @@ float faiss::AdditiveQuantizer::norm_max norm_max + faiss::AdditiveQuantizer::norm_max = NAN @@ -1104,6 +1147,7 @@ size_t faiss::Quantizer::d d + faiss::Quantizer::d size of the input vectors @@ -1118,6 +1162,7 @@ size_t faiss::Quantizer::code_size code_size + faiss::Quantizer::code_size bytes per indexed vector @@ -1127,11 +1172,12 @@ - - + + Search_type_t + faiss::AdditiveQuantizer::Search_type_t ST_decompress @@ -1219,13 +1265,19 @@ - + Product Local Search Quantizer + + + + + + @@ -1238,30 +1290,25 @@ - - - - - - - - - - + + + + - - - - - + + qnorm + + + + @@ -1274,35 +1321,34 @@ + + + + + + - - - - - - - - + + + + - - qnorm + + + + + - - - - - - @@ -1361,7 +1407,7 @@ faiss::ProductLocalSearchQuantizerST_norm_qint4 faiss::ProductLocalSearchQuantizerST_norm_qint8 faiss::ProductLocalSearchQuantizerST_norm_rq2x4 - faiss::ProductLocalSearchQuantizersubquantizer + faiss::ProductLocalSearchQuantizersubquantizer faiss::ProductLocalSearchQuantizertot_bits faiss::ProductLocalSearchQuantizertotal_codebook_size faiss::ProductLocalSearchQuantizertrain diff --git a/xml/structfaiss_1_1ProductQuantizer.xml b/xml/structfaiss_1_1ProductQuantizer.xml index c8d500af8e..943adf3e19 100644 --- a/xml/structfaiss_1_1ProductQuantizer.xml +++ b/xml/structfaiss_1_1ProductQuantizer.xml @@ -1,13 +1,14 @@ - + faiss::ProductQuantizer faiss::Quantizer ProductQuantizer.h - + train_type_t + faiss::ProductQuantizer::train_type_t Train_default @@ -56,13 +57,14 @@ - - + + size_t size_t faiss::ProductQuantizer::M M + faiss::ProductQuantizer::M number of subquantizers @@ -77,6 +79,7 @@ size_t faiss::ProductQuantizer::nbits nbits + faiss::ProductQuantizer::nbits number of bits per quantization index @@ -91,6 +94,7 @@ size_t faiss::ProductQuantizer::dsub dsub + faiss::ProductQuantizer::dsub dimensionality of each subvector @@ -105,6 +109,7 @@ size_t faiss::ProductQuantizer::ksub ksub + faiss::ProductQuantizer::ksub number of centroids for each subquantizer @@ -119,6 +124,7 @@ bool faiss::ProductQuantizer::verbose verbose + faiss::ProductQuantizer::verbose verbose during training? @@ -133,6 +139,7 @@ train_type_t faiss::ProductQuantizer::train_type train_type + faiss::ProductQuantizer::train_type @@ -146,6 +153,7 @@ ClusteringParameters faiss::ProductQuantizer::cp cp + faiss::ProductQuantizer::cp parameters used during clustering @@ -160,6 +168,7 @@ Index* faiss::ProductQuantizer::assign_index assign_index + faiss::ProductQuantizer::assign_index @@ -174,6 +183,7 @@ std::vector<float> faiss::ProductQuantizer::centroids centroids + faiss::ProductQuantizer::centroids @@ -188,6 +198,7 @@ std::vector<float> faiss::ProductQuantizer::transposed_centroids transposed_centroids + faiss::ProductQuantizer::transposed_centroids @@ -202,6 +213,7 @@ std::vector<float> faiss::ProductQuantizer::centroids_sq_lengths centroids_sq_lengths + faiss::ProductQuantizer::centroids_sq_lengths @@ -216,6 +228,7 @@ std::vector<float> faiss::ProductQuantizer::sdc_table sdc_table + faiss::ProductQuantizer::sdc_table Symmetric Distance Table. @@ -230,6 +243,7 @@ size_t faiss::Quantizer::d d + faiss::Quantizer::d size of the input vectors @@ -244,6 +258,7 @@ size_t faiss::Quantizer::code_size code_size + faiss::Quantizer::code_size bytes per indexed vector @@ -253,13 +268,14 @@ - - - + + + float * - float* faiss::ProductQuantizer::get_centroids + float * faiss::ProductQuantizer::get_centroids (size_t m, size_t i) get_centroids + faiss::ProductQuantizer::get_centroids size_t m @@ -277,11 +293,12 @@ - + const float * - const float* faiss::ProductQuantizer::get_centroids + const float * faiss::ProductQuantizer::get_centroids (size_t m, size_t i) const get_centroids + faiss::ProductQuantizer::get_centroids size_t m @@ -303,6 +320,7 @@ void faiss::ProductQuantizer::train (size_t n, const float *x) override train + faiss::ProductQuantizer::train train size_t @@ -336,6 +354,7 @@ faiss::ProductQuantizer::ProductQuantizer (size_t d, size_t M, size_t nbits) ProductQuantizer + faiss::ProductQuantizer::ProductQuantizer size_t d @@ -361,6 +380,7 @@ faiss::ProductQuantizer::ProductQuantizer () ProductQuantizer + faiss::ProductQuantizer::ProductQuantizer @@ -374,6 +394,7 @@ void faiss::ProductQuantizer::set_derived_values () set_derived_values + faiss::ProductQuantizer::set_derived_values compute derived values when d, M and nbits have been set @@ -388,6 +409,7 @@ void faiss::ProductQuantizer::set_params (const float *centroids, int m) set_params + faiss::ProductQuantizer::set_params const float * centroids @@ -410,6 +432,7 @@ void faiss::ProductQuantizer::compute_code (const float *x, uint8_t *code) const compute_code + faiss::ProductQuantizer::compute_code const float * x @@ -432,6 +455,7 @@ void faiss::ProductQuantizer::compute_codes (const float *x, uint8_t *codes, size_t n) const override compute_codes + faiss::ProductQuantizer::compute_codes compute_codes const float * @@ -459,6 +483,7 @@ void faiss::ProductQuantizer::compute_codes_with_assign_index (const float *x, uint8_t *codes, size_t n) compute_codes_with_assign_index + faiss::ProductQuantizer::compute_codes_with_assign_index const float * x @@ -485,6 +510,7 @@ void faiss::ProductQuantizer::decode (const uint8_t *code, float *x) const decode + faiss::ProductQuantizer::decode const uint8_t * code @@ -507,6 +533,7 @@ void faiss::ProductQuantizer::decode (const uint8_t *code, float *x, size_t n) const override decode + faiss::ProductQuantizer::decode decode const uint8_t * @@ -552,6 +579,7 @@ void faiss::ProductQuantizer::compute_code_from_distance_table (const float *tab, uint8_t *code) const compute_code_from_distance_table + faiss::ProductQuantizer::compute_code_from_distance_table const float * tab @@ -574,6 +602,7 @@ void faiss::ProductQuantizer::compute_distance_table (const float *x, float *dis_table) const compute_distance_table + faiss::ProductQuantizer::compute_distance_table const float * x @@ -617,6 +646,7 @@ void faiss::ProductQuantizer::compute_inner_prod_table (const float *x, float *dis_table) const compute_inner_prod_table + faiss::ProductQuantizer::compute_inner_prod_table const float * x @@ -638,6 +668,7 @@ void faiss::ProductQuantizer::compute_distance_tables (size_t nx, const float *x, float *dis_tables) const compute_distance_tables + faiss::ProductQuantizer::compute_distance_tables size_t nx @@ -689,6 +720,7 @@ void faiss::ProductQuantizer::compute_inner_prod_tables (size_t nx, const float *x, float *dis_tables) const compute_inner_prod_tables + faiss::ProductQuantizer::compute_inner_prod_tables size_t nx @@ -714,6 +746,7 @@ void faiss::ProductQuantizer::search (const float *x, size_t nx, const uint8_t *codes, const size_t ncodes, float_maxheap_array_t *res, bool init_finalize_heap=true) const search + faiss::ProductQuantizer::search const float * x @@ -802,6 +835,7 @@ void faiss::ProductQuantizer::search_ip (const float *x, size_t nx, const uint8_t *codes, const size_t ncodes, float_minheap_array_t *res, bool init_finalize_heap=true) const search_ip + faiss::ProductQuantizer::search_ip const float * x @@ -841,6 +875,7 @@ void faiss::ProductQuantizer::compute_sdc_table () compute_sdc_table + faiss::ProductQuantizer::compute_sdc_table @@ -854,6 +889,7 @@ void faiss::ProductQuantizer::search_sdc (const uint8_t *qcodes, size_t nq, const uint8_t *bcodes, const size_t ncodes, float_maxheap_array_t *res, bool init_finalize_heap=true) const search_sdc + faiss::ProductQuantizer::search_sdc const uint8_t * qcodes @@ -892,6 +928,7 @@ void faiss::ProductQuantizer::sync_transposed_centroids () sync_transposed_centroids + faiss::ProductQuantizer::sync_transposed_centroids @@ -906,6 +943,7 @@ void faiss::ProductQuantizer::clear_transposed_centroids () clear_transposed_centroids + faiss::ProductQuantizer::clear_transposed_centroids Clear transposed centroids table so ones are no longer used. @@ -915,49 +953,49 @@ - + Product Quantizer. PQ is trained using k-means, minimizing the L2 distance to centroids. PQ supports L2 and Inner Product search, however the quantization error is biased towards L2 distance. - - - - + + + + - + - + - - - - - assign_index + cp - cp + assign_index + + + + @@ -980,8 +1018,8 @@ faiss::ProductQuantizerdecode faiss::ProductQuantizerdecode faiss::ProductQuantizerdsub - faiss::ProductQuantizerget_centroids - faiss::ProductQuantizerget_centroids + faiss::ProductQuantizerget_centroids + faiss::ProductQuantizerget_centroids faiss::ProductQuantizerksub faiss::ProductQuantizerM faiss::ProductQuantizernbits diff --git a/xml/structfaiss_1_1ProductResidualQuantizer.xml b/xml/structfaiss_1_1ProductResidualQuantizer.xml index 9ab6effdd2..512114bd5b 100644 --- a/xml/structfaiss_1_1ProductResidualQuantizer.xml +++ b/xml/structfaiss_1_1ProductResidualQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::ProductResidualQuantizer faiss::ProductAdditiveQuantizer ProductAdditiveQuantizer.h - + faiss::ProductResidualQuantizer::ProductResidualQuantizer (size_t d, size_t nsplits, size_t Msub, size_t nbits, Search_type_t search_type=ST_decompress) ProductResidualQuantizer + faiss::ProductResidualQuantizer::ProductResidualQuantizer size_t d @@ -87,6 +88,7 @@ faiss::ProductResidualQuantizer::ProductResidualQuantizer () ProductResidualQuantizer + faiss::ProductResidualQuantizer::ProductResidualQuantizer @@ -100,6 +102,7 @@ void faiss::ProductAdditiveQuantizer::init (size_t d, const std::vector< AdditiveQuantizer * > &aqs, Search_type_t search_type) init + faiss::ProductAdditiveQuantizer::init size_t d @@ -120,11 +123,12 @@ - + AdditiveQuantizer * - AdditiveQuantizer* faiss::ProductAdditiveQuantizer::subquantizer + AdditiveQuantizer * faiss::ProductAdditiveQuantizer::subquantizer (size_t m) const subquantizer + faiss::ProductAdditiveQuantizer::subquantizer size_t m @@ -143,6 +147,7 @@ void faiss::ProductAdditiveQuantizer::train (size_t n, const float *x) override train + faiss::ProductAdditiveQuantizer::train train size_t @@ -176,6 +181,7 @@ void faiss::ProductAdditiveQuantizer::compute_codes_add_centroids (const float *x, uint8_t *codes, size_t n, const float *centroids=nullptr) const override compute_codes_add_centroids + faiss::ProductAdditiveQuantizer::compute_codes_add_centroids compute_codes_add_centroids const float * @@ -234,6 +240,7 @@ void faiss::ProductAdditiveQuantizer::compute_unpacked_codes (const float *x, int32_t *codes, size_t n, const float *centroids=nullptr) const compute_unpacked_codes + faiss::ProductAdditiveQuantizer::compute_unpacked_codes const float * x @@ -264,6 +271,7 @@ void faiss::ProductAdditiveQuantizer::decode_unpacked (const int32_t *codes, float *x, size_t n, int64_t ld_codes=-1) const override decode_unpacked + faiss::ProductAdditiveQuantizer::decode_unpacked decode_unpacked const int32_t * @@ -314,6 +322,7 @@ void faiss::ProductAdditiveQuantizer::decode (const uint8_t *codes, float *x, size_t n) const override decode + faiss::ProductAdditiveQuantizer::decode decode const uint8_t * @@ -359,6 +368,7 @@ void faiss::ProductAdditiveQuantizer::compute_LUT (size_t n, const float *xq, float *LUT, float alpha=1.0f, long ld_lut=-1) const override compute_LUT + faiss::ProductAdditiveQuantizer::compute_LUT compute_LUT size_t @@ -430,6 +440,7 @@ void faiss::AdditiveQuantizer::compute_codebook_tables () compute_codebook_tables + faiss::AdditiveQuantizer::compute_codebook_tables @@ -443,6 +454,7 @@ uint64_t faiss::AdditiveQuantizer::encode_norm (float norm) const encode_norm + faiss::AdditiveQuantizer::encode_norm float norm @@ -461,6 +473,7 @@ uint32_t faiss::AdditiveQuantizer::encode_qcint (float x) const encode_qcint + faiss::AdditiveQuantizer::encode_qcint float x @@ -479,6 +492,7 @@ float faiss::AdditiveQuantizer::decode_qcint (uint32_t c) const decode_qcint + faiss::AdditiveQuantizer::decode_qcint uint32_t c @@ -497,6 +511,7 @@ void faiss::AdditiveQuantizer::set_derived_values () set_derived_values + faiss::AdditiveQuantizer::set_derived_values Train the norm quantizer. @@ -511,6 +526,7 @@ void faiss::AdditiveQuantizer::train_norm (size_t n, const float *norms) train_norm + faiss::AdditiveQuantizer::train_norm size_t n @@ -532,6 +548,7 @@ void faiss::AdditiveQuantizer::compute_codes (const float *x, uint8_t *codes, size_t n) const override compute_codes + faiss::AdditiveQuantizer::compute_codes compute_codes const float * @@ -577,6 +594,7 @@ void faiss::AdditiveQuantizer::pack_codes (size_t n, const int32_t *codes, uint8_t *packed_codes, int64_t ld_codes=-1, const float *norms=nullptr, const float *centroids=nullptr) const pack_codes + faiss::AdditiveQuantizer::pack_codes size_t n @@ -672,6 +690,7 @@ float faiss::AdditiveQuantizer::compute_1_distance_LUT (const uint8_t *codes, const float *LUT) const compute_1_distance_LUT + faiss::AdditiveQuantizer::compute_1_distance_LUT const uint8_t * codes @@ -693,6 +712,7 @@ void faiss::AdditiveQuantizer::decode_64bit (idx_t n, float *x) const decode_64bit + faiss::AdditiveQuantizer::decode_64bit idx_t n @@ -715,6 +735,7 @@ void faiss::AdditiveQuantizer::knn_centroids_inner_product (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels) const knn_centroids_inner_product + faiss::AdditiveQuantizer::knn_centroids_inner_product idx_t n @@ -749,6 +770,7 @@ void faiss::AdditiveQuantizer::compute_centroid_norms (float *norms) const compute_centroid_norms + faiss::AdditiveQuantizer::compute_centroid_norms float * norms @@ -777,6 +799,7 @@ void faiss::AdditiveQuantizer::knn_centroids_L2 (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels, const float *centroid_norms) const knn_centroids_L2 + faiss::AdditiveQuantizer::knn_centroids_L2 idx_t n @@ -810,13 +833,14 @@ - - + + size_t size_t faiss::ProductAdditiveQuantizer::nsplits nsplits + faiss::ProductAdditiveQuantizer::nsplits number of sub-vectors we split a vector into @@ -831,6 +855,7 @@ std::vector<AdditiveQuantizer*> faiss::ProductAdditiveQuantizer::quantizers quantizers + faiss::ProductAdditiveQuantizer::quantizers @@ -844,6 +869,7 @@ size_t faiss::AdditiveQuantizer::M M + faiss::AdditiveQuantizer::M number of codebooks @@ -858,6 +884,7 @@ std::vector<size_t> faiss::AdditiveQuantizer::nbits nbits + faiss::AdditiveQuantizer::nbits bits for each step @@ -872,6 +899,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebooks codebooks + faiss::AdditiveQuantizer::codebooks codebooks @@ -886,6 +914,7 @@ std::vector<uint64_t> faiss::AdditiveQuantizer::codebook_offsets codebook_offsets + faiss::AdditiveQuantizer::codebook_offsets @@ -900,6 +929,7 @@ size_t faiss::AdditiveQuantizer::tot_bits tot_bits + faiss::AdditiveQuantizer::tot_bits = 0 total number of bits (indexes + norms) @@ -915,6 +945,7 @@ size_t faiss::AdditiveQuantizer::norm_bits norm_bits + faiss::AdditiveQuantizer::norm_bits = 0 bits allocated for the norms @@ -930,6 +961,7 @@ size_t faiss::AdditiveQuantizer::total_codebook_size total_codebook_size + faiss::AdditiveQuantizer::total_codebook_size = 0 size of the codebook in vectors @@ -945,6 +977,7 @@ bool faiss::AdditiveQuantizer::only_8bit only_8bit + faiss::AdditiveQuantizer::only_8bit = false are all nbits = 8 (use faster decoder) @@ -960,6 +993,7 @@ bool faiss::AdditiveQuantizer::verbose verbose + faiss::AdditiveQuantizer::verbose = false verbose during training? @@ -975,6 +1009,7 @@ bool faiss::AdditiveQuantizer::is_trained is_trained + faiss::AdditiveQuantizer::is_trained = false is trained or not @@ -990,6 +1025,7 @@ std::vector<float> faiss::AdditiveQuantizer::norm_tabs norm_tabs + faiss::AdditiveQuantizer::norm_tabs @@ -1004,6 +1040,7 @@ IndexFlat1D faiss::AdditiveQuantizer::qnorm qnorm + faiss::AdditiveQuantizer::qnorm store and search norms @@ -1018,6 +1055,7 @@ std::vector<float> faiss::AdditiveQuantizer::centroid_norms centroid_norms + faiss::AdditiveQuantizer::centroid_norms norms of all codebook entries (size total_codebook_size) @@ -1032,6 +1070,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebook_cross_products codebook_cross_products + faiss::AdditiveQuantizer::codebook_cross_products @@ -1046,6 +1085,7 @@ size_t faiss::AdditiveQuantizer::max_mem_distances max_mem_distances + faiss::AdditiveQuantizer::max_mem_distances = 5 * (size_t(1) << 30) @@ -1061,6 +1101,7 @@ Search_type_t faiss::AdditiveQuantizer::search_type search_type + faiss::AdditiveQuantizer::search_type Also determines what's in the codes. @@ -1075,6 +1116,7 @@ float faiss::AdditiveQuantizer::norm_min norm_min + faiss::AdditiveQuantizer::norm_min = NAN min/max for quantization of norms @@ -1090,6 +1132,7 @@ float faiss::AdditiveQuantizer::norm_max norm_max + faiss::AdditiveQuantizer::norm_max = NAN @@ -1104,6 +1147,7 @@ size_t faiss::Quantizer::d d + faiss::Quantizer::d size of the input vectors @@ -1118,6 +1162,7 @@ size_t faiss::Quantizer::code_size code_size + faiss::Quantizer::code_size bytes per indexed vector @@ -1127,11 +1172,12 @@ - - + + Search_type_t + faiss::AdditiveQuantizer::Search_type_t ST_decompress @@ -1219,25 +1265,25 @@ - + Product Residual Quantizer - - - - - - + + + + + + @@ -1250,11 +1296,18 @@ - - - - + + + + + + qnorm + + + + + @@ -1268,23 +1321,22 @@ + + + + + + - - - - - - - - - - - qnorm + + + + @@ -1297,12 +1349,6 @@ - - - - - - @@ -1361,7 +1407,7 @@ faiss::ProductResidualQuantizerST_norm_qint4 faiss::ProductResidualQuantizerST_norm_qint8 faiss::ProductResidualQuantizerST_norm_rq2x4 - faiss::ProductResidualQuantizersubquantizer + faiss::ProductResidualQuantizersubquantizer faiss::ProductResidualQuantizertot_bits faiss::ProductResidualQuantizertotal_codebook_size faiss::ProductResidualQuantizertrain diff --git a/xml/structfaiss_1_1ProgressiveDimClustering.xml b/xml/structfaiss_1_1ProgressiveDimClustering.xml index b38c0b8642..dc22d1da99 100644 --- a/xml/structfaiss_1_1ProgressiveDimClustering.xml +++ b/xml/structfaiss_1_1ProgressiveDimClustering.xml @@ -1,15 +1,16 @@ - + faiss::ProgressiveDimClustering faiss::ProgressiveDimClusteringParameters Clustering.h - + size_t size_t faiss::ProgressiveDimClustering::d d + faiss::ProgressiveDimClustering::d dimension of the vectors @@ -24,6 +25,7 @@ size_t faiss::ProgressiveDimClustering::k k + faiss::ProgressiveDimClustering::k nb of centroids @@ -38,6 +40,7 @@ std::vector<float> faiss::ProgressiveDimClustering::centroids centroids + faiss::ProgressiveDimClustering::centroids @@ -52,6 +55,7 @@ std::vector<ClusteringIterationStats> faiss::ProgressiveDimClustering::iteration_stats iteration_stats + faiss::ProgressiveDimClustering::iteration_stats stats at every iteration of clustering @@ -66,6 +70,7 @@ int faiss::ProgressiveDimClusteringParameters::progressive_dim_steps progressive_dim_steps + faiss::ProgressiveDimClusteringParameters::progressive_dim_steps number of incremental steps @@ -80,6 +85,7 @@ bool faiss::ProgressiveDimClusteringParameters::apply_pca apply_pca + faiss::ProgressiveDimClusteringParameters::apply_pca apply PCA on input @@ -94,6 +100,7 @@ int faiss::ClusteringParameters::niter niter + faiss::ClusteringParameters::niter = 25 number of clustering iterations @@ -109,6 +116,7 @@ int faiss::ClusteringParameters::nredo nredo + faiss::ClusteringParameters::nredo = 1 @@ -124,6 +132,7 @@ bool faiss::ClusteringParameters::verbose verbose + faiss::ClusteringParameters::verbose = false @@ -138,6 +147,7 @@ bool faiss::ClusteringParameters::spherical spherical + faiss::ClusteringParameters::spherical = false @@ -153,6 +163,7 @@ bool faiss::ClusteringParameters::int_centroids int_centroids + faiss::ClusteringParameters::int_centroids = false round centroids coordinates to integer after each iteration? @@ -168,6 +179,7 @@ bool faiss::ClusteringParameters::update_index update_index + faiss::ClusteringParameters::update_index = false re-train index after each iteration? @@ -183,6 +195,7 @@ bool faiss::ClusteringParameters::frozen_centroids frozen_centroids + faiss::ClusteringParameters::frozen_centroids = false @@ -198,6 +211,7 @@ int faiss::ClusteringParameters::min_points_per_centroid min_points_per_centroid + faiss::ClusteringParameters::min_points_per_centroid = 39 @@ -213,6 +227,7 @@ int faiss::ClusteringParameters::max_points_per_centroid max_points_per_centroid + faiss::ClusteringParameters::max_points_per_centroid = 256 to limit size of dataset, otherwise the training set is subsampled @@ -228,6 +243,7 @@ int faiss::ClusteringParameters::seed seed + faiss::ClusteringParameters::seed = 1234 @@ -243,6 +259,7 @@ size_t faiss::ClusteringParameters::decode_block_size decode_block_size + faiss::ClusteringParameters::decode_block_size = 32768 when the training set is encoded, batch size of the codec decoder @@ -258,6 +275,7 @@ bool faiss::ClusteringParameters::check_input_data_for_NaNs check_input_data_for_NaNs + faiss::ClusteringParameters::check_input_data_for_NaNs = true whether to check for NaNs in an input data @@ -273,6 +291,7 @@ bool faiss::ClusteringParameters::use_faster_subsampling use_faster_subsampling + faiss::ClusteringParameters::use_faster_subsampling = false @@ -283,13 +302,14 @@ - - + + faiss::ProgressiveDimClustering::ProgressiveDimClustering (int d, int k) ProgressiveDimClustering + faiss::ProgressiveDimClustering::ProgressiveDimClustering int d @@ -311,6 +331,7 @@ faiss::ProgressiveDimClustering::ProgressiveDimClustering (int d, int k, const ProgressiveDimClusteringParameters &cp) ProgressiveDimClustering + faiss::ProgressiveDimClustering::ProgressiveDimClustering int d @@ -336,6 +357,7 @@ void faiss::ProgressiveDimClustering::train (idx_t n, const float *x, ProgressiveDimIndexFactory &factory) train + faiss::ProgressiveDimClustering::train idx_t n @@ -361,6 +383,7 @@ virtual faiss::ProgressiveDimClustering::~ProgressiveDimClustering () ~ProgressiveDimClustering + faiss::ProgressiveDimClustering::~ProgressiveDimClustering @@ -369,7 +392,7 @@ - + @@ -381,11 +404,9 @@ Nearest Neighbor Search" https://arxiv.org/abs/1509.05195 - - - - - + + + @@ -393,27 +414,29 @@ Nearest Neighbor Search" - - - - - - + + + + + + - - - + + + + + diff --git a/xml/structfaiss_1_1ProgressiveDimClusteringParameters.xml b/xml/structfaiss_1_1ProgressiveDimClusteringParameters.xml index 45efa03ab6..2966cbbf7a 100644 --- a/xml/structfaiss_1_1ProgressiveDimClusteringParameters.xml +++ b/xml/structfaiss_1_1ProgressiveDimClusteringParameters.xml @@ -1,15 +1,16 @@ - + faiss::ProgressiveDimClusteringParameters faiss::ClusteringParameters faiss::ProgressiveDimClustering - + int int faiss::ProgressiveDimClusteringParameters::progressive_dim_steps progressive_dim_steps + faiss::ProgressiveDimClusteringParameters::progressive_dim_steps number of incremental steps @@ -24,6 +25,7 @@ bool faiss::ProgressiveDimClusteringParameters::apply_pca apply_pca + faiss::ProgressiveDimClusteringParameters::apply_pca apply PCA on input @@ -38,6 +40,7 @@ int faiss::ClusteringParameters::niter niter + faiss::ClusteringParameters::niter = 25 number of clustering iterations @@ -53,6 +56,7 @@ int faiss::ClusteringParameters::nredo nredo + faiss::ClusteringParameters::nredo = 1 @@ -68,6 +72,7 @@ bool faiss::ClusteringParameters::verbose verbose + faiss::ClusteringParameters::verbose = false @@ -82,6 +87,7 @@ bool faiss::ClusteringParameters::spherical spherical + faiss::ClusteringParameters::spherical = false @@ -97,6 +103,7 @@ bool faiss::ClusteringParameters::int_centroids int_centroids + faiss::ClusteringParameters::int_centroids = false round centroids coordinates to integer after each iteration? @@ -112,6 +119,7 @@ bool faiss::ClusteringParameters::update_index update_index + faiss::ClusteringParameters::update_index = false re-train index after each iteration? @@ -127,6 +135,7 @@ bool faiss::ClusteringParameters::frozen_centroids frozen_centroids + faiss::ClusteringParameters::frozen_centroids = false @@ -142,6 +151,7 @@ int faiss::ClusteringParameters::min_points_per_centroid min_points_per_centroid + faiss::ClusteringParameters::min_points_per_centroid = 39 @@ -157,6 +167,7 @@ int faiss::ClusteringParameters::max_points_per_centroid max_points_per_centroid + faiss::ClusteringParameters::max_points_per_centroid = 256 to limit size of dataset, otherwise the training set is subsampled @@ -172,6 +183,7 @@ int faiss::ClusteringParameters::seed seed + faiss::ClusteringParameters::seed = 1234 @@ -187,6 +199,7 @@ size_t faiss::ClusteringParameters::decode_block_size decode_block_size + faiss::ClusteringParameters::decode_block_size = 32768 when the training set is encoded, batch size of the codec decoder @@ -202,6 +215,7 @@ bool faiss::ClusteringParameters::check_input_data_for_NaNs check_input_data_for_NaNs + faiss::ClusteringParameters::check_input_data_for_NaNs = true whether to check for NaNs in an input data @@ -217,6 +231,7 @@ bool faiss::ClusteringParameters::use_faster_subsampling use_faster_subsampling + faiss::ClusteringParameters::use_faster_subsampling = false @@ -227,13 +242,14 @@ - - + + faiss::ProgressiveDimClusteringParameters::ProgressiveDimClusteringParameters () ProgressiveDimClusteringParameters + faiss::ProgressiveDimClusteringParameters::ProgressiveDimClusteringParameters @@ -242,17 +258,15 @@ - + - - - - - + + + @@ -260,22 +274,24 @@ - - - - - - + + + + + + + + diff --git a/xml/structfaiss_1_1ProgressiveDimIndexFactory.xml b/xml/structfaiss_1_1ProgressiveDimIndexFactory.xml index a17f2ba878..4f32a84350 100644 --- a/xml/structfaiss_1_1ProgressiveDimIndexFactory.xml +++ b/xml/structfaiss_1_1ProgressiveDimIndexFactory.xml @@ -1,16 +1,17 @@ - + faiss::ProgressiveDimIndexFactory faiss::gpu::GpuProgressiveDimIndexFactory Clustering.h - - + + Index * - virtual Index* faiss::ProgressiveDimIndexFactory::operator() + virtual Index * faiss::ProgressiveDimIndexFactory::operator() (int dim) operator() - operator() + faiss::ProgressiveDimIndexFactory::operator() + operator() int dim @@ -29,6 +30,7 @@ virtual faiss::ProgressiveDimIndexFactory::~ProgressiveDimIndexFactory () ~ProgressiveDimIndexFactory + faiss::ProgressiveDimIndexFactory::~ProgressiveDimIndexFactory @@ -37,7 +39,7 @@ - + @@ -57,7 +59,7 @@ - faiss::ProgressiveDimIndexFactoryoperator() + faiss::ProgressiveDimIndexFactoryoperator() faiss::ProgressiveDimIndexFactory~ProgressiveDimIndexFactory diff --git a/xml/structfaiss_1_1QINCo.xml b/xml/structfaiss_1_1QINCo.xml index 624ddf1eee..cbd1b0c2eb 100644 --- a/xml/structfaiss_1_1QINCo.xml +++ b/xml/structfaiss_1_1QINCo.xml @@ -1,14 +1,15 @@ - + faiss::QINCo faiss::NeuralNetCodec - + int int faiss::QINCo::K K + faiss::QINCo::K @@ -22,6 +23,7 @@ int faiss::QINCo::L L + faiss::QINCo::L @@ -35,6 +37,7 @@ int faiss::QINCo::h h + faiss::QINCo::h @@ -48,6 +51,7 @@ nn::Embedding faiss::QINCo::codebook0 codebook0 + faiss::QINCo::codebook0 @@ -61,6 +65,7 @@ std::vector<QINCoStep> faiss::QINCo::steps steps + faiss::QINCo::steps @@ -74,6 +79,7 @@ int faiss::NeuralNetCodec::d d + faiss::NeuralNetCodec::d @@ -87,6 +93,7 @@ int faiss::NeuralNetCodec::M M + faiss::NeuralNetCodec::M @@ -95,13 +102,14 @@ - - + + faiss::QINCo::QINCo (int d, int K, int L, int M, int h) QINCo + faiss::QINCo::QINCo int d @@ -130,11 +138,12 @@ - + QINCoStep & - QINCoStep& faiss::QINCo::get_step + QINCoStep & faiss::QINCo::get_step (int i) get_step + faiss::QINCo::get_step int i @@ -152,6 +161,7 @@ nn::Tensor2D faiss::QINCo::decode (const nn::Int32Tensor2D &codes) const override decode + faiss::QINCo::decode decode const nn::Int32Tensor2D & @@ -170,6 +180,7 @@ nn::Int32Tensor2D faiss::QINCo::encode (const nn::Tensor2D &x) const override encode + faiss::QINCo::encode encode const nn::Tensor2D & @@ -188,6 +199,7 @@ virtual faiss::QINCo::~QINCo () ~QINCo + faiss::QINCo::~QINCo @@ -196,24 +208,28 @@ - + + + + + + + - - @@ -227,10 +243,6 @@ - - - - @@ -238,7 +250,7 @@ faiss::QINCod faiss::QINCodecode faiss::QINCoencode - faiss::QINCoget_step + faiss::QINCoget_step faiss::QINCoh faiss::QINCoK faiss::QINCoL diff --git a/xml/structfaiss_1_1QINCoStep.xml b/xml/structfaiss_1_1QINCoStep.xml index 770e1604b2..bee98c1c15 100644 --- a/xml/structfaiss_1_1QINCoStep.xml +++ b/xml/structfaiss_1_1QINCoStep.xml @@ -1,13 +1,14 @@ - + faiss::QINCoStep - + int int faiss::QINCoStep::d d + faiss::QINCoStep::d d: input dim, K: codebook size, L: # of residual blocks, h: hidden dim @@ -22,6 +23,7 @@ int faiss::QINCoStep::K K + faiss::QINCoStep::K @@ -35,6 +37,7 @@ int faiss::QINCoStep::L L + faiss::QINCoStep::L @@ -48,6 +51,7 @@ int faiss::QINCoStep::h h + faiss::QINCoStep::h @@ -61,6 +65,7 @@ nn::Embedding faiss::QINCoStep::codebook codebook + faiss::QINCoStep::codebook @@ -74,6 +79,7 @@ nn::Linear faiss::QINCoStep::MLPconcat MLPconcat + faiss::QINCoStep::MLPconcat @@ -87,6 +93,7 @@ std::vector<nn::FFN> faiss::QINCoStep::residual_blocks residual_blocks + faiss::QINCoStep::residual_blocks @@ -95,13 +102,14 @@ - - + + faiss::QINCoStep::QINCoStep (int d, int K, int L, int h) QINCoStep + faiss::QINCoStep::QINCoStep int d @@ -126,11 +134,12 @@ - + nn::FFN & - nn::FFN& faiss::QINCoStep::get_residual_block + nn::FFN & faiss::QINCoStep::get_residual_block (int i) get_residual_block + faiss::QINCoStep::get_residual_block int i @@ -148,6 +157,7 @@ nn::Int32Tensor2D faiss::QINCoStep::encode (const nn::Tensor2D &xhat, const nn::Tensor2D &x, nn::Tensor2D *residuals=nullptr) const encode + faiss::QINCoStep::encode const nn::Tensor2D & xhat @@ -175,6 +185,7 @@ nn::Tensor2D faiss::QINCoStep::decode (const nn::Tensor2D &xhat, const nn::Int32Tensor2D &codes) const decode + faiss::QINCoStep::decode const nn::Tensor2D & xhat @@ -191,30 +202,30 @@ - + - - - - - MLPconcat + codebook - codebook + MLPconcat - + + + + + @@ -222,7 +233,7 @@ faiss::QINCoStepd faiss::QINCoStepdecode faiss::QINCoStepencode - faiss::QINCoStepget_residual_block + faiss::QINCoStepget_residual_block faiss::QINCoSteph faiss::QINCoStepK faiss::QINCoStepL diff --git a/xml/structfaiss_1_1Quantizer.xml b/xml/structfaiss_1_1Quantizer.xml index 7ef8922046..d5b64a7f00 100644 --- a/xml/structfaiss_1_1Quantizer.xml +++ b/xml/structfaiss_1_1Quantizer.xml @@ -1,17 +1,18 @@ - + faiss::Quantizer faiss::AdditiveQuantizer faiss::ProductQuantizer faiss::ScalarQuantizer Quantizer.h - + size_t size_t faiss::Quantizer::d d + faiss::Quantizer::d size of the input vectors @@ -26,6 +27,7 @@ size_t faiss::Quantizer::code_size code_size + faiss::Quantizer::code_size bytes per indexed vector @@ -35,13 +37,14 @@ - - + + faiss::Quantizer::Quantizer (size_t d=0, size_t code_size=0) Quantizer + faiss::Quantizer::Quantizer size_t d @@ -65,6 +68,7 @@ virtual void faiss::Quantizer::train (size_t n, const float *x)=0 train + faiss::Quantizer::train train train train @@ -102,6 +106,7 @@ virtual void faiss::Quantizer::compute_codes (const float *x, uint8_t *codes, size_t n) const =0 compute_codes + faiss::Quantizer::compute_codes compute_codes compute_codes compute_codes @@ -149,6 +154,7 @@ virtual void faiss::Quantizer::decode (const uint8_t *code, float *x, size_t n) const =0 decode + faiss::Quantizer::decode decode decode decode @@ -197,6 +203,7 @@ virtual faiss::Quantizer::~Quantizer () ~Quantizer + faiss::Quantizer::~Quantizer @@ -205,23 +212,23 @@ - + General interface for quantizer objects - - - - + + + + - - - - + + + + @@ -230,21 +237,15 @@ - - - - - - - - - + + + @@ -258,9 +259,15 @@ - - - + + + + + + + + + diff --git a/xml/structfaiss_1_1RandomGenerator.xml b/xml/structfaiss_1_1RandomGenerator.xml index e4ed2e0149..0d171e59ea 100644 --- a/xml/structfaiss_1_1RandomGenerator.xml +++ b/xml/structfaiss_1_1RandomGenerator.xml @@ -1,14 +1,15 @@ - + faiss::RandomGenerator random.h - + std::mt19937 std::mt19937 faiss::RandomGenerator::mt mt + faiss::RandomGenerator::mt @@ -17,13 +18,14 @@ - - + + int int faiss::RandomGenerator::rand_int () rand_int + faiss::RandomGenerator::rand_int random positive integer @@ -38,6 +40,7 @@ int64_t faiss::RandomGenerator::rand_int64 () rand_int64 + faiss::RandomGenerator::rand_int64 random int64_t @@ -52,6 +55,7 @@ int faiss::RandomGenerator::rand_int (int max) rand_int + faiss::RandomGenerator::rand_int int max @@ -70,6 +74,7 @@ float faiss::RandomGenerator::rand_float () rand_float + faiss::RandomGenerator::rand_float between 0 and 1 @@ -84,6 +89,7 @@ double faiss::RandomGenerator::rand_double () rand_double + faiss::RandomGenerator::rand_double @@ -97,6 +103,7 @@ faiss::RandomGenerator::RandomGenerator (int64_t seed=1234) RandomGenerator + faiss::RandomGenerator::RandomGenerator int64_t seed @@ -110,7 +117,7 @@ - + random generator that can be used in multithreaded contexts diff --git a/xml/structfaiss_1_1RandomRotationMatrix.xml b/xml/structfaiss_1_1RandomRotationMatrix.xml index a1d36493b8..9a17ba2954 100644 --- a/xml/structfaiss_1_1RandomRotationMatrix.xml +++ b/xml/structfaiss_1_1RandomRotationMatrix.xml @@ -1,15 +1,16 @@ - + faiss::RandomRotationMatrix faiss::LinearTransform VectorTransform.h - + faiss::RandomRotationMatrix::RandomRotationMatrix (int d_in, int d_out) RandomRotationMatrix + faiss::RandomRotationMatrix::RandomRotationMatrix int d_in @@ -32,6 +33,7 @@ void faiss::RandomRotationMatrix::init (int seed) init + faiss::RandomRotationMatrix::init int seed @@ -50,6 +52,7 @@ void faiss::RandomRotationMatrix::train (idx_t n, const float *x) override train + faiss::RandomRotationMatrix::train train idx_t @@ -91,6 +94,7 @@ faiss::RandomRotationMatrix::RandomRotationMatrix () RandomRotationMatrix + faiss::RandomRotationMatrix::RandomRotationMatrix @@ -104,6 +108,7 @@ void faiss::LinearTransform::apply_noalloc (idx_t n, const float *x, float *xt) const override apply_noalloc + faiss::LinearTransform::apply_noalloc apply_noalloc idx_t @@ -131,6 +136,7 @@ void faiss::LinearTransform::transform_transpose (idx_t n, const float *y, float *x) const transform_transpose + faiss::LinearTransform::transform_transpose idx_t n @@ -157,6 +163,7 @@ void faiss::LinearTransform::reverse_transform (idx_t n, const float *xt, float *x) const override reverse_transform + faiss::LinearTransform::reverse_transform reverse_transform idx_t @@ -184,6 +191,7 @@ void faiss::LinearTransform::set_is_orthonormal () set_is_orthonormal + faiss::LinearTransform::set_is_orthonormal compute A^T * A to set the is_orthonormal flag @@ -198,6 +206,7 @@ void faiss::LinearTransform::print_if_verbose (const char *name, const std::vector< double > &mat, int n, int d) const print_if_verbose + faiss::LinearTransform::print_if_verbose const char * name @@ -227,6 +236,7 @@ void faiss::LinearTransform::check_identical (const VectorTransform &other) const override check_identical + faiss::LinearTransform::check_identical check_identical const VectorTransform & @@ -240,11 +250,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -281,13 +292,14 @@ - - + + bool bool faiss::LinearTransform::have_bias have_bias + faiss::LinearTransform::have_bias @@ -301,6 +313,7 @@ bool faiss::LinearTransform::is_orthonormal is_orthonormal + faiss::LinearTransform::is_orthonormal ! whether to use the bias term @@ -316,6 +329,7 @@ std::vector<float> faiss::LinearTransform::A A + faiss::LinearTransform::A Transformation matrix, size d_out * d_in. @@ -330,6 +344,7 @@ std::vector<float> faiss::LinearTransform::b b + faiss::LinearTransform::b bias vector, size d_out @@ -344,6 +359,7 @@ bool faiss::LinearTransform::verbose verbose + faiss::LinearTransform::verbose @@ -357,6 +373,7 @@ int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -370,6 +387,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -384,6 +402,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -393,7 +412,7 @@ - + Randomly rotate a set of vectors. @@ -406,16 +425,16 @@ - - - - + + + + @@ -424,21 +443,21 @@ - - - - + + + + faiss::RandomRotationMatrixA - faiss::RandomRotationMatrixapply + faiss::RandomRotationMatrixapply faiss::RandomRotationMatrixapply_noalloc faiss::RandomRotationMatrixb faiss::RandomRotationMatrixcheck_identical diff --git a/xml/structfaiss_1_1RangeQueryResult.xml b/xml/structfaiss_1_1RangeQueryResult.xml index a9d52db122..14dbadb8b4 100644 --- a/xml/structfaiss_1_1RangeQueryResult.xml +++ b/xml/structfaiss_1_1RangeQueryResult.xml @@ -1,14 +1,15 @@ - + faiss::RangeQueryResult AuxIndexStructures.h - + idx_t idx_t faiss::RangeQueryResult::qno qno + faiss::RangeQueryResult::qno @@ -22,6 +23,7 @@ size_t faiss::RangeQueryResult::nres nres + faiss::RangeQueryResult::nres @@ -35,6 +37,7 @@ RangeSearchPartialResult* faiss::RangeQueryResult::pres pres + faiss::RangeQueryResult::pres @@ -43,13 +46,14 @@ - - + + void void faiss::RangeQueryResult::add (float dis, idx_t id) add + faiss::RangeQueryResult::add float dis @@ -67,17 +71,13 @@ - + result structure for a single query - - - - @@ -98,6 +98,10 @@ res + + + + diff --git a/xml/structfaiss_1_1RangeSearchBlockResultHandler.xml b/xml/structfaiss_1_1RangeSearchBlockResultHandler.xml index 57760d8901..25ef975cfa 100644 --- a/xml/structfaiss_1_1RangeSearchBlockResultHandler.xml +++ b/xml/structfaiss_1_1RangeSearchBlockResultHandler.xml @@ -1,5 +1,5 @@ - + faiss::RangeSearchBlockResultHandler faiss::BlockResultHandler< C, false > @@ -15,12 +15,13 @@ false - + typename C::T using faiss::RangeSearchBlockResultHandler< C, use_sel >::T = typename C::T T + faiss::RangeSearchBlockResultHandler::T @@ -34,6 +35,7 @@ using faiss::RangeSearchBlockResultHandler< C, use_sel >::TI = typename C::TI TI + faiss::RangeSearchBlockResultHandler::TI @@ -42,13 +44,14 @@ - - + + RangeSearchResult * RangeSearchResult* faiss::RangeSearchBlockResultHandler< C, use_sel >::res res + faiss::RangeSearchBlockResultHandler::res @@ -62,6 +65,7 @@ T faiss::RangeSearchBlockResultHandler< C, use_sel >::radius radius + faiss::RangeSearchBlockResultHandler::radius @@ -75,6 +79,7 @@ std::vector<RangeSearchPartialResult*> faiss::RangeSearchBlockResultHandler< C, use_sel >::partial_results partial_results + faiss::RangeSearchBlockResultHandler::partial_results @@ -88,6 +93,7 @@ std::vector<size_t> faiss::RangeSearchBlockResultHandler< C, use_sel >::j0s j0s + faiss::RangeSearchBlockResultHandler::j0s @@ -101,6 +107,7 @@ int faiss::RangeSearchBlockResultHandler< C, use_sel >::pr pr + faiss::RangeSearchBlockResultHandler::pr = 0 @@ -115,6 +122,7 @@ size_t faiss::BlockResultHandler< C, use_sel >::nq nq + faiss::BlockResultHandler::nq @@ -128,6 +136,7 @@ const IDSelector* faiss::BlockResultHandler< C, use_sel >::sel sel + faiss::BlockResultHandler::sel @@ -141,6 +150,8 @@ size_t faiss::BlockResultHandler< C, use_sel >::i0 i0 + faiss::BlockResultHandler::i0 + = 0 @@ -154,6 +165,8 @@ size_t faiss::BlockResultHandler< C, use_sel >::i1 i1 + faiss::BlockResultHandler::i1 + = 0 @@ -162,13 +175,14 @@ - - + + faiss::RangeSearchBlockResultHandler< C, use_sel >::RangeSearchBlockResultHandler (RangeSearchResult *res, float radius, const IDSelector *sel=nullptr) RangeSearchBlockResultHandler + faiss::RangeSearchBlockResultHandler::RangeSearchBlockResultHandler RangeSearchResult * res @@ -195,6 +209,7 @@ void faiss::RangeSearchBlockResultHandler< C, use_sel >::begin_multiple (size_t i0_2, size_t i1_2) begin_multiple + faiss::RangeSearchBlockResultHandler::begin_multiple begin_multiple size_t @@ -218,6 +233,7 @@ void faiss::RangeSearchBlockResultHandler< C, use_sel >::add_results (size_t j0, size_t j1, const T *dis_tab) add_results + faiss::RangeSearchBlockResultHandler::add_results size_t j0 @@ -244,6 +260,7 @@ faiss::RangeSearchBlockResultHandler< C, use_sel >::~RangeSearchBlockResultHandler () ~RangeSearchBlockResultHandler + faiss::RangeSearchBlockResultHandler::~RangeSearchBlockResultHandler @@ -257,6 +274,7 @@ virtual void faiss::BlockResultHandler< C, use_sel >::add_results (size_t, size_t, const typename C::T *) add_results + faiss::BlockResultHandler::add_results size_t @@ -279,6 +297,7 @@ virtual void faiss::BlockResultHandler< C, use_sel >::end_multiple () end_multiple + faiss::BlockResultHandler::end_multiple end_multiple end_multiple @@ -294,6 +313,7 @@ bool faiss::BlockResultHandler< C, use_sel >::is_in_selection (idx_t i) const is_in_selection + faiss::BlockResultHandler::is_in_selection idx_t i @@ -306,46 +326,53 @@ - + + + + + + + - + + + sel + - - - - + + - + res - - - + + + faiss::RangeSearchBlockResultHandleradd_results - faiss::RangeSearchBlockResultHandleradd_results + faiss::RangeSearchBlockResultHandleradd_results faiss::RangeSearchBlockResultHandlerbegin_multiple faiss::RangeSearchBlockResultHandlerBlockResultHandler faiss::RangeSearchBlockResultHandlerend_multiple diff --git a/xml/structfaiss_1_1RangeSearchBlockResultHandler_1_1SingleResultHandler.xml b/xml/structfaiss_1_1RangeSearchBlockResultHandler_1_1SingleResultHandler.xml index 5aa3197354..30d3bffa30 100644 --- a/xml/structfaiss_1_1RangeSearchBlockResultHandler_1_1SingleResultHandler.xml +++ b/xml/structfaiss_1_1RangeSearchBlockResultHandler_1_1SingleResultHandler.xml @@ -1,14 +1,15 @@ - + faiss::RangeSearchBlockResultHandler::SingleResultHandler faiss::ResultHandler< C > - + RangeSearchPartialResult RangeSearchPartialResult faiss::RangeSearchBlockResultHandler< C, use_sel >::SingleResultHandler::pres pres + faiss::RangeSearchBlockResultHandler::SingleResultHandler::pres @@ -22,6 +23,7 @@ RangeQueryResult* faiss::RangeSearchBlockResultHandler< C, use_sel >::SingleResultHandler::qr qr + faiss::RangeSearchBlockResultHandler::SingleResultHandler::qr = nullptr @@ -36,6 +38,7 @@ C::T faiss::ResultHandler< C >::threshold threshold + faiss::ResultHandler::threshold = C::neutral() @@ -45,13 +48,14 @@ - - + + faiss::RangeSearchBlockResultHandler< C, use_sel >::SingleResultHandler::SingleResultHandler (RangeSearchBlockResultHandler &rh) SingleResultHandler + faiss::RangeSearchBlockResultHandler::SingleResultHandler::SingleResultHandler RangeSearchBlockResultHandler & rh @@ -69,6 +73,7 @@ void faiss::RangeSearchBlockResultHandler< C, use_sel >::SingleResultHandler::begin (size_t i) begin + faiss::RangeSearchBlockResultHandler::SingleResultHandler::begin size_t i @@ -87,6 +92,7 @@ bool faiss::RangeSearchBlockResultHandler< C, use_sel >::SingleResultHandler::add_result (T dis, TI idx) final add_result + faiss::RangeSearchBlockResultHandler::SingleResultHandler::add_result add_result T @@ -110,6 +116,7 @@ void faiss::RangeSearchBlockResultHandler< C, use_sel >::SingleResultHandler::end () end + faiss::RangeSearchBlockResultHandler::SingleResultHandler::end series of results for query i is done @@ -124,6 +131,7 @@ faiss::RangeSearchBlockResultHandler< C, use_sel >::SingleResultHandler::~SingleResultHandler () ~SingleResultHandler + faiss::RangeSearchBlockResultHandler::SingleResultHandler::~SingleResultHandler @@ -132,7 +140,7 @@ - + @@ -150,46 +158,46 @@ - - - - - + + + + + + pres + + - qr - - pres - - - - - - - - - - pres + + qr - + - + - + res + + + + + + + + diff --git a/xml/structfaiss_1_1RangeSearchPartialResult.xml b/xml/structfaiss_1_1RangeSearchPartialResult.xml index cff15a2892..6078c8b4f8 100644 --- a/xml/structfaiss_1_1RangeSearchPartialResult.xml +++ b/xml/structfaiss_1_1RangeSearchPartialResult.xml @@ -1,15 +1,16 @@ - + faiss::RangeSearchPartialResult faiss::BufferList AuxIndexStructures.h - + RangeSearchResult * RangeSearchResult* faiss::RangeSearchPartialResult::res res + faiss::RangeSearchPartialResult::res @@ -23,6 +24,7 @@ std::vector<RangeQueryResult> faiss::RangeSearchPartialResult::queries queries + faiss::RangeSearchPartialResult::queries query ids + nb of results per query. @@ -37,6 +39,7 @@ size_t faiss::BufferList::buffer_size buffer_size + faiss::BufferList::buffer_size @@ -50,6 +53,7 @@ std::vector<Buffer> faiss::BufferList::buffers buffers + faiss::BufferList::buffers @@ -63,6 +67,7 @@ size_t faiss::BufferList::wp wp + faiss::BufferList::wp write pointer in the last buffer. @@ -72,13 +77,14 @@ - - + + faiss::RangeSearchPartialResult::RangeSearchPartialResult (RangeSearchResult *res_in) RangeSearchPartialResult + faiss::RangeSearchPartialResult::RangeSearchPartialResult RangeSearchResult * res_in @@ -92,11 +98,12 @@ - + RangeQueryResult & - RangeQueryResult& faiss::RangeSearchPartialResult::new_result + RangeQueryResult & faiss::RangeSearchPartialResult::new_result (idx_t qno) new_result + faiss::RangeSearchPartialResult::new_result idx_t qno @@ -115,6 +122,7 @@ void faiss::RangeSearchPartialResult::finalize () finalize + faiss::RangeSearchPartialResult::finalize @@ -128,6 +136,7 @@ void faiss::RangeSearchPartialResult::set_lims () set_lims + faiss::RangeSearchPartialResult::set_lims called by range_search before do_allocation @@ -142,6 +151,7 @@ void faiss::RangeSearchPartialResult::copy_result (bool incremental=false) copy_result + faiss::RangeSearchPartialResult::copy_result bool incremental @@ -161,6 +171,7 @@ void faiss::BufferList::append_buffer () append_buffer + faiss::BufferList::append_buffer create a new buffer @@ -175,6 +186,7 @@ void faiss::BufferList::add (idx_t id, float dis) add + faiss::BufferList::add idx_t id @@ -197,6 +209,7 @@ void faiss::BufferList::copy_range (size_t ofs, size_t n, idx_t *dest_ids, float *dest_dis) copy_range + faiss::BufferList::copy_range size_t ofs @@ -222,13 +235,14 @@ - - + + void static void faiss::RangeSearchPartialResult::merge (std::vector< RangeSearchPartialResult * > &partial_results, bool do_delete=true) merge + faiss::RangeSearchPartialResult::merge std::vector< RangeSearchPartialResult * > & partial_results @@ -247,7 +261,7 @@ - + the entries in the buffers are split per query @@ -266,10 +280,6 @@ - - - - @@ -283,6 +293,10 @@ res + + + + @@ -295,7 +309,7 @@ faiss::RangeSearchPartialResultcopy_result faiss::RangeSearchPartialResultfinalize faiss::RangeSearchPartialResultmerge - faiss::RangeSearchPartialResultnew_result + faiss::RangeSearchPartialResultnew_result faiss::RangeSearchPartialResultqueries faiss::RangeSearchPartialResultRangeSearchPartialResult faiss::RangeSearchPartialResultres diff --git a/xml/structfaiss_1_1RangeSearchResult.xml b/xml/structfaiss_1_1RangeSearchResult.xml index 19cc1bee1c..d7091001b9 100644 --- a/xml/structfaiss_1_1RangeSearchResult.xml +++ b/xml/structfaiss_1_1RangeSearchResult.xml @@ -1,14 +1,15 @@ - + faiss::RangeSearchResult AuxIndexStructures.h - + size_t size_t faiss::RangeSearchResult::nq nq + faiss::RangeSearchResult::nq nb of queries @@ -23,6 +24,7 @@ size_t* faiss::RangeSearchResult::lims lims + faiss::RangeSearchResult::lims size (nq + 1) @@ -37,6 +39,7 @@ idx_t* faiss::RangeSearchResult::labels labels + faiss::RangeSearchResult::labels result for query i is labels[lims[i]:lims[i+1]] @@ -51,6 +54,7 @@ float* faiss::RangeSearchResult::distances distances + faiss::RangeSearchResult::distances corresponding distances (not sorted) @@ -65,6 +69,7 @@ size_t faiss::RangeSearchResult::buffer_size buffer_size + faiss::RangeSearchResult::buffer_size size of the result buffers used @@ -74,13 +79,14 @@ - - + + faiss::RangeSearchResult::RangeSearchResult (size_t nq, bool alloc_lims=true) RangeSearchResult + faiss::RangeSearchResult::RangeSearchResult size_t nq @@ -104,6 +110,7 @@ virtual void faiss::RangeSearchResult::do_allocation () do_allocation + faiss::RangeSearchResult::do_allocation @@ -118,6 +125,7 @@ virtual faiss::RangeSearchResult::~RangeSearchResult () ~RangeSearchResult + faiss::RangeSearchResult::~RangeSearchResult @@ -126,7 +134,7 @@ - + diff --git a/xml/structfaiss_1_1ReadOnlyInvertedLists.xml b/xml/structfaiss_1_1ReadOnlyInvertedLists.xml index e84069175c..cec053eba8 100644 --- a/xml/structfaiss_1_1ReadOnlyInvertedLists.xml +++ b/xml/structfaiss_1_1ReadOnlyInvertedLists.xml @@ -1,5 +1,5 @@ - + faiss::ReadOnlyInvertedLists faiss::InvertedLists @@ -9,12 +9,13 @@ faiss::StopWordsInvertedLists faiss::VStackInvertedLists InvertedLists.h - + faiss::ReadOnlyInvertedLists::ReadOnlyInvertedLists (size_t nlist, size_t code_size) ReadOnlyInvertedLists + faiss::ReadOnlyInvertedLists::ReadOnlyInvertedLists size_t nlist @@ -36,6 +37,7 @@ size_t faiss::ReadOnlyInvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override add_entries + faiss::ReadOnlyInvertedLists::add_entries add_entries size_t @@ -66,6 +68,7 @@ void faiss::ReadOnlyInvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override update_entries + faiss::ReadOnlyInvertedLists::update_entries update_entries size_t @@ -100,6 +103,7 @@ void faiss::ReadOnlyInvertedLists::resize (size_t list_no, size_t new_size) override resize + faiss::ReadOnlyInvertedLists::resize resize size_t @@ -122,6 +126,7 @@ virtual size_t faiss::InvertedLists::list_size (size_t list_no) const =0 list_size + faiss::InvertedLists::list_size list_size list_size list_size @@ -143,19 +148,20 @@ - + const uint8_t * - virtual const uint8_t* faiss::InvertedLists::get_codes + virtual const uint8_t * faiss::InvertedLists::get_codes (size_t list_no) const =0 get_codes - get_codes - get_codes - get_codes - get_codes - get_codes - get_codes - get_codes - get_codes + faiss::InvertedLists::get_codes + get_codes + get_codes + get_codes + get_codes + get_codes + get_codes + get_codes + get_codes size_t list_no @@ -172,19 +178,20 @@ - + const idx_t * - virtual const idx_t* faiss::InvertedLists::get_ids + virtual const idx_t * faiss::InvertedLists::get_ids (size_t list_no) const =0 get_ids - get_ids - get_ids - get_ids - get_ids - get_ids - get_ids - get_ids - get_ids + faiss::InvertedLists::get_ids + get_ids + get_ids + get_ids + get_ids + get_ids + get_ids + get_ids + get_ids size_t list_no @@ -206,6 +213,7 @@ virtual void faiss::InvertedLists::release_codes (size_t list_no, const uint8_t *codes) const release_codes + faiss::InvertedLists::release_codes release_codes release_codes release_codes @@ -233,6 +241,7 @@ virtual void faiss::InvertedLists::release_ids (size_t list_no, const idx_t *ids) const release_ids + faiss::InvertedLists::release_ids release_ids release_ids release_ids @@ -260,6 +269,7 @@ virtual idx_t faiss::InvertedLists::get_single_id (size_t list_no, size_t offset) const get_single_id + faiss::InvertedLists::get_single_id get_single_id get_single_id get_single_id @@ -284,16 +294,17 @@ - + const uint8_t * - virtual const uint8_t* faiss::InvertedLists::get_single_code + virtual const uint8_t * faiss::InvertedLists::get_single_code (size_t list_no, size_t offset) const get_single_code - get_single_code - get_single_code - get_single_code - get_single_code - get_single_code + faiss::InvertedLists::get_single_code + get_single_code + get_single_code + get_single_code + get_single_code + get_single_code size_t list_no @@ -318,6 +329,7 @@ virtual void faiss::InvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const prefetch_lists + faiss::InvertedLists::prefetch_lists prefetch_lists prefetch_lists prefetch_lists @@ -346,6 +358,7 @@ virtual bool faiss::InvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const is_empty + faiss::InvertedLists::is_empty is_empty size_t @@ -365,11 +378,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -393,6 +407,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -424,6 +439,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -453,6 +469,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -466,6 +483,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -488,6 +506,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -520,6 +539,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -534,6 +554,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -548,6 +569,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -557,11 +579,12 @@ - - + + int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -612,13 +635,14 @@ - - + + size_t size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -633,6 +657,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -647,6 +672,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -657,13 +683,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -674,23 +701,23 @@ - + invlists that fail for all write functions - - - - + + + + @@ -703,6 +730,12 @@ + + + + + + @@ -715,12 +748,6 @@ - - - - - - @@ -741,10 +768,10 @@ faiss::ReadOnlyInvertedListscode_size faiss::ReadOnlyInvertedListscompute_ntotal faiss::ReadOnlyInvertedListscopy_subset_to - faiss::ReadOnlyInvertedListsget_codes - faiss::ReadOnlyInvertedListsget_ids - faiss::ReadOnlyInvertedListsget_iterator - faiss::ReadOnlyInvertedListsget_single_code + faiss::ReadOnlyInvertedListsget_codes + faiss::ReadOnlyInvertedListsget_ids + faiss::ReadOnlyInvertedListsget_iterator + faiss::ReadOnlyInvertedListsget_single_code faiss::ReadOnlyInvertedListsget_single_id faiss::ReadOnlyInvertedListsimbalance_factor faiss::ReadOnlyInvertedListsINVALID_CODE_SIZE diff --git a/xml/structfaiss_1_1RemapDimensionsTransform.xml b/xml/structfaiss_1_1RemapDimensionsTransform.xml index ae435a0c4f..e3d728b958 100644 --- a/xml/structfaiss_1_1RemapDimensionsTransform.xml +++ b/xml/structfaiss_1_1RemapDimensionsTransform.xml @@ -1,15 +1,16 @@ - + faiss::RemapDimensionsTransform faiss::VectorTransform VectorTransform.h - + std::vector< int > std::vector<int> faiss::RemapDimensionsTransform::map map + faiss::RemapDimensionsTransform::map @@ -24,6 +25,7 @@ int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -37,6 +39,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -51,6 +54,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -60,13 +64,14 @@ - - + + faiss::RemapDimensionsTransform::RemapDimensionsTransform (int d_in, int d_out, const int *map) RemapDimensionsTransform + faiss::RemapDimensionsTransform::RemapDimensionsTransform int d_in @@ -92,6 +97,7 @@ faiss::RemapDimensionsTransform::RemapDimensionsTransform (int d_in, int d_out, bool uniform=true) RemapDimensionsTransform + faiss::RemapDimensionsTransform::RemapDimensionsTransform int d_in @@ -119,6 +125,7 @@ void faiss::RemapDimensionsTransform::apply_noalloc (idx_t n, const float *x, float *xt) const override apply_noalloc + faiss::RemapDimensionsTransform::apply_noalloc apply_noalloc idx_t @@ -171,6 +178,7 @@ void faiss::RemapDimensionsTransform::reverse_transform (idx_t n, const float *xt, float *x) const override reverse_transform + faiss::RemapDimensionsTransform::reverse_transform reverse_transform idx_t @@ -198,6 +206,7 @@ faiss::RemapDimensionsTransform::RemapDimensionsTransform () RemapDimensionsTransform + faiss::RemapDimensionsTransform::RemapDimensionsTransform @@ -211,6 +220,7 @@ void faiss::RemapDimensionsTransform::check_identical (const VectorTransform &other) const override check_identical + faiss::RemapDimensionsTransform::check_identical check_identical const VectorTransform & @@ -229,6 +239,7 @@ virtual void faiss::VectorTransform::train (idx_t n, const float *x) train + faiss::VectorTransform::train train train train @@ -270,11 +281,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -311,39 +323,39 @@ - + remap dimensions for intput vectors, possibly inserting 0s strictly speaking this is also a linear transform but we don't want to compute it with matrix multiplies - - - - - - + + + + + + - faiss::RemapDimensionsTransformapply + faiss::RemapDimensionsTransformapply faiss::RemapDimensionsTransformapply_noalloc faiss::RemapDimensionsTransformcheck_identical faiss::RemapDimensionsTransformd_in diff --git a/xml/structfaiss_1_1Repeat.xml b/xml/structfaiss_1_1Repeat.xml index ae00a84f0e..ac19affe80 100644 --- a/xml/structfaiss_1_1Repeat.xml +++ b/xml/structfaiss_1_1Repeat.xml @@ -1,13 +1,14 @@ - + faiss::Repeat - + float float faiss::Repeat::val val + faiss::Repeat::val @@ -21,6 +22,7 @@ int faiss::Repeat::n n + faiss::Repeat::n @@ -29,7 +31,7 @@ - + diff --git a/xml/structfaiss_1_1Repeats.xml b/xml/structfaiss_1_1Repeats.xml index c3f80312a4..d37bc07cea 100644 --- a/xml/structfaiss_1_1Repeats.xml +++ b/xml/structfaiss_1_1Repeats.xml @@ -1,15 +1,16 @@ - + faiss::Repeats faiss::ZnSphereCodec::CodeSegment lattice_Zn.h - + int int faiss::Repeats::dim dim + faiss::Repeats::dim @@ -23,6 +24,7 @@ std::vector<Repeat> faiss::Repeats::repeats repeats + faiss::Repeats::repeats @@ -31,13 +33,14 @@ - - + + faiss::Repeats::Repeats (int dim=0, const float *c=nullptr) Repeats + faiss::Repeats::Repeats int dim @@ -61,6 +64,7 @@ uint64_t faiss::Repeats::count () const count + faiss::Repeats::count @@ -74,6 +78,7 @@ uint64_t faiss::Repeats::encode (const float *c) const encode + faiss::Repeats::encode const float * c @@ -91,6 +96,7 @@ void faiss::Repeats::decode (uint64_t code, float *c) const decode + faiss::Repeats::decode uint64_t code @@ -107,23 +113,23 @@ - + Repeats: used to encode a vector that has n occurrences of val. Encodes the signs and permutation of the vector. Useful for atoms. + + + + - - - - diff --git a/xml/structfaiss_1_1ReproduceDistancesObjective.xml b/xml/structfaiss_1_1ReproduceDistancesObjective.xml index f3fe1f17aa..5d09c918b1 100644 --- a/xml/structfaiss_1_1ReproduceDistancesObjective.xml +++ b/xml/structfaiss_1_1ReproduceDistancesObjective.xml @@ -1,14 +1,15 @@ - + faiss::ReproduceDistancesObjective faiss::PermutationObjective - + double double faiss::ReproduceDistancesObjective::dis_weight_factor dis_weight_factor + faiss::ReproduceDistancesObjective::dis_weight_factor @@ -22,6 +23,7 @@ std::vector<double> faiss::ReproduceDistancesObjective::source_dis source_dis + faiss::ReproduceDistancesObjective::source_dis "real" corrected distances (size n^2) @@ -36,6 +38,7 @@ const double* faiss::ReproduceDistancesObjective::target_dis target_dis + faiss::ReproduceDistancesObjective::target_dis wanted distances (size n^2) @@ -50,6 +53,7 @@ std::vector<double> faiss::ReproduceDistancesObjective::weights weights + faiss::ReproduceDistancesObjective::weights weights for each distance (size n^2) @@ -64,6 +68,7 @@ int faiss::PermutationObjective::n n + faiss::PermutationObjective::n @@ -72,13 +77,14 @@ - - + + double static double faiss::ReproduceDistancesObjective::sqr (double x) sqr + faiss::ReproduceDistancesObjective::sqr double x @@ -96,6 +102,7 @@ static void faiss::ReproduceDistancesObjective::compute_mean_stdev (const double *tab, size_t n2, double *mean_out, double *stddev_out) compute_mean_stdev + faiss::ReproduceDistancesObjective::compute_mean_stdev const double * tab @@ -120,13 +127,14 @@ - - + + double double faiss::ReproduceDistancesObjective::dis_weight (double x) const dis_weight + faiss::ReproduceDistancesObjective::dis_weight double x @@ -144,6 +152,7 @@ double faiss::ReproduceDistancesObjective::get_source_dis (int i, int j) const get_source_dis + faiss::ReproduceDistancesObjective::get_source_dis int i @@ -165,6 +174,7 @@ double faiss::ReproduceDistancesObjective::compute_cost (const int *perm) const override compute_cost + faiss::ReproduceDistancesObjective::compute_cost compute_cost const int * @@ -183,6 +193,7 @@ double faiss::ReproduceDistancesObjective::cost_update (const int *perm, int iw, int jw) const override cost_update + faiss::ReproduceDistancesObjective::cost_update cost_update const int * @@ -209,6 +220,7 @@ faiss::ReproduceDistancesObjective::ReproduceDistancesObjective (int n, const double *source_dis_in, const double *target_dis_in, double dis_weight_factor) ReproduceDistancesObjective + faiss::ReproduceDistancesObjective::ReproduceDistancesObjective int n @@ -238,6 +250,7 @@ void faiss::ReproduceDistancesObjective::set_affine_target_dis (const double *source_dis_in) set_affine_target_dis + faiss::ReproduceDistancesObjective::set_affine_target_dis const double * source_dis_in @@ -255,6 +268,7 @@ faiss::ReproduceDistancesObjective::~ReproduceDistancesObjective () override ~ReproduceDistancesObjective + faiss::ReproduceDistancesObjective::~ReproduceDistancesObjective @@ -263,34 +277,34 @@ - + + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1ReservoirBlockResultHandler.xml b/xml/structfaiss_1_1ReservoirBlockResultHandler.xml index 3927ddcb71..b949c26b2b 100644 --- a/xml/structfaiss_1_1ReservoirBlockResultHandler.xml +++ b/xml/structfaiss_1_1ReservoirBlockResultHandler.xml @@ -1,5 +1,5 @@ - + faiss::ReservoirBlockResultHandler faiss::BlockResultHandler< C, false > @@ -15,12 +15,13 @@ false - + typename C::T using faiss::ReservoirBlockResultHandler< C, use_sel >::T = typename C::T T + faiss::ReservoirBlockResultHandler::T @@ -34,6 +35,7 @@ using faiss::ReservoirBlockResultHandler< C, use_sel >::TI = typename C::TI TI + faiss::ReservoirBlockResultHandler::TI @@ -42,13 +44,14 @@ - - + + T * T* faiss::ReservoirBlockResultHandler< C, use_sel >::heap_dis_tab heap_dis_tab + faiss::ReservoirBlockResultHandler::heap_dis_tab @@ -62,6 +65,7 @@ TI* faiss::ReservoirBlockResultHandler< C, use_sel >::heap_ids_tab heap_ids_tab + faiss::ReservoirBlockResultHandler::heap_ids_tab @@ -75,6 +79,7 @@ int64_t faiss::ReservoirBlockResultHandler< C, use_sel >::k k + faiss::ReservoirBlockResultHandler::k @@ -88,6 +93,7 @@ size_t faiss::ReservoirBlockResultHandler< C, use_sel >::capacity capacity + faiss::ReservoirBlockResultHandler::capacity @@ -101,6 +107,7 @@ std::vector<T> faiss::ReservoirBlockResultHandler< C, use_sel >::reservoir_dis reservoir_dis + faiss::ReservoirBlockResultHandler::reservoir_dis @@ -114,6 +121,7 @@ std::vector<TI> faiss::ReservoirBlockResultHandler< C, use_sel >::reservoir_ids reservoir_ids + faiss::ReservoirBlockResultHandler::reservoir_ids @@ -127,6 +135,7 @@ std::vector<ReservoirTopN<C> > faiss::ReservoirBlockResultHandler< C, use_sel >::reservoirs reservoirs + faiss::ReservoirBlockResultHandler::reservoirs @@ -140,6 +149,7 @@ size_t faiss::BlockResultHandler< C, use_sel >::nq nq + faiss::BlockResultHandler::nq @@ -153,6 +163,7 @@ const IDSelector* faiss::BlockResultHandler< C, use_sel >::sel sel + faiss::BlockResultHandler::sel @@ -166,6 +177,8 @@ size_t faiss::BlockResultHandler< C, use_sel >::i0 i0 + faiss::BlockResultHandler::i0 + = 0 @@ -179,6 +192,8 @@ size_t faiss::BlockResultHandler< C, use_sel >::i1 i1 + faiss::BlockResultHandler::i1 + = 0 @@ -187,13 +202,14 @@ - - + + faiss::ReservoirBlockResultHandler< C, use_sel >::ReservoirBlockResultHandler (size_t nq, T *heap_dis_tab, TI *heap_ids_tab, size_t k, const IDSelector *sel=nullptr) ReservoirBlockResultHandler + faiss::ReservoirBlockResultHandler::ReservoirBlockResultHandler size_t nq @@ -228,6 +244,7 @@ void faiss::ReservoirBlockResultHandler< C, use_sel >::begin_multiple (size_t i0_2, size_t i1_2) begin_multiple + faiss::ReservoirBlockResultHandler::begin_multiple begin_multiple size_t @@ -251,6 +268,7 @@ void faiss::ReservoirBlockResultHandler< C, use_sel >::add_results (size_t j0, size_t j1, const T *dis_tab) add_results + faiss::ReservoirBlockResultHandler::add_results size_t j0 @@ -277,6 +295,7 @@ void faiss::ReservoirBlockResultHandler< C, use_sel >::end_multiple () final end_multiple + faiss::ReservoirBlockResultHandler::end_multiple end_multiple series of results for queries i0..i1 is done @@ -292,6 +311,7 @@ virtual void faiss::BlockResultHandler< C, use_sel >::add_results (size_t, size_t, const typename C::T *) add_results + faiss::BlockResultHandler::add_results size_t @@ -314,6 +334,7 @@ bool faiss::BlockResultHandler< C, use_sel >::is_in_selection (idx_t i) const is_in_selection + faiss::BlockResultHandler::is_in_selection idx_t i @@ -326,39 +347,46 @@ - + + + + + + + - + + + sel + + + + + - - - - - - faiss::ReservoirBlockResultHandleradd_results - faiss::ReservoirBlockResultHandleradd_results + faiss::ReservoirBlockResultHandleradd_results faiss::ReservoirBlockResultHandlerbegin_multiple faiss::ReservoirBlockResultHandlerBlockResultHandler faiss::ReservoirBlockResultHandlercapacity diff --git a/xml/structfaiss_1_1ReservoirBlockResultHandler_1_1SingleResultHandler.xml b/xml/structfaiss_1_1ReservoirBlockResultHandler_1_1SingleResultHandler.xml index 87980e604e..df4d0f0c20 100644 --- a/xml/structfaiss_1_1ReservoirBlockResultHandler_1_1SingleResultHandler.xml +++ b/xml/structfaiss_1_1ReservoirBlockResultHandler_1_1SingleResultHandler.xml @@ -1,14 +1,15 @@ - + faiss::ReservoirBlockResultHandler::SingleResultHandler faiss::ReservoirTopN< C > - + ReservoirBlockResultHandler & ReservoirBlockResultHandler& faiss::ReservoirBlockResultHandler< C, use_sel >::SingleResultHandler::hr hr + faiss::ReservoirBlockResultHandler::SingleResultHandler::hr @@ -22,6 +23,7 @@ std::vector<T> faiss::ReservoirBlockResultHandler< C, use_sel >::SingleResultHandler::reservoir_dis reservoir_dis + faiss::ReservoirBlockResultHandler::SingleResultHandler::reservoir_dis @@ -35,6 +37,7 @@ std::vector<TI> faiss::ReservoirBlockResultHandler< C, use_sel >::SingleResultHandler::reservoir_ids reservoir_ids + faiss::ReservoirBlockResultHandler::SingleResultHandler::reservoir_ids @@ -48,6 +51,7 @@ size_t faiss::ReservoirBlockResultHandler< C, use_sel >::SingleResultHandler::qno qno + faiss::ReservoirBlockResultHandler::SingleResultHandler::qno @@ -61,6 +65,7 @@ T* faiss::ReservoirTopN< C >::vals vals + faiss::ReservoirTopN::vals @@ -74,6 +79,7 @@ TI* faiss::ReservoirTopN< C >::ids ids + faiss::ReservoirTopN::ids @@ -87,6 +93,7 @@ size_t faiss::ReservoirTopN< C >::i i + faiss::ReservoirTopN::i @@ -100,6 +107,7 @@ size_t faiss::ReservoirTopN< C >::n n + faiss::ReservoirTopN::n @@ -113,6 +121,7 @@ size_t faiss::ReservoirTopN< C >::capacity capacity + faiss::ReservoirTopN::capacity @@ -126,6 +135,7 @@ C::T faiss::ResultHandler< C >::threshold threshold + faiss::ResultHandler::threshold = C::neutral() @@ -135,13 +145,14 @@ - - + + faiss::ReservoirBlockResultHandler< C, use_sel >::SingleResultHandler::SingleResultHandler (ReservoirBlockResultHandler &hr) SingleResultHandler + faiss::ReservoirBlockResultHandler::SingleResultHandler::SingleResultHandler ReservoirBlockResultHandler & hr @@ -159,6 +170,7 @@ void faiss::ReservoirBlockResultHandler< C, use_sel >::SingleResultHandler::begin (size_t qno_2) begin + faiss::ReservoirBlockResultHandler::SingleResultHandler::begin size_t qno_2 @@ -177,6 +189,7 @@ void faiss::ReservoirBlockResultHandler< C, use_sel >::SingleResultHandler::end () end + faiss::ReservoirBlockResultHandler::SingleResultHandler::end series of results for query qno is done @@ -191,6 +204,7 @@ bool faiss::ReservoirTopN< C >::add_result (T val, TI id) final add_result + faiss::ReservoirTopN::add_result add_result T @@ -213,6 +227,7 @@ void faiss::ReservoirTopN< C >::add (T val, TI id) add + faiss::ReservoirTopN::add T val @@ -234,6 +249,7 @@ void faiss::ReservoirTopN< C >::shrink_fuzzy () shrink_fuzzy + faiss::ReservoirTopN::shrink_fuzzy @@ -247,6 +263,7 @@ void faiss::ReservoirTopN< C >::shrink () shrink + faiss::ReservoirTopN::shrink @@ -260,6 +277,7 @@ void faiss::ReservoirTopN< C >::to_result (T *heap_dis, TI *heap_ids) const to_result + faiss::ReservoirTopN::to_result T * heap_dis @@ -276,13 +294,14 @@ - - + + typename C::T using faiss::ReservoirTopN< C >::T = typename C::T T + faiss::ReservoirTopN::T @@ -296,6 +315,7 @@ using faiss::ReservoirTopN< C >::TI = typename C::TI TI + faiss::ReservoirTopN::TI @@ -304,7 +324,7 @@ - + @@ -328,16 +348,23 @@ + + + + + sel + + + + + + - - - - diff --git a/xml/structfaiss_1_1ReservoirTopN.xml b/xml/structfaiss_1_1ReservoirTopN.xml index 5f18176218..ec10068523 100644 --- a/xml/structfaiss_1_1ReservoirTopN.xml +++ b/xml/structfaiss_1_1ReservoirTopN.xml @@ -1,5 +1,5 @@ - + faiss::ReservoirTopN faiss::ResultHandler< C > @@ -10,12 +10,13 @@ class C - + typename C::T using faiss::ReservoirTopN< C >::T = typename C::T T + faiss::ReservoirTopN::T @@ -29,6 +30,7 @@ using faiss::ReservoirTopN< C >::TI = typename C::TI TI + faiss::ReservoirTopN::TI @@ -37,13 +39,14 @@ - - + + T * T* faiss::ReservoirTopN< C >::vals vals + faiss::ReservoirTopN::vals @@ -57,6 +60,7 @@ TI* faiss::ReservoirTopN< C >::ids ids + faiss::ReservoirTopN::ids @@ -70,6 +74,7 @@ size_t faiss::ReservoirTopN< C >::i i + faiss::ReservoirTopN::i @@ -83,6 +88,7 @@ size_t faiss::ReservoirTopN< C >::n n + faiss::ReservoirTopN::n @@ -96,6 +102,7 @@ size_t faiss::ReservoirTopN< C >::capacity capacity + faiss::ReservoirTopN::capacity @@ -109,6 +116,7 @@ C::T faiss::ResultHandler< C >::threshold threshold + faiss::ResultHandler::threshold = C::neutral() @@ -118,13 +126,14 @@ - - + + faiss::ReservoirTopN< C >::ReservoirTopN () ReservoirTopN + faiss::ReservoirTopN::ReservoirTopN @@ -138,6 +147,7 @@ faiss::ReservoirTopN< C >::ReservoirTopN (size_t n, size_t capacity, T *vals, TI *ids) ReservoirTopN + faiss::ReservoirTopN::ReservoirTopN size_t n @@ -167,6 +177,7 @@ bool faiss::ReservoirTopN< C >::add_result (T val, TI id) final add_result + faiss::ReservoirTopN::add_result add_result T @@ -189,6 +200,7 @@ void faiss::ReservoirTopN< C >::add (T val, TI id) add + faiss::ReservoirTopN::add T val @@ -210,6 +222,7 @@ void faiss::ReservoirTopN< C >::shrink_fuzzy () shrink_fuzzy + faiss::ReservoirTopN::shrink_fuzzy @@ -223,6 +236,7 @@ void faiss::ReservoirTopN< C >::shrink () shrink + faiss::ReservoirTopN::shrink @@ -236,6 +250,7 @@ void faiss::ReservoirTopN< C >::to_result (T *heap_dis, TI *heap_ids) const to_result + faiss::ReservoirTopN::to_result T * heap_dis @@ -252,7 +267,7 @@ - + Reservoir for a single query. diff --git a/xml/structfaiss_1_1ResidualCoarseQuantizer.xml b/xml/structfaiss_1_1ResidualCoarseQuantizer.xml index 74ae1b3534..6d1b04555c 100644 --- a/xml/structfaiss_1_1ResidualCoarseQuantizer.xml +++ b/xml/structfaiss_1_1ResidualCoarseQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::ResidualCoarseQuantizer faiss::AdditiveCoarseQuantizer IndexAdditiveQuantizer.h - + ResidualQuantizer ResidualQuantizer faiss::ResidualCoarseQuantizer::rq rq + faiss::ResidualCoarseQuantizer::rq The residual quantizer used to encode the vectors. @@ -24,6 +25,7 @@ float faiss::ResidualCoarseQuantizer::beam_factor beam_factor + faiss::ResidualCoarseQuantizer::beam_factor = 4.0f @@ -39,6 +41,7 @@ AdditiveQuantizer* faiss::AdditiveCoarseQuantizer::aq aq + faiss::AdditiveCoarseQuantizer::aq @@ -52,6 +55,7 @@ std::vector<float> faiss::AdditiveCoarseQuantizer::centroid_norms centroid_norms + faiss::AdditiveCoarseQuantizer::centroid_norms norms of centroids, useful for knn-search @@ -66,6 +70,7 @@ int faiss::Index::d d + faiss::Index::d vector dimension @@ -80,6 +85,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -94,6 +100,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -108,6 +115,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -122,6 +130,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -136,6 +145,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -145,13 +155,14 @@ - - + + void void faiss::ResidualCoarseQuantizer::set_beam_factor (float new_beam_factor) set_beam_factor + faiss::ResidualCoarseQuantizer::set_beam_factor float new_beam_factor @@ -170,6 +181,7 @@ faiss::ResidualCoarseQuantizer::ResidualCoarseQuantizer (int d, size_t M, size_t nbits, MetricType metric=METRIC_L2) ResidualCoarseQuantizer + faiss::ResidualCoarseQuantizer::ResidualCoarseQuantizer int d @@ -233,6 +245,7 @@ faiss::ResidualCoarseQuantizer::ResidualCoarseQuantizer (int d, const std::vector< size_t > &nbits, MetricType metric=METRIC_L2) ResidualCoarseQuantizer + faiss::ResidualCoarseQuantizer::ResidualCoarseQuantizer int d @@ -259,6 +272,7 @@ void faiss::ResidualCoarseQuantizer::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::ResidualCoarseQuantizer::search search idx_t @@ -342,6 +356,7 @@ void faiss::ResidualCoarseQuantizer::initialize_from (const ResidualCoarseQuantizer &other) initialize_from + faiss::ResidualCoarseQuantizer::initialize_from const ResidualCoarseQuantizer & other @@ -360,6 +375,7 @@ faiss::ResidualCoarseQuantizer::ResidualCoarseQuantizer () ResidualCoarseQuantizer + faiss::ResidualCoarseQuantizer::ResidualCoarseQuantizer @@ -373,6 +389,7 @@ void faiss::AdditiveCoarseQuantizer::add (idx_t n, const float *x) override add + faiss::AdditiveCoarseQuantizer::add add idx_t @@ -396,6 +413,7 @@ void faiss::AdditiveCoarseQuantizer::reconstruct (idx_t key, float *recons) const override reconstruct + faiss::AdditiveCoarseQuantizer::reconstruct reconstruct idx_t @@ -437,6 +455,7 @@ void faiss::AdditiveCoarseQuantizer::train (idx_t n, const float *x) override train + faiss::AdditiveCoarseQuantizer::train train idx_t @@ -478,6 +497,7 @@ void faiss::AdditiveCoarseQuantizer::reset () override reset + faiss::AdditiveCoarseQuantizer::reset reset N/A. @@ -493,6 +513,7 @@ virtual void faiss::Index::add_with_ids (idx_t n, const float *x, const idx_t *xids) add_with_ids + faiss::Index::add_with_ids add_with_ids add_with_ids add_with_ids @@ -552,6 +573,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -630,6 +652,7 @@ virtual void faiss::Index::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const assign + faiss::Index::assign assign idx_t @@ -696,6 +719,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -720,6 +744,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -773,6 +798,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -830,6 +856,7 @@ virtual void faiss::Index::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const search_and_reconstruct + faiss::Index::search_and_reconstruct search_and_reconstruct search_and_reconstruct search_and_reconstruct @@ -927,6 +954,7 @@ virtual void faiss::Index::compute_residual (const float *x, float *residual, idx_t key) const compute_residual + faiss::Index::compute_residual compute_residual compute_residual @@ -982,6 +1010,7 @@ virtual void faiss::Index::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const compute_residual_n + faiss::Index::compute_residual_n compute_residual_n compute_residual_n @@ -1044,15 +1073,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -1068,6 +1098,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -1089,8 +1121,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -1154,14 +1188,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -1226,6 +1260,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -1254,6 +1289,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -1276,6 +1312,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1317,13 +1354,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1337,6 +1375,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1345,114 +1384,114 @@ - + The ResidualCoarseQuantizer is a bit specialized compared to the default AdditiveCoarseQuantizer because it can use a beam search at search time (slow but may be useful for very large vocabularies) - - - - + + + + + + + + + + + + - - - - - - - + + aq - - - - - - - cp + + + + - - assign_index_factory + + qnorm - - - - + + + + - - - - - - - rq - - + + + + + + - - - - - - - - - - - qnorm + + + + + + + + - - - - + + + + + + + rq - - - - + + + + - - aq + + cp + + + assign_index_factory @@ -1472,7 +1511,7 @@ faiss::ResidualCoarseQuantizercompute_residual_n faiss::ResidualCoarseQuantizerd faiss::ResidualCoarseQuantizerdistance_t - faiss::ResidualCoarseQuantizerget_distance_computer + faiss::ResidualCoarseQuantizerget_distance_computer faiss::ResidualCoarseQuantizerIndex faiss::ResidualCoarseQuantizerinitialize_from faiss::ResidualCoarseQuantizeris_trained diff --git a/xml/structfaiss_1_1ResidualQuantizer.xml b/xml/structfaiss_1_1ResidualQuantizer.xml index e4b8dc44e4..825eb836d2 100644 --- a/xml/structfaiss_1_1ResidualQuantizer.xml +++ b/xml/structfaiss_1_1ResidualQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::ResidualQuantizer faiss::AdditiveQuantizer ResidualQuantizer.h - + int using faiss::ResidualQuantizer::train_type_t = int train_type_t + faiss::ResidualQuantizer::train_type_t initialization @@ -22,6 +23,7 @@ Search_type_t + faiss::AdditiveQuantizer::Search_type_t ST_decompress @@ -109,13 +111,14 @@ - - + + train_type_t train_type_t faiss::ResidualQuantizer::train_type train_type + faiss::ResidualQuantizer::train_type = Train_progressive_dim Binary or of the Train_* flags below. @@ -131,6 +134,7 @@ int faiss::ResidualQuantizer::niter_codebook_refine niter_codebook_refine + faiss::ResidualQuantizer::niter_codebook_refine = 5 number of iterations for codebook refinement. @@ -146,6 +150,7 @@ int faiss::ResidualQuantizer::max_beam_size max_beam_size + faiss::ResidualQuantizer::max_beam_size = 5 beam size used for training and for encoding @@ -161,6 +166,7 @@ int faiss::ResidualQuantizer::use_beam_LUT use_beam_LUT + faiss::ResidualQuantizer::use_beam_LUT = 0 use LUT for beam search @@ -176,6 +182,7 @@ ApproxTopK_mode_t faiss::ResidualQuantizer::approx_topk_mode approx_topk_mode + faiss::ResidualQuantizer::approx_topk_mode = ApproxTopK_mode_t::EXACT_TOPK @@ -191,6 +198,7 @@ ProgressiveDimClusteringParameters faiss::ResidualQuantizer::cp cp + faiss::ResidualQuantizer::cp clustering parameters @@ -205,6 +213,7 @@ ProgressiveDimIndexFactory* faiss::ResidualQuantizer::assign_index_factory assign_index_factory + faiss::ResidualQuantizer::assign_index_factory = nullptr if non-NULL, use this index for assignment @@ -220,6 +229,7 @@ size_t faiss::AdditiveQuantizer::M M + faiss::AdditiveQuantizer::M number of codebooks @@ -234,6 +244,7 @@ std::vector<size_t> faiss::AdditiveQuantizer::nbits nbits + faiss::AdditiveQuantizer::nbits bits for each step @@ -248,6 +259,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebooks codebooks + faiss::AdditiveQuantizer::codebooks codebooks @@ -262,6 +274,7 @@ std::vector<uint64_t> faiss::AdditiveQuantizer::codebook_offsets codebook_offsets + faiss::AdditiveQuantizer::codebook_offsets @@ -276,6 +289,7 @@ size_t faiss::AdditiveQuantizer::tot_bits tot_bits + faiss::AdditiveQuantizer::tot_bits = 0 total number of bits (indexes + norms) @@ -291,6 +305,7 @@ size_t faiss::AdditiveQuantizer::norm_bits norm_bits + faiss::AdditiveQuantizer::norm_bits = 0 bits allocated for the norms @@ -306,6 +321,7 @@ size_t faiss::AdditiveQuantizer::total_codebook_size total_codebook_size + faiss::AdditiveQuantizer::total_codebook_size = 0 size of the codebook in vectors @@ -321,6 +337,7 @@ bool faiss::AdditiveQuantizer::only_8bit only_8bit + faiss::AdditiveQuantizer::only_8bit = false are all nbits = 8 (use faster decoder) @@ -336,6 +353,7 @@ bool faiss::AdditiveQuantizer::verbose verbose + faiss::AdditiveQuantizer::verbose = false verbose during training? @@ -351,6 +369,7 @@ bool faiss::AdditiveQuantizer::is_trained is_trained + faiss::AdditiveQuantizer::is_trained = false is trained or not @@ -366,6 +385,7 @@ std::vector<float> faiss::AdditiveQuantizer::norm_tabs norm_tabs + faiss::AdditiveQuantizer::norm_tabs @@ -380,6 +400,7 @@ IndexFlat1D faiss::AdditiveQuantizer::qnorm qnorm + faiss::AdditiveQuantizer::qnorm store and search norms @@ -394,6 +415,7 @@ std::vector<float> faiss::AdditiveQuantizer::centroid_norms centroid_norms + faiss::AdditiveQuantizer::centroid_norms norms of all codebook entries (size total_codebook_size) @@ -408,6 +430,7 @@ std::vector<float> faiss::AdditiveQuantizer::codebook_cross_products codebook_cross_products + faiss::AdditiveQuantizer::codebook_cross_products @@ -422,6 +445,7 @@ size_t faiss::AdditiveQuantizer::max_mem_distances max_mem_distances + faiss::AdditiveQuantizer::max_mem_distances = 5 * (size_t(1) << 30) @@ -437,6 +461,7 @@ Search_type_t faiss::AdditiveQuantizer::search_type search_type + faiss::AdditiveQuantizer::search_type Also determines what's in the codes. @@ -451,6 +476,7 @@ float faiss::AdditiveQuantizer::norm_min norm_min + faiss::AdditiveQuantizer::norm_min = NAN min/max for quantization of norms @@ -466,6 +492,7 @@ float faiss::AdditiveQuantizer::norm_max norm_max + faiss::AdditiveQuantizer::norm_max = NAN @@ -480,6 +507,7 @@ size_t faiss::Quantizer::d d + faiss::Quantizer::d size of the input vectors @@ -494,6 +522,7 @@ size_t faiss::Quantizer::code_size code_size + faiss::Quantizer::code_size bytes per indexed vector @@ -503,13 +532,14 @@ - - + + const int const int faiss::ResidualQuantizer::Train_default Train_default + faiss::ResidualQuantizer::Train_default = 0 regular k-means (minimal amount of computation) @@ -525,6 +555,7 @@ const int faiss::ResidualQuantizer::Train_progressive_dim Train_progressive_dim + faiss::ResidualQuantizer::Train_progressive_dim = 1 progressive dim clustering (set by default) @@ -540,6 +571,7 @@ const int faiss::ResidualQuantizer::Train_refine_codebook Train_refine_codebook + faiss::ResidualQuantizer::Train_refine_codebook = 2 do a few iterations of codebook refinement after first level estimation @@ -555,6 +587,7 @@ const int faiss::ResidualQuantizer::Train_top_beam Train_top_beam + faiss::ResidualQuantizer::Train_top_beam = 1024 @@ -570,6 +603,7 @@ const int faiss::ResidualQuantizer::Skip_codebook_tables Skip_codebook_tables + faiss::ResidualQuantizer::Skip_codebook_tables = 2048 @@ -580,13 +614,14 @@ - - + + faiss::ResidualQuantizer::ResidualQuantizer (size_t d, const std::vector< size_t > &nbits, Search_type_t search_type=ST_decompress) ResidualQuantizer + faiss::ResidualQuantizer::ResidualQuantizer size_t d @@ -613,6 +648,7 @@ faiss::ResidualQuantizer::ResidualQuantizer (size_t d, size_t M, size_t nbits, Search_type_t search_type=ST_decompress) ResidualQuantizer + faiss::ResidualQuantizer::ResidualQuantizer size_t d @@ -643,6 +679,7 @@ faiss::ResidualQuantizer::ResidualQuantizer () ResidualQuantizer + faiss::ResidualQuantizer::ResidualQuantizer @@ -656,6 +693,7 @@ void faiss::ResidualQuantizer::train (size_t n, const float *x) override train + faiss::ResidualQuantizer::train train size_t @@ -679,6 +717,7 @@ void faiss::ResidualQuantizer::initialize_from (const ResidualQuantizer &other, int skip_M=0) initialize_from + faiss::ResidualQuantizer::initialize_from const ResidualQuantizer & other @@ -702,6 +741,7 @@ float faiss::ResidualQuantizer::retrain_AQ_codebook (size_t n, const float *x) retrain_AQ_codebook + faiss::ResidualQuantizer::retrain_AQ_codebook size_t n @@ -744,6 +784,7 @@ void faiss::ResidualQuantizer::compute_codes_add_centroids (const float *x, uint8_t *codes, size_t n, const float *centroids=nullptr) const override compute_codes_add_centroids + faiss::ResidualQuantizer::compute_codes_add_centroids compute_codes_add_centroids const float * @@ -802,6 +843,7 @@ void faiss::ResidualQuantizer::refine_beam (size_t n, size_t beam_size, const float *residuals, int new_beam_size, int32_t *new_codes, float *new_residuals=nullptr, float *new_distances=nullptr) const refine_beam + faiss::ResidualQuantizer::refine_beam size_t n @@ -904,6 +946,7 @@ void faiss::ResidualQuantizer::refine_beam_LUT (size_t n, const float *query_norms, const float *query_cp, int new_beam_size, int32_t *new_codes, float *new_distances=nullptr) const refine_beam_LUT + faiss::ResidualQuantizer::refine_beam_LUT size_t n @@ -942,6 +985,7 @@ size_t faiss::ResidualQuantizer::memory_per_point (int beam_size=-1) const memory_per_point + faiss::ResidualQuantizer::memory_per_point int beam_size @@ -971,6 +1015,7 @@ void faiss::AdditiveQuantizer::compute_codebook_tables () compute_codebook_tables + faiss::AdditiveQuantizer::compute_codebook_tables @@ -984,6 +1029,7 @@ uint64_t faiss::AdditiveQuantizer::encode_norm (float norm) const encode_norm + faiss::AdditiveQuantizer::encode_norm float norm @@ -1002,6 +1048,7 @@ uint32_t faiss::AdditiveQuantizer::encode_qcint (float x) const encode_qcint + faiss::AdditiveQuantizer::encode_qcint float x @@ -1020,6 +1067,7 @@ float faiss::AdditiveQuantizer::decode_qcint (uint32_t c) const decode_qcint + faiss::AdditiveQuantizer::decode_qcint uint32_t c @@ -1038,6 +1086,7 @@ void faiss::AdditiveQuantizer::set_derived_values () set_derived_values + faiss::AdditiveQuantizer::set_derived_values Train the norm quantizer. @@ -1052,6 +1101,7 @@ void faiss::AdditiveQuantizer::train_norm (size_t n, const float *norms) train_norm + faiss::AdditiveQuantizer::train_norm size_t n @@ -1073,6 +1123,7 @@ void faiss::AdditiveQuantizer::compute_codes (const float *x, uint8_t *codes, size_t n) const override compute_codes + faiss::AdditiveQuantizer::compute_codes compute_codes const float * @@ -1118,6 +1169,7 @@ void faiss::AdditiveQuantizer::pack_codes (size_t n, const int32_t *codes, uint8_t *packed_codes, int64_t ld_codes=-1, const float *norms=nullptr, const float *centroids=nullptr) const pack_codes + faiss::AdditiveQuantizer::pack_codes size_t n @@ -1201,6 +1253,7 @@ void faiss::AdditiveQuantizer::decode (const uint8_t *codes, float *x, size_t n) const override decode + faiss::AdditiveQuantizer::decode decode decode @@ -1247,6 +1300,7 @@ virtual void faiss::AdditiveQuantizer::decode_unpacked (const int32_t *codes, float *x, size_t n, int64_t ld_codes=-1) const decode_unpacked + faiss::AdditiveQuantizer::decode_unpacked decode_unpacked const int32_t * @@ -1309,6 +1363,7 @@ float faiss::AdditiveQuantizer::compute_1_distance_LUT (const uint8_t *codes, const float *LUT) const compute_1_distance_LUT + faiss::AdditiveQuantizer::compute_1_distance_LUT const uint8_t * codes @@ -1330,6 +1385,7 @@ void faiss::AdditiveQuantizer::decode_64bit (idx_t n, float *x) const decode_64bit + faiss::AdditiveQuantizer::decode_64bit idx_t n @@ -1352,6 +1408,7 @@ virtual void faiss::AdditiveQuantizer::compute_LUT (size_t n, const float *xq, float *LUT, float alpha=1.0f, long ld_lut=-1) const compute_LUT + faiss::AdditiveQuantizer::compute_LUT compute_LUT size_t @@ -1423,6 +1480,7 @@ void faiss::AdditiveQuantizer::knn_centroids_inner_product (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels) const knn_centroids_inner_product + faiss::AdditiveQuantizer::knn_centroids_inner_product idx_t n @@ -1457,6 +1515,7 @@ void faiss::AdditiveQuantizer::compute_centroid_norms (float *norms) const compute_centroid_norms + faiss::AdditiveQuantizer::compute_centroid_norms float * norms @@ -1485,6 +1544,7 @@ void faiss::AdditiveQuantizer::knn_centroids_L2 (idx_t n, const float *xq, idx_t k, float *distances, idx_t *labels, const float *centroid_norms) const knn_centroids_L2 + faiss::AdditiveQuantizer::knn_centroids_L2 idx_t n @@ -1518,7 +1578,7 @@ - + @@ -1526,12 +1586,6 @@ The residual centroids are stored in a big cumulative centroid table. The codes are represented either as a non-compact table of size (n, M) or as the compact output (n, code_size). - - - - - - @@ -1542,34 +1596,31 @@ - - - - - - - - - - cp + + + + + + + - - assign_index_factory + + qnorm - - - - + + + + @@ -1582,33 +1633,42 @@ + + + + + + - - - - - - - - - - - qnorm + + + + + + + + - - - - + + + + + + + cp + + + assign_index_factory diff --git a/xml/structfaiss_1_1ResultHandler.xml b/xml/structfaiss_1_1ResultHandler.xml index bcea747b9a..583eaeea72 100644 --- a/xml/structfaiss_1_1ResultHandler.xml +++ b/xml/structfaiss_1_1ResultHandler.xml @@ -1,5 +1,5 @@ - + faiss::ResultHandler faiss::HeapBlockResultHandler< C, use_sel >::SingleResultHandler @@ -11,12 +11,13 @@ class C - + C::T C::T faiss::ResultHandler< C >::threshold threshold + faiss::ResultHandler::threshold = C::neutral() @@ -26,13 +27,14 @@ - - + + bool virtual bool faiss::ResultHandler< C >::add_result (typename C::T dis, typename C::TI idx)=0 add_result + faiss::ResultHandler::add_result add_result add_result add_result @@ -58,6 +60,7 @@ virtual faiss::ResultHandler< C >::~ResultHandler () ~ResultHandler + faiss::ResultHandler::~ResultHandler @@ -66,21 +69,21 @@ - + - - - + + + - - - + + + @@ -100,9 +103,9 @@ - - - + + + diff --git a/xml/structfaiss_1_1SIMDResultHandler.xml b/xml/structfaiss_1_1SIMDResultHandler.xml index 072dec627e..c766c2d1e3 100644 --- a/xml/structfaiss_1_1SIMDResultHandler.xml +++ b/xml/structfaiss_1_1SIMDResultHandler.xml @@ -1,17 +1,18 @@ - + faiss::SIMDResultHandler faiss::SIMDResultHandlerToFloat faiss::simd_result_handlers::DummyResultHandler faiss::simd_result_handlers::FixedStorageHandler< NQ, BB > faiss::simd_result_handlers::StoreResultHandler - + bool bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -26,6 +27,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -40,6 +42,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -49,13 +52,14 @@ - - + + void virtual void faiss::SIMDResultHandler::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1)=0 handle + faiss::SIMDResultHandler::handle handle handle handle @@ -94,6 +98,7 @@ virtual void faiss::SIMDResultHandler::set_block_origin (size_t i0, size_t j0)=0 set_block_origin + faiss::SIMDResultHandler::set_block_origin set_block_origin set_block_origin set_block_origin @@ -121,6 +126,7 @@ virtual faiss::SIMDResultHandler::~SIMDResultHandler () ~SIMDResultHandler + faiss::SIMDResultHandler::~SIMDResultHandler @@ -129,40 +135,32 @@ - + - - - - - - - + - + - - - - + + + + - - - - - + + + - - - - + + + + @@ -171,44 +169,52 @@ - - - - + + + + - - - - - - - + - - - + + + - - - - + + + + - - - + + + + + - + + + + + + + - + + + + + + + diff --git a/xml/structfaiss_1_1SIMDResultHandlerToFloat.xml b/xml/structfaiss_1_1SIMDResultHandlerToFloat.xml index 4878661340..1bf8cba820 100644 --- a/xml/structfaiss_1_1SIMDResultHandlerToFloat.xml +++ b/xml/structfaiss_1_1SIMDResultHandlerToFloat.xml @@ -1,16 +1,17 @@ - + faiss::SIMDResultHandlerToFloat faiss::SIMDResultHandler faiss::simd_result_handlers::ResultHandlerCompare< C, false > faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map > - + size_t size_t faiss::SIMDResultHandlerToFloat::nq nq + faiss::SIMDResultHandlerToFloat::nq @@ -24,6 +25,7 @@ size_t faiss::SIMDResultHandlerToFloat::ntotal ntotal + faiss::SIMDResultHandlerToFloat::ntotal @@ -37,6 +39,7 @@ const idx_t* faiss::SIMDResultHandlerToFloat::id_map id_map + faiss::SIMDResultHandlerToFloat::id_map = nullptr these fields are used mainly for the IVF variants (with_id_map=true) @@ -52,6 +55,7 @@ const int* faiss::SIMDResultHandlerToFloat::q_map q_map + faiss::SIMDResultHandlerToFloat::q_map = nullptr @@ -66,6 +70,7 @@ const uint16_t* faiss::SIMDResultHandlerToFloat::dbias dbias + faiss::SIMDResultHandlerToFloat::dbias = nullptr @@ -81,6 +86,7 @@ const float* faiss::SIMDResultHandlerToFloat::normalizers normalizers + faiss::SIMDResultHandlerToFloat::normalizers = nullptr @@ -95,6 +101,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -109,6 +116,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -123,6 +131,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -132,13 +141,14 @@ - - + + faiss::SIMDResultHandlerToFloat::SIMDResultHandlerToFloat (size_t nq, size_t ntotal) SIMDResultHandlerToFloat + faiss::SIMDResultHandlerToFloat::SIMDResultHandlerToFloat size_t nq @@ -160,6 +170,7 @@ virtual void faiss::SIMDResultHandlerToFloat::begin (const float *norms) begin + faiss::SIMDResultHandlerToFloat::begin begin begin @@ -179,6 +190,7 @@ virtual void faiss::SIMDResultHandlerToFloat::end () end + faiss::SIMDResultHandlerToFloat::end end end end @@ -198,6 +210,7 @@ virtual void faiss::SIMDResultHandler::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1)=0 handle + faiss::SIMDResultHandler::handle handle handle handle @@ -236,6 +249,7 @@ virtual void faiss::SIMDResultHandler::set_block_origin (size_t i0, size_t j0)=0 set_block_origin + faiss::SIMDResultHandler::set_block_origin set_block_origin set_block_origin set_block_origin @@ -258,28 +272,16 @@ - + - - - - - - - + - - - - - - - + @@ -288,52 +290,64 @@ - - - - + + + + + + + + - + - + - - - + + + - - - - + + + + - - - + + + + + - + + + + + + + - + + + + + - - - - diff --git a/xml/structfaiss_1_1ScalarQuantizer.xml b/xml/structfaiss_1_1ScalarQuantizer.xml index 5673911edb..127fe651d7 100644 --- a/xml/structfaiss_1_1ScalarQuantizer.xml +++ b/xml/structfaiss_1_1ScalarQuantizer.xml @@ -1,15 +1,16 @@ - + faiss::ScalarQuantizer faiss::Quantizer ScalarQuantizer.h faiss::ScalarQuantizer::SQDistanceComputer faiss::ScalarQuantizer::SQuantizer - + QuantizerType + faiss::ScalarQuantizer::QuantizerType QT_8bit @@ -90,6 +91,7 @@ RangeStat + faiss::ScalarQuantizer::RangeStat RS_minmax @@ -131,13 +133,14 @@ - - + + QuantizerType QuantizerType faiss::ScalarQuantizer::qtype qtype + faiss::ScalarQuantizer::qtype = QT_8bit @@ -152,6 +155,7 @@ RangeStat faiss::ScalarQuantizer::rangestat rangestat + faiss::ScalarQuantizer::rangestat = RS_minmax @@ -166,6 +170,7 @@ float faiss::ScalarQuantizer::rangestat_arg rangestat_arg + faiss::ScalarQuantizer::rangestat_arg = 0 @@ -180,6 +185,7 @@ size_t faiss::ScalarQuantizer::bits bits + faiss::ScalarQuantizer::bits = 0 bits per scalar code @@ -195,6 +201,7 @@ std::vector<float> faiss::ScalarQuantizer::trained trained + faiss::ScalarQuantizer::trained trained values (including the range) @@ -209,6 +216,7 @@ size_t faiss::Quantizer::d d + faiss::Quantizer::d size of the input vectors @@ -223,6 +231,7 @@ size_t faiss::Quantizer::code_size code_size + faiss::Quantizer::code_size bytes per indexed vector @@ -232,13 +241,14 @@ - - + + faiss::ScalarQuantizer::ScalarQuantizer (size_t d, QuantizerType qtype) ScalarQuantizer + faiss::ScalarQuantizer::ScalarQuantizer size_t d @@ -260,6 +270,7 @@ faiss::ScalarQuantizer::ScalarQuantizer () ScalarQuantizer + faiss::ScalarQuantizer::ScalarQuantizer @@ -273,6 +284,7 @@ void faiss::ScalarQuantizer::set_derived_sizes () set_derived_sizes + faiss::ScalarQuantizer::set_derived_sizes updates internal values based on qtype and d @@ -287,6 +299,7 @@ void faiss::ScalarQuantizer::train (size_t n, const float *x) override train + faiss::ScalarQuantizer::train train size_t @@ -320,6 +333,7 @@ void faiss::ScalarQuantizer::compute_codes (const float *x, uint8_t *codes, size_t n) const override compute_codes + faiss::ScalarQuantizer::compute_codes compute_codes const float * @@ -365,6 +379,7 @@ void faiss::ScalarQuantizer::decode (const uint8_t *code, float *x, size_t n) const override decode + faiss::ScalarQuantizer::decode decode const uint8_t * @@ -405,11 +420,12 @@ - + SQuantizer * - SQuantizer* faiss::ScalarQuantizer::select_quantizer + SQuantizer * faiss::ScalarQuantizer::select_quantizer () const select_quantizer + faiss::ScalarQuantizer::select_quantizer @@ -418,11 +434,12 @@ - + SQDistanceComputer * - SQDistanceComputer* faiss::ScalarQuantizer::get_distance_computer + SQDistanceComputer * faiss::ScalarQuantizer::get_distance_computer (MetricType metric=METRIC_L2) const get_distance_computer + faiss::ScalarQuantizer::get_distance_computer MetricType metric @@ -436,11 +453,12 @@ - + InvertedListScanner * - InvertedListScanner* faiss::ScalarQuantizer::select_InvertedListScanner + InvertedListScanner * faiss::ScalarQuantizer::select_InvertedListScanner (MetricType mt, const Index *quantizer, bool store_pairs, const IDSelector *sel, bool by_residual=false) const select_InvertedListScanner + faiss::ScalarQuantizer::select_InvertedListScanner MetricType mt @@ -470,35 +488,35 @@ - + The uniform quantizer has a range [vmin, vmax]. The range can be the same for all dimensions (uniform) or specific per dimension (default). + + + + + + - - - - - - @@ -507,7 +525,7 @@ faiss::ScalarQuantizercompute_codes faiss::ScalarQuantizerd faiss::ScalarQuantizerdecode - faiss::ScalarQuantizerget_distance_computer + faiss::ScalarQuantizerget_distance_computer faiss::ScalarQuantizerQT_4bit faiss::ScalarQuantizerQT_4bit_uniform faiss::ScalarQuantizerQT_6bit @@ -529,8 +547,8 @@ faiss::ScalarQuantizerRS_quantiles faiss::ScalarQuantizerScalarQuantizer faiss::ScalarQuantizerScalarQuantizer - faiss::ScalarQuantizerselect_InvertedListScanner - faiss::ScalarQuantizerselect_quantizer + faiss::ScalarQuantizerselect_InvertedListScanner + faiss::ScalarQuantizerselect_quantizer faiss::ScalarQuantizerset_derived_sizes faiss::ScalarQuantizertrain faiss::ScalarQuantizertrained diff --git a/xml/structfaiss_1_1ScalarQuantizer_1_1SQDistanceComputer.xml b/xml/structfaiss_1_1ScalarQuantizer_1_1SQDistanceComputer.xml index 5f286ccdb2..456265afaa 100644 --- a/xml/structfaiss_1_1ScalarQuantizer_1_1SQDistanceComputer.xml +++ b/xml/structfaiss_1_1ScalarQuantizer_1_1SQDistanceComputer.xml @@ -1,14 +1,15 @@ - + faiss::ScalarQuantizer::SQDistanceComputer faiss::FlatCodesDistanceComputer - + const float * const float* faiss::ScalarQuantizer::SQDistanceComputer::q q + faiss::ScalarQuantizer::SQDistanceComputer::q @@ -22,6 +23,7 @@ const uint8_t* faiss::FlatCodesDistanceComputer::codes codes + faiss::FlatCodesDistanceComputer::codes @@ -35,6 +37,7 @@ size_t faiss::FlatCodesDistanceComputer::code_size code_size + faiss::FlatCodesDistanceComputer::code_size @@ -43,13 +46,14 @@ - - + + faiss::ScalarQuantizer::SQDistanceComputer::SQDistanceComputer () SQDistanceComputer + faiss::ScalarQuantizer::SQDistanceComputer::SQDistanceComputer @@ -63,6 +67,7 @@ virtual float faiss::ScalarQuantizer::SQDistanceComputer::query_to_code (const uint8_t *code) const =0 query_to_code + faiss::ScalarQuantizer::SQDistanceComputer::query_to_code const uint8_t * code @@ -80,6 +85,7 @@ float faiss::ScalarQuantizer::SQDistanceComputer::distance_to_code (const uint8_t *code) final distance_to_code + faiss::ScalarQuantizer::SQDistanceComputer::distance_to_code distance_to_code const uint8_t * @@ -99,6 +105,7 @@ float faiss::FlatCodesDistanceComputer::operator() (idx_t i) override operator() + faiss::FlatCodesDistanceComputer::operator() operator() idx_t @@ -118,6 +125,7 @@ virtual void faiss::DistanceComputer::set_query (const float *x)=0 set_query + faiss::DistanceComputer::set_query set_query const float * @@ -137,6 +145,7 @@ virtual void faiss::DistanceComputer::distances_batch_4 (const idx_t idx0, const idx_t idx1, const idx_t idx2, const idx_t idx3, float &dis0, float &dis1, float &dis2, float &dis3) distances_batch_4 + faiss::DistanceComputer::distances_batch_4 distances_batch_4 const idx_t @@ -184,6 +193,7 @@ virtual float faiss::DistanceComputer::symmetric_dis (idx_t i, idx_t j)=0 symmetric_dis + faiss::DistanceComputer::symmetric_dis symmetric_dis idx_t @@ -202,17 +212,15 @@ - + - - - - - + + + @@ -220,27 +228,29 @@ - - - - - - + + + + + + - - - + + + + + diff --git a/xml/structfaiss_1_1ScalarQuantizer_1_1SQuantizer.xml b/xml/structfaiss_1_1ScalarQuantizer_1_1SQuantizer.xml index 4b283decc1..d72c98f55b 100644 --- a/xml/structfaiss_1_1ScalarQuantizer_1_1SQuantizer.xml +++ b/xml/structfaiss_1_1ScalarQuantizer_1_1SQuantizer.xml @@ -1,13 +1,14 @@ - + faiss::ScalarQuantizer::SQuantizer - + void virtual void faiss::ScalarQuantizer::SQuantizer::encode_vector (const float *x, uint8_t *code) const =0 encode_vector + faiss::ScalarQuantizer::SQuantizer::encode_vector const float * x @@ -29,6 +30,7 @@ virtual void faiss::ScalarQuantizer::SQuantizer::decode_vector (const uint8_t *code, float *x) const =0 decode_vector + faiss::ScalarQuantizer::SQuantizer::decode_vector const uint8_t * code @@ -50,6 +52,7 @@ virtual faiss::ScalarQuantizer::SQuantizer::~SQuantizer () ~SQuantizer + faiss::ScalarQuantizer::SQuantizer::~SQuantizer @@ -58,7 +61,7 @@ - + diff --git a/xml/structfaiss_1_1SearchParameters.xml b/xml/structfaiss_1_1SearchParameters.xml index 67f8c6d1fb..919f996057 100644 --- a/xml/structfaiss_1_1SearchParameters.xml +++ b/xml/structfaiss_1_1SearchParameters.xml @@ -1,5 +1,5 @@ - + faiss::SearchParameters faiss::IndexRefineSearchParameters @@ -10,12 +10,13 @@ faiss::SearchParametersResidualCoarseQuantizer faiss::gpu::SearchParametersCagra Index.h - + IDSelector * IDSelector* faiss::SearchParameters::sel sel + faiss::SearchParameters::sel = nullptr if non-null, only these IDs will be considered during search. @@ -26,13 +27,14 @@ - - + + virtual faiss::SearchParameters::~SearchParameters () ~SearchParameters + faiss::SearchParameters::~SearchParameters make sure we can dynamic_cast this @@ -42,7 +44,7 @@ - + @@ -50,16 +52,10 @@ Sub-classes with additional search parameters should inherit this class. Ownership of the object fields is always to the caller. - - - - - - - - - - + + + + @@ -68,31 +64,31 @@ - - - - - - - - - + + + - - - - + + + + - - - + + + + + + + + + @@ -102,8 +98,18 @@ + + + + + + + + + + @@ -111,10 +117,6 @@ sel - - - - diff --git a/xml/structfaiss_1_1SearchParametersHNSW.xml b/xml/structfaiss_1_1SearchParametersHNSW.xml index e069db565c..f5f29f41f0 100644 --- a/xml/structfaiss_1_1SearchParametersHNSW.xml +++ b/xml/structfaiss_1_1SearchParametersHNSW.xml @@ -1,14 +1,15 @@ - + faiss::SearchParametersHNSW faiss::SearchParameters - + int int faiss::SearchParametersHNSW::efSearch efSearch + faiss::SearchParametersHNSW::efSearch = 16 @@ -23,6 +24,7 @@ bool faiss::SearchParametersHNSW::check_relative_distance check_relative_distance + faiss::SearchParametersHNSW::check_relative_distance = true @@ -37,6 +39,7 @@ bool faiss::SearchParametersHNSW::bounded_queue bounded_queue + faiss::SearchParametersHNSW::bounded_queue = true @@ -51,6 +54,7 @@ IDSelector* faiss::SearchParameters::sel sel + faiss::SearchParameters::sel = nullptr if non-null, only these IDs will be considered during search. @@ -61,13 +65,14 @@ - - + + faiss::SearchParametersHNSW::~SearchParametersHNSW () ~SearchParametersHNSW + faiss::SearchParametersHNSW::~SearchParametersHNSW @@ -76,7 +81,7 @@ - + @@ -94,6 +99,10 @@ + + + + @@ -101,10 +110,6 @@ sel - - - - diff --git a/xml/structfaiss_1_1SearchParametersIVF.xml b/xml/structfaiss_1_1SearchParametersIVF.xml index 8eca4bb9ea..a0101c1193 100644 --- a/xml/structfaiss_1_1SearchParametersIVF.xml +++ b/xml/structfaiss_1_1SearchParametersIVF.xml @@ -1,15 +1,16 @@ - + faiss::SearchParametersIVF faiss::SearchParameters faiss::IVFPQSearchParameters - + size_t size_t faiss::SearchParametersIVF::nprobe nprobe + faiss::SearchParametersIVF::nprobe = 1 number of probes at query time @@ -25,6 +26,7 @@ size_t faiss::SearchParametersIVF::max_codes max_codes + faiss::SearchParametersIVF::max_codes = 0 max nb of codes to visit to do a query @@ -40,6 +42,7 @@ SearchParameters* faiss::SearchParametersIVF::quantizer_params quantizer_params + faiss::SearchParametersIVF::quantizer_params = nullptr @@ -54,6 +57,7 @@ void* faiss::SearchParametersIVF::inverted_list_context inverted_list_context + faiss::SearchParametersIVF::inverted_list_context = nullptr context object to pass to InvertedLists @@ -69,6 +73,7 @@ IDSelector* faiss::SearchParameters::sel sel + faiss::SearchParameters::sel = nullptr if non-null, only these IDs will be considered during search. @@ -79,13 +84,14 @@ - - + + virtual faiss::SearchParametersIVF::~SearchParametersIVF () ~SearchParametersIVF + faiss::SearchParametersIVF::~SearchParametersIVF @@ -94,38 +100,33 @@ - + - - - - - - - - - - - - + + + + - - quantizer_params - + + + + + + @@ -134,9 +135,14 @@ sel - - - + + + + + + + quantizer_params + diff --git a/xml/structfaiss_1_1SearchParametersPQ.xml b/xml/structfaiss_1_1SearchParametersPQ.xml index 9ee5080711..fcd1416555 100644 --- a/xml/structfaiss_1_1SearchParametersPQ.xml +++ b/xml/structfaiss_1_1SearchParametersPQ.xml @@ -1,15 +1,16 @@ - + faiss::SearchParametersPQ faiss::SearchParameters IndexPQ.h - + IndexPQ::Search_type_t IndexPQ::Search_type_t faiss::SearchParametersPQ::search_type search_type + faiss::SearchParametersPQ::search_type @@ -23,6 +24,7 @@ int faiss::SearchParametersPQ::polysemous_ht polysemous_ht + faiss::SearchParametersPQ::polysemous_ht @@ -36,6 +38,7 @@ IDSelector* faiss::SearchParameters::sel sel + faiss::SearchParameters::sel = nullptr if non-null, only these IDs will be considered during search. @@ -46,31 +49,29 @@ - + override search parameters from the class - - - - - - - - + + + + + + @@ -78,9 +79,11 @@ sel - - - + + + + + diff --git a/xml/structfaiss_1_1SearchParametersPreTransform.xml b/xml/structfaiss_1_1SearchParametersPreTransform.xml index c2258a78cd..58acf93a37 100644 --- a/xml/structfaiss_1_1SearchParametersPreTransform.xml +++ b/xml/structfaiss_1_1SearchParametersPreTransform.xml @@ -1,14 +1,15 @@ - + faiss::SearchParametersPreTransform faiss::SearchParameters - + SearchParameters * SearchParameters* faiss::SearchParametersPreTransform::index_params index_params + faiss::SearchParametersPreTransform::index_params = nullptr @@ -23,6 +24,7 @@ IDSelector* faiss::SearchParameters::sel sel + faiss::SearchParameters::sel = nullptr if non-null, only these IDs will be considered during search. @@ -33,24 +35,35 @@ - + + + + + + + + + + + + + sel + - - @@ -60,17 +73,6 @@ index_params - - - - - sel - - - - - - diff --git a/xml/structfaiss_1_1SearchParametersResidualCoarseQuantizer.xml b/xml/structfaiss_1_1SearchParametersResidualCoarseQuantizer.xml index b2f4d78846..5f3c5662de 100644 --- a/xml/structfaiss_1_1SearchParametersResidualCoarseQuantizer.xml +++ b/xml/structfaiss_1_1SearchParametersResidualCoarseQuantizer.xml @@ -1,14 +1,15 @@ - + faiss::SearchParametersResidualCoarseQuantizer faiss::SearchParameters - + float float faiss::SearchParametersResidualCoarseQuantizer::beam_factor beam_factor + faiss::SearchParametersResidualCoarseQuantizer::beam_factor = 4.0f @@ -23,6 +24,7 @@ IDSelector* faiss::SearchParameters::sel sel + faiss::SearchParameters::sel = nullptr if non-null, only these IDs will be considered during search. @@ -33,13 +35,14 @@ - - + + faiss::SearchParametersResidualCoarseQuantizer::~SearchParametersResidualCoarseQuantizer () ~SearchParametersResidualCoarseQuantizer + faiss::SearchParametersResidualCoarseQuantizer::~SearchParametersResidualCoarseQuantizer @@ -48,7 +51,7 @@ - + @@ -66,6 +69,10 @@ + + + + @@ -73,10 +80,6 @@ sel - - - - diff --git a/xml/structfaiss_1_1SimulatedAnnealingOptimizer.xml b/xml/structfaiss_1_1SimulatedAnnealingOptimizer.xml index 193c865a0d..d9fe11b945 100644 --- a/xml/structfaiss_1_1SimulatedAnnealingOptimizer.xml +++ b/xml/structfaiss_1_1SimulatedAnnealingOptimizer.xml @@ -1,15 +1,16 @@ - + faiss::SimulatedAnnealingOptimizer faiss::SimulatedAnnealingParameters PolysemousTraining.h - + PermutationObjective * PermutationObjective* faiss::SimulatedAnnealingOptimizer::obj obj + faiss::SimulatedAnnealingOptimizer::obj @@ -23,6 +24,7 @@ int faiss::SimulatedAnnealingOptimizer::n n + faiss::SimulatedAnnealingOptimizer::n size of the permutation @@ -37,6 +39,7 @@ FILE* faiss::SimulatedAnnealingOptimizer::logfile logfile + faiss::SimulatedAnnealingOptimizer::logfile @@ -50,6 +53,7 @@ RandomGenerator* faiss::SimulatedAnnealingOptimizer::rnd rnd + faiss::SimulatedAnnealingOptimizer::rnd @@ -63,6 +67,7 @@ double faiss::SimulatedAnnealingOptimizer::init_cost init_cost + faiss::SimulatedAnnealingOptimizer::init_cost remember initial cost of optimization @@ -77,6 +82,7 @@ double faiss::SimulatedAnnealingParameters::init_temperature init_temperature + faiss::SimulatedAnnealingParameters::init_temperature = 0.7 @@ -91,6 +97,7 @@ double faiss::SimulatedAnnealingParameters::temperature_decay temperature_decay + faiss::SimulatedAnnealingParameters::temperature_decay = 0.9997893011688015 @@ -105,6 +112,7 @@ int faiss::SimulatedAnnealingParameters::n_iter n_iter + faiss::SimulatedAnnealingParameters::n_iter = 500000 @@ -119,6 +127,7 @@ int faiss::SimulatedAnnealingParameters::n_redo n_redo + faiss::SimulatedAnnealingParameters::n_redo = 2 @@ -133,6 +142,7 @@ int faiss::SimulatedAnnealingParameters::seed seed + faiss::SimulatedAnnealingParameters::seed = 123 @@ -147,6 +157,7 @@ int faiss::SimulatedAnnealingParameters::verbose verbose + faiss::SimulatedAnnealingParameters::verbose = 0 @@ -161,6 +172,7 @@ bool faiss::SimulatedAnnealingParameters::only_bit_flips only_bit_flips + faiss::SimulatedAnnealingParameters::only_bit_flips = false @@ -175,6 +187,7 @@ bool faiss::SimulatedAnnealingParameters::init_random init_random + faiss::SimulatedAnnealingParameters::init_random = false @@ -185,13 +198,14 @@ - - + + faiss::SimulatedAnnealingOptimizer::SimulatedAnnealingOptimizer (PermutationObjective *obj, const SimulatedAnnealingParameters &p) SimulatedAnnealingOptimizer + faiss::SimulatedAnnealingOptimizer::SimulatedAnnealingOptimizer PermutationObjective * obj @@ -214,6 +228,7 @@ double faiss::SimulatedAnnealingOptimizer::optimize (int *perm) optimize + faiss::SimulatedAnnealingOptimizer::optimize int * perm @@ -231,6 +246,7 @@ double faiss::SimulatedAnnealingOptimizer::run_optimization (int *best_perm) run_optimization + faiss::SimulatedAnnealingOptimizer::run_optimization int * best_perm @@ -248,6 +264,7 @@ virtual faiss::SimulatedAnnealingOptimizer::~SimulatedAnnealingOptimizer () ~SimulatedAnnealingOptimizer + faiss::SimulatedAnnealingOptimizer::~SimulatedAnnealingOptimizer @@ -256,7 +273,7 @@ - + Simulated annealing optimization algorithm for permutations. @@ -275,6 +292,10 @@ + + + + @@ -291,10 +312,6 @@ rnd - - - - diff --git a/xml/structfaiss_1_1SimulatedAnnealingParameters.xml b/xml/structfaiss_1_1SimulatedAnnealingParameters.xml index a538679f15..7164eeaa89 100644 --- a/xml/structfaiss_1_1SimulatedAnnealingParameters.xml +++ b/xml/structfaiss_1_1SimulatedAnnealingParameters.xml @@ -1,16 +1,17 @@ - + faiss::SimulatedAnnealingParameters faiss::PolysemousTraining faiss::SimulatedAnnealingOptimizer PolysemousTraining.h - + double double faiss::SimulatedAnnealingParameters::init_temperature init_temperature + faiss::SimulatedAnnealingParameters::init_temperature = 0.7 @@ -25,6 +26,7 @@ double faiss::SimulatedAnnealingParameters::temperature_decay temperature_decay + faiss::SimulatedAnnealingParameters::temperature_decay = 0.9997893011688015 @@ -39,6 +41,7 @@ int faiss::SimulatedAnnealingParameters::n_iter n_iter + faiss::SimulatedAnnealingParameters::n_iter = 500000 @@ -53,6 +56,7 @@ int faiss::SimulatedAnnealingParameters::n_redo n_redo + faiss::SimulatedAnnealingParameters::n_redo = 2 @@ -67,6 +71,7 @@ int faiss::SimulatedAnnealingParameters::seed seed + faiss::SimulatedAnnealingParameters::seed = 123 @@ -81,6 +86,7 @@ int faiss::SimulatedAnnealingParameters::verbose verbose + faiss::SimulatedAnnealingParameters::verbose = 0 @@ -95,6 +101,7 @@ bool faiss::SimulatedAnnealingParameters::only_bit_flips only_bit_flips + faiss::SimulatedAnnealingParameters::only_bit_flips = false @@ -109,6 +116,7 @@ bool faiss::SimulatedAnnealingParameters::init_random init_random + faiss::SimulatedAnnealingParameters::init_random = false @@ -119,13 +127,14 @@ - - + + faiss::SimulatedAnnealingParameters::SimulatedAnnealingParameters () SimulatedAnnealingParameters + faiss::SimulatedAnnealingParameters::SimulatedAnnealingParameters @@ -134,13 +143,19 @@ - + parameters used for the simulated annealing method + + + + + + @@ -151,12 +166,6 @@ - - - - - - diff --git a/xml/structfaiss_1_1SliceInvertedLists.xml b/xml/structfaiss_1_1SliceInvertedLists.xml index 07c78b81e9..2d9a47b125 100644 --- a/xml/structfaiss_1_1SliceInvertedLists.xml +++ b/xml/structfaiss_1_1SliceInvertedLists.xml @@ -1,15 +1,16 @@ - + faiss::SliceInvertedLists faiss::ReadOnlyInvertedLists InvertedLists.h - + const InvertedLists * const InvertedLists* faiss::SliceInvertedLists::il il + faiss::SliceInvertedLists::il @@ -23,6 +24,7 @@ idx_t faiss::SliceInvertedLists::i0 i0 + faiss::SliceInvertedLists::i0 @@ -36,6 +38,7 @@ idx_t faiss::SliceInvertedLists::i1 i1 + faiss::SliceInvertedLists::i1 @@ -49,6 +52,7 @@ size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -63,6 +67,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -77,6 +82,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -87,13 +93,14 @@ - - + + faiss::SliceInvertedLists::SliceInvertedLists (const InvertedLists *il, idx_t i0, idx_t i1) SliceInvertedLists + faiss::SliceInvertedLists::SliceInvertedLists const InvertedLists * il @@ -119,6 +126,7 @@ size_t faiss::SliceInvertedLists::list_size (size_t list_no) const override list_size + faiss::SliceInvertedLists::list_size list_size size_t @@ -133,12 +141,13 @@ - + const uint8_t * - const uint8_t* faiss::SliceInvertedLists::get_codes + const uint8_t * faiss::SliceInvertedLists::get_codes (size_t list_no) const override get_codes - get_codes + faiss::SliceInvertedLists::get_codes + get_codes size_t list_no @@ -155,12 +164,13 @@ - + const idx_t * - const idx_t* faiss::SliceInvertedLists::get_ids + const idx_t * faiss::SliceInvertedLists::get_ids (size_t list_no) const override get_ids - get_ids + faiss::SliceInvertedLists::get_ids + get_ids size_t list_no @@ -182,6 +192,7 @@ void faiss::SliceInvertedLists::release_codes (size_t list_no, const uint8_t *codes) const override release_codes + faiss::SliceInvertedLists::release_codes release_codes size_t @@ -205,6 +216,7 @@ void faiss::SliceInvertedLists::release_ids (size_t list_no, const idx_t *ids) const override release_ids + faiss::SliceInvertedLists::release_ids release_ids size_t @@ -228,6 +240,7 @@ idx_t faiss::SliceInvertedLists::get_single_id (size_t list_no, size_t offset) const override get_single_id + faiss::SliceInvertedLists::get_single_id get_single_id size_t @@ -248,12 +261,13 @@ - + const uint8_t * - const uint8_t* faiss::SliceInvertedLists::get_single_code + const uint8_t * faiss::SliceInvertedLists::get_single_code (size_t list_no, size_t offset) const override get_single_code - get_single_code + faiss::SliceInvertedLists::get_single_code + get_single_code size_t list_no @@ -278,6 +292,7 @@ void faiss::SliceInvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const override prefetch_lists + faiss::SliceInvertedLists::prefetch_lists prefetch_lists const idx_t * @@ -301,6 +316,7 @@ size_t faiss::ReadOnlyInvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override add_entries + faiss::ReadOnlyInvertedLists::add_entries add_entries size_t @@ -331,6 +347,7 @@ void faiss::ReadOnlyInvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override update_entries + faiss::ReadOnlyInvertedLists::update_entries update_entries size_t @@ -365,6 +382,7 @@ void faiss::ReadOnlyInvertedLists::resize (size_t list_no, size_t new_size) override resize + faiss::ReadOnlyInvertedLists::resize resize size_t @@ -387,6 +405,7 @@ virtual bool faiss::InvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const is_empty + faiss::InvertedLists::is_empty is_empty size_t @@ -406,11 +425,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -434,6 +454,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -465,6 +486,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -494,6 +516,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -507,6 +530,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -529,6 +553,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -561,6 +586,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -575,6 +601,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -589,6 +616,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -598,11 +626,12 @@ - - + + int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -653,13 +682,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -670,7 +700,7 @@ - + vertical slice of indexes in another InvertedLists @@ -722,10 +752,10 @@ faiss::SliceInvertedListscode_size faiss::SliceInvertedListscompute_ntotal faiss::SliceInvertedListscopy_subset_to - faiss::SliceInvertedListsget_codes - faiss::SliceInvertedListsget_ids - faiss::SliceInvertedListsget_iterator - faiss::SliceInvertedListsget_single_code + faiss::SliceInvertedListsget_codes + faiss::SliceInvertedListsget_ids + faiss::SliceInvertedListsget_iterator + faiss::SliceInvertedListsget_single_code faiss::SliceInvertedListsget_single_id faiss::SliceInvertedListsi0 faiss::SliceInvertedListsi1 diff --git a/xml/structfaiss_1_1SplitMix64RandomGenerator.xml b/xml/structfaiss_1_1SplitMix64RandomGenerator.xml index 45dcdbff1e..233accffd8 100644 --- a/xml/structfaiss_1_1SplitMix64RandomGenerator.xml +++ b/xml/structfaiss_1_1SplitMix64RandomGenerator.xml @@ -1,14 +1,15 @@ - + faiss::SplitMix64RandomGenerator random.h - + uint64_t uint64_t faiss::SplitMix64RandomGenerator::state state + faiss::SplitMix64RandomGenerator::state @@ -17,13 +18,14 @@ - - + + int int faiss::SplitMix64RandomGenerator::rand_int () rand_int + faiss::SplitMix64RandomGenerator::rand_int random positive integer @@ -38,6 +40,7 @@ int64_t faiss::SplitMix64RandomGenerator::rand_int64 () rand_int64 + faiss::SplitMix64RandomGenerator::rand_int64 random int64_t @@ -52,6 +55,7 @@ int faiss::SplitMix64RandomGenerator::rand_int (int max) rand_int + faiss::SplitMix64RandomGenerator::rand_int int max @@ -70,6 +74,7 @@ float faiss::SplitMix64RandomGenerator::rand_float () rand_float + faiss::SplitMix64RandomGenerator::rand_float between 0 and 1 @@ -84,6 +89,7 @@ double faiss::SplitMix64RandomGenerator::rand_double () rand_double + faiss::SplitMix64RandomGenerator::rand_double @@ -97,6 +103,7 @@ faiss::SplitMix64RandomGenerator::SplitMix64RandomGenerator (int64_t seed=1234) SplitMix64RandomGenerator + faiss::SplitMix64RandomGenerator::SplitMix64RandomGenerator int64_t seed @@ -115,6 +122,7 @@ uint64_t faiss::SplitMix64RandomGenerator::next () next + faiss::SplitMix64RandomGenerator::next @@ -123,7 +131,7 @@ - + diff --git a/xml/structfaiss_1_1StopWordsInvertedLists.xml b/xml/structfaiss_1_1StopWordsInvertedLists.xml index ecd3527993..0070fee753 100644 --- a/xml/structfaiss_1_1StopWordsInvertedLists.xml +++ b/xml/structfaiss_1_1StopWordsInvertedLists.xml @@ -1,15 +1,16 @@ - + faiss::StopWordsInvertedLists faiss::ReadOnlyInvertedLists InvertedLists.h - + const InvertedLists * const InvertedLists* faiss::StopWordsInvertedLists::il0 il0 + faiss::StopWordsInvertedLists::il0 @@ -23,6 +24,7 @@ size_t faiss::StopWordsInvertedLists::maxsize maxsize + faiss::StopWordsInvertedLists::maxsize @@ -36,6 +38,7 @@ size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -50,6 +53,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -64,6 +68,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -74,13 +79,14 @@ - - + + faiss::StopWordsInvertedLists::StopWordsInvertedLists (const InvertedLists *il, size_t maxsize) StopWordsInvertedLists + faiss::StopWordsInvertedLists::StopWordsInvertedLists const InvertedLists * il @@ -102,6 +108,7 @@ size_t faiss::StopWordsInvertedLists::list_size (size_t list_no) const override list_size + faiss::StopWordsInvertedLists::list_size list_size size_t @@ -116,12 +123,13 @@ - + const uint8_t * - const uint8_t* faiss::StopWordsInvertedLists::get_codes + const uint8_t * faiss::StopWordsInvertedLists::get_codes (size_t list_no) const override get_codes - get_codes + faiss::StopWordsInvertedLists::get_codes + get_codes size_t list_no @@ -138,12 +146,13 @@ - + const idx_t * - const idx_t* faiss::StopWordsInvertedLists::get_ids + const idx_t * faiss::StopWordsInvertedLists::get_ids (size_t list_no) const override get_ids - get_ids + faiss::StopWordsInvertedLists::get_ids + get_ids size_t list_no @@ -165,6 +174,7 @@ void faiss::StopWordsInvertedLists::release_codes (size_t list_no, const uint8_t *codes) const override release_codes + faiss::StopWordsInvertedLists::release_codes release_codes size_t @@ -188,6 +198,7 @@ void faiss::StopWordsInvertedLists::release_ids (size_t list_no, const idx_t *ids) const override release_ids + faiss::StopWordsInvertedLists::release_ids release_ids size_t @@ -211,6 +222,7 @@ idx_t faiss::StopWordsInvertedLists::get_single_id (size_t list_no, size_t offset) const override get_single_id + faiss::StopWordsInvertedLists::get_single_id get_single_id size_t @@ -231,12 +243,13 @@ - + const uint8_t * - const uint8_t* faiss::StopWordsInvertedLists::get_single_code + const uint8_t * faiss::StopWordsInvertedLists::get_single_code (size_t list_no, size_t offset) const override get_single_code - get_single_code + faiss::StopWordsInvertedLists::get_single_code + get_single_code size_t list_no @@ -261,6 +274,7 @@ void faiss::StopWordsInvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const override prefetch_lists + faiss::StopWordsInvertedLists::prefetch_lists prefetch_lists const idx_t * @@ -284,6 +298,7 @@ size_t faiss::ReadOnlyInvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override add_entries + faiss::ReadOnlyInvertedLists::add_entries add_entries size_t @@ -314,6 +329,7 @@ void faiss::ReadOnlyInvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override update_entries + faiss::ReadOnlyInvertedLists::update_entries update_entries size_t @@ -348,6 +364,7 @@ void faiss::ReadOnlyInvertedLists::resize (size_t list_no, size_t new_size) override resize + faiss::ReadOnlyInvertedLists::resize resize size_t @@ -370,6 +387,7 @@ virtual bool faiss::InvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const is_empty + faiss::InvertedLists::is_empty is_empty size_t @@ -389,11 +407,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -417,6 +436,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -448,6 +468,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -477,6 +498,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -490,6 +512,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -512,6 +535,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -544,6 +568,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -558,6 +583,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -572,6 +598,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -581,11 +608,12 @@ - - + + int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -636,13 +664,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -653,7 +682,7 @@ - + @@ -705,10 +734,10 @@ faiss::StopWordsInvertedListscode_size faiss::StopWordsInvertedListscompute_ntotal faiss::StopWordsInvertedListscopy_subset_to - faiss::StopWordsInvertedListsget_codes - faiss::StopWordsInvertedListsget_ids - faiss::StopWordsInvertedListsget_iterator - faiss::StopWordsInvertedListsget_single_code + faiss::StopWordsInvertedListsget_codes + faiss::StopWordsInvertedListsget_ids + faiss::StopWordsInvertedListsget_iterator + faiss::StopWordsInvertedListsget_single_code faiss::StopWordsInvertedListsget_single_id faiss::StopWordsInvertedListsil0 faiss::StopWordsInvertedListsimbalance_factor diff --git a/xml/structfaiss_1_1TimeoutCallback.xml b/xml/structfaiss_1_1TimeoutCallback.xml index fbbe9e50e0..7e04e7bdd3 100644 --- a/xml/structfaiss_1_1TimeoutCallback.xml +++ b/xml/structfaiss_1_1TimeoutCallback.xml @@ -1,14 +1,15 @@ - + faiss::TimeoutCallback faiss::InterruptCallback - + std::chrono::time_point< std::chrono::steady_clock > std::chrono::time_point<std::chrono::steady_clock> faiss::TimeoutCallback::start start + faiss::TimeoutCallback::start @@ -22,6 +23,7 @@ double faiss::TimeoutCallback::timeout timeout + faiss::TimeoutCallback::timeout @@ -30,13 +32,14 @@ - - + + bool bool faiss::TimeoutCallback::want_interrupt () override want_interrupt + faiss::TimeoutCallback::want_interrupt want_interrupt @@ -51,6 +54,7 @@ void faiss::TimeoutCallback::set_timeout (double timeout_in_seconds) set_timeout + faiss::TimeoutCallback::set_timeout double timeout_in_seconds @@ -63,13 +67,14 @@ - - + + void static void faiss::TimeoutCallback::reset (double timeout_in_seconds) reset + faiss::TimeoutCallback::reset double timeout_in_seconds @@ -87,6 +92,7 @@ static void faiss::InterruptCallback::clear_instance () clear_instance + faiss::InterruptCallback::clear_instance @@ -100,6 +106,7 @@ static void faiss::InterruptCallback::check () check + faiss::InterruptCallback::check @@ -118,6 +125,7 @@ static bool faiss::InterruptCallback::is_interrupted () is_interrupted + faiss::InterruptCallback::is_interrupted @@ -132,6 +140,7 @@ static size_t faiss::InterruptCallback::get_period_hint (size_t flops) get_period_hint + faiss::InterruptCallback::get_period_hint size_t flops @@ -145,13 +154,14 @@ - - + + std::mutex std::mutex faiss::InterruptCallback::lock lock + faiss::InterruptCallback::lock @@ -165,6 +175,7 @@ std::unique_ptr<InterruptCallback> faiss::InterruptCallback::instance instance + faiss::InterruptCallback::instance @@ -173,34 +184,34 @@ - + + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1Top1BlockResultHandler.xml b/xml/structfaiss_1_1Top1BlockResultHandler.xml index 27b4b377be..ad17a0cdd0 100644 --- a/xml/structfaiss_1_1Top1BlockResultHandler.xml +++ b/xml/structfaiss_1_1Top1BlockResultHandler.xml @@ -1,5 +1,5 @@ - + faiss::Top1BlockResultHandler faiss::BlockResultHandler< C, false > @@ -15,12 +15,13 @@ false - + typename C::T using faiss::Top1BlockResultHandler< C, use_sel >::T = typename C::T T + faiss::Top1BlockResultHandler::T @@ -34,6 +35,7 @@ using faiss::Top1BlockResultHandler< C, use_sel >::TI = typename C::TI TI + faiss::Top1BlockResultHandler::TI @@ -42,13 +44,14 @@ - - + + T * T* faiss::Top1BlockResultHandler< C, use_sel >::dis_tab dis_tab + faiss::Top1BlockResultHandler::dis_tab @@ -62,6 +65,7 @@ TI* faiss::Top1BlockResultHandler< C, use_sel >::ids_tab ids_tab + faiss::Top1BlockResultHandler::ids_tab @@ -75,6 +79,7 @@ size_t faiss::BlockResultHandler< C, use_sel >::nq nq + faiss::BlockResultHandler::nq @@ -88,6 +93,7 @@ const IDSelector* faiss::BlockResultHandler< C, use_sel >::sel sel + faiss::BlockResultHandler::sel @@ -101,6 +107,8 @@ size_t faiss::BlockResultHandler< C, use_sel >::i0 i0 + faiss::BlockResultHandler::i0 + = 0 @@ -114,6 +122,8 @@ size_t faiss::BlockResultHandler< C, use_sel >::i1 i1 + faiss::BlockResultHandler::i1 + = 0 @@ -122,13 +132,14 @@ - - + + faiss::Top1BlockResultHandler< C, use_sel >::Top1BlockResultHandler (size_t nq, T *dis_tab, TI *ids_tab, const IDSelector *sel=nullptr) Top1BlockResultHandler + faiss::Top1BlockResultHandler::Top1BlockResultHandler size_t nq @@ -159,6 +170,7 @@ void faiss::Top1BlockResultHandler< C, use_sel >::begin_multiple (size_t i0, size_t i1) final begin_multiple + faiss::Top1BlockResultHandler::begin_multiple begin_multiple size_t @@ -182,6 +194,7 @@ void faiss::Top1BlockResultHandler< C, use_sel >::add_results (size_t j0, size_t j1, const T *dis_tab_2) final add_results + faiss::Top1BlockResultHandler::add_results size_t j0 @@ -208,6 +221,7 @@ void faiss::Top1BlockResultHandler< C, use_sel >::add_result (const size_t i, const T dis, const TI idx) add_result + faiss::Top1BlockResultHandler::add_result const size_t i @@ -233,6 +247,7 @@ virtual void faiss::BlockResultHandler< C, use_sel >::add_results (size_t, size_t, const typename C::T *) add_results + faiss::BlockResultHandler::add_results size_t @@ -255,6 +270,7 @@ virtual void faiss::BlockResultHandler< C, use_sel >::end_multiple () end_multiple + faiss::BlockResultHandler::end_multiple end_multiple end_multiple @@ -270,6 +286,7 @@ bool faiss::BlockResultHandler< C, use_sel >::is_in_selection (idx_t i) const is_in_selection + faiss::BlockResultHandler::is_in_selection idx_t i @@ -282,40 +299,47 @@ - + + + + + + + - + + + sel + + + + + - - - - - - faiss::Top1BlockResultHandleradd_result faiss::Top1BlockResultHandleradd_results - faiss::Top1BlockResultHandleradd_results + faiss::Top1BlockResultHandleradd_results faiss::Top1BlockResultHandlerbegin_multiple faiss::Top1BlockResultHandlerBlockResultHandler faiss::Top1BlockResultHandlerdis_tab diff --git a/xml/structfaiss_1_1Top1BlockResultHandler_1_1SingleResultHandler.xml b/xml/structfaiss_1_1Top1BlockResultHandler_1_1SingleResultHandler.xml index 1947eef06d..5eb726f580 100644 --- a/xml/structfaiss_1_1Top1BlockResultHandler_1_1SingleResultHandler.xml +++ b/xml/structfaiss_1_1Top1BlockResultHandler_1_1SingleResultHandler.xml @@ -1,14 +1,15 @@ - + faiss::Top1BlockResultHandler::SingleResultHandler faiss::ResultHandler< C > - + Top1BlockResultHandler & Top1BlockResultHandler& faiss::Top1BlockResultHandler< C, use_sel >::SingleResultHandler::hr hr + faiss::Top1BlockResultHandler::SingleResultHandler::hr @@ -22,6 +23,7 @@ TI faiss::Top1BlockResultHandler< C, use_sel >::SingleResultHandler::min_idx min_idx + faiss::Top1BlockResultHandler::SingleResultHandler::min_idx @@ -35,6 +37,7 @@ size_t faiss::Top1BlockResultHandler< C, use_sel >::SingleResultHandler::current_idx current_idx + faiss::Top1BlockResultHandler::SingleResultHandler::current_idx = 0 @@ -49,6 +52,7 @@ C::T faiss::ResultHandler< C >::threshold threshold + faiss::ResultHandler::threshold = C::neutral() @@ -58,13 +62,14 @@ - - + + faiss::Top1BlockResultHandler< C, use_sel >::SingleResultHandler::SingleResultHandler (Top1BlockResultHandler &hr) SingleResultHandler + faiss::Top1BlockResultHandler::SingleResultHandler::SingleResultHandler Top1BlockResultHandler & hr @@ -82,6 +87,7 @@ void faiss::Top1BlockResultHandler< C, use_sel >::SingleResultHandler::begin (const size_t current_idx_2) begin + faiss::Top1BlockResultHandler::SingleResultHandler::begin const size_t current_idx_2 @@ -100,6 +106,7 @@ bool faiss::Top1BlockResultHandler< C, use_sel >::SingleResultHandler::add_result (T dis, TI idx) final add_result + faiss::Top1BlockResultHandler::SingleResultHandler::add_result add_result T @@ -123,6 +130,7 @@ void faiss::Top1BlockResultHandler< C, use_sel >::SingleResultHandler::end () end + faiss::Top1BlockResultHandler::SingleResultHandler::end series of results for query i is done @@ -132,34 +140,45 @@ - + + + + + + + + + + + + sel + + + + + + - - - - - - @@ -169,10 +188,6 @@ hr - - - - diff --git a/xml/structfaiss_1_1TransformedVectors.xml b/xml/structfaiss_1_1TransformedVectors.xml index 0892938b13..b28360117b 100644 --- a/xml/structfaiss_1_1TransformedVectors.xml +++ b/xml/structfaiss_1_1TransformedVectors.xml @@ -1,14 +1,15 @@ - + faiss::TransformedVectors FaissException.h - + const float * const float* faiss::TransformedVectors::x x + faiss::TransformedVectors::x @@ -22,6 +23,7 @@ bool faiss::TransformedVectors::own_x own_x + faiss::TransformedVectors::own_x @@ -30,13 +32,14 @@ - - + + faiss::TransformedVectors::TransformedVectors (const float *x_orig, const float *x) TransformedVectors + faiss::TransformedVectors::TransformedVectors const float * x_orig @@ -58,6 +61,7 @@ faiss::TransformedVectors::~TransformedVectors () ~TransformedVectors + faiss::TransformedVectors::~TransformedVectors @@ -66,7 +70,7 @@ - + diff --git a/xml/structfaiss_1_1VStackInvertedLists.xml b/xml/structfaiss_1_1VStackInvertedLists.xml index f4468dfda8..c1c15a1460 100644 --- a/xml/structfaiss_1_1VStackInvertedLists.xml +++ b/xml/structfaiss_1_1VStackInvertedLists.xml @@ -1,14 +1,15 @@ - + faiss::VStackInvertedLists faiss::ReadOnlyInvertedLists - + std::vector< const InvertedLists * > std::vector<const InvertedLists*> faiss::VStackInvertedLists::ils ils + faiss::VStackInvertedLists::ils @@ -22,6 +23,7 @@ std::vector<idx_t> faiss::VStackInvertedLists::cumsz cumsz + faiss::VStackInvertedLists::cumsz @@ -35,6 +37,7 @@ size_t faiss::InvertedLists::nlist nlist + faiss::InvertedLists::nlist number of possible key values @@ -49,6 +52,7 @@ size_t faiss::InvertedLists::code_size code_size + faiss::InvertedLists::code_size code size per vector in bytes @@ -63,6 +67,7 @@ bool faiss::InvertedLists::use_iterator use_iterator + faiss::InvertedLists::use_iterator = false request to use iterator rather than get_codes / get_ids @@ -73,13 +78,14 @@ - - + + faiss::VStackInvertedLists::VStackInvertedLists (int nil, const InvertedLists **ils) VStackInvertedLists + faiss::VStackInvertedLists::VStackInvertedLists int nil @@ -102,6 +108,7 @@ size_t faiss::VStackInvertedLists::list_size (size_t list_no) const override list_size + faiss::VStackInvertedLists::list_size list_size size_t @@ -116,12 +123,13 @@ - + const uint8_t * - const uint8_t* faiss::VStackInvertedLists::get_codes + const uint8_t * faiss::VStackInvertedLists::get_codes (size_t list_no) const override get_codes - get_codes + faiss::VStackInvertedLists::get_codes + get_codes size_t list_no @@ -138,12 +146,13 @@ - + const idx_t * - const idx_t* faiss::VStackInvertedLists::get_ids + const idx_t * faiss::VStackInvertedLists::get_ids (size_t list_no) const override get_ids - get_ids + faiss::VStackInvertedLists::get_ids + get_ids size_t list_no @@ -165,6 +174,7 @@ void faiss::VStackInvertedLists::release_codes (size_t list_no, const uint8_t *codes) const override release_codes + faiss::VStackInvertedLists::release_codes release_codes size_t @@ -188,6 +198,7 @@ void faiss::VStackInvertedLists::release_ids (size_t list_no, const idx_t *ids) const override release_ids + faiss::VStackInvertedLists::release_ids release_ids size_t @@ -211,6 +222,7 @@ idx_t faiss::VStackInvertedLists::get_single_id (size_t list_no, size_t offset) const override get_single_id + faiss::VStackInvertedLists::get_single_id get_single_id size_t @@ -231,12 +243,13 @@ - + const uint8_t * - const uint8_t* faiss::VStackInvertedLists::get_single_code + const uint8_t * faiss::VStackInvertedLists::get_single_code (size_t list_no, size_t offset) const override get_single_code - get_single_code + faiss::VStackInvertedLists::get_single_code + get_single_code size_t list_no @@ -261,6 +274,7 @@ void faiss::VStackInvertedLists::prefetch_lists (const idx_t *list_nos, int nlist) const override prefetch_lists + faiss::VStackInvertedLists::prefetch_lists prefetch_lists const idx_t * @@ -284,6 +298,7 @@ size_t faiss::ReadOnlyInvertedLists::add_entries (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override add_entries + faiss::ReadOnlyInvertedLists::add_entries add_entries size_t @@ -314,6 +329,7 @@ void faiss::ReadOnlyInvertedLists::update_entries (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override update_entries + faiss::ReadOnlyInvertedLists::update_entries update_entries size_t @@ -348,6 +364,7 @@ void faiss::ReadOnlyInvertedLists::resize (size_t list_no, size_t new_size) override resize + faiss::ReadOnlyInvertedLists::resize resize size_t @@ -370,6 +387,7 @@ virtual bool faiss::InvertedLists::is_empty (size_t list_no, void *inverted_list_context=nullptr) const is_empty + faiss::InvertedLists::is_empty is_empty size_t @@ -389,11 +407,12 @@ - + InvertedListsIterator * - virtual InvertedListsIterator* faiss::InvertedLists::get_iterator + virtual InvertedListsIterator * faiss::InvertedLists::get_iterator (size_t list_no, void *inverted_list_context=nullptr) const get_iterator + faiss::InvertedLists::get_iterator size_t list_no @@ -417,6 +436,7 @@ virtual size_t faiss::InvertedLists::add_entry (size_t list_no, idx_t theid, const uint8_t *code, void *inverted_list_context=nullptr) add_entry + faiss::InvertedLists::add_entry size_t list_no @@ -448,6 +468,7 @@ virtual void faiss::InvertedLists::update_entry (size_t list_no, size_t offset, idx_t id, const uint8_t *code) update_entry + faiss::InvertedLists::update_entry size_t list_no @@ -477,6 +498,7 @@ virtual void faiss::InvertedLists::reset () reset + faiss::InvertedLists::reset @@ -490,6 +512,7 @@ void faiss::InvertedLists::merge_from (InvertedLists *oivf, size_t add_id) merge_from + faiss::InvertedLists::merge_from InvertedLists * oivf @@ -512,6 +535,7 @@ size_t faiss::InvertedLists::copy_subset_to (InvertedLists &other, subset_type_t subset_type, idx_t a1, idx_t a2) const copy_subset_to + faiss::InvertedLists::copy_subset_to InvertedLists & other @@ -544,6 +568,7 @@ double faiss::InvertedLists::imbalance_factor () const imbalance_factor + faiss::InvertedLists::imbalance_factor 1= perfectly balanced, >1: imbalanced @@ -558,6 +583,7 @@ void faiss::InvertedLists::print_stats () const print_stats + faiss::InvertedLists::print_stats display some stats about the inverted lists @@ -572,6 +598,7 @@ size_t faiss::InvertedLists::compute_ntotal () const compute_ntotal + faiss::InvertedLists::compute_ntotal sum up list sizes @@ -581,11 +608,12 @@ - - + + int subset_type_t + faiss::InvertedLists::subset_type_t SUBSET_TYPE_ID_RANGE = 0 @@ -636,13 +664,14 @@ - - + + const size_t const size_t faiss::InvertedLists::INVALID_CODE_SIZE INVALID_CODE_SIZE + faiss::InvertedLists::INVALID_CODE_SIZE = static_cast<size_t>(-1) @@ -653,7 +682,7 @@ - + @@ -702,10 +731,10 @@ faiss::VStackInvertedListscompute_ntotal faiss::VStackInvertedListscopy_subset_to faiss::VStackInvertedListscumsz - faiss::VStackInvertedListsget_codes - faiss::VStackInvertedListsget_ids - faiss::VStackInvertedListsget_iterator - faiss::VStackInvertedListsget_single_code + faiss::VStackInvertedListsget_codes + faiss::VStackInvertedListsget_ids + faiss::VStackInvertedListsget_iterator + faiss::VStackInvertedListsget_single_code faiss::VStackInvertedListsget_single_id faiss::VStackInvertedListsils faiss::VStackInvertedListsimbalance_factor diff --git a/xml/structfaiss_1_1VectorDistance.xml b/xml/structfaiss_1_1VectorDistance.xml index 62b93a9599..fb331f3946 100644 --- a/xml/structfaiss_1_1VectorDistance.xml +++ b/xml/structfaiss_1_1VectorDistance.xml @@ -1,5 +1,5 @@ - + faiss::VectorDistance @@ -9,12 +9,13 @@ mt - + typename std::conditional< is_similarity_metric(mt), CMin< float, int64_t >, CMax< float, int64_t > >::type using faiss::VectorDistance< mt >::C = typename std::conditional< is_similarity_metric(mt), CMin<float, int64_t>, CMax<float, int64_t> >::type C + faiss::VectorDistance::C @@ -23,13 +24,14 @@ - - + + size_t size_t faiss::VectorDistance< mt >::d d + faiss::VectorDistance::d @@ -43,6 +45,7 @@ float faiss::VectorDistance< mt >::metric_arg metric_arg + faiss::VectorDistance::metric_arg @@ -51,13 +54,14 @@ - - + + constexpr bool constexpr bool faiss::VectorDistance< mt >::is_similarity is_similarity + faiss::VectorDistance::is_similarity = is_similarity_metric(mt) @@ -67,13 +71,14 @@ - - + + float float faiss::VectorDistance< mt >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -95,6 +100,7 @@ float faiss::VectorDistance< METRIC_L2 >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -116,6 +122,7 @@ float faiss::VectorDistance< METRIC_INNER_PRODUCT >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -137,6 +144,7 @@ float faiss::VectorDistance< METRIC_L1 >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -158,6 +166,7 @@ float faiss::VectorDistance< METRIC_Linf >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -179,6 +188,7 @@ float faiss::VectorDistance< METRIC_Lp >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -200,6 +210,7 @@ float faiss::VectorDistance< METRIC_Canberra >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -221,6 +232,7 @@ float faiss::VectorDistance< METRIC_BrayCurtis >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -242,6 +254,7 @@ float faiss::VectorDistance< METRIC_JensenShannon >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -263,6 +276,7 @@ float faiss::VectorDistance< METRIC_Jaccard >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -284,6 +298,7 @@ float faiss::VectorDistance< METRIC_NaNEuclidean >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -305,6 +320,7 @@ float faiss::VectorDistance< METRIC_ABS_INNER_PRODUCT >::operator() (const float *x, const float *y) const operator() + faiss::VectorDistance::operator() const float * x @@ -321,7 +337,7 @@ - + diff --git a/xml/structfaiss_1_1VectorIOReader.xml b/xml/structfaiss_1_1VectorIOReader.xml index a260b5e22f..eb9ca5894e 100644 --- a/xml/structfaiss_1_1VectorIOReader.xml +++ b/xml/structfaiss_1_1VectorIOReader.xml @@ -1,14 +1,15 @@ - + faiss::VectorIOReader faiss::IOReader - + std::vector< uint8_t > std::vector<uint8_t> faiss::VectorIOReader::data data + faiss::VectorIOReader::data @@ -22,6 +23,7 @@ size_t faiss::VectorIOReader::rp rp + faiss::VectorIOReader::rp = 0 @@ -36,6 +38,7 @@ std::string faiss::IOReader::name name + faiss::IOReader::name @@ -44,13 +47,14 @@ - - + + size_t size_t faiss::VectorIOReader::operator() (void *ptr, size_t size, size_t nitems) override operator() + faiss::VectorIOReader::operator() operator() void * @@ -77,6 +81,7 @@ virtual int faiss::IOReader::filedescriptor () filedescriptor + faiss::IOReader::filedescriptor filedescriptor @@ -86,34 +91,34 @@ - + + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1VectorIOWriter.xml b/xml/structfaiss_1_1VectorIOWriter.xml index b29bdbd86d..29bb0a3c8e 100644 --- a/xml/structfaiss_1_1VectorIOWriter.xml +++ b/xml/structfaiss_1_1VectorIOWriter.xml @@ -1,14 +1,15 @@ - + faiss::VectorIOWriter faiss::IOWriter - + std::vector< uint8_t > std::vector<uint8_t> faiss::VectorIOWriter::data data + faiss::VectorIOWriter::data @@ -22,6 +23,7 @@ std::string faiss::IOWriter::name name + faiss::IOWriter::name @@ -30,13 +32,14 @@ - - + + size_t size_t faiss::VectorIOWriter::operator() (const void *ptr, size_t size, size_t nitems) override operator() + faiss::VectorIOWriter::operator() operator() const void * @@ -63,6 +66,7 @@ virtual int faiss::IOWriter::filedescriptor () filedescriptor + faiss::IOWriter::filedescriptor filedescriptor @@ -72,34 +76,34 @@ - + + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1VectorTransform.xml b/xml/structfaiss_1_1VectorTransform.xml index 8a58d4400a..4b28da920b 100644 --- a/xml/structfaiss_1_1VectorTransform.xml +++ b/xml/structfaiss_1_1VectorTransform.xml @@ -1,5 +1,5 @@ - + faiss::VectorTransform faiss::CenteringTransform @@ -8,12 +8,13 @@ faiss::NormalizationTransform faiss::RemapDimensionsTransform VectorTransform.h - + int int faiss::VectorTransform::d_in d_in + faiss::VectorTransform::d_in @@ -27,6 +28,7 @@ int faiss::VectorTransform::d_out d_out + faiss::VectorTransform::d_out ! input dimension @@ -41,6 +43,7 @@ bool faiss::VectorTransform::is_trained is_trained + faiss::VectorTransform::is_trained @@ -50,13 +53,14 @@ - - + + faiss::VectorTransform::VectorTransform (int d_in=0, int d_out=0) VectorTransform + faiss::VectorTransform::VectorTransform int d_in @@ -81,6 +85,7 @@ virtual void faiss::VectorTransform::train (idx_t n, const float *x) train + faiss::VectorTransform::train train train train @@ -122,11 +127,12 @@ - + float * - float* faiss::VectorTransform::apply + float * faiss::VectorTransform::apply (idx_t n, const float *x) const apply + faiss::VectorTransform::apply idx_t n @@ -168,6 +174,7 @@ virtual void faiss::VectorTransform::apply_noalloc (idx_t n, const float *x, float *xt) const =0 apply_noalloc + faiss::VectorTransform::apply_noalloc apply_noalloc apply_noalloc apply_noalloc @@ -224,6 +231,7 @@ virtual void faiss::VectorTransform::reverse_transform (idx_t n, const float *xt, float *x) const reverse_transform + faiss::VectorTransform::reverse_transform reverse_transform reverse_transform reverse_transform @@ -254,6 +262,7 @@ virtual void faiss::VectorTransform::check_identical (const VectorTransform &other) const =0 check_identical + faiss::VectorTransform::check_identical check_identical check_identical check_identical @@ -276,6 +285,7 @@ virtual faiss::VectorTransform::~VectorTransform () ~VectorTransform + faiss::VectorTransform::~VectorTransform @@ -284,35 +294,13 @@ - + Any transformation applied on a set of vectors - - - - - - - - - - - - - - - - - - - - - - @@ -325,15 +313,21 @@ - - - + + + - - - + + + + + + + + + @@ -349,10 +343,26 @@ + + + + + + + + + + + + + + + + - faiss::VectorTransformapply + faiss::VectorTransformapply faiss::VectorTransformapply_noalloc faiss::VectorTransformcheck_identical faiss::VectorTransformd_in diff --git a/xml/structfaiss_1_1VisitedTable.xml b/xml/structfaiss_1_1VisitedTable.xml index 5b46f5cd37..a14e8f2375 100644 --- a/xml/structfaiss_1_1VisitedTable.xml +++ b/xml/structfaiss_1_1VisitedTable.xml @@ -1,14 +1,15 @@ - + faiss::VisitedTable AuxIndexStructures.h - + std::vector< uint8_t > std::vector<uint8_t> faiss::VisitedTable::visited visited + faiss::VisitedTable::visited @@ -22,6 +23,7 @@ uint8_t faiss::VisitedTable::visno visno + faiss::VisitedTable::visno @@ -30,13 +32,14 @@ - - + + faiss::VisitedTable::VisitedTable (int size) VisitedTable + faiss::VisitedTable::VisitedTable int size @@ -54,6 +57,7 @@ void faiss::VisitedTable::set (int no) set + faiss::VisitedTable::set int no @@ -72,6 +76,7 @@ bool faiss::VisitedTable::get (int no) const get + faiss::VisitedTable::get int no @@ -90,6 +95,7 @@ void faiss::VisitedTable::advance () advance + faiss::VisitedTable::advance reset all flags to false @@ -99,7 +105,7 @@ - + set implementation optimized for fast access. diff --git a/xml/structfaiss_1_1ZnSphereCodec.xml b/xml/structfaiss_1_1ZnSphereCodec.xml index c65fbeb5b1..070a6f36fc 100644 --- a/xml/structfaiss_1_1ZnSphereCodec.xml +++ b/xml/structfaiss_1_1ZnSphereCodec.xml @@ -1,5 +1,5 @@ - + faiss::ZnSphereCodec faiss::ZnSphereSearch @@ -7,12 +7,13 @@ faiss::ZnSphereCodecAlt lattice_Zn.h faiss::ZnSphereCodec::CodeSegment - + std::vector< CodeSegment > std::vector<CodeSegment> faiss::ZnSphereCodec::code_segments code_segments + faiss::ZnSphereCodec::code_segments @@ -26,6 +27,7 @@ uint64_t faiss::ZnSphereCodec::nv nv + faiss::ZnSphereCodec::nv @@ -39,6 +41,7 @@ size_t faiss::ZnSphereCodec::code_size code_size + faiss::ZnSphereCodec::code_size @@ -52,6 +55,7 @@ int faiss::ZnSphereSearch::dimS dimS + faiss::ZnSphereSearch::dimS @@ -65,6 +69,7 @@ int faiss::ZnSphereSearch::r2 r2 + faiss::ZnSphereSearch::r2 @@ -78,6 +83,7 @@ int faiss::ZnSphereSearch::natom natom + faiss::ZnSphereSearch::natom @@ -91,6 +97,7 @@ std::vector<float> faiss::ZnSphereSearch::voc voc + faiss::ZnSphereSearch::voc size dim * ntatom @@ -105,6 +112,7 @@ int faiss::EnumeratedVectors::dim dim + faiss::EnumeratedVectors::dim @@ -113,13 +121,14 @@ - - + + faiss::ZnSphereCodec::ZnSphereCodec (int dim, int r2) ZnSphereCodec + faiss::ZnSphereCodec::ZnSphereCodec int dim @@ -141,6 +150,7 @@ uint64_t faiss::ZnSphereCodec::search_and_encode (const float *x) const search_and_encode + faiss::ZnSphereCodec::search_and_encode const float * x @@ -158,6 +168,7 @@ void faiss::ZnSphereCodec::decode (uint64_t code, float *c) const override decode + faiss::ZnSphereCodec::decode decode decode @@ -182,6 +193,7 @@ uint64_t faiss::ZnSphereCodec::encode (const float *x) const override encode + faiss::ZnSphereCodec::encode encode encode @@ -202,6 +214,7 @@ float faiss::ZnSphereSearch::search (const float *x, float *c) const search + faiss::ZnSphereSearch::search const float * x @@ -224,6 +237,7 @@ float faiss::ZnSphereSearch::search (const float *x, float *c, float *tmp, int *tmp_int, int *ibest_out=nullptr) const search + faiss::ZnSphereSearch::search const float * x @@ -259,6 +273,7 @@ void faiss::ZnSphereSearch::search_multi (int n, const float *x, float *c_out, float *dp_out) search_multi + faiss::ZnSphereSearch::search_multi int n @@ -288,6 +303,7 @@ void faiss::EnumeratedVectors::encode_multi (size_t nc, const float *c, uint64_t *codes) const encode_multi + faiss::EnumeratedVectors::encode_multi size_t nc @@ -313,6 +329,7 @@ void faiss::EnumeratedVectors::decode_multi (size_t nc, const uint64_t *codes, float *c) const decode_multi + faiss::EnumeratedVectors::decode_multi size_t nc @@ -338,6 +355,7 @@ void faiss::EnumeratedVectors::find_nn (size_t n, const uint64_t *codes, size_t nq, const float *xq, int64_t *idx, float *dis) find_nn + faiss::EnumeratedVectors::find_nn size_t n @@ -370,7 +388,7 @@ - + @@ -378,12 +396,6 @@ uses the ZnSphereSearch to encode the vector by encoding the permutation and signs. Depends on ZnSphereSearch because it uses the atom numbers - - - - - - @@ -396,6 +408,12 @@ + + + + + + diff --git a/xml/structfaiss_1_1ZnSphereCodecAlt.xml b/xml/structfaiss_1_1ZnSphereCodecAlt.xml index aeb7c94b5c..37170c2241 100644 --- a/xml/structfaiss_1_1ZnSphereCodecAlt.xml +++ b/xml/structfaiss_1_1ZnSphereCodecAlt.xml @@ -1,15 +1,16 @@ - + faiss::ZnSphereCodecAlt faiss::ZnSphereCodec lattice_Zn.h - + bool bool faiss::ZnSphereCodecAlt::use_rec use_rec + faiss::ZnSphereCodecAlt::use_rec @@ -23,6 +24,7 @@ ZnSphereCodecRec faiss::ZnSphereCodecAlt::znc_rec znc_rec + faiss::ZnSphereCodecAlt::znc_rec @@ -36,6 +38,7 @@ std::vector<CodeSegment> faiss::ZnSphereCodec::code_segments code_segments + faiss::ZnSphereCodec::code_segments @@ -49,6 +52,7 @@ uint64_t faiss::ZnSphereCodec::nv nv + faiss::ZnSphereCodec::nv @@ -62,6 +66,7 @@ size_t faiss::ZnSphereCodec::code_size code_size + faiss::ZnSphereCodec::code_size @@ -75,6 +80,7 @@ int faiss::ZnSphereSearch::dimS dimS + faiss::ZnSphereSearch::dimS @@ -88,6 +94,7 @@ int faiss::ZnSphereSearch::r2 r2 + faiss::ZnSphereSearch::r2 @@ -101,6 +108,7 @@ int faiss::ZnSphereSearch::natom natom + faiss::ZnSphereSearch::natom @@ -114,6 +122,7 @@ std::vector<float> faiss::ZnSphereSearch::voc voc + faiss::ZnSphereSearch::voc size dim * ntatom @@ -128,6 +137,7 @@ int faiss::EnumeratedVectors::dim dim + faiss::EnumeratedVectors::dim @@ -136,13 +146,14 @@ - - + + faiss::ZnSphereCodecAlt::ZnSphereCodecAlt (int dim, int r2) ZnSphereCodecAlt + faiss::ZnSphereCodecAlt::ZnSphereCodecAlt int dim @@ -164,6 +175,7 @@ uint64_t faiss::ZnSphereCodecAlt::encode (const float *x) const override encode + faiss::ZnSphereCodecAlt::encode encode const float * @@ -183,6 +195,7 @@ void faiss::ZnSphereCodecAlt::decode (uint64_t code, float *c) const override decode + faiss::ZnSphereCodecAlt::decode decode uint64_t @@ -206,6 +219,7 @@ uint64_t faiss::ZnSphereCodec::search_and_encode (const float *x) const search_and_encode + faiss::ZnSphereCodec::search_and_encode const float * x @@ -223,6 +237,7 @@ float faiss::ZnSphereSearch::search (const float *x, float *c) const search + faiss::ZnSphereSearch::search const float * x @@ -245,6 +260,7 @@ float faiss::ZnSphereSearch::search (const float *x, float *c, float *tmp, int *tmp_int, int *ibest_out=nullptr) const search + faiss::ZnSphereSearch::search const float * x @@ -280,6 +296,7 @@ void faiss::ZnSphereSearch::search_multi (int n, const float *x, float *c_out, float *dp_out) search_multi + faiss::ZnSphereSearch::search_multi int n @@ -309,6 +326,7 @@ void faiss::EnumeratedVectors::encode_multi (size_t nc, const float *c, uint64_t *codes) const encode_multi + faiss::EnumeratedVectors::encode_multi size_t nc @@ -334,6 +352,7 @@ void faiss::EnumeratedVectors::decode_multi (size_t nc, const uint64_t *codes, float *c) const decode_multi + faiss::EnumeratedVectors::decode_multi size_t nc @@ -359,6 +378,7 @@ void faiss::EnumeratedVectors::find_nn (size_t n, const uint64_t *codes, size_t nq, const float *xq, int64_t *idx, float *dis) find_nn + faiss::EnumeratedVectors::find_nn size_t n @@ -391,19 +411,13 @@ - + Codec that uses the recursive codec if dim is a power of 2 and the regular one otherwise - - - - - - @@ -416,12 +430,30 @@ + + + + + + + + + + + + + + + + + + @@ -437,18 +469,6 @@ - - - - - - - - - - - - diff --git a/xml/structfaiss_1_1ZnSphereCodecRec.xml b/xml/structfaiss_1_1ZnSphereCodecRec.xml index 8d20ed210f..447e840699 100644 --- a/xml/structfaiss_1_1ZnSphereCodecRec.xml +++ b/xml/structfaiss_1_1ZnSphereCodecRec.xml @@ -1,15 +1,16 @@ - + faiss::ZnSphereCodecRec faiss::EnumeratedVectors lattice_Zn.h - + int int faiss::ZnSphereCodecRec::r2 r2 + faiss::ZnSphereCodecRec::r2 @@ -23,6 +24,7 @@ int faiss::ZnSphereCodecRec::log2_dim log2_dim + faiss::ZnSphereCodecRec::log2_dim @@ -36,6 +38,7 @@ int faiss::ZnSphereCodecRec::code_size code_size + faiss::ZnSphereCodecRec::code_size @@ -49,6 +52,7 @@ std::vector<uint64_t> faiss::ZnSphereCodecRec::all_nv all_nv + faiss::ZnSphereCodecRec::all_nv @@ -62,6 +66,7 @@ std::vector<uint64_t> faiss::ZnSphereCodecRec::all_nv_cum all_nv_cum + faiss::ZnSphereCodecRec::all_nv_cum @@ -75,6 +80,7 @@ int faiss::ZnSphereCodecRec::decode_cache_ld decode_cache_ld + faiss::ZnSphereCodecRec::decode_cache_ld @@ -88,6 +94,7 @@ std::vector<std::vector<float> > faiss::ZnSphereCodecRec::decode_cache decode_cache + faiss::ZnSphereCodecRec::decode_cache @@ -101,6 +108,7 @@ uint64_t faiss::EnumeratedVectors::nv nv + faiss::EnumeratedVectors::nv size of the collection @@ -115,6 +123,7 @@ int faiss::EnumeratedVectors::dim dim + faiss::EnumeratedVectors::dim @@ -123,13 +132,14 @@ - - + + faiss::ZnSphereCodecRec::ZnSphereCodecRec (int dim, int r2) ZnSphereCodecRec + faiss::ZnSphereCodecRec::ZnSphereCodecRec int dim @@ -151,6 +161,7 @@ uint64_t faiss::ZnSphereCodecRec::encode_centroid (const float *c) const encode_centroid + faiss::ZnSphereCodecRec::encode_centroid const float * c @@ -168,6 +179,7 @@ void faiss::ZnSphereCodecRec::decode (uint64_t code, float *c) const override decode + faiss::ZnSphereCodecRec::decode decode uint64_t @@ -191,6 +203,7 @@ uint64_t faiss::ZnSphereCodecRec::encode (const float *x) const override encode + faiss::ZnSphereCodecRec::encode encode const float * @@ -210,6 +223,7 @@ uint64_t faiss::ZnSphereCodecRec::get_nv (int ld, int r2a) const get_nv + faiss::ZnSphereCodecRec::get_nv int ld @@ -231,6 +245,7 @@ uint64_t faiss::ZnSphereCodecRec::get_nv_cum (int ld, int r2t, int r2a) const get_nv_cum + faiss::ZnSphereCodecRec::get_nv_cum int ld @@ -256,6 +271,7 @@ void faiss::ZnSphereCodecRec::set_nv_cum (int ld, int r2t, int r2a, uint64_t v) set_nv_cum + faiss::ZnSphereCodecRec::set_nv_cum int ld @@ -285,6 +301,7 @@ void faiss::EnumeratedVectors::encode_multi (size_t nc, const float *c, uint64_t *codes) const encode_multi + faiss::EnumeratedVectors::encode_multi size_t nc @@ -310,6 +327,7 @@ void faiss::EnumeratedVectors::decode_multi (size_t nc, const uint64_t *codes, float *c) const decode_multi + faiss::EnumeratedVectors::decode_multi size_t nc @@ -335,6 +353,7 @@ void faiss::EnumeratedVectors::find_nn (size_t n, const uint64_t *codes, size_t nq, const float *xq, int64_t *idx, float *dis) find_nn + faiss::EnumeratedVectors::find_nn size_t n @@ -367,7 +386,7 @@ - + @@ -375,28 +394,28 @@ Uses a recursive decomposition on the dimensions to encode centroids found by the ZnSphereSearch. The codes are not compatible with the ones of ZnSpehreCodec + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1ZnSphereCodec_1_1CodeSegment.xml b/xml/structfaiss_1_1ZnSphereCodec_1_1CodeSegment.xml index 97809d2f31..3843100100 100644 --- a/xml/structfaiss_1_1ZnSphereCodec_1_1CodeSegment.xml +++ b/xml/structfaiss_1_1ZnSphereCodec_1_1CodeSegment.xml @@ -1,14 +1,15 @@ - + faiss::ZnSphereCodec::CodeSegment faiss::Repeats - + uint64_t uint64_t faiss::ZnSphereCodec::CodeSegment::c0 c0 + faiss::ZnSphereCodec::CodeSegment::c0 @@ -22,6 +23,7 @@ int faiss::ZnSphereCodec::CodeSegment::signbits signbits + faiss::ZnSphereCodec::CodeSegment::signbits @@ -35,6 +37,7 @@ int faiss::Repeats::dim dim + faiss::Repeats::dim @@ -48,6 +51,7 @@ std::vector<Repeat> faiss::Repeats::repeats repeats + faiss::Repeats::repeats @@ -56,13 +60,14 @@ - - + + faiss::ZnSphereCodec::CodeSegment::CodeSegment (const Repeats &r) CodeSegment + faiss::ZnSphereCodec::CodeSegment::CodeSegment const Repeats & r @@ -80,6 +85,7 @@ uint64_t faiss::Repeats::count () const count + faiss::Repeats::count @@ -93,6 +99,7 @@ uint64_t faiss::Repeats::encode (const float *c) const encode + faiss::Repeats::encode const float * c @@ -110,6 +117,7 @@ void faiss::Repeats::decode (uint64_t code, float *c) const decode + faiss::Repeats::decode uint64_t code @@ -126,34 +134,34 @@ - + + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1ZnSphereSearch.xml b/xml/structfaiss_1_1ZnSphereSearch.xml index 074d2e2f28..a1d0bafc39 100644 --- a/xml/structfaiss_1_1ZnSphereSearch.xml +++ b/xml/structfaiss_1_1ZnSphereSearch.xml @@ -1,15 +1,16 @@ - + faiss::ZnSphereSearch faiss::ZnSphereCodec lattice_Zn.h - + int int faiss::ZnSphereSearch::dimS dimS + faiss::ZnSphereSearch::dimS @@ -23,6 +24,7 @@ int faiss::ZnSphereSearch::r2 r2 + faiss::ZnSphereSearch::r2 @@ -36,6 +38,7 @@ int faiss::ZnSphereSearch::natom natom + faiss::ZnSphereSearch::natom @@ -49,6 +52,7 @@ std::vector<float> faiss::ZnSphereSearch::voc voc + faiss::ZnSphereSearch::voc size dim * ntatom @@ -58,13 +62,14 @@ - - + + faiss::ZnSphereSearch::ZnSphereSearch (int dim, int r2) ZnSphereSearch + faiss::ZnSphereSearch::ZnSphereSearch int dim @@ -86,6 +91,7 @@ float faiss::ZnSphereSearch::search (const float *x, float *c) const search + faiss::ZnSphereSearch::search const float * x @@ -108,6 +114,7 @@ float faiss::ZnSphereSearch::search (const float *x, float *c, float *tmp, int *tmp_int, int *ibest_out=nullptr) const search + faiss::ZnSphereSearch::search const float * x @@ -143,6 +150,7 @@ void faiss::ZnSphereSearch::search_multi (int n, const float *x, float *c_out, float *dp_out) search_multi + faiss::ZnSphereSearch::search_multi int n @@ -167,7 +175,7 @@ - + @@ -175,18 +183,18 @@ Algorithm: all points are derived from a one atom vector up to a permutation and sign changes. The search function finds the most appropriate atom and transformation. - - - - - - + + + + + + diff --git a/xml/structfaiss_1_1cppcontrib_1_1Index2LevelDecoder.xml b/xml/structfaiss_1_1cppcontrib_1_1Index2LevelDecoder.xml index 295170e557..e868097ef7 100644 --- a/xml/structfaiss_1_1cppcontrib_1_1Index2LevelDecoder.xml +++ b/xml/structfaiss_1_1cppcontrib_1_1Index2LevelDecoder.xml @@ -1,5 +1,5 @@ - + faiss::cppcontrib::Index2LevelDecoder Level2-inl.h @@ -32,12 +32,13 @@ 8 - + typename detail::CoarseBitType< COARSE_BITS >::bit_type using faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::coarse_storage_type = typename detail::CoarseBitType<COARSE_BITS>::bit_type coarse_storage_type + faiss::cppcontrib::Index2LevelDecoder::coarse_storage_type @@ -46,13 +47,14 @@ - - + + constexpr intptr_t static constexpr intptr_t faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::dim dim + faiss::cppcontrib::Index2LevelDecoder::dim = DIM @@ -67,6 +69,7 @@ static constexpr intptr_t faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::coarseSize coarseSize + faiss::cppcontrib::Index2LevelDecoder::coarseSize = COARSE_SIZE @@ -81,6 +84,7 @@ static constexpr intptr_t faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::fineSize fineSize + faiss::cppcontrib::Index2LevelDecoder::fineSize = FINE_SIZE @@ -95,6 +99,7 @@ static constexpr intptr_t faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::coarseBits coarseBits + faiss::cppcontrib::Index2LevelDecoder::coarseBits = COARSE_BITS @@ -109,6 +114,7 @@ static constexpr intptr_t faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::fineBits fineBits + faiss::cppcontrib::Index2LevelDecoder::fineBits = FINE_BITS @@ -123,6 +129,7 @@ constexpr intptr_t faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::COARSE_TABLE_BYTES COARSE_TABLE_BYTES + faiss::cppcontrib::Index2LevelDecoder::COARSE_TABLE_BYTES = (1 << COARSE_BITS) @@ -137,6 +144,7 @@ constexpr intptr_t faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::FINE_TABLE_BYTES FINE_TABLE_BYTES + faiss::cppcontrib::Index2LevelDecoder::FINE_TABLE_BYTES = (1 << FINE_BITS) @@ -146,13 +154,14 @@ - - + + void static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::store (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::Index2LevelDecoder::store const float *const __restrict pqCoarseCentroids @@ -182,6 +191,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids @@ -215,6 +225,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids0 @@ -264,6 +275,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids @@ -305,6 +317,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqCoarseCentroids2, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids0 @@ -370,6 +383,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids @@ -419,6 +433,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::store (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::Index2LevelDecoder::store const float *const __restrict pqCoarseCentroids @@ -448,6 +463,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids @@ -481,6 +497,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids0 @@ -530,6 +547,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids @@ -571,6 +589,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqCoarseCentroids2, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids0 @@ -636,6 +655,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids @@ -685,6 +705,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::store (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::Index2LevelDecoder::store const float *const __restrict pqCoarseCentroids @@ -714,6 +735,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids @@ -747,6 +769,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids0 @@ -796,6 +819,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids @@ -837,6 +861,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqCoarseCentroids2, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids0 @@ -902,6 +927,7 @@ static void faiss::cppcontrib::Index2LevelDecoder< DIM, COARSE_SIZE, FINE_SIZE, COARSE_BITS, FINE_BITS >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::Index2LevelDecoder::accum const float *const __restrict pqCoarseCentroids @@ -946,7 +972,7 @@ - + Index2LevelDecoder. diff --git a/xml/structfaiss_1_1cppcontrib_1_1IndexMinMaxDecoder.xml b/xml/structfaiss_1_1cppcontrib_1_1IndexMinMaxDecoder.xml index 88f35a3092..450767f7b5 100644 --- a/xml/structfaiss_1_1cppcontrib_1_1IndexMinMaxDecoder.xml +++ b/xml/structfaiss_1_1cppcontrib_1_1IndexMinMaxDecoder.xml @@ -1,5 +1,5 @@ - + faiss::cppcontrib::IndexMinMaxDecoder @@ -7,12 +7,13 @@ typename SubIndexT - + constexpr intptr_t constexpr intptr_t faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::dim dim + faiss::cppcontrib::IndexMinMaxDecoder::dim = SubIndexT::dim @@ -22,13 +23,14 @@ - - + + void static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::store (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::IndexMinMaxDecoder::store const float *const __restrict pqCoarseCentroids @@ -58,6 +60,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::store (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::IndexMinMaxDecoder::store const float *const __restrict pqFineCentroids @@ -83,6 +86,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqCoarseCentroids @@ -120,6 +124,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqFineCentroids @@ -153,6 +158,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqCoarseCentroids0 @@ -206,6 +212,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqCoarseCentroids @@ -251,6 +258,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqFineCentroids0 @@ -296,6 +304,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqFineCentroids @@ -337,6 +346,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqCoarseCentroids2, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqCoarseCentroids0 @@ -406,6 +416,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqCoarseCentroids @@ -459,6 +470,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqFineCentroids0 @@ -516,6 +528,7 @@ static void faiss::cppcontrib::IndexMinMaxDecoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxDecoder::accum const float *const __restrict pqFineCentroids @@ -560,7 +573,7 @@ - + diff --git a/xml/structfaiss_1_1cppcontrib_1_1IndexMinMaxFP16Decoder.xml b/xml/structfaiss_1_1cppcontrib_1_1IndexMinMaxFP16Decoder.xml index 8a434c2122..0770c04fca 100644 --- a/xml/structfaiss_1_1cppcontrib_1_1IndexMinMaxFP16Decoder.xml +++ b/xml/structfaiss_1_1cppcontrib_1_1IndexMinMaxFP16Decoder.xml @@ -1,5 +1,5 @@ - + faiss::cppcontrib::IndexMinMaxFP16Decoder @@ -7,12 +7,13 @@ typename SubIndexT - + constexpr intptr_t constexpr intptr_t faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::dim dim + faiss::cppcontrib::IndexMinMaxFP16Decoder::dim = SubIndexT::dim @@ -22,13 +23,14 @@ - - + + void static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::store (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::IndexMinMaxFP16Decoder::store const float *const __restrict pqCoarseCentroids @@ -58,6 +60,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::store (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::IndexMinMaxFP16Decoder::store const float *const __restrict pqFineCentroids @@ -83,6 +86,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqCoarseCentroids @@ -120,6 +124,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqFineCentroids @@ -153,6 +158,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqCoarseCentroids0 @@ -206,6 +212,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqCoarseCentroids @@ -251,6 +258,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqFineCentroids0 @@ -296,6 +304,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqFineCentroids @@ -337,6 +346,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids0, const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqCoarseCentroids1, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqCoarseCentroids2, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqCoarseCentroids0 @@ -406,6 +416,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqCoarseCentroids, const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqCoarseCentroids @@ -459,6 +470,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqFineCentroids0 @@ -516,6 +528,7 @@ static void faiss::cppcontrib::IndexMinMaxFP16Decoder< SubIndexT >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum, float &minvAccum) accum + faiss::cppcontrib::IndexMinMaxFP16Decoder::accum const float *const __restrict pqFineCentroids @@ -560,7 +573,7 @@ - + diff --git a/xml/structfaiss_1_1cppcontrib_1_1IndexPQDecoder.xml b/xml/structfaiss_1_1cppcontrib_1_1IndexPQDecoder.xml index 127b4fcb76..2f5fb412e9 100644 --- a/xml/structfaiss_1_1cppcontrib_1_1IndexPQDecoder.xml +++ b/xml/structfaiss_1_1cppcontrib_1_1IndexPQDecoder.xml @@ -1,5 +1,5 @@ - + faiss::cppcontrib::IndexPQDecoder PQ-inl.h @@ -21,12 +21,13 @@ 8 - + constexpr intptr_t static constexpr intptr_t faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::dim dim + faiss::cppcontrib::IndexPQDecoder::dim = DIM @@ -41,6 +42,7 @@ static constexpr intptr_t faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::fineSize fineSize + faiss::cppcontrib::IndexPQDecoder::fineSize = FINE_SIZE @@ -55,6 +57,7 @@ static constexpr intptr_t faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::fineBits fineBits + faiss::cppcontrib::IndexPQDecoder::fineBits = FINE_BITS @@ -69,6 +72,7 @@ constexpr intptr_t faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::FINE_TABLE_BYTES FINE_TABLE_BYTES + faiss::cppcontrib::IndexPQDecoder::FINE_TABLE_BYTES = (1 << FINE_BITS) @@ -78,13 +82,14 @@ - - + + void static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::store (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::IndexPQDecoder::store const float *const __restrict pqFineCentroids @@ -110,6 +115,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids @@ -139,6 +145,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids0 @@ -180,6 +187,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids @@ -217,6 +225,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids0 @@ -270,6 +279,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids @@ -315,6 +325,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::store (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::IndexPQDecoder::store const float *const __restrict pqFineCentroids @@ -340,6 +351,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids @@ -369,6 +381,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids0 @@ -410,6 +423,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids @@ -447,6 +461,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids0 @@ -500,6 +515,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids @@ -545,6 +561,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::store (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, float *const __restrict outputStore) store + faiss::cppcontrib::IndexPQDecoder::store const float *const __restrict pqFineCentroids @@ -570,6 +587,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code, const float weight, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids @@ -599,6 +617,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids0 @@ -640,6 +659,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids @@ -677,6 +697,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids0, const uint8_t *const __restrict code0, const float weight0, const float *const __restrict pqFineCentroids1, const uint8_t *const __restrict code1, const float weight1, const float *const __restrict pqFineCentroids2, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids0 @@ -730,6 +751,7 @@ static void faiss::cppcontrib::IndexPQDecoder< DIM, FINE_SIZE, FINE_BITS >::accum (const float *const __restrict pqFineCentroids, const uint8_t *const __restrict code0, const float weight0, const uint8_t *const __restrict code1, const float weight1, const uint8_t *const __restrict code2, const float weight2, float *const __restrict outputAccum) accum + faiss::cppcontrib::IndexPQDecoder::accum const float *const __restrict pqFineCentroids @@ -770,7 +792,7 @@ - + IndexPQDecoder. diff --git a/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType.xml b/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType.xml index 98e414e065..9e614d6c4f 100644 --- a/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType.xml +++ b/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType.xml @@ -1,5 +1,5 @@ - + faiss::cppcontrib::detail::CoarseBitType diff --git a/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType_3_0116_01_4.xml b/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType_3_0116_01_4.xml index ebae65f6ce..3e2a2ef947 100644 --- a/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType_3_0116_01_4.xml +++ b/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType_3_0116_01_4.xml @@ -1,15 +1,16 @@ - + faiss::cppcontrib::detail::CoarseBitType< 16 > - + uint16_t using faiss::cppcontrib::detail::CoarseBitType< 16 >::bit_type = uint16_t bit_type + faiss::cppcontrib::detail::CoarseBitType< 16 >::bit_type @@ -18,7 +19,7 @@ - + diff --git a/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType_3_018_01_4.xml b/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType_3_018_01_4.xml index 0e7c4eecf3..234c31d2f4 100644 --- a/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType_3_018_01_4.xml +++ b/xml/structfaiss_1_1cppcontrib_1_1detail_1_1CoarseBitType_3_018_01_4.xml @@ -1,15 +1,16 @@ - + faiss::cppcontrib::detail::CoarseBitType< 8 > - + uint8_t using faiss::cppcontrib::detail::CoarseBitType< 8 >::bit_type = uint8_t bit_type + faiss::cppcontrib::detail::CoarseBitType< 8 >::bit_type @@ -18,7 +19,7 @@ - + diff --git a/xml/structfaiss_1_1detail_1_1simdlib_1_1binary__func__impl.xml b/xml/structfaiss_1_1detail_1_1simdlib_1_1binary__func__impl.xml index 71857bad9d..77ae242a79 100644 --- a/xml/structfaiss_1_1detail_1_1simdlib_1_1binary__func__impl.xml +++ b/xml/structfaiss_1_1detail_1_1simdlib_1_1binary__func__impl.xml @@ -1,5 +1,5 @@ - + faiss::detail::simdlib::binary_func_impl @@ -10,12 +10,13 @@ typename U - + remove_cv_ref_t< decltype(std::declval< T >().val[0])> using faiss::detail::simdlib::binary_func_impl< T, U >::Telem = remove_cv_ref_t<decltype(std::declval<T>().val[0])> Telem + faiss::detail::simdlib::binary_func_impl::Telem @@ -29,6 +30,7 @@ using faiss::detail::simdlib::binary_func_impl< T, U >::Uelem = remove_cv_ref_t<decltype(std::declval<U>().val[0])> Uelem + faiss::detail::simdlib::binary_func_impl::Uelem @@ -37,13 +39,14 @@ - - + + const U & const U& faiss::detail::simdlib::binary_func_impl< T, U >::a a + faiss::detail::simdlib::binary_func_impl::a @@ -57,6 +60,7 @@ const U& faiss::detail::simdlib::binary_func_impl< T, U >::b b + faiss::detail::simdlib::binary_func_impl::b @@ -65,8 +69,8 @@ - - + + @@ -79,6 +83,7 @@ T faiss::detail::simdlib::binary_func_impl< T, U >::call () call + faiss::detail::simdlib::binary_func_impl::call @@ -87,7 +92,7 @@ - + diff --git a/xml/structfaiss_1_1detail_1_1simdlib_1_1is__simd256bit.xml b/xml/structfaiss_1_1detail_1_1simdlib_1_1is__simd256bit.xml index 8645f54d1e..72d366bbe9 100644 --- a/xml/structfaiss_1_1detail_1_1simdlib_1_1is__simd256bit.xml +++ b/xml/structfaiss_1_1detail_1_1simdlib_1_1is__simd256bit.xml @@ -1,5 +1,5 @@ - + faiss::detail::simdlib::is_simd256bit std::is_same< decltype(reinterpret_u8(std::declval< T >().data)), uint8x16x2_t > @@ -17,26 +17,26 @@ - - - - - + + + + + diff --git a/xml/structfaiss_1_1detail_1_1simdlib_1_1set1__impl.xml b/xml/structfaiss_1_1detail_1_1simdlib_1_1set1__impl.xml index 871c2189ce..a1357d466c 100644 --- a/xml/structfaiss_1_1detail_1_1simdlib_1_1set1__impl.xml +++ b/xml/structfaiss_1_1detail_1_1simdlib_1_1set1__impl.xml @@ -1,5 +1,5 @@ - + faiss::detail::simdlib::set1_impl @@ -10,12 +10,13 @@ typename T - + D & D& faiss::detail::simdlib::set1_impl< D, T >::d d + faiss::detail::simdlib::set1_impl::d @@ -29,6 +30,7 @@ T faiss::detail::simdlib::set1_impl< D, T >::t t + faiss::detail::simdlib::set1_impl::t @@ -37,8 +39,8 @@ - - + + @@ -51,6 +53,7 @@ void faiss::detail::simdlib::set1_impl< D, T >::call () call + faiss::detail::simdlib::set1_impl::call @@ -59,7 +62,7 @@ - + diff --git a/xml/structfaiss_1_1detail_1_1simdlib_1_1unary__func__impl.xml b/xml/structfaiss_1_1detail_1_1simdlib_1_1unary__func__impl.xml index 9a3156e52a..f9a9803d92 100644 --- a/xml/structfaiss_1_1detail_1_1simdlib_1_1unary__func__impl.xml +++ b/xml/structfaiss_1_1detail_1_1simdlib_1_1unary__func__impl.xml @@ -1,5 +1,5 @@ - + faiss::detail::simdlib::unary_func_impl @@ -10,12 +10,13 @@ typename U - + remove_cv_ref_t< decltype(std::declval< T >().val[0])> using faiss::detail::simdlib::unary_func_impl< T, U >::Telem = remove_cv_ref_t<decltype(std::declval<T>().val[0])> Telem + faiss::detail::simdlib::unary_func_impl::Telem @@ -29,6 +30,7 @@ using faiss::detail::simdlib::unary_func_impl< T, U >::Uelem = remove_cv_ref_t<decltype(std::declval<U>().val[0])> Uelem + faiss::detail::simdlib::unary_func_impl::Uelem @@ -37,13 +39,14 @@ - - + + const U & const U& faiss::detail::simdlib::unary_func_impl< T, U >::a a + faiss::detail::simdlib::unary_func_impl::a @@ -52,8 +55,8 @@ - - + + @@ -66,6 +69,7 @@ T faiss::detail::simdlib::unary_func_impl< T, U >::call () call + faiss::detail::simdlib::unary_func_impl::call @@ -74,7 +78,7 @@ - + diff --git a/xml/structfaiss_1_1gpu_1_1AllocInfo.xml b/xml/structfaiss_1_1gpu_1_1AllocInfo.xml index a26e44872c..9ba9996d62 100644 --- a/xml/structfaiss_1_1gpu_1_1AllocInfo.xml +++ b/xml/structfaiss_1_1gpu_1_1AllocInfo.xml @@ -1,15 +1,16 @@ - + faiss::gpu::AllocInfo faiss::gpu::AllocRequest GpuResources.h - + AllocType AllocType faiss::gpu::AllocInfo::type type + faiss::gpu::AllocInfo::type = AllocType::Other The internal category of the allocation. @@ -25,6 +26,7 @@ int faiss::gpu::AllocInfo::device device + faiss::gpu::AllocInfo::device = 0 The device on which the allocation is happening. @@ -40,6 +42,7 @@ MemorySpace faiss::gpu::AllocInfo::space space + faiss::gpu::AllocInfo::space = MemorySpace::Device The memory space of the allocation. @@ -55,6 +58,7 @@ cudaStream_t faiss::gpu::AllocInfo::stream stream + faiss::gpu::AllocInfo::stream = nullptr @@ -66,13 +70,14 @@ - - + + faiss::gpu::AllocInfo::AllocInfo () AllocInfo + faiss::gpu::AllocInfo::AllocInfo @@ -86,6 +91,7 @@ faiss::gpu::AllocInfo::AllocInfo (AllocType at, int dev, MemorySpace sp, cudaStream_t st) AllocInfo + faiss::gpu::AllocInfo::AllocInfo AllocType at @@ -115,6 +121,7 @@ std::string faiss::gpu::AllocInfo::toString () const toString + faiss::gpu::AllocInfo::toString Returns a string representation of this info. @@ -124,7 +131,7 @@ - + Information on what/where an allocation is. diff --git a/xml/structfaiss_1_1gpu_1_1AllocRequest.xml b/xml/structfaiss_1_1gpu_1_1AllocRequest.xml index 532d163f4d..6e40e46f86 100644 --- a/xml/structfaiss_1_1gpu_1_1AllocRequest.xml +++ b/xml/structfaiss_1_1gpu_1_1AllocRequest.xml @@ -1,15 +1,16 @@ - + faiss::gpu::AllocRequest faiss::gpu::AllocInfo GpuResources.h - + size_t size_t faiss::gpu::AllocRequest::size size + faiss::gpu::AllocRequest::size = 0 The size in bytes of the allocation. @@ -25,6 +26,7 @@ AllocType faiss::gpu::AllocInfo::type type + faiss::gpu::AllocInfo::type = AllocType::Other The internal category of the allocation. @@ -40,6 +42,7 @@ int faiss::gpu::AllocInfo::device device + faiss::gpu::AllocInfo::device = 0 The device on which the allocation is happening. @@ -55,6 +58,7 @@ MemorySpace faiss::gpu::AllocInfo::space space + faiss::gpu::AllocInfo::space = MemorySpace::Device The memory space of the allocation. @@ -70,6 +74,7 @@ cudaStream_t faiss::gpu::AllocInfo::stream stream + faiss::gpu::AllocInfo::stream = nullptr @@ -81,13 +86,14 @@ - - + + faiss::gpu::AllocRequest::AllocRequest () AllocRequest + faiss::gpu::AllocRequest::AllocRequest @@ -101,6 +107,7 @@ faiss::gpu::AllocRequest::AllocRequest (const AllocInfo &info, size_t sz) AllocRequest + faiss::gpu::AllocRequest::AllocRequest const AllocInfo & info @@ -122,6 +129,7 @@ faiss::gpu::AllocRequest::AllocRequest (AllocType at, int dev, MemorySpace sp, cudaStream_t st, size_t sz) AllocRequest + faiss::gpu::AllocRequest::AllocRequest AllocType at @@ -155,6 +163,7 @@ std::string faiss::gpu::AllocRequest::toString () const toString + faiss::gpu::AllocRequest::toString Returns a string representation of this request. @@ -164,7 +173,7 @@ - + Information on what/where an allocation is, along with how big it should be. diff --git a/xml/structfaiss_1_1gpu_1_1GpuClonerOptions.xml b/xml/structfaiss_1_1gpu_1_1GpuClonerOptions.xml index 8c49a57c44..3ac5f268e2 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuClonerOptions.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuClonerOptions.xml @@ -1,16 +1,17 @@ - + faiss::gpu::GpuClonerOptions faiss::gpu::GpuMultipleClonerOptions faiss::gpu::ToGpuCloner GpuClonerOptions.h - + IndicesOptions IndicesOptions faiss::gpu::GpuClonerOptions::indicesOptions indicesOptions + faiss::gpu::GpuClonerOptions::indicesOptions = INDICES_64_BIT @@ -26,6 +27,7 @@ bool faiss::gpu::GpuClonerOptions::useFloat16CoarseQuantizer useFloat16CoarseQuantizer + faiss::gpu::GpuClonerOptions::useFloat16CoarseQuantizer = false is the coarse quantizer in float16? @@ -41,6 +43,7 @@ bool faiss::gpu::GpuClonerOptions::useFloat16 useFloat16 + faiss::gpu::GpuClonerOptions::useFloat16 = false @@ -56,6 +59,7 @@ bool faiss::gpu::GpuClonerOptions::usePrecomputed usePrecomputed + faiss::gpu::GpuClonerOptions::usePrecomputed = false use precomputed tables? @@ -71,6 +75,7 @@ long faiss::gpu::GpuClonerOptions::reserveVecs reserveVecs + faiss::gpu::GpuClonerOptions::reserveVecs = 0 reserve vectors in the invfiles? @@ -86,6 +91,7 @@ bool faiss::gpu::GpuClonerOptions::storeTransposed storeTransposed + faiss::gpu::GpuClonerOptions::storeTransposed = false For GpuIndexFlat, store data in transposed layout? @@ -101,6 +107,7 @@ bool faiss::gpu::GpuClonerOptions::verbose verbose + faiss::gpu::GpuClonerOptions::verbose = false Set verbose options on the index. @@ -116,6 +123,7 @@ bool faiss::gpu::GpuClonerOptions::use_cuvs use_cuvs + faiss::gpu::GpuClonerOptions::use_cuvs = false use the cuVS implementation @@ -131,6 +139,7 @@ bool faiss::gpu::GpuClonerOptions::allowCpuCoarseQuantizer allowCpuCoarseQuantizer + faiss::gpu::GpuClonerOptions::allowCpuCoarseQuantizer = false @@ -141,22 +150,28 @@ - + set some options on how to copy to GPU + + + + - - - + + + + + @@ -164,12 +179,6 @@ - - - - - - diff --git a/xml/structfaiss_1_1gpu_1_1GpuDistanceParams.xml b/xml/structfaiss_1_1gpu_1_1GpuDistanceParams.xml index 14c5c4de5d..0733524d1f 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuDistanceParams.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuDistanceParams.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuDistanceParams GpuDistance.h - + faiss::MetricType faiss::MetricType faiss::gpu::GpuDistanceParams::metric metric + faiss::gpu::GpuDistanceParams::metric = METRIC_L2 Search parameter: distance metric. @@ -24,6 +25,7 @@ float faiss::gpu::GpuDistanceParams::metricArg metricArg + faiss::gpu::GpuDistanceParams::metricArg = 0 @@ -39,6 +41,7 @@ int faiss::gpu::GpuDistanceParams::k k + faiss::gpu::GpuDistanceParams::k = 0 @@ -54,6 +57,7 @@ int faiss::gpu::GpuDistanceParams::dims dims + faiss::gpu::GpuDistanceParams::dims = 0 Vector dimensionality. @@ -69,6 +73,7 @@ const void* faiss::gpu::GpuDistanceParams::vectors vectors + faiss::gpu::GpuDistanceParams::vectors = nullptr @@ -84,6 +89,7 @@ DistanceDataType faiss::gpu::GpuDistanceParams::vectorType vectorType + faiss::gpu::GpuDistanceParams::vectorType = DistanceDataType::F32 @@ -98,6 +104,7 @@ bool faiss::gpu::GpuDistanceParams::vectorsRowMajor vectorsRowMajor + faiss::gpu::GpuDistanceParams::vectorsRowMajor = true @@ -112,6 +119,7 @@ idx_t faiss::gpu::GpuDistanceParams::numVectors numVectors + faiss::gpu::GpuDistanceParams::numVectors = 0 @@ -126,6 +134,7 @@ const float* faiss::gpu::GpuDistanceParams::vectorNorms vectorNorms + faiss::gpu::GpuDistanceParams::vectorNorms = nullptr @@ -141,6 +150,7 @@ const void* faiss::gpu::GpuDistanceParams::queries queries + faiss::gpu::GpuDistanceParams::queries = nullptr @@ -156,6 +166,7 @@ DistanceDataType faiss::gpu::GpuDistanceParams::queryType queryType + faiss::gpu::GpuDistanceParams::queryType = DistanceDataType::F32 @@ -170,6 +181,7 @@ bool faiss::gpu::GpuDistanceParams::queriesRowMajor queriesRowMajor + faiss::gpu::GpuDistanceParams::queriesRowMajor = true @@ -184,6 +196,7 @@ idx_t faiss::gpu::GpuDistanceParams::numQueries numQueries + faiss::gpu::GpuDistanceParams::numQueries = 0 @@ -198,6 +211,7 @@ float* faiss::gpu::GpuDistanceParams::outDistances outDistances + faiss::gpu::GpuDistanceParams::outDistances = nullptr @@ -213,6 +227,7 @@ bool faiss::gpu::GpuDistanceParams::ignoreOutDistances ignoreOutDistances + faiss::gpu::GpuDistanceParams::ignoreOutDistances = false @@ -228,6 +243,7 @@ IndicesDataType faiss::gpu::GpuDistanceParams::outIndicesType outIndicesType + faiss::gpu::GpuDistanceParams::outIndicesType = IndicesDataType::I64 @@ -243,6 +259,7 @@ void* faiss::gpu::GpuDistanceParams::outIndices outIndices + faiss::gpu::GpuDistanceParams::outIndices = nullptr @@ -257,6 +274,7 @@ int faiss::gpu::GpuDistanceParams::device device + faiss::gpu::GpuDistanceParams::device = -1 @@ -272,6 +290,7 @@ bool faiss::gpu::GpuDistanceParams::use_cuvs use_cuvs + faiss::gpu::GpuDistanceParams::use_cuvs = false Should the index dispatch down to cuVS? @@ -282,7 +301,7 @@ - + Arguments to brute-force GPU k-nearest neighbor searching. diff --git a/xml/structfaiss_1_1gpu_1_1GpuIcmEncoderFactory.xml b/xml/structfaiss_1_1gpu_1_1GpuIcmEncoderFactory.xml index 9139e8ac4c..7b48c2cee5 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIcmEncoderFactory.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIcmEncoderFactory.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuIcmEncoderFactory faiss::lsq::IcmEncoderFactory - + std::vector< GpuResourcesProvider * > std::vector<GpuResourcesProvider*> faiss::gpu::GpuIcmEncoderFactory::provs provs + faiss::gpu::GpuIcmEncoderFactory::provs @@ -22,6 +23,7 @@ std::vector<int> faiss::gpu::GpuIcmEncoderFactory::devices devices + faiss::gpu::GpuIcmEncoderFactory::devices @@ -30,13 +32,14 @@ - - + + faiss::gpu::GpuIcmEncoderFactory::GpuIcmEncoderFactory (int ngpus=1) GpuIcmEncoderFactory + faiss::gpu::GpuIcmEncoderFactory::GpuIcmEncoderFactory int ngpus @@ -50,12 +53,13 @@ - + lsq::IcmEncoder * - lsq::IcmEncoder* faiss::gpu::GpuIcmEncoderFactory::get + lsq::IcmEncoder * faiss::gpu::GpuIcmEncoderFactory::get (const LocalSearchQuantizer *lsq) override get - get + faiss::gpu::GpuIcmEncoderFactory::get + get const LocalSearchQuantizer * lsq @@ -68,39 +72,39 @@ - + - - - - - - + + + + + + faiss::gpu::GpuIcmEncoderFactorydevices - faiss::gpu::GpuIcmEncoderFactoryget + faiss::gpu::GpuIcmEncoderFactoryget faiss::gpu::GpuIcmEncoderFactoryGpuIcmEncoderFactory faiss::gpu::GpuIcmEncoderFactoryprovs faiss::gpu::GpuIcmEncoderFactory~IcmEncoderFactory diff --git a/xml/structfaiss_1_1gpu_1_1GpuIndexBinaryFlatConfig.xml b/xml/structfaiss_1_1gpu_1_1GpuIndexBinaryFlatConfig.xml index 814042c59d..bcf9bd3187 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIndexBinaryFlatConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIndexBinaryFlatConfig.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuIndexBinaryFlatConfig faiss::gpu::GpuIndexConfig - + int int faiss::gpu::GpuIndexConfig::device device + faiss::gpu::GpuIndexConfig::device = 0 GPU device on which the index is resident. @@ -24,6 +25,7 @@ MemorySpace faiss::gpu::GpuIndexConfig::memorySpace memorySpace + faiss::gpu::GpuIndexConfig::memorySpace = MemorySpace::Device @@ -39,6 +41,7 @@ bool faiss::gpu::GpuIndexConfig::use_cuvs use_cuvs + faiss::gpu::GpuIndexConfig::use_cuvs = false Should the index dispatch down to cuVS? @@ -49,34 +52,34 @@ - + - - - - - - + + + + + + diff --git a/xml/structfaiss_1_1gpu_1_1GpuIndexCagra.xml b/xml/structfaiss_1_1gpu_1_1GpuIndexCagra.xml index fb624571e3..490f4c0b5f 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIndexCagra.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIndexCagra.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuIndexCagra faiss::gpu::GpuIndex - + const GpuIndexCagraConfig const GpuIndexCagraConfig faiss::gpu::GpuIndexCagra::cagraConfig_ cagraConfig_ + faiss::gpu::GpuIndexCagra::cagraConfig_ Our configuration options. @@ -23,6 +24,7 @@ std::shared_ptr<CuvsCagra> faiss::gpu::GpuIndexCagra::index_ index_ + faiss::gpu::GpuIndexCagra::index_ Instance that we own; contains the inverted lists. @@ -37,6 +39,7 @@ std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::resources_ resources_ + faiss::gpu::GpuIndex::resources_ Manages streams, cuBLAS handles and scratch memory for devices. @@ -51,6 +54,7 @@ const GpuIndexConfig faiss::gpu::GpuIndex::config_ config_ + faiss::gpu::GpuIndex::config_ Our configuration options. @@ -65,6 +69,7 @@ size_t faiss::gpu::GpuIndex::minPagedSize_ minPagedSize_ + faiss::gpu::GpuIndex::minPagedSize_ Size above which we page copies from the CPU to GPU. @@ -74,13 +79,14 @@ - - + + faiss::gpu::GpuIndexCagra::GpuIndexCagra (GpuResourcesProvider *provider, int dims, faiss::MetricType metric=faiss::METRIC_L2, GpuIndexCagraConfig config=GpuIndexCagraConfig()) GpuIndexCagra + faiss::gpu::GpuIndexCagra::GpuIndexCagra GpuResourcesProvider * provider @@ -112,6 +118,7 @@ void faiss::gpu::GpuIndexCagra::train (idx_t n, const float *x) override train + faiss::gpu::GpuIndexCagra::train train idx_t @@ -135,6 +142,7 @@ void faiss::gpu::GpuIndexCagra::copyFrom (const faiss::IndexHNSWCagra *index) copyFrom + faiss::gpu::GpuIndexCagra::copyFrom const faiss::IndexHNSWCagra * index @@ -153,6 +161,7 @@ void faiss::gpu::GpuIndexCagra::copyTo (faiss::IndexHNSWCagra *index) const copyTo + faiss::gpu::GpuIndexCagra::copyTo faiss::IndexHNSWCagra * index @@ -171,6 +180,7 @@ void faiss::gpu::GpuIndexCagra::reset () override reset + faiss::gpu::GpuIndexCagra::reset reset removes all elements from the database. @@ -181,11 +191,12 @@ - + std::vector< idx_t > - std::vector<idx_t> faiss::gpu::GpuIndexCagra::get_knngraph + std::vector< idx_t > faiss::gpu::GpuIndexCagra::get_knngraph () const get_knngraph + faiss::gpu::GpuIndexCagra::get_knngraph @@ -199,6 +210,7 @@ int faiss::gpu::GpuIndex::getDevice () const getDevice + faiss::gpu::GpuIndex::getDevice Returns the device that this index is resident on. @@ -208,11 +220,12 @@ - + std::shared_ptr< GpuResources > - std::shared_ptr<GpuResources> faiss::gpu::GpuIndex::getResources + std::shared_ptr< GpuResources > faiss::gpu::GpuIndex::getResources () getResources + faiss::gpu::GpuIndex::getResources @@ -227,6 +240,7 @@ void faiss::gpu::GpuIndex::setMinPagingSize (size_t size) setMinPagingSize + faiss::gpu::GpuIndex::setMinPagingSize size_t size @@ -245,6 +259,7 @@ size_t faiss::gpu::GpuIndex::getMinPagingSize () const getMinPagingSize + faiss::gpu::GpuIndex::getMinPagingSize Returns the current minimum data size for paged searches. @@ -259,6 +274,7 @@ void faiss::gpu::GpuIndex::add (idx_t, const float *x) override add + faiss::gpu::GpuIndex::add add add @@ -282,6 +298,7 @@ void faiss::gpu::GpuIndex::add_with_ids (idx_t n, const float *x, const idx_t *ids) override add_with_ids + faiss::gpu::GpuIndex::add_with_ids add_with_ids idx_t @@ -309,6 +326,7 @@ void faiss::gpu::GpuIndex::assign (idx_t n, const float *x, idx_t *labels, idx_t k=1) const override assign + faiss::gpu::GpuIndex::assign assign idx_t @@ -341,6 +359,7 @@ void faiss::gpu::GpuIndex::search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, const SearchParameters *params=nullptr) const override search + faiss::gpu::GpuIndex::search search idx_t @@ -381,6 +400,7 @@ void faiss::gpu::GpuIndex::search_and_reconstruct (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons, const SearchParameters *params=nullptr) const override search_and_reconstruct + faiss::gpu::GpuIndex::search_and_reconstruct search_and_reconstruct idx_t @@ -425,6 +445,7 @@ void faiss::gpu::GpuIndex::compute_residual (const float *x, float *residual, idx_t key) const override compute_residual + faiss::gpu::GpuIndex::compute_residual compute_residual compute_residual @@ -453,6 +474,7 @@ void faiss::gpu::GpuIndex::compute_residual_n (idx_t n, const float *xs, float *residuals, const idx_t *keys) const override compute_residual_n + faiss::gpu::GpuIndex::compute_residual_n compute_residual_n compute_residual_n @@ -485,6 +507,7 @@ virtual void faiss::Index::range_search (idx_t n, const float *x, float radius, RangeSearchResult *result, const SearchParameters *params=nullptr) const range_search + faiss::Index::range_search range_search range_search range_search @@ -563,6 +586,7 @@ virtual size_t faiss::Index::remove_ids (const IDSelector &sel) remove_ids + faiss::Index::remove_ids remove_ids remove_ids remove_ids @@ -587,6 +611,7 @@ virtual void faiss::Index::reconstruct (idx_t key, float *recons) const reconstruct + faiss::Index::reconstruct reconstruct reconstruct reconstruct @@ -640,6 +665,7 @@ virtual void faiss::Index::reconstruct_batch (idx_t n, const idx_t *keys, float *recons) const reconstruct_batch + faiss::Index::reconstruct_batch reconstruct_batch idx_t @@ -693,6 +719,7 @@ virtual void faiss::Index::reconstruct_n (idx_t i0, idx_t ni, float *recons) const reconstruct_n + faiss::Index::reconstruct_n reconstruct_n reconstruct_n reconstruct_n @@ -745,15 +772,16 @@ - + DistanceComputer * - virtual DistanceComputer* faiss::Index::get_distance_computer + virtual DistanceComputer * faiss::Index::get_distance_computer () const get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer - get_distance_computer + faiss::Index::get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer + get_distance_computer @@ -769,6 +797,8 @@ virtual size_t faiss::Index::sa_code_size () const sa_code_size + faiss::Index::sa_code_size + sa_code_size sa_code_size sa_code_size sa_code_size @@ -790,8 +820,10 @@ virtual void faiss::Index::sa_encode (idx_t n, const float *x, uint8_t *bytes) const sa_encode + faiss::Index::sa_encode sa_encode sa_encode + sa_encode sa_encode sa_encode sa_encode @@ -855,14 +887,14 @@ virtual void faiss::Index::sa_decode (idx_t n, const uint8_t *bytes, float *x) const sa_decode + faiss::Index::sa_decode sa_decode sa_decode sa_decode sa_decode - sa_decode + sa_decode sa_decode sa_decode - sa_decode sa_decode sa_decode sa_decode @@ -927,6 +959,7 @@ virtual void faiss::Index::merge_from (Index &otherIndex, idx_t add_id=0) merge_from + faiss::Index::merge_from merge_from merge_from merge_from @@ -955,6 +988,7 @@ virtual void faiss::Index::check_compatible_for_merge (const Index &otherIndex) const check_compatible_for_merge + faiss::Index::check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge check_compatible_for_merge @@ -977,6 +1011,7 @@ virtual void faiss::Index::add_sa_codes (idx_t n, const uint8_t *codes, const idx_t *xids) add_sa_codes + faiss::Index::add_sa_codes add_sa_codes add_sa_codes @@ -1018,13 +1053,14 @@ - - + + bool bool faiss::gpu::GpuIndexCagra::addImplRequiresIDs_ () const override addImplRequiresIDs_ + faiss::gpu::GpuIndexCagra::addImplRequiresIDs_ addImplRequiresIDs_ @@ -1040,6 +1076,7 @@ void faiss::gpu::GpuIndexCagra::addImpl_ (idx_t n, const float *x, const idx_t *ids) override addImpl_ + faiss::gpu::GpuIndexCagra::addImpl_ addImpl_ idx_t @@ -1067,6 +1104,7 @@ void faiss::gpu::GpuIndexCagra::searchImpl_ (idx_t n, const float *x, int k, float *distances, idx_t *labels, const SearchParameters *search_params) const override searchImpl_ + faiss::gpu::GpuIndexCagra::searchImpl_ searchImpl_ idx_t @@ -1106,6 +1144,7 @@ void faiss::gpu::GpuIndex::copyFrom (const faiss::Index *index) copyFrom + faiss::gpu::GpuIndex::copyFrom const faiss::Index * index @@ -1124,6 +1163,7 @@ void faiss::gpu::GpuIndex::copyTo (faiss::Index *index) const copyTo + faiss::gpu::GpuIndex::copyTo faiss::Index * index @@ -1137,13 +1177,14 @@ - - + + float using faiss::Index::component_t = float component_t + faiss::Index::component_t @@ -1157,6 +1198,7 @@ using faiss::Index::distance_t = float distance_t + faiss::Index::distance_t @@ -1165,13 +1207,14 @@ - - + + int int faiss::Index::d d + faiss::Index::d vector dimension @@ -1186,6 +1229,7 @@ idx_t faiss::Index::ntotal ntotal + faiss::Index::ntotal total nb of indexed vectors @@ -1200,6 +1244,7 @@ bool faiss::Index::verbose verbose + faiss::Index::verbose verbosity level @@ -1214,6 +1259,7 @@ bool faiss::Index::is_trained is_trained + faiss::Index::is_trained @@ -1228,6 +1274,7 @@ MetricType faiss::Index::metric_type metric_type + faiss::Index::metric_type type of metric this index uses for search @@ -1242,6 +1289,7 @@ float faiss::Index::metric_arg metric_arg + faiss::Index::metric_arg argument of the metric type @@ -1251,12 +1299,16 @@ - + + + + + @@ -1269,16 +1321,12 @@ + + - - - - - - @@ -1288,10 +1336,6 @@ config_ - - - - @@ -1307,20 +1351,24 @@ - ivf_pq_search_params + ivf_pq_params - ivf_pq_params + ivf_pq_search_params - - - + + + - + + + + + @@ -1342,11 +1390,11 @@ faiss::gpu::GpuIndexCagracopyTo faiss::gpu::GpuIndexCagrad faiss::gpu::GpuIndexCagradistance_t - faiss::gpu::GpuIndexCagraget_distance_computer - faiss::gpu::GpuIndexCagraget_knngraph + faiss::gpu::GpuIndexCagraget_distance_computer + faiss::gpu::GpuIndexCagraget_knngraph faiss::gpu::GpuIndexCagragetDevice faiss::gpu::GpuIndexCagragetMinPagingSize - faiss::gpu::GpuIndexCagragetResources + faiss::gpu::GpuIndexCagragetResources faiss::gpu::GpuIndexCagraGpuIndex faiss::gpu::GpuIndexCagraGpuIndexCagra faiss::gpu::GpuIndexCagraIndex diff --git a/xml/structfaiss_1_1gpu_1_1GpuIndexCagraConfig.xml b/xml/structfaiss_1_1gpu_1_1GpuIndexCagraConfig.xml index 238cbc0a37..9cf06f1259 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIndexCagraConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIndexCagraConfig.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuIndexCagraConfig faiss::gpu::GpuIndexConfig - + size_t size_t faiss::gpu::GpuIndexCagraConfig::intermediate_graph_degree intermediate_graph_degree + faiss::gpu::GpuIndexCagraConfig::intermediate_graph_degree = 128 Degree of input graph for pruning. @@ -24,6 +25,7 @@ size_t faiss::gpu::GpuIndexCagraConfig::graph_degree graph_degree + faiss::gpu::GpuIndexCagraConfig::graph_degree = 64 Degree of output graph. @@ -39,6 +41,7 @@ graph_build_algo faiss::gpu::GpuIndexCagraConfig::build_algo build_algo + faiss::gpu::GpuIndexCagraConfig::build_algo = graph_build_algo::IVF_PQ ANN algorithm to build knn graph. @@ -54,6 +57,7 @@ size_t faiss::gpu::GpuIndexCagraConfig::nn_descent_niter nn_descent_niter + faiss::gpu::GpuIndexCagraConfig::nn_descent_niter = 20 Number of Iterations to run if building with NN_DESCENT. @@ -69,6 +73,7 @@ IVFPQBuildCagraConfig* faiss::gpu::GpuIndexCagraConfig::ivf_pq_params ivf_pq_params + faiss::gpu::GpuIndexCagraConfig::ivf_pq_params = nullptr @@ -83,6 +88,7 @@ IVFPQSearchCagraConfig* faiss::gpu::GpuIndexCagraConfig::ivf_pq_search_params ivf_pq_search_params + faiss::gpu::GpuIndexCagraConfig::ivf_pq_search_params = nullptr @@ -97,6 +103,7 @@ float faiss::gpu::GpuIndexCagraConfig::refine_rate refine_rate + faiss::gpu::GpuIndexCagraConfig::refine_rate = 2.0f @@ -111,6 +118,7 @@ bool faiss::gpu::GpuIndexCagraConfig::store_dataset store_dataset + faiss::gpu::GpuIndexCagraConfig::store_dataset = true @@ -125,6 +133,7 @@ int faiss::gpu::GpuIndexConfig::device device + faiss::gpu::GpuIndexConfig::device = 0 GPU device on which the index is resident. @@ -140,6 +149,7 @@ MemorySpace faiss::gpu::GpuIndexConfig::memorySpace memorySpace + faiss::gpu::GpuIndexConfig::memorySpace = MemorySpace::Device @@ -155,6 +165,7 @@ bool faiss::gpu::GpuIndexConfig::use_cuvs use_cuvs + faiss::gpu::GpuIndexConfig::use_cuvs = false Should the index dispatch down to cuVS? @@ -165,48 +176,48 @@ - + - - - - - - - - - - + + - ivf_pq_search_params + ivf_pq_params - ivf_pq_params + ivf_pq_search_params - + + + + + + + + + diff --git a/xml/structfaiss_1_1gpu_1_1GpuIndexConfig.xml b/xml/structfaiss_1_1gpu_1_1GpuIndexConfig.xml index e4b8b8cd7b..274e2f0e2c 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIndexConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIndexConfig.xml @@ -1,17 +1,18 @@ - + faiss::gpu::GpuIndexConfig faiss::gpu::GpuIndexBinaryFlatConfig faiss::gpu::GpuIndexCagraConfig faiss::gpu::GpuIndexFlatConfig faiss::gpu::GpuIndexIVFConfig - + int int faiss::gpu::GpuIndexConfig::device device + faiss::gpu::GpuIndexConfig::device = 0 GPU device on which the index is resident. @@ -27,6 +28,7 @@ MemorySpace faiss::gpu::GpuIndexConfig::memorySpace memorySpace + faiss::gpu::GpuIndexConfig::memorySpace = MemorySpace::Device @@ -42,6 +44,7 @@ bool faiss::gpu::GpuIndexConfig::use_cuvs use_cuvs + faiss::gpu::GpuIndexConfig::use_cuvs = false Should the index dispatch down to cuVS? @@ -52,25 +55,15 @@ - + - - - - - - - - - - - - - + + + @@ -80,9 +73,19 @@ - - - + + + + + + + + + + + + + @@ -92,10 +95,10 @@ - - - - + + + + diff --git a/xml/structfaiss_1_1gpu_1_1GpuIndexFlatConfig.xml b/xml/structfaiss_1_1gpu_1_1GpuIndexFlatConfig.xml index dcae91887d..e56030dca1 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIndexFlatConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIndexFlatConfig.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuIndexFlatConfig faiss::gpu::GpuIndexConfig - + bool bool faiss::gpu::GpuIndexFlatConfig::storeTransposed storeTransposed + faiss::gpu::GpuIndexFlatConfig::storeTransposed = false @@ -24,6 +25,7 @@ int faiss::gpu::GpuIndexConfig::device device + faiss::gpu::GpuIndexConfig::device = 0 GPU device on which the index is resident. @@ -39,6 +41,7 @@ MemorySpace faiss::gpu::GpuIndexConfig::memorySpace memorySpace + faiss::gpu::GpuIndexConfig::memorySpace = MemorySpace::Device @@ -54,6 +57,7 @@ bool faiss::gpu::GpuIndexConfig::use_cuvs use_cuvs + faiss::gpu::GpuIndexConfig::use_cuvs = false Should the index dispatch down to cuVS? @@ -64,13 +68,14 @@ - - + + bool bool faiss::gpu::GpuIndexFlatConfig::ALIGNED (8) useFloat16 ALIGNED + faiss::gpu::GpuIndexFlatConfig::ALIGNED 8 @@ -83,7 +88,7 @@ - + diff --git a/xml/structfaiss_1_1gpu_1_1GpuIndexIVFConfig.xml b/xml/structfaiss_1_1gpu_1_1GpuIndexIVFConfig.xml index 8d7b4d9fed..51b82daf25 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIndexIVFConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIndexIVFConfig.xml @@ -1,17 +1,18 @@ - + faiss::gpu::GpuIndexIVFConfig faiss::gpu::GpuIndexConfig faiss::gpu::GpuIndexIVFFlatConfig faiss::gpu::GpuIndexIVFPQConfig faiss::gpu::GpuIndexIVFScalarQuantizerConfig - + IndicesOptions IndicesOptions faiss::gpu::GpuIndexIVFConfig::indicesOptions indicesOptions + faiss::gpu::GpuIndexIVFConfig::indicesOptions = INDICES_64_BIT Index storage options for the GPU. @@ -27,6 +28,7 @@ GpuIndexFlatConfig faiss::gpu::GpuIndexIVFConfig::flatConfig flatConfig + faiss::gpu::GpuIndexIVFConfig::flatConfig Configuration for the coarse quantizer object. @@ -41,6 +43,7 @@ bool faiss::gpu::GpuIndexIVFConfig::allowCpuCoarseQuantizer allowCpuCoarseQuantizer + faiss::gpu::GpuIndexIVFConfig::allowCpuCoarseQuantizer = false @@ -56,6 +59,7 @@ int faiss::gpu::GpuIndexConfig::device device + faiss::gpu::GpuIndexConfig::device = 0 GPU device on which the index is resident. @@ -71,6 +75,7 @@ MemorySpace faiss::gpu::GpuIndexConfig::memorySpace memorySpace + faiss::gpu::GpuIndexConfig::memorySpace = MemorySpace::Device @@ -86,6 +91,7 @@ bool faiss::gpu::GpuIndexConfig::use_cuvs use_cuvs + faiss::gpu::GpuIndexConfig::use_cuvs = false Should the index dispatch down to cuVS? @@ -96,18 +102,12 @@ - + - - - - - - @@ -124,6 +124,12 @@ + + + + + + @@ -136,6 +142,12 @@ + + + + + + @@ -145,12 +157,6 @@ flatConfig - - - - - - diff --git a/xml/structfaiss_1_1gpu_1_1GpuIndexIVFFlatConfig.xml b/xml/structfaiss_1_1gpu_1_1GpuIndexIVFFlatConfig.xml index 81bb350e0c..422f90956c 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIndexIVFFlatConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIndexIVFFlatConfig.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuIndexIVFFlatConfig faiss::gpu::GpuIndexIVFConfig - + bool bool faiss::gpu::GpuIndexIVFFlatConfig::interleavedLayout interleavedLayout + faiss::gpu::GpuIndexIVFFlatConfig::interleavedLayout = true @@ -24,6 +25,7 @@ IndicesOptions faiss::gpu::GpuIndexIVFConfig::indicesOptions indicesOptions + faiss::gpu::GpuIndexIVFConfig::indicesOptions = INDICES_64_BIT Index storage options for the GPU. @@ -39,6 +41,7 @@ GpuIndexFlatConfig faiss::gpu::GpuIndexIVFConfig::flatConfig flatConfig + faiss::gpu::GpuIndexIVFConfig::flatConfig Configuration for the coarse quantizer object. @@ -53,6 +56,7 @@ bool faiss::gpu::GpuIndexIVFConfig::allowCpuCoarseQuantizer allowCpuCoarseQuantizer + faiss::gpu::GpuIndexIVFConfig::allowCpuCoarseQuantizer = false @@ -68,6 +72,7 @@ int faiss::gpu::GpuIndexConfig::device device + faiss::gpu::GpuIndexConfig::device = 0 GPU device on which the index is resident. @@ -83,6 +88,7 @@ MemorySpace faiss::gpu::GpuIndexConfig::memorySpace memorySpace + faiss::gpu::GpuIndexConfig::memorySpace = MemorySpace::Device @@ -98,6 +104,7 @@ bool faiss::gpu::GpuIndexConfig::use_cuvs use_cuvs + faiss::gpu::GpuIndexConfig::use_cuvs = false Should the index dispatch down to cuVS? @@ -108,7 +115,7 @@ - + @@ -136,6 +143,12 @@ + + + + + + @@ -151,12 +164,6 @@ - - - - - - diff --git a/xml/structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.xml b/xml/structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.xml index a4d987026f..ea3867c6fe 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuIndexIVFPQConfig faiss::gpu::GpuIndexIVFConfig - + bool bool faiss::gpu::GpuIndexIVFPQConfig::useFloat16LookupTables useFloat16LookupTables + faiss::gpu::GpuIndexIVFPQConfig::useFloat16LookupTables = false @@ -24,6 +25,7 @@ bool faiss::gpu::GpuIndexIVFPQConfig::usePrecomputedTables usePrecomputedTables + faiss::gpu::GpuIndexIVFPQConfig::usePrecomputedTables = false @@ -39,6 +41,7 @@ bool faiss::gpu::GpuIndexIVFPQConfig::interleavedLayout interleavedLayout + faiss::gpu::GpuIndexIVFPQConfig::interleavedLayout = false @@ -54,6 +57,7 @@ bool faiss::gpu::GpuIndexIVFPQConfig::useMMCodeDistance useMMCodeDistance + faiss::gpu::GpuIndexIVFPQConfig::useMMCodeDistance = false @@ -70,6 +74,7 @@ IndicesOptions faiss::gpu::GpuIndexIVFConfig::indicesOptions indicesOptions + faiss::gpu::GpuIndexIVFConfig::indicesOptions = INDICES_64_BIT Index storage options for the GPU. @@ -85,6 +90,7 @@ GpuIndexFlatConfig faiss::gpu::GpuIndexIVFConfig::flatConfig flatConfig + faiss::gpu::GpuIndexIVFConfig::flatConfig Configuration for the coarse quantizer object. @@ -99,6 +105,7 @@ bool faiss::gpu::GpuIndexIVFConfig::allowCpuCoarseQuantizer allowCpuCoarseQuantizer + faiss::gpu::GpuIndexIVFConfig::allowCpuCoarseQuantizer = false @@ -114,6 +121,7 @@ int faiss::gpu::GpuIndexConfig::device device + faiss::gpu::GpuIndexConfig::device = 0 GPU device on which the index is resident. @@ -129,6 +137,7 @@ MemorySpace faiss::gpu::GpuIndexConfig::memorySpace memorySpace + faiss::gpu::GpuIndexConfig::memorySpace = MemorySpace::Device @@ -144,6 +153,7 @@ bool faiss::gpu::GpuIndexConfig::use_cuvs use_cuvs + faiss::gpu::GpuIndexConfig::use_cuvs = false Should the index dispatch down to cuVS? @@ -154,18 +164,12 @@ - + - - - - - - @@ -176,18 +180,24 @@ - - + + + + + + + + @@ -197,10 +207,10 @@ flatConfig - - - - + + + + diff --git a/xml/structfaiss_1_1gpu_1_1GpuIndexIVFScalarQuantizerConfig.xml b/xml/structfaiss_1_1gpu_1_1GpuIndexIVFScalarQuantizerConfig.xml index cb3b311522..94df7c07fb 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuIndexIVFScalarQuantizerConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuIndexIVFScalarQuantizerConfig.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuIndexIVFScalarQuantizerConfig faiss::gpu::GpuIndexIVFConfig - + bool bool faiss::gpu::GpuIndexIVFScalarQuantizerConfig::interleavedLayout interleavedLayout + faiss::gpu::GpuIndexIVFScalarQuantizerConfig::interleavedLayout = true @@ -24,6 +25,7 @@ IndicesOptions faiss::gpu::GpuIndexIVFConfig::indicesOptions indicesOptions + faiss::gpu::GpuIndexIVFConfig::indicesOptions = INDICES_64_BIT Index storage options for the GPU. @@ -39,6 +41,7 @@ GpuIndexFlatConfig faiss::gpu::GpuIndexIVFConfig::flatConfig flatConfig + faiss::gpu::GpuIndexIVFConfig::flatConfig Configuration for the coarse quantizer object. @@ -53,6 +56,7 @@ bool faiss::gpu::GpuIndexIVFConfig::allowCpuCoarseQuantizer allowCpuCoarseQuantizer + faiss::gpu::GpuIndexIVFConfig::allowCpuCoarseQuantizer = false @@ -68,6 +72,7 @@ int faiss::gpu::GpuIndexConfig::device device + faiss::gpu::GpuIndexConfig::device = 0 GPU device on which the index is resident. @@ -83,6 +88,7 @@ MemorySpace faiss::gpu::GpuIndexConfig::memorySpace memorySpace + faiss::gpu::GpuIndexConfig::memorySpace = MemorySpace::Device @@ -98,6 +104,7 @@ bool faiss::gpu::GpuIndexConfig::use_cuvs use_cuvs + faiss::gpu::GpuIndexConfig::use_cuvs = false Should the index dispatch down to cuVS? @@ -108,7 +115,7 @@ - + @@ -136,6 +143,12 @@ + + + + + + @@ -145,12 +158,6 @@ flatConfig - - - - - - diff --git a/xml/structfaiss_1_1gpu_1_1GpuMemoryReservation.xml b/xml/structfaiss_1_1gpu_1_1GpuMemoryReservation.xml index 182df17d0e..c4e8b79148 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuMemoryReservation.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuMemoryReservation.xml @@ -1,14 +1,15 @@ - + faiss::gpu::GpuMemoryReservation GpuResources.h - + GpuResources * GpuResources* faiss::gpu::GpuMemoryReservation::res res + faiss::gpu::GpuMemoryReservation::res @@ -22,6 +23,7 @@ int faiss::gpu::GpuMemoryReservation::device device + faiss::gpu::GpuMemoryReservation::device @@ -35,6 +37,7 @@ cudaStream_t faiss::gpu::GpuMemoryReservation::stream stream + faiss::gpu::GpuMemoryReservation::stream @@ -48,6 +51,7 @@ void* faiss::gpu::GpuMemoryReservation::data data + faiss::gpu::GpuMemoryReservation::data @@ -61,6 +65,7 @@ size_t faiss::gpu::GpuMemoryReservation::size size + faiss::gpu::GpuMemoryReservation::size @@ -69,13 +74,14 @@ - - + + faiss::gpu::GpuMemoryReservation::GpuMemoryReservation () GpuMemoryReservation + faiss::gpu::GpuMemoryReservation::GpuMemoryReservation @@ -89,6 +95,7 @@ faiss::gpu::GpuMemoryReservation::GpuMemoryReservation (GpuResources *r, int dev, cudaStream_t str, void *p, size_t sz) GpuMemoryReservation + faiss::gpu::GpuMemoryReservation::GpuMemoryReservation GpuResources * r @@ -122,6 +129,7 @@ faiss::gpu::GpuMemoryReservation::GpuMemoryReservation (GpuMemoryReservation &&m) noexcept GpuMemoryReservation + faiss::gpu::GpuMemoryReservation::GpuMemoryReservation GpuMemoryReservation && m @@ -139,6 +147,7 @@ faiss::gpu::GpuMemoryReservation::~GpuMemoryReservation () ~GpuMemoryReservation + faiss::gpu::GpuMemoryReservation::~GpuMemoryReservation @@ -147,11 +156,12 @@ - + GpuMemoryReservation & - GpuMemoryReservation& faiss::gpu::GpuMemoryReservation::operator= + GpuMemoryReservation & faiss::gpu::GpuMemoryReservation::operator= (GpuMemoryReservation &&m) operator= + faiss::gpu::GpuMemoryReservation::operator= GpuMemoryReservation && m @@ -164,11 +174,12 @@ - + void * - void* faiss::gpu::GpuMemoryReservation::get + void * faiss::gpu::GpuMemoryReservation::get () get + faiss::gpu::GpuMemoryReservation::get @@ -182,6 +193,7 @@ void faiss::gpu::GpuMemoryReservation::release () release + faiss::gpu::GpuMemoryReservation::release @@ -190,17 +202,13 @@ - + A RAII object that manages a temporary memory request. - - - - @@ -208,16 +216,20 @@ res + + + + faiss::gpu::GpuMemoryReservationdata faiss::gpu::GpuMemoryReservationdevice - faiss::gpu::GpuMemoryReservationget + faiss::gpu::GpuMemoryReservationget faiss::gpu::GpuMemoryReservationGpuMemoryReservation faiss::gpu::GpuMemoryReservationGpuMemoryReservation faiss::gpu::GpuMemoryReservationGpuMemoryReservation - faiss::gpu::GpuMemoryReservationoperator= + faiss::gpu::GpuMemoryReservationoperator= faiss::gpu::GpuMemoryReservationrelease faiss::gpu::GpuMemoryReservationres faiss::gpu::GpuMemoryReservationsize diff --git a/xml/structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.xml b/xml/structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.xml index e58b46a501..ba68140390 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuMultipleClonerOptions faiss::gpu::GpuClonerOptions faiss::gpu::ToGpuClonerMultiple - + bool bool faiss::gpu::GpuMultipleClonerOptions::shard shard + faiss::gpu::GpuMultipleClonerOptions::shard = false @@ -25,6 +26,7 @@ int faiss::gpu::GpuMultipleClonerOptions::shard_type shard_type + faiss::gpu::GpuMultipleClonerOptions::shard_type = 1 IndexIVF::copy_subset_to subset type. @@ -40,6 +42,7 @@ bool faiss::gpu::GpuMultipleClonerOptions::common_ivf_quantizer common_ivf_quantizer + faiss::gpu::GpuMultipleClonerOptions::common_ivf_quantizer = false @@ -55,6 +58,7 @@ IndicesOptions faiss::gpu::GpuClonerOptions::indicesOptions indicesOptions + faiss::gpu::GpuClonerOptions::indicesOptions = INDICES_64_BIT @@ -70,6 +74,7 @@ bool faiss::gpu::GpuClonerOptions::useFloat16CoarseQuantizer useFloat16CoarseQuantizer + faiss::gpu::GpuClonerOptions::useFloat16CoarseQuantizer = false is the coarse quantizer in float16? @@ -85,6 +90,7 @@ bool faiss::gpu::GpuClonerOptions::useFloat16 useFloat16 + faiss::gpu::GpuClonerOptions::useFloat16 = false @@ -100,6 +106,7 @@ bool faiss::gpu::GpuClonerOptions::usePrecomputed usePrecomputed + faiss::gpu::GpuClonerOptions::usePrecomputed = false use precomputed tables? @@ -115,6 +122,7 @@ long faiss::gpu::GpuClonerOptions::reserveVecs reserveVecs + faiss::gpu::GpuClonerOptions::reserveVecs = 0 reserve vectors in the invfiles? @@ -130,6 +138,7 @@ bool faiss::gpu::GpuClonerOptions::storeTransposed storeTransposed + faiss::gpu::GpuClonerOptions::storeTransposed = false For GpuIndexFlat, store data in transposed layout? @@ -145,6 +154,7 @@ bool faiss::gpu::GpuClonerOptions::verbose verbose + faiss::gpu::GpuClonerOptions::verbose = false Set verbose options on the index. @@ -160,6 +170,7 @@ bool faiss::gpu::GpuClonerOptions::use_cuvs use_cuvs + faiss::gpu::GpuClonerOptions::use_cuvs = false use the cuVS implementation @@ -175,6 +186,7 @@ bool faiss::gpu::GpuClonerOptions::allowCpuCoarseQuantizer allowCpuCoarseQuantizer + faiss::gpu::GpuClonerOptions::allowCpuCoarseQuantizer = false @@ -185,22 +197,22 @@ - + + + + + - - - - @@ -209,16 +221,16 @@ + + + + - - - - diff --git a/xml/structfaiss_1_1gpu_1_1GpuParameterSpace.xml b/xml/structfaiss_1_1gpu_1_1GpuParameterSpace.xml index 45f5980ce0..0d68a5aaeb 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuParameterSpace.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuParameterSpace.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuParameterSpace faiss::ParameterSpace GpuAutoTune.h - + void void faiss::gpu::GpuParameterSpace::initialize (const faiss::Index *index) override initialize + faiss::gpu::GpuParameterSpace::initialize initialize const faiss::Index * @@ -29,6 +30,7 @@ void faiss::gpu::GpuParameterSpace::set_index_parameter (faiss::Index *index, const std::string &name, double val) const override set_index_parameter + faiss::gpu::GpuParameterSpace::set_index_parameter set_index_parameter faiss::Index * @@ -56,6 +58,7 @@ size_t faiss::ParameterSpace::n_combinations () const n_combinations + faiss::ParameterSpace::n_combinations nb of combinations, = product of values sizes @@ -70,6 +73,7 @@ bool faiss::ParameterSpace::combination_ge (size_t c1, size_t c2) const combination_ge + faiss::ParameterSpace::combination_ge size_t c1 @@ -92,6 +96,7 @@ std::string faiss::ParameterSpace::combination_name (size_t cno) const combination_name + faiss::ParameterSpace::combination_name size_t cno @@ -110,6 +115,7 @@ void faiss::ParameterSpace::display () const display + faiss::ParameterSpace::display print a description on stdout @@ -119,11 +125,12 @@ - + ParameterRange & - ParameterRange& faiss::ParameterSpace::add_range + ParameterRange & faiss::ParameterSpace::add_range (const std::string &name) add_range + faiss::ParameterSpace::add_range const std::string & name @@ -142,6 +149,7 @@ void faiss::ParameterSpace::set_index_parameters (Index *index, size_t cno) const set_index_parameters + faiss::ParameterSpace::set_index_parameters Index * index @@ -164,6 +172,7 @@ void faiss::ParameterSpace::set_index_parameters (Index *index, const char *param_string) const set_index_parameters + faiss::ParameterSpace::set_index_parameters Index * index @@ -186,6 +195,7 @@ void faiss::ParameterSpace::update_bounds (size_t cno, const OperatingPoint &op, double *upper_bound_perf, double *lower_bound_t) const update_bounds + faiss::ParameterSpace::update_bounds size_t cno @@ -216,6 +226,7 @@ void faiss::ParameterSpace::explore (Index *index, size_t nq, const float *xq, const AutoTuneCriterion &crit, OperatingPoints *ops) const explore + faiss::ParameterSpace::explore Index * index @@ -278,13 +289,14 @@ - - + + std::vector< ParameterRange > std::vector<ParameterRange> faiss::ParameterSpace::parameter_ranges parameter_ranges + faiss::ParameterSpace::parameter_ranges all tunable parameters @@ -299,6 +311,7 @@ int faiss::ParameterSpace::verbose verbose + faiss::ParameterSpace::verbose verbosity during exploration @@ -313,6 +326,7 @@ int faiss::ParameterSpace::n_experiments n_experiments + faiss::ParameterSpace::n_experiments nb of experiments during optimization (0 = try all combinations) @@ -327,6 +341,7 @@ size_t faiss::ParameterSpace::batchsize batchsize + faiss::ParameterSpace::batchsize maximum number of queries to submit at a time. @@ -341,6 +356,7 @@ bool faiss::ParameterSpace::thread_over_batches thread_over_batches + faiss::ParameterSpace::thread_over_batches @@ -355,6 +371,7 @@ double faiss::ParameterSpace::min_test_duration min_test_duration + faiss::ParameterSpace::min_test_duration @@ -364,7 +381,7 @@ - + parameter space and setters for GPU indexes @@ -396,7 +413,7 @@ - faiss::gpu::GpuParameterSpaceadd_range + faiss::gpu::GpuParameterSpaceadd_range faiss::gpu::GpuParameterSpacebatchsize faiss::gpu::GpuParameterSpacecombination_ge faiss::gpu::GpuParameterSpacecombination_name diff --git a/xml/structfaiss_1_1gpu_1_1GpuProgressiveDimIndexFactory.xml b/xml/structfaiss_1_1gpu_1_1GpuProgressiveDimIndexFactory.xml index 301deac085..daff2a5a16 100644 --- a/xml/structfaiss_1_1gpu_1_1GpuProgressiveDimIndexFactory.xml +++ b/xml/structfaiss_1_1gpu_1_1GpuProgressiveDimIndexFactory.xml @@ -1,15 +1,16 @@ - + faiss::gpu::GpuProgressiveDimIndexFactory faiss::ProgressiveDimIndexFactory GpuCloner.h - + GpuMultipleClonerOptions GpuMultipleClonerOptions faiss::gpu::GpuProgressiveDimIndexFactory::options options + faiss::gpu::GpuProgressiveDimIndexFactory::options @@ -23,6 +24,7 @@ std::vector<GpuResourcesProvider*> faiss::gpu::GpuProgressiveDimIndexFactory::vres vres + faiss::gpu::GpuProgressiveDimIndexFactory::vres @@ -36,6 +38,7 @@ std::vector<int> faiss::gpu::GpuProgressiveDimIndexFactory::devices devices + faiss::gpu::GpuProgressiveDimIndexFactory::devices @@ -49,6 +52,7 @@ int faiss::gpu::GpuProgressiveDimIndexFactory::ncall ncall + faiss::gpu::GpuProgressiveDimIndexFactory::ncall @@ -57,13 +61,14 @@ - - + + faiss::gpu::GpuProgressiveDimIndexFactory::GpuProgressiveDimIndexFactory (int ngpu) GpuProgressiveDimIndexFactory + faiss::gpu::GpuProgressiveDimIndexFactory::GpuProgressiveDimIndexFactory int ngpu @@ -76,12 +81,13 @@ - + Index * - Index* faiss::gpu::GpuProgressiveDimIndexFactory::operator() + Index * faiss::gpu::GpuProgressiveDimIndexFactory::operator() (int dim) override operator() - operator() + faiss::gpu::GpuProgressiveDimIndexFactory::operator() + operator() int dim @@ -100,6 +106,7 @@ virtual faiss::gpu::GpuProgressiveDimIndexFactory::~GpuProgressiveDimIndexFactory () override ~GpuProgressiveDimIndexFactory + faiss::gpu::GpuProgressiveDimIndexFactory::~GpuProgressiveDimIndexFactory @@ -108,7 +115,7 @@ - + index factory for the ProgressiveDimClustering object @@ -127,16 +134,20 @@ + + + + + + + + - - - - @@ -146,17 +157,13 @@ options - - - - faiss::gpu::GpuProgressiveDimIndexFactorydevices faiss::gpu::GpuProgressiveDimIndexFactoryGpuProgressiveDimIndexFactory faiss::gpu::GpuProgressiveDimIndexFactoryncall - faiss::gpu::GpuProgressiveDimIndexFactoryoperator() + faiss::gpu::GpuProgressiveDimIndexFactoryoperator() faiss::gpu::GpuProgressiveDimIndexFactoryoptions faiss::gpu::GpuProgressiveDimIndexFactoryvres faiss::gpu::GpuProgressiveDimIndexFactory~GpuProgressiveDimIndexFactory diff --git a/xml/structfaiss_1_1gpu_1_1IVFPQBuildCagraConfig.xml b/xml/structfaiss_1_1gpu_1_1IVFPQBuildCagraConfig.xml index 4acd4db2d5..d615ad8ad3 100644 --- a/xml/structfaiss_1_1gpu_1_1IVFPQBuildCagraConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1IVFPQBuildCagraConfig.xml @@ -1,13 +1,14 @@ - + faiss::gpu::IVFPQBuildCagraConfig - + uint32_t uint32_t faiss::gpu::IVFPQBuildCagraConfig::n_lists n_lists + faiss::gpu::IVFPQBuildCagraConfig::n_lists = 1024 @@ -24,6 +25,7 @@ uint32_t faiss::gpu::IVFPQBuildCagraConfig::kmeans_n_iters kmeans_n_iters + faiss::gpu::IVFPQBuildCagraConfig::kmeans_n_iters = 20 The number of iterations searching for kmeans centers (index building). @@ -39,6 +41,7 @@ double faiss::gpu::IVFPQBuildCagraConfig::kmeans_trainset_fraction kmeans_trainset_fraction + faiss::gpu::IVFPQBuildCagraConfig::kmeans_trainset_fraction = 0.5 The fraction of data to use during iterative kmeans building. @@ -54,6 +57,7 @@ uint32_t faiss::gpu::IVFPQBuildCagraConfig::pq_bits pq_bits + faiss::gpu::IVFPQBuildCagraConfig::pq_bits = 8 @@ -71,6 +75,7 @@ uint32_t faiss::gpu::IVFPQBuildCagraConfig::pq_dim pq_dim + faiss::gpu::IVFPQBuildCagraConfig::pq_dim = 0 @@ -88,6 +93,7 @@ codebook_gen faiss::gpu::IVFPQBuildCagraConfig::codebook_kind codebook_kind + faiss::gpu::IVFPQBuildCagraConfig::codebook_kind = codebook_gen::PER_SUBSPACE How PQ codebooks are created. @@ -103,6 +109,7 @@ bool faiss::gpu::IVFPQBuildCagraConfig::force_random_rotation force_random_rotation + faiss::gpu::IVFPQBuildCagraConfig::force_random_rotation = false @@ -120,6 +127,7 @@ bool faiss::gpu::IVFPQBuildCagraConfig::conservative_memory_allocation conservative_memory_allocation + faiss::gpu::IVFPQBuildCagraConfig::conservative_memory_allocation = false @@ -131,7 +139,7 @@ - + diff --git a/xml/structfaiss_1_1gpu_1_1IVFPQSearchCagraConfig.xml b/xml/structfaiss_1_1gpu_1_1IVFPQSearchCagraConfig.xml index 4b9c648de6..e0eefeba65 100644 --- a/xml/structfaiss_1_1gpu_1_1IVFPQSearchCagraConfig.xml +++ b/xml/structfaiss_1_1gpu_1_1IVFPQSearchCagraConfig.xml @@ -1,13 +1,14 @@ - + faiss::gpu::IVFPQSearchCagraConfig - + uint32_t uint32_t faiss::gpu::IVFPQSearchCagraConfig::n_probes n_probes + faiss::gpu::IVFPQSearchCagraConfig::n_probes = 20 The number of clusters to search. @@ -23,6 +24,7 @@ cudaDataType_t faiss::gpu::IVFPQSearchCagraConfig::lut_dtype lut_dtype + faiss::gpu::IVFPQSearchCagraConfig::lut_dtype = CUDA_R_32F @@ -40,6 +42,7 @@ cudaDataType_t faiss::gpu::IVFPQSearchCagraConfig::internal_distance_dtype internal_distance_dtype + faiss::gpu::IVFPQSearchCagraConfig::internal_distance_dtype = CUDA_R_32F @@ -57,6 +60,7 @@ double faiss::gpu::IVFPQSearchCagraConfig::preferred_shmem_carveout preferred_shmem_carveout + faiss::gpu::IVFPQSearchCagraConfig::preferred_shmem_carveout = 1.0 @@ -70,7 +74,7 @@ - + diff --git a/xml/structfaiss_1_1gpu_1_1IndexWrapper.xml b/xml/structfaiss_1_1gpu_1_1IndexWrapper.xml index e950502219..075039fa63 100644 --- a/xml/structfaiss_1_1gpu_1_1IndexWrapper.xml +++ b/xml/structfaiss_1_1gpu_1_1IndexWrapper.xml @@ -1,5 +1,5 @@ - + faiss::gpu::IndexWrapper @@ -7,12 +7,13 @@ typename GpuIndex - + std::vector< std::unique_ptr< faiss::gpu::StandardGpuResources > > std::vector<std::unique_ptr<faiss::gpu::StandardGpuResources> > faiss::gpu::IndexWrapper< GpuIndex >::resources resources + faiss::gpu::IndexWrapper::resources @@ -26,6 +27,7 @@ std::vector<std::unique_ptr<GpuIndex> > faiss::gpu::IndexWrapper< GpuIndex >::subIndex subIndex + faiss::gpu::IndexWrapper::subIndex @@ -39,6 +41,7 @@ std::unique_ptr<faiss::IndexReplicas> faiss::gpu::IndexWrapper< GpuIndex >::replicaIndex replicaIndex + faiss::gpu::IndexWrapper::replicaIndex @@ -47,13 +50,14 @@ - - + + faiss::gpu::IndexWrapper< GpuIndex >::IndexWrapper (int numGpus, std::function< std::unique_ptr< GpuIndex >(GpuResourcesProvider *, int)> init) IndexWrapper + faiss::gpu::IndexWrapper::IndexWrapper int numGpus @@ -75,6 +79,7 @@ faiss::Index * faiss::gpu::IndexWrapper< GpuIndex >::getIndex () getIndex + faiss::gpu::IndexWrapper::getIndex @@ -88,6 +93,7 @@ void faiss::gpu::IndexWrapper< GpuIndex >::runOnIndices (std::function< void(GpuIndex *)> f) runOnIndices + faiss::gpu::IndexWrapper::runOnIndices std::function< void(GpuIndex *)> f @@ -105,6 +111,7 @@ void faiss::gpu::IndexWrapper< GpuIndex >::setNumProbes (size_t nprobe) setNumProbes + faiss::gpu::IndexWrapper::setNumProbes size_t nprobe @@ -117,7 +124,7 @@ - + diff --git a/xml/structfaiss_1_1gpu_1_1SearchParametersCagra.xml b/xml/structfaiss_1_1gpu_1_1SearchParametersCagra.xml index e9c570cd1a..c2fca6fcd8 100644 --- a/xml/structfaiss_1_1gpu_1_1SearchParametersCagra.xml +++ b/xml/structfaiss_1_1gpu_1_1SearchParametersCagra.xml @@ -1,14 +1,15 @@ - + faiss::gpu::SearchParametersCagra faiss::SearchParameters - + size_t size_t faiss::gpu::SearchParametersCagra::max_queries max_queries + faiss::gpu::SearchParametersCagra::max_queries = 0 @@ -24,6 +25,7 @@ size_t faiss::gpu::SearchParametersCagra::itopk_size itopk_size + faiss::gpu::SearchParametersCagra::itopk_size = 64 @@ -40,6 +42,7 @@ size_t faiss::gpu::SearchParametersCagra::max_iterations max_iterations + faiss::gpu::SearchParametersCagra::max_iterations = 0 Upper limit of search iterations. Auto select when 0. @@ -55,6 +58,7 @@ search_algo faiss::gpu::SearchParametersCagra::algo algo + faiss::gpu::SearchParametersCagra::algo = search_algo::AUTO Which search implementation to use. @@ -70,6 +74,7 @@ size_t faiss::gpu::SearchParametersCagra::team_size team_size + faiss::gpu::SearchParametersCagra::team_size = 0 Number of threads used to calculate a single distance. 4, 8, 16, or 32. @@ -85,6 +90,7 @@ size_t faiss::gpu::SearchParametersCagra::search_width search_width + faiss::gpu::SearchParametersCagra::search_width = 1 @@ -100,6 +106,7 @@ size_t faiss::gpu::SearchParametersCagra::min_iterations min_iterations + faiss::gpu::SearchParametersCagra::min_iterations = 0 Lower limit of search iterations. @@ -115,6 +122,7 @@ size_t faiss::gpu::SearchParametersCagra::thread_block_size thread_block_size + faiss::gpu::SearchParametersCagra::thread_block_size = 0 Thread block size. 0, 64, 128, 256, 512, 1024. Auto selection when 0. @@ -130,6 +138,7 @@ hash_mode faiss::gpu::SearchParametersCagra::hashmap_mode hashmap_mode + faiss::gpu::SearchParametersCagra::hashmap_mode = hash_mode::AUTO Hashmap type. Auto selection when AUTO. @@ -145,6 +154,7 @@ size_t faiss::gpu::SearchParametersCagra::hashmap_min_bitlen hashmap_min_bitlen + faiss::gpu::SearchParametersCagra::hashmap_min_bitlen = 0 Lower limit of hashmap bit length. More than 8. @@ -160,6 +170,7 @@ float faiss::gpu::SearchParametersCagra::hashmap_max_fill_rate hashmap_max_fill_rate + faiss::gpu::SearchParametersCagra::hashmap_max_fill_rate = 0.5 Upper limit of hashmap fill rate. More than 0.1, less than 0.9. @@ -175,6 +186,7 @@ uint32_t faiss::gpu::SearchParametersCagra::num_random_samplings num_random_samplings + faiss::gpu::SearchParametersCagra::num_random_samplings = 1 Number of iterations of initial random seed node selection. 1 or more. @@ -190,6 +202,7 @@ uint64_t faiss::gpu::SearchParametersCagra::seed seed + faiss::gpu::SearchParametersCagra::seed = 0x128394 Bit mask used for initial random seed node selection. @@ -205,6 +218,7 @@ IDSelector* faiss::SearchParameters::sel sel + faiss::SearchParameters::sel = nullptr if non-null, only these IDs will be considered during search. @@ -215,7 +229,7 @@ - + @@ -233,6 +247,10 @@ + + + + @@ -240,10 +258,6 @@ sel - - - - diff --git a/xml/structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.xml b/xml/structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.xml index 1bc475fe87..17c586c915 100644 --- a/xml/structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.xml +++ b/xml/structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.xml @@ -1,14 +1,15 @@ - + faiss::gpu::StackDeviceMemory::Range StackDeviceMemory.h - + char * char* faiss::gpu::StackDeviceMemory::Range::start_ start_ + faiss::gpu::StackDeviceMemory::Range::start_ @@ -22,6 +23,7 @@ char* faiss::gpu::StackDeviceMemory::Range::end_ end_ + faiss::gpu::StackDeviceMemory::Range::end_ @@ -35,6 +37,7 @@ cudaStream_t faiss::gpu::StackDeviceMemory::Range::stream_ stream_ + faiss::gpu::StackDeviceMemory::Range::stream_ @@ -43,13 +46,14 @@ - - + + faiss::gpu::StackDeviceMemory::Range::Range (char *s, char *e, cudaStream_t str) Range + faiss::gpu::StackDeviceMemory::Range::Range char * s @@ -70,7 +74,7 @@ - + diff --git a/xml/structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.xml b/xml/structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.xml index a8de8babc7..18a0746a52 100644 --- a/xml/structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.xml +++ b/xml/structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.xml @@ -1,13 +1,14 @@ - + faiss::gpu::StackDeviceMemory::Stack - + GpuResources * GpuResources* faiss::gpu::StackDeviceMemory::Stack::res_ res_ + faiss::gpu::StackDeviceMemory::Stack::res_ Our GpuResources object. @@ -22,6 +23,7 @@ int faiss::gpu::StackDeviceMemory::Stack::device_ device_ + faiss::gpu::StackDeviceMemory::Stack::device_ Device this allocation is on. @@ -36,6 +38,7 @@ char* faiss::gpu::StackDeviceMemory::Stack::alloc_ alloc_ + faiss::gpu::StackDeviceMemory::Stack::alloc_ @@ -50,6 +53,7 @@ size_t faiss::gpu::StackDeviceMemory::Stack::allocSize_ allocSize_ + faiss::gpu::StackDeviceMemory::Stack::allocSize_ Total size of our allocation. @@ -64,6 +68,7 @@ char* faiss::gpu::StackDeviceMemory::Stack::start_ start_ + faiss::gpu::StackDeviceMemory::Stack::start_ Our temporary memory region; [start_, end_) is valid. @@ -78,6 +83,7 @@ char* faiss::gpu::StackDeviceMemory::Stack::end_ end_ + faiss::gpu::StackDeviceMemory::Stack::end_ @@ -91,6 +97,7 @@ char* faiss::gpu::StackDeviceMemory::Stack::head_ head_ + faiss::gpu::StackDeviceMemory::Stack::head_ Stack head within [start, end) @@ -105,6 +112,7 @@ std::list<Range> faiss::gpu::StackDeviceMemory::Stack::lastUsers_ lastUsers_ + faiss::gpu::StackDeviceMemory::Stack::lastUsers_ @@ -119,6 +127,7 @@ size_t faiss::gpu::StackDeviceMemory::Stack::highWaterMemoryUsed_ highWaterMemoryUsed_ + faiss::gpu::StackDeviceMemory::Stack::highWaterMemoryUsed_ @@ -128,13 +137,14 @@ - - + + faiss::gpu::StackDeviceMemory::Stack::Stack (GpuResources *res, int device, size_t size) Stack + faiss::gpu::StackDeviceMemory::Stack::Stack GpuResources * res @@ -161,6 +171,7 @@ faiss::gpu::StackDeviceMemory::Stack::~Stack () ~Stack + faiss::gpu::StackDeviceMemory::Stack::~Stack @@ -174,6 +185,7 @@ size_t faiss::gpu::StackDeviceMemory::Stack::getSizeAvailable () const getSizeAvailable + faiss::gpu::StackDeviceMemory::Stack::getSizeAvailable @@ -183,11 +195,12 @@ - + char * - char* faiss::gpu::StackDeviceMemory::Stack::getAlloc + char * faiss::gpu::StackDeviceMemory::Stack::getAlloc (size_t size, cudaStream_t stream) getAlloc + faiss::gpu::StackDeviceMemory::Stack::getAlloc size_t size @@ -210,6 +223,7 @@ void faiss::gpu::StackDeviceMemory::Stack::returnAlloc (char *p, size_t size, cudaStream_t stream) returnAlloc + faiss::gpu::StackDeviceMemory::Stack::returnAlloc char * p @@ -236,6 +250,7 @@ std::string faiss::gpu::StackDeviceMemory::Stack::toString () const toString + faiss::gpu::StackDeviceMemory::Stack::toString Returns the stack state. @@ -245,7 +260,7 @@ - + @@ -269,7 +284,7 @@ faiss::gpu::StackDeviceMemory::StackallocSize_ faiss::gpu::StackDeviceMemory::Stackdevice_ faiss::gpu::StackDeviceMemory::Stackend_ - faiss::gpu::StackDeviceMemory::StackgetAlloc + faiss::gpu::StackDeviceMemory::StackgetAlloc faiss::gpu::StackDeviceMemory::StackgetSizeAvailable faiss::gpu::StackDeviceMemory::Stackhead_ faiss::gpu::StackDeviceMemory::StackhighWaterMemoryUsed_ diff --git a/xml/structfaiss_1_1gpu_1_1ToCPUCloner.xml b/xml/structfaiss_1_1gpu_1_1ToCPUCloner.xml index b3c4db378f..c7a269c63d 100644 --- a/xml/structfaiss_1_1gpu_1_1ToCPUCloner.xml +++ b/xml/structfaiss_1_1gpu_1_1ToCPUCloner.xml @@ -1,15 +1,16 @@ - + faiss::gpu::ToCPUCloner faiss::Cloner GpuCloner.h - + void void faiss::gpu::ToCPUCloner::merge_index (Index *dst, Index *src, bool successive_ids) merge_index + faiss::gpu::ToCPUCloner::merge_index Index * dst @@ -30,12 +31,13 @@ - + Index * - Index* faiss::gpu::ToCPUCloner::clone_Index + Index * faiss::gpu::ToCPUCloner::clone_Index (const Index *index) override clone_Index - clone_Index + faiss::gpu::ToCPUCloner::clone_Index + clone_Index const Index * index @@ -48,11 +50,12 @@ - + VectorTransform * - virtual VectorTransform* faiss::Cloner::clone_VectorTransform + virtual VectorTransform * faiss::Cloner::clone_VectorTransform (const VectorTransform *) clone_VectorTransform + faiss::Cloner::clone_VectorTransform const VectorTransform * @@ -64,11 +67,12 @@ - + IndexIVF * - virtual IndexIVF* faiss::Cloner::clone_IndexIVF + virtual IndexIVF * faiss::Cloner::clone_IndexIVF (const IndexIVF *) clone_IndexIVF + faiss::Cloner::clone_IndexIVF const IndexIVF * @@ -80,7 +84,7 @@ - + Cloner specialized for GPU -> CPU. @@ -112,9 +116,9 @@ - faiss::gpu::ToCPUClonerclone_Index - faiss::gpu::ToCPUClonerclone_IndexIVF - faiss::gpu::ToCPUClonerclone_VectorTransform + faiss::gpu::ToCPUClonerclone_Index + faiss::gpu::ToCPUClonerclone_IndexIVF + faiss::gpu::ToCPUClonerclone_VectorTransform faiss::gpu::ToCPUClonermerge_index faiss::gpu::ToCPUCloner~Cloner diff --git a/xml/structfaiss_1_1gpu_1_1ToGpuCloner.xml b/xml/structfaiss_1_1gpu_1_1ToGpuCloner.xml index 12c72de3a8..2246e26a3d 100644 --- a/xml/structfaiss_1_1gpu_1_1ToGpuCloner.xml +++ b/xml/structfaiss_1_1gpu_1_1ToGpuCloner.xml @@ -1,16 +1,17 @@ - + faiss::gpu::ToGpuCloner faiss::Cloner faiss::gpu::GpuClonerOptions GpuCloner.h - + GpuResourcesProvider * GpuResourcesProvider* faiss::gpu::ToGpuCloner::provider provider + faiss::gpu::ToGpuCloner::provider @@ -24,6 +25,7 @@ int faiss::gpu::ToGpuCloner::device device + faiss::gpu::ToGpuCloner::device @@ -37,6 +39,7 @@ IndicesOptions faiss::gpu::GpuClonerOptions::indicesOptions indicesOptions + faiss::gpu::GpuClonerOptions::indicesOptions = INDICES_64_BIT @@ -52,6 +55,7 @@ bool faiss::gpu::GpuClonerOptions::useFloat16CoarseQuantizer useFloat16CoarseQuantizer + faiss::gpu::GpuClonerOptions::useFloat16CoarseQuantizer = false is the coarse quantizer in float16? @@ -67,6 +71,7 @@ bool faiss::gpu::GpuClonerOptions::useFloat16 useFloat16 + faiss::gpu::GpuClonerOptions::useFloat16 = false @@ -82,6 +87,7 @@ bool faiss::gpu::GpuClonerOptions::usePrecomputed usePrecomputed + faiss::gpu::GpuClonerOptions::usePrecomputed = false use precomputed tables? @@ -97,6 +103,7 @@ long faiss::gpu::GpuClonerOptions::reserveVecs reserveVecs + faiss::gpu::GpuClonerOptions::reserveVecs = 0 reserve vectors in the invfiles? @@ -112,6 +119,7 @@ bool faiss::gpu::GpuClonerOptions::storeTransposed storeTransposed + faiss::gpu::GpuClonerOptions::storeTransposed = false For GpuIndexFlat, store data in transposed layout? @@ -127,6 +135,7 @@ bool faiss::gpu::GpuClonerOptions::verbose verbose + faiss::gpu::GpuClonerOptions::verbose = false Set verbose options on the index. @@ -142,6 +151,7 @@ bool faiss::gpu::GpuClonerOptions::use_cuvs use_cuvs + faiss::gpu::GpuClonerOptions::use_cuvs = false use the cuVS implementation @@ -157,6 +167,7 @@ bool faiss::gpu::GpuClonerOptions::allowCpuCoarseQuantizer allowCpuCoarseQuantizer + faiss::gpu::GpuClonerOptions::allowCpuCoarseQuantizer = false @@ -167,13 +178,14 @@ - - + + faiss::gpu::ToGpuCloner::ToGpuCloner (GpuResourcesProvider *prov, int device, const GpuClonerOptions &options) ToGpuCloner + faiss::gpu::ToGpuCloner::ToGpuCloner GpuResourcesProvider * prov @@ -194,12 +206,13 @@ - + Index * - Index* faiss::gpu::ToGpuCloner::clone_Index + Index * faiss::gpu::ToGpuCloner::clone_Index (const Index *index) override clone_Index - clone_Index + faiss::gpu::ToGpuCloner::clone_Index + clone_Index const Index * index @@ -212,11 +225,12 @@ - + VectorTransform * - virtual VectorTransform* faiss::Cloner::clone_VectorTransform + virtual VectorTransform * faiss::Cloner::clone_VectorTransform (const VectorTransform *) clone_VectorTransform + faiss::Cloner::clone_VectorTransform const VectorTransform * @@ -228,11 +242,12 @@ - + IndexIVF * - virtual IndexIVF* faiss::Cloner::clone_IndexIVF + virtual IndexIVF * faiss::Cloner::clone_IndexIVF (const IndexIVF *) clone_IndexIVF + faiss::Cloner::clone_IndexIVF const IndexIVF * @@ -244,7 +259,7 @@ - + Cloner specialized for CPU -> 1 GPU. @@ -273,14 +288,14 @@ - - - - + + + + @@ -296,9 +311,9 @@ faiss::gpu::ToGpuClonerallowCpuCoarseQuantizer - faiss::gpu::ToGpuClonerclone_Index - faiss::gpu::ToGpuClonerclone_IndexIVF - faiss::gpu::ToGpuClonerclone_VectorTransform + faiss::gpu::ToGpuClonerclone_Index + faiss::gpu::ToGpuClonerclone_IndexIVF + faiss::gpu::ToGpuClonerclone_VectorTransform faiss::gpu::ToGpuClonerdevice faiss::gpu::ToGpuClonerindicesOptions faiss::gpu::ToGpuClonerprovider diff --git a/xml/structfaiss_1_1gpu_1_1ToGpuClonerMultiple.xml b/xml/structfaiss_1_1gpu_1_1ToGpuClonerMultiple.xml index d029fa47fc..2af51f3758 100644 --- a/xml/structfaiss_1_1gpu_1_1ToGpuClonerMultiple.xml +++ b/xml/structfaiss_1_1gpu_1_1ToGpuClonerMultiple.xml @@ -1,16 +1,17 @@ - + faiss::gpu::ToGpuClonerMultiple faiss::Cloner faiss::gpu::GpuMultipleClonerOptions GpuCloner.h - + std::vector< ToGpuCloner > std::vector<ToGpuCloner> faiss::gpu::ToGpuClonerMultiple::sub_cloners sub_cloners + faiss::gpu::ToGpuClonerMultiple::sub_cloners @@ -24,6 +25,7 @@ bool faiss::gpu::GpuMultipleClonerOptions::shard shard + faiss::gpu::GpuMultipleClonerOptions::shard = false @@ -39,6 +41,7 @@ int faiss::gpu::GpuMultipleClonerOptions::shard_type shard_type + faiss::gpu::GpuMultipleClonerOptions::shard_type = 1 IndexIVF::copy_subset_to subset type. @@ -54,6 +57,7 @@ bool faiss::gpu::GpuMultipleClonerOptions::common_ivf_quantizer common_ivf_quantizer + faiss::gpu::GpuMultipleClonerOptions::common_ivf_quantizer = false @@ -69,6 +73,7 @@ IndicesOptions faiss::gpu::GpuClonerOptions::indicesOptions indicesOptions + faiss::gpu::GpuClonerOptions::indicesOptions = INDICES_64_BIT @@ -84,6 +89,7 @@ bool faiss::gpu::GpuClonerOptions::useFloat16CoarseQuantizer useFloat16CoarseQuantizer + faiss::gpu::GpuClonerOptions::useFloat16CoarseQuantizer = false is the coarse quantizer in float16? @@ -99,6 +105,7 @@ bool faiss::gpu::GpuClonerOptions::useFloat16 useFloat16 + faiss::gpu::GpuClonerOptions::useFloat16 = false @@ -114,6 +121,7 @@ bool faiss::gpu::GpuClonerOptions::usePrecomputed usePrecomputed + faiss::gpu::GpuClonerOptions::usePrecomputed = false use precomputed tables? @@ -129,6 +137,7 @@ long faiss::gpu::GpuClonerOptions::reserveVecs reserveVecs + faiss::gpu::GpuClonerOptions::reserveVecs = 0 reserve vectors in the invfiles? @@ -144,6 +153,7 @@ bool faiss::gpu::GpuClonerOptions::storeTransposed storeTransposed + faiss::gpu::GpuClonerOptions::storeTransposed = false For GpuIndexFlat, store data in transposed layout? @@ -159,6 +169,7 @@ bool faiss::gpu::GpuClonerOptions::verbose verbose + faiss::gpu::GpuClonerOptions::verbose = false Set verbose options on the index. @@ -174,6 +185,7 @@ bool faiss::gpu::GpuClonerOptions::use_cuvs use_cuvs + faiss::gpu::GpuClonerOptions::use_cuvs = false use the cuVS implementation @@ -189,6 +201,7 @@ bool faiss::gpu::GpuClonerOptions::allowCpuCoarseQuantizer allowCpuCoarseQuantizer + faiss::gpu::GpuClonerOptions::allowCpuCoarseQuantizer = false @@ -199,13 +212,14 @@ - - + + faiss::gpu::ToGpuClonerMultiple::ToGpuClonerMultiple (std::vector< GpuResourcesProvider * > &provider, std::vector< int > &devices, const GpuMultipleClonerOptions &options) ToGpuClonerMultiple + faiss::gpu::ToGpuClonerMultiple::ToGpuClonerMultiple std::vector< GpuResourcesProvider * > & provider @@ -231,6 +245,7 @@ faiss::gpu::ToGpuClonerMultiple::ToGpuClonerMultiple (const std::vector< ToGpuCloner > &sub_cloners, const GpuMultipleClonerOptions &options) ToGpuClonerMultiple + faiss::gpu::ToGpuClonerMultiple::ToGpuClonerMultiple const std::vector< ToGpuCloner > & sub_cloners @@ -252,6 +267,7 @@ void faiss::gpu::ToGpuClonerMultiple::copy_ivf_shard (const IndexIVF *index_ivf, IndexIVF *idx2, idx_t n, idx_t i) copy_ivf_shard + faiss::gpu::ToGpuClonerMultiple::copy_ivf_shard const IndexIVF * index_ivf @@ -276,11 +292,12 @@ - + Index * - Index* faiss::gpu::ToGpuClonerMultiple::clone_Index_to_shards + Index * faiss::gpu::ToGpuClonerMultiple::clone_Index_to_shards (const Index *index) clone_Index_to_shards + faiss::gpu::ToGpuClonerMultiple::clone_Index_to_shards const Index * index @@ -293,12 +310,13 @@ - + Index * - Index* faiss::gpu::ToGpuClonerMultiple::clone_Index + Index * faiss::gpu::ToGpuClonerMultiple::clone_Index (const Index *index) override clone_Index - clone_Index + faiss::gpu::ToGpuClonerMultiple::clone_Index + clone_Index const Index * index @@ -312,11 +330,12 @@ - + VectorTransform * - virtual VectorTransform* faiss::Cloner::clone_VectorTransform + virtual VectorTransform * faiss::Cloner::clone_VectorTransform (const VectorTransform *) clone_VectorTransform + faiss::Cloner::clone_VectorTransform const VectorTransform * @@ -328,11 +347,12 @@ - + IndexIVF * - virtual IndexIVF* faiss::Cloner::clone_IndexIVF + virtual IndexIVF * faiss::Cloner::clone_IndexIVF (const IndexIVF *) clone_IndexIVF + faiss::Cloner::clone_IndexIVF const IndexIVF * @@ -344,7 +364,7 @@ - + Cloner specialized for CPU -> multiple GPUs. @@ -355,16 +375,16 @@ + + + + - - - - @@ -379,16 +399,16 @@ + + + + - - - - @@ -401,10 +421,10 @@ faiss::gpu::ToGpuClonerMultipleallowCpuCoarseQuantizer - faiss::gpu::ToGpuClonerMultipleclone_Index - faiss::gpu::ToGpuClonerMultipleclone_Index_to_shards - faiss::gpu::ToGpuClonerMultipleclone_IndexIVF - faiss::gpu::ToGpuClonerMultipleclone_VectorTransform + faiss::gpu::ToGpuClonerMultipleclone_Index + faiss::gpu::ToGpuClonerMultipleclone_Index_to_shards + faiss::gpu::ToGpuClonerMultipleclone_IndexIVF + faiss::gpu::ToGpuClonerMultipleclone_VectorTransform faiss::gpu::ToGpuClonerMultiplecommon_ivf_quantizer faiss::gpu::ToGpuClonerMultiplecopy_ivf_shard faiss::gpu::ToGpuClonerMultipleindicesOptions diff --git a/xml/structfaiss_1_1ivflib_1_1SlidingIndexWindow.xml b/xml/structfaiss_1_1ivflib_1_1SlidingIndexWindow.xml index d55141a9f5..588753a403 100644 --- a/xml/structfaiss_1_1ivflib_1_1SlidingIndexWindow.xml +++ b/xml/structfaiss_1_1ivflib_1_1SlidingIndexWindow.xml @@ -1,14 +1,15 @@ - + faiss::ivflib::SlidingIndexWindow IVFlib.h - + Index * Index* faiss::ivflib::SlidingIndexWindow::index index + faiss::ivflib::SlidingIndexWindow::index common index that contains the sliding window @@ -23,6 +24,7 @@ ArrayInvertedLists* faiss::ivflib::SlidingIndexWindow::ils ils + faiss::ivflib::SlidingIndexWindow::ils InvertedLists of index. @@ -37,6 +39,7 @@ int faiss::ivflib::SlidingIndexWindow::n_slice n_slice + faiss::ivflib::SlidingIndexWindow::n_slice number of slices currently in index @@ -51,6 +54,7 @@ size_t faiss::ivflib::SlidingIndexWindow::nlist nlist + faiss::ivflib::SlidingIndexWindow::nlist same as index->nlist @@ -65,6 +69,7 @@ std::vector<std::vector<size_t> > faiss::ivflib::SlidingIndexWindow::sizes sizes + faiss::ivflib::SlidingIndexWindow::sizes cumulative list sizes at each slice @@ -74,13 +79,14 @@ - - + + faiss::ivflib::SlidingIndexWindow::SlidingIndexWindow (Index *index) SlidingIndexWindow + faiss::ivflib::SlidingIndexWindow::SlidingIndexWindow Index * index @@ -99,6 +105,7 @@ void faiss::ivflib::SlidingIndexWindow::step (const Index *sub_index, bool remove_oldest) step + faiss::ivflib::SlidingIndexWindow::step const Index * sub_index @@ -134,7 +141,7 @@ - + @@ -142,28 +149,28 @@ - - + + + + - + - - - - - + + + - ils - - index + + ils + diff --git a/xml/structfaiss_1_1lsq_1_1IcmEncoder.xml b/xml/structfaiss_1_1lsq_1_1IcmEncoder.xml index f152030981..222fd0ace8 100644 --- a/xml/structfaiss_1_1lsq_1_1IcmEncoder.xml +++ b/xml/structfaiss_1_1lsq_1_1IcmEncoder.xml @@ -1,14 +1,15 @@ - + faiss::lsq::IcmEncoder faiss::gpu::GpuIcmEncoder - + std::vector< float > std::vector<float> faiss::lsq::IcmEncoder::binaries binaries + faiss::lsq::IcmEncoder::binaries @@ -22,6 +23,7 @@ bool faiss::lsq::IcmEncoder::verbose verbose + faiss::lsq::IcmEncoder::verbose @@ -35,6 +37,7 @@ const LocalSearchQuantizer* faiss::lsq::IcmEncoder::lsq lsq + faiss::lsq::IcmEncoder::lsq @@ -43,13 +46,14 @@ - - + + faiss::lsq::IcmEncoder::IcmEncoder (const LocalSearchQuantizer *lsq) IcmEncoder + faiss::lsq::IcmEncoder::IcmEncoder const LocalSearchQuantizer * lsq @@ -67,6 +71,7 @@ virtual faiss::lsq::IcmEncoder::~IcmEncoder () ~IcmEncoder + faiss::lsq::IcmEncoder::~IcmEncoder compute binary terms @@ -81,6 +86,7 @@ virtual void faiss::lsq::IcmEncoder::set_binary_term () set_binary_term + faiss::lsq::IcmEncoder::set_binary_term set_binary_term @@ -95,6 +101,7 @@ virtual void faiss::lsq::IcmEncoder::encode (int32_t *codes, const float *x, std::mt19937 &gen, size_t n, size_t ils_iters) const encode + faiss::lsq::IcmEncoder::encode encode int32_t * @@ -167,7 +174,7 @@ - + @@ -185,19 +192,19 @@ - - - - - - - - + + + + - - icm_encoder_factory + + qnorm + + + + @@ -210,35 +217,31 @@ + + + + + + - - - - - - - - + + + + - - qnorm + + icm_encoder_factory - - - - - - @@ -246,6 +249,10 @@ lsq + + + + diff --git a/xml/structfaiss_1_1lsq_1_1IcmEncoderFactory.xml b/xml/structfaiss_1_1lsq_1_1IcmEncoderFactory.xml index 9dc6207474..59a5c9f552 100644 --- a/xml/structfaiss_1_1lsq_1_1IcmEncoderFactory.xml +++ b/xml/structfaiss_1_1lsq_1_1IcmEncoderFactory.xml @@ -1,15 +1,16 @@ - + faiss::lsq::IcmEncoderFactory faiss::gpu::GpuIcmEncoderFactory - - + + IcmEncoder * - virtual IcmEncoder* faiss::lsq::IcmEncoderFactory::get + virtual IcmEncoder * faiss::lsq::IcmEncoderFactory::get (const LocalSearchQuantizer *lsq) get - get + faiss::lsq::IcmEncoderFactory::get + get const LocalSearchQuantizer * lsq @@ -27,6 +28,7 @@ virtual faiss::lsq::IcmEncoderFactory::~IcmEncoderFactory () ~IcmEncoderFactory + faiss::lsq::IcmEncoderFactory::~IcmEncoderFactory @@ -35,26 +37,26 @@ - + - - - - + + + + - faiss::lsq::IcmEncoderFactoryget + faiss::lsq::IcmEncoderFactoryget faiss::lsq::IcmEncoderFactory~IcmEncoderFactory diff --git a/xml/structfaiss_1_1lsq_1_1LSQTimer.xml b/xml/structfaiss_1_1lsq_1_1LSQTimer.xml index c29872363c..5dea283525 100644 --- a/xml/structfaiss_1_1lsq_1_1LSQTimer.xml +++ b/xml/structfaiss_1_1lsq_1_1LSQTimer.xml @@ -1,14 +1,15 @@ - + faiss::lsq::LSQTimer LocalSearchQuantizer.h - + std::unordered_map< std::string, double > std::unordered_map<std::string, double> faiss::lsq::LSQTimer::t t + faiss::lsq::LSQTimer::t @@ -17,13 +18,14 @@ - - + + faiss::lsq::LSQTimer::LSQTimer () LSQTimer + faiss::lsq::LSQTimer::LSQTimer @@ -37,6 +39,7 @@ double faiss::lsq::LSQTimer::get (const std::string &name) get + faiss::lsq::LSQTimer::get const std::string & name @@ -54,6 +57,7 @@ void faiss::lsq::LSQTimer::add (const std::string &name, double delta) add + faiss::lsq::LSQTimer::add const std::string & name @@ -75,6 +79,7 @@ void faiss::lsq::LSQTimer::reset () reset + faiss::lsq::LSQTimer::reset @@ -83,7 +88,7 @@ - + diff --git a/xml/structfaiss_1_1lsq_1_1LSQTimerScope.xml b/xml/structfaiss_1_1lsq_1_1LSQTimerScope.xml index 4e9c144bdd..fb1affd740 100644 --- a/xml/structfaiss_1_1lsq_1_1LSQTimerScope.xml +++ b/xml/structfaiss_1_1lsq_1_1LSQTimerScope.xml @@ -1,13 +1,14 @@ - + faiss::lsq::LSQTimerScope - + double double faiss::lsq::LSQTimerScope::t0 t0 + faiss::lsq::LSQTimerScope::t0 @@ -21,6 +22,7 @@ LSQTimer* faiss::lsq::LSQTimerScope::timer timer + faiss::lsq::LSQTimerScope::timer @@ -34,6 +36,7 @@ std::string faiss::lsq::LSQTimerScope::name name + faiss::lsq::LSQTimerScope::name @@ -47,6 +50,7 @@ bool faiss::lsq::LSQTimerScope::finished finished + faiss::lsq::LSQTimerScope::finished @@ -55,13 +59,14 @@ - - + + faiss::lsq::LSQTimerScope::LSQTimerScope (LSQTimer *timer, std::string name) LSQTimerScope + faiss::lsq::LSQTimerScope::LSQTimerScope LSQTimer * timer @@ -83,6 +88,7 @@ void faiss::lsq::LSQTimerScope::finish () finish + faiss::lsq::LSQTimerScope::finish @@ -96,6 +102,7 @@ faiss::lsq::LSQTimerScope::~LSQTimerScope () ~LSQTimerScope + faiss::lsq::LSQTimerScope::~LSQTimerScope @@ -104,12 +111,16 @@ - + + + + + @@ -117,10 +128,6 @@ timer - - - - diff --git a/xml/structfaiss_1_1nn_1_1Embedding.xml b/xml/structfaiss_1_1nn_1_1Embedding.xml index 2ec1518f12..fcd8cdbdbe 100644 --- a/xml/structfaiss_1_1nn_1_1Embedding.xml +++ b/xml/structfaiss_1_1nn_1_1Embedding.xml @@ -1,14 +1,15 @@ - + faiss::nn::Embedding NeuralNet.h - + size_t size_t faiss::nn::Embedding::num_embeddings num_embeddings + faiss::nn::Embedding::num_embeddings @@ -22,6 +23,7 @@ size_t faiss::nn::Embedding::embedding_dim embedding_dim + faiss::nn::Embedding::embedding_dim @@ -35,6 +37,7 @@ std::vector<float> faiss::nn::Embedding::weight weight + faiss::nn::Embedding::weight @@ -43,13 +46,14 @@ - - + + faiss::nn::Embedding::Embedding (size_t num_embeddings, size_t embedding_dim) Embedding + faiss::nn::Embedding::Embedding size_t num_embeddings @@ -71,6 +75,7 @@ Tensor2D faiss::nn::Embedding::operator() (const Int32Tensor2D &) const operator() + faiss::nn::Embedding::operator() const Int32Tensor2D & @@ -82,11 +87,12 @@ - + float * - float* faiss::nn::Embedding::data + float * faiss::nn::Embedding::data () data + faiss::nn::Embedding::data @@ -95,11 +101,12 @@ - + const float * - const float* faiss::nn::Embedding::data + const float * faiss::nn::Embedding::data () const data + faiss::nn::Embedding::data @@ -108,7 +115,7 @@ - + minimal translation of nn.Embedding @@ -116,8 +123,8 @@ - faiss::nn::Embeddingdata - faiss::nn::Embeddingdata + faiss::nn::Embeddingdata + faiss::nn::Embeddingdata faiss::nn::EmbeddingEmbedding faiss::nn::Embeddingembedding_dim faiss::nn::Embeddingnum_embeddings diff --git a/xml/structfaiss_1_1nn_1_1FFN.xml b/xml/structfaiss_1_1nn_1_1FFN.xml index 8c7da70b17..d33bd86078 100644 --- a/xml/structfaiss_1_1nn_1_1FFN.xml +++ b/xml/structfaiss_1_1nn_1_1FFN.xml @@ -1,14 +1,15 @@ - + faiss::nn::FFN NeuralNet.h - + Linear Linear faiss::nn::FFN::linear1 linear1 + faiss::nn::FFN::linear1 @@ -22,6 +23,7 @@ Linear faiss::nn::FFN::linear2 linear2 + faiss::nn::FFN::linear2 @@ -30,13 +32,14 @@ - - + + faiss::nn::FFN::FFN (int d, int h) FFN + faiss::nn::FFN::FFN int d @@ -58,6 +61,7 @@ Tensor2D faiss::nn::FFN::operator() (const Tensor2D &x) const operator() + faiss::nn::FFN::operator() const Tensor2D & x @@ -70,7 +74,7 @@ - + diff --git a/xml/structfaiss_1_1nn_1_1Linear.xml b/xml/structfaiss_1_1nn_1_1Linear.xml index 4e757aa6eb..37023b59a6 100644 --- a/xml/structfaiss_1_1nn_1_1Linear.xml +++ b/xml/structfaiss_1_1nn_1_1Linear.xml @@ -1,14 +1,15 @@ - + faiss::nn::Linear NeuralNet.h - + size_t size_t faiss::nn::Linear::in_features in_features + faiss::nn::Linear::in_features @@ -22,6 +23,7 @@ size_t faiss::nn::Linear::out_features out_features + faiss::nn::Linear::out_features @@ -35,6 +37,7 @@ std::vector<float> faiss::nn::Linear::weight weight + faiss::nn::Linear::weight @@ -48,6 +51,7 @@ std::vector<float> faiss::nn::Linear::bias bias + faiss::nn::Linear::bias @@ -56,13 +60,14 @@ - - + + faiss::nn::Linear::Linear (size_t in_features, size_t out_features, bool bias=true) Linear + faiss::nn::Linear::Linear size_t in_features @@ -89,6 +94,7 @@ Tensor2D faiss::nn::Linear::operator() (const Tensor2D &x) const operator() + faiss::nn::Linear::operator() const Tensor2D & x @@ -101,7 +107,7 @@ - + minimal translation of nn.Linear diff --git a/xml/structfaiss_1_1nn_1_1Tensor2DTemplate.xml b/xml/structfaiss_1_1nn_1_1Tensor2DTemplate.xml index 078bf584e4..e025649831 100644 --- a/xml/structfaiss_1_1nn_1_1Tensor2DTemplate.xml +++ b/xml/structfaiss_1_1nn_1_1Tensor2DTemplate.xml @@ -1,5 +1,5 @@ - + faiss::nn::Tensor2DTemplate @@ -7,12 +7,13 @@ typename T - + size_t size_t faiss::nn::Tensor2DTemplate< T >::shape[2] [2] shape + faiss::nn::Tensor2DTemplate::shape @@ -26,6 +27,7 @@ std::vector<T> faiss::nn::Tensor2DTemplate< T >::v v + faiss::nn::Tensor2DTemplate::v @@ -34,13 +36,14 @@ - - + + faiss::nn::Tensor2DTemplate< T >::Tensor2DTemplate (size_t n0, size_t n1, const T *data=nullptr) Tensor2DTemplate + faiss::nn::Tensor2DTemplate::Tensor2DTemplate size_t n0 @@ -62,11 +65,12 @@ - + Tensor2DTemplate & - Tensor2DTemplate& faiss::nn::Tensor2DTemplate< T >::operator+= + Tensor2DTemplate & faiss::nn::Tensor2DTemplate< T >::operator+= (const Tensor2DTemplate &) operator+= + faiss::nn::Tensor2DTemplate::operator+= const Tensor2DTemplate & @@ -83,6 +87,7 @@ Tensor2DTemplate faiss::nn::Tensor2DTemplate< T >::column (size_t j) const column + faiss::nn::Tensor2DTemplate::column size_t j @@ -101,6 +106,7 @@ size_t faiss::nn::Tensor2DTemplate< T >::numel () const numel + faiss::nn::Tensor2DTemplate::numel @@ -109,11 +115,12 @@ - + T * - T* faiss::nn::Tensor2DTemplate< T >::data + T * faiss::nn::Tensor2DTemplate< T >::data () data + faiss::nn::Tensor2DTemplate::data @@ -122,11 +129,12 @@ - + const T * - const T* faiss::nn::Tensor2DTemplate< T >::data + const T * faiss::nn::Tensor2DTemplate< T >::data () const data + faiss::nn::Tensor2DTemplate::data @@ -135,7 +143,7 @@ - + @@ -143,10 +151,10 @@ faiss::nn::Tensor2DTemplatecolumn - faiss::nn::Tensor2DTemplatedata - faiss::nn::Tensor2DTemplatedata + faiss::nn::Tensor2DTemplatedata + faiss::nn::Tensor2DTemplatedata faiss::nn::Tensor2DTemplatenumel - faiss::nn::Tensor2DTemplateoperator+= + faiss::nn::Tensor2DTemplateoperator+= faiss::nn::Tensor2DTemplateshape faiss::nn::Tensor2DTemplateTensor2DTemplate faiss::nn::Tensor2DTemplatev diff --git a/xml/structfaiss_1_1nndescent_1_1Neighbor.xml b/xml/structfaiss_1_1nndescent_1_1Neighbor.xml index 6e224595c0..d1e22f8b57 100644 --- a/xml/structfaiss_1_1nndescent_1_1Neighbor.xml +++ b/xml/structfaiss_1_1nndescent_1_1Neighbor.xml @@ -1,13 +1,14 @@ - + faiss::nndescent::Neighbor - + int int faiss::nndescent::Neighbor::id id + faiss::nndescent::Neighbor::id @@ -21,6 +22,7 @@ float faiss::nndescent::Neighbor::distance distance + faiss::nndescent::Neighbor::distance @@ -34,6 +36,7 @@ bool faiss::nndescent::Neighbor::flag flag + faiss::nndescent::Neighbor::flag @@ -42,13 +45,14 @@ - - + + faiss::nndescent::Neighbor::Neighbor ()=default Neighbor + faiss::nndescent::Neighbor::Neighbor @@ -62,6 +66,7 @@ faiss::nndescent::Neighbor::Neighbor (int id, float distance, bool f) Neighbor + faiss::nndescent::Neighbor::Neighbor int id @@ -87,6 +92,7 @@ bool faiss::nndescent::Neighbor::operator< (const Neighbor &other) const operator< + faiss::nndescent::Neighbor::operator< const Neighbor & other @@ -99,7 +105,7 @@ - + diff --git a/xml/structfaiss_1_1nndescent_1_1Nhood.xml b/xml/structfaiss_1_1nndescent_1_1Nhood.xml index 2ae38ce9f9..d9fb6ba998 100644 --- a/xml/structfaiss_1_1nndescent_1_1Nhood.xml +++ b/xml/structfaiss_1_1nndescent_1_1Nhood.xml @@ -1,13 +1,14 @@ - + faiss::nndescent::Nhood - + std::mutex std::mutex faiss::nndescent::Nhood::lock lock + faiss::nndescent::Nhood::lock @@ -21,6 +22,7 @@ std::vector<Neighbor> faiss::nndescent::Nhood::pool pool + faiss::nndescent::Nhood::pool @@ -34,6 +36,7 @@ int faiss::nndescent::Nhood::M M + faiss::nndescent::Nhood::M @@ -47,6 +50,7 @@ std::vector<int> faiss::nndescent::Nhood::nn_old nn_old + faiss::nndescent::Nhood::nn_old @@ -60,6 +64,7 @@ std::vector<int> faiss::nndescent::Nhood::nn_new nn_new + faiss::nndescent::Nhood::nn_new @@ -73,6 +78,7 @@ std::vector<int> faiss::nndescent::Nhood::rnn_old rnn_old + faiss::nndescent::Nhood::rnn_old @@ -86,6 +92,7 @@ std::vector<int> faiss::nndescent::Nhood::rnn_new rnn_new + faiss::nndescent::Nhood::rnn_new @@ -94,13 +101,14 @@ - - + + faiss::nndescent::Nhood::Nhood ()=default Nhood + faiss::nndescent::Nhood::Nhood @@ -114,6 +122,7 @@ faiss::nndescent::Nhood::Nhood (int l, int s, std::mt19937 &rng, int N) Nhood + faiss::nndescent::Nhood::Nhood int l @@ -138,11 +147,12 @@ - + Nhood & - Nhood& faiss::nndescent::Nhood::operator= + Nhood & faiss::nndescent::Nhood::operator= (const Nhood &other) operator= + faiss::nndescent::Nhood::operator= const Nhood & other @@ -160,6 +170,7 @@ faiss::nndescent::Nhood::Nhood (const Nhood &other) Nhood + faiss::nndescent::Nhood::Nhood const Nhood & other @@ -177,6 +188,7 @@ void faiss::nndescent::Nhood::insert (int id, float dist) insert + faiss::nndescent::Nhood::insert int id @@ -203,6 +215,7 @@ void faiss::nndescent::Nhood::join (C callback) const join + faiss::nndescent::Nhood::join C callback @@ -215,7 +228,7 @@ - + @@ -231,7 +244,7 @@ faiss::nndescent::NhoodNhood faiss::nndescent::Nhoodnn_new faiss::nndescent::Nhoodnn_old - faiss::nndescent::Nhoodoperator= + faiss::nndescent::Nhoodoperator= faiss::nndescent::Nhoodpool faiss::nndescent::Nhoodrnn_new faiss::nndescent::Nhoodrnn_old diff --git a/xml/structfaiss_1_1nsg_1_1Graph.xml b/xml/structfaiss_1_1nsg_1_1Graph.xml index a22c5f0448..446fe07bb5 100644 --- a/xml/structfaiss_1_1nsg_1_1Graph.xml +++ b/xml/structfaiss_1_1nsg_1_1Graph.xml @@ -1,5 +1,5 @@ - + faiss::nsg::Graph @@ -7,12 +7,13 @@ class node_t - + node_t * node_t* faiss::nsg::Graph< node_t >::data data + faiss::nsg::Graph::data the flattened adjacency matrix, size N-by-K @@ -27,6 +28,7 @@ int faiss::nsg::Graph< node_t >::K K + faiss::nsg::Graph::K nb of neighbors per node @@ -41,6 +43,7 @@ int faiss::nsg::Graph< node_t >::N N + faiss::nsg::Graph::N total nb of nodes @@ -55,6 +58,7 @@ bool faiss::nsg::Graph< node_t >::own_fields own_fields + faiss::nsg::Graph::own_fields the underlying data owned by itself or not @@ -64,13 +68,14 @@ - - + + faiss::nsg::Graph< node_t >::Graph (node_t *data, int N, int K) Graph + faiss::nsg::Graph::Graph node_t * data @@ -96,6 +101,7 @@ faiss::nsg::Graph< node_t >::Graph (int N, int K) Graph + faiss::nsg::Graph::Graph int N @@ -117,6 +123,7 @@ faiss::nsg::Graph< node_t >::Graph (const Graph &g) Graph + faiss::nsg::Graph::Graph const Graph & g @@ -134,6 +141,7 @@ virtual faiss::nsg::Graph< node_t >::~Graph () ~Graph + faiss::nsg::Graph::~Graph @@ -147,6 +155,7 @@ node_t faiss::nsg::Graph< node_t >::at (int i, int j) const at + faiss::nsg::Graph::at int i @@ -163,11 +172,12 @@ - + node_t & - node_t& faiss::nsg::Graph< node_t >::at + node_t & faiss::nsg::Graph< node_t >::at (int i, int j) at + faiss::nsg::Graph::at int i @@ -189,6 +199,7 @@ virtual size_t faiss::nsg::Graph< node_t >::get_neighbors (int i, node_t *neighbors) const get_neighbors + faiss::nsg::Graph::get_neighbors int i @@ -205,7 +216,7 @@ - + @@ -213,7 +224,7 @@ faiss::nsg::Graphat - faiss::nsg::Graphat + faiss::nsg::Graphat faiss::nsg::Graphdata faiss::nsg::Graphget_neighbors faiss::nsg::GraphGraph diff --git a/xml/structfaiss_1_1rq__encode__steps_1_1ComputeCodesAddCentroidsLUT0MemoryPool.xml b/xml/structfaiss_1_1rq__encode__steps_1_1ComputeCodesAddCentroidsLUT0MemoryPool.xml index 61bf1131cf..3fa0fdb086 100644 --- a/xml/structfaiss_1_1rq__encode__steps_1_1ComputeCodesAddCentroidsLUT0MemoryPool.xml +++ b/xml/structfaiss_1_1rq__encode__steps_1_1ComputeCodesAddCentroidsLUT0MemoryPool.xml @@ -1,13 +1,14 @@ - + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool - + std::vector< int32_t > std::vector<int32_t> faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::codes codes + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::codes @@ -21,6 +22,7 @@ std::vector<float> faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::norms norms + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::norms @@ -34,6 +36,7 @@ std::vector<float> faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::distances distances + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::distances @@ -47,6 +50,7 @@ std::vector<float> faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::residuals residuals + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::residuals @@ -60,6 +64,7 @@ RefineBeamMemoryPool faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::refine_beam_pool refine_beam_pool + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT0MemoryPool::refine_beam_pool @@ -68,16 +73,12 @@ - + - - - - @@ -85,6 +86,10 @@ refine_beam_pool + + + + diff --git a/xml/structfaiss_1_1rq__encode__steps_1_1ComputeCodesAddCentroidsLUT1MemoryPool.xml b/xml/structfaiss_1_1rq__encode__steps_1_1ComputeCodesAddCentroidsLUT1MemoryPool.xml index a3eebccbc7..be444f7bb0 100644 --- a/xml/structfaiss_1_1rq__encode__steps_1_1ComputeCodesAddCentroidsLUT1MemoryPool.xml +++ b/xml/structfaiss_1_1rq__encode__steps_1_1ComputeCodesAddCentroidsLUT1MemoryPool.xml @@ -1,13 +1,14 @@ - + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool - + std::vector< int32_t > std::vector<int32_t> faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::codes codes + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::codes @@ -21,6 +22,7 @@ std::vector<float> faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::distances distances + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::distances @@ -34,6 +36,7 @@ std::vector<float> faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::query_norms query_norms + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::query_norms @@ -47,6 +50,7 @@ std::vector<float> faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::query_cp query_cp + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::query_cp @@ -60,6 +64,7 @@ std::vector<float> faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::residuals residuals + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::residuals @@ -73,6 +78,7 @@ RefineBeamLUTMemoryPool faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::refine_beam_lut_pool refine_beam_lut_pool + faiss::rq_encode_steps::ComputeCodesAddCentroidsLUT1MemoryPool::refine_beam_lut_pool @@ -81,7 +87,7 @@ - + diff --git a/xml/structfaiss_1_1rq__encode__steps_1_1RefineBeamLUTMemoryPool.xml b/xml/structfaiss_1_1rq__encode__steps_1_1RefineBeamLUTMemoryPool.xml index 4162dbffe8..d890f5afcd 100644 --- a/xml/structfaiss_1_1rq__encode__steps_1_1RefineBeamLUTMemoryPool.xml +++ b/xml/structfaiss_1_1rq__encode__steps_1_1RefineBeamLUTMemoryPool.xml @@ -1,13 +1,14 @@ - + faiss::rq_encode_steps::RefineBeamLUTMemoryPool - + std::vector< int32_t > std::vector<int32_t> faiss::rq_encode_steps::RefineBeamLUTMemoryPool::new_codes new_codes + faiss::rq_encode_steps::RefineBeamLUTMemoryPool::new_codes @@ -21,6 +22,7 @@ std::vector<float> faiss::rq_encode_steps::RefineBeamLUTMemoryPool::new_distances new_distances + faiss::rq_encode_steps::RefineBeamLUTMemoryPool::new_distances @@ -34,6 +36,7 @@ std::vector<int32_t> faiss::rq_encode_steps::RefineBeamLUTMemoryPool::codes codes + faiss::rq_encode_steps::RefineBeamLUTMemoryPool::codes @@ -47,6 +50,7 @@ std::vector<float> faiss::rq_encode_steps::RefineBeamLUTMemoryPool::distances distances + faiss::rq_encode_steps::RefineBeamLUTMemoryPool::distances @@ -55,7 +59,7 @@ - + diff --git a/xml/structfaiss_1_1rq__encode__steps_1_1RefineBeamMemoryPool.xml b/xml/structfaiss_1_1rq__encode__steps_1_1RefineBeamMemoryPool.xml index ed70e31318..fc131dc6f0 100644 --- a/xml/structfaiss_1_1rq__encode__steps_1_1RefineBeamMemoryPool.xml +++ b/xml/structfaiss_1_1rq__encode__steps_1_1RefineBeamMemoryPool.xml @@ -1,13 +1,14 @@ - + faiss::rq_encode_steps::RefineBeamMemoryPool - + std::vector< int32_t > std::vector<int32_t> faiss::rq_encode_steps::RefineBeamMemoryPool::new_codes new_codes + faiss::rq_encode_steps::RefineBeamMemoryPool::new_codes @@ -21,6 +22,7 @@ std::vector<float> faiss::rq_encode_steps::RefineBeamMemoryPool::new_residuals new_residuals + faiss::rq_encode_steps::RefineBeamMemoryPool::new_residuals @@ -34,6 +36,7 @@ std::vector<float> faiss::rq_encode_steps::RefineBeamMemoryPool::residuals residuals + faiss::rq_encode_steps::RefineBeamMemoryPool::residuals @@ -47,6 +50,7 @@ std::vector<int32_t> faiss::rq_encode_steps::RefineBeamMemoryPool::codes codes + faiss::rq_encode_steps::RefineBeamMemoryPool::codes @@ -60,6 +64,7 @@ std::vector<float> faiss::rq_encode_steps::RefineBeamMemoryPool::distances distances + faiss::rq_encode_steps::RefineBeamMemoryPool::distances @@ -68,7 +73,7 @@ - + diff --git a/xml/structfaiss_1_1simd16uint16.xml b/xml/structfaiss_1_1simd16uint16.xml index e3c330f9ed..e390128b54 100644 --- a/xml/structfaiss_1_1simd16uint16.xml +++ b/xml/structfaiss_1_1simd16uint16.xml @@ -1,17 +1,18 @@ - + faiss::simd16uint16 faiss::simd256bit faiss::simd256bit faiss::simd256bit simdlib_avx2.h - + uint16x8x2_t uint16x8x2_t faiss::simd16uint16::data data + faiss::simd16uint16::data @@ -25,6 +26,7 @@ __m256i faiss::simd256bit::i i + faiss::simd256bit::i @@ -38,6 +40,7 @@ __m256 faiss::simd256bit::f f + faiss::simd256bit::f @@ -47,10 +50,11 @@ - union faiss::simd256bit::@0 - union faiss::simd256bit::@0 faiss::simd256bit::@1 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @1 + + faiss::simd256bit @@ -64,6 +68,7 @@ uint8_t faiss::simd256bit::u8[32] [32] u8 + faiss::simd256bit::u8 @@ -77,6 +82,7 @@ uint16_t faiss::simd256bit::u16[16] [16] u16 + faiss::simd256bit::u16 @@ -90,6 +96,7 @@ uint32_t faiss::simd256bit::u32[8] [8] u32 + faiss::simd256bit::u32 @@ -103,6 +110,7 @@ float faiss::simd256bit::f32[8] [8] f32 + faiss::simd256bit::f32 @@ -112,10 +120,11 @@ - union faiss::simd256bit::@4 - union faiss::simd256bit::@4 faiss::simd256bit::@5 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @5 + + faiss::simd256bit @@ -125,10 +134,11 @@ - union faiss::simd256bit::@6 - union faiss::simd256bit::@6 faiss::simd256bit::@7 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @7 + + faiss::simd256bit @@ -137,13 +147,14 @@ - - + + faiss::simd16uint16::simd16uint16 () simd16uint16 + faiss::simd16uint16::simd16uint16 @@ -157,6 +168,7 @@ faiss::simd16uint16::simd16uint16 (__m256i i) simd16uint16 + faiss::simd16uint16::simd16uint16 __m256i i @@ -174,6 +186,7 @@ faiss::simd16uint16::simd16uint16 (int x) simd16uint16 + faiss::simd16uint16::simd16uint16 int x @@ -191,6 +204,7 @@ faiss::simd16uint16::simd16uint16 (uint16_t x) simd16uint16 + faiss::simd16uint16::simd16uint16 uint16_t x @@ -208,6 +222,7 @@ faiss::simd16uint16::simd16uint16 (simd256bit x) simd16uint16 + faiss::simd16uint16::simd16uint16 simd256bit x @@ -225,6 +240,7 @@ faiss::simd16uint16::simd16uint16 (const uint16_t *x) simd16uint16 + faiss::simd16uint16::simd16uint16 const uint16_t * x @@ -242,6 +258,7 @@ faiss::simd16uint16::simd16uint16 (uint16_t u0, uint16_t u1, uint16_t u2, uint16_t u3, uint16_t u4, uint16_t u5, uint16_t u6, uint16_t u7, uint16_t u8, uint16_t u9, uint16_t u10, uint16_t u11, uint16_t u12, uint16_t u13, uint16_t u14, uint16_t u15) simd16uint16 + faiss::simd16uint16::simd16uint16 uint16_t u0 @@ -319,6 +336,7 @@ std::string faiss::simd16uint16::elements_to_string (const char *fmt) const elements_to_string + faiss::simd16uint16::elements_to_string const char * fmt @@ -336,6 +354,7 @@ std::string faiss::simd16uint16::hex () const hex + faiss::simd16uint16::hex @@ -349,6 +368,7 @@ std::string faiss::simd16uint16::dec () const dec + faiss::simd16uint16::dec @@ -362,6 +382,7 @@ void faiss::simd16uint16::set1 (uint16_t x) set1 + faiss::simd16uint16::set1 uint16_t x @@ -379,6 +400,7 @@ simd16uint16 faiss::simd16uint16::operator* (const simd16uint16 &other) const operator* + faiss::simd16uint16::operator* const simd16uint16 & other @@ -396,6 +418,7 @@ simd16uint16 faiss::simd16uint16::operator>> (const int shift) const operator>> + faiss::simd16uint16::operator>> const int shift @@ -413,6 +436,7 @@ simd16uint16 faiss::simd16uint16::operator<< (const int shift) const operator<< + faiss::simd16uint16::operator<< const int shift @@ -430,6 +454,7 @@ simd16uint16 faiss::simd16uint16::operator+= (simd16uint16 other) operator+= + faiss::simd16uint16::operator+= simd16uint16 other @@ -447,6 +472,7 @@ simd16uint16 faiss::simd16uint16::operator-= (simd16uint16 other) operator-= + faiss::simd16uint16::operator-= simd16uint16 other @@ -464,6 +490,7 @@ simd16uint16 faiss::simd16uint16::operator+ (simd16uint16 other) const operator+ + faiss::simd16uint16::operator+ simd16uint16 other @@ -481,6 +508,7 @@ simd16uint16 faiss::simd16uint16::operator- (simd16uint16 other) const operator- + faiss::simd16uint16::operator- simd16uint16 other @@ -498,6 +526,7 @@ simd16uint16 faiss::simd16uint16::operator& (simd256bit other) const operator& + faiss::simd16uint16::operator& simd256bit other @@ -515,6 +544,7 @@ simd16uint16 faiss::simd16uint16::operator| (simd256bit other) const operator| + faiss::simd16uint16::operator| simd256bit other @@ -532,6 +562,7 @@ simd16uint16 faiss::simd16uint16::operator^ (simd256bit other) const operator^ + faiss::simd16uint16::operator^ simd256bit other @@ -549,6 +580,7 @@ simd16uint16 faiss::simd16uint16::operator~ () const operator~ + faiss::simd16uint16::operator~ @@ -562,6 +594,7 @@ uint16_t faiss::simd16uint16::get_scalar_0 () const get_scalar_0 + faiss::simd16uint16::get_scalar_0 @@ -575,6 +608,7 @@ uint32_t faiss::simd16uint16::ge_mask (simd16uint16 thresh) const ge_mask + faiss::simd16uint16::ge_mask simd16uint16 thresh @@ -592,6 +626,7 @@ uint32_t faiss::simd16uint16::le_mask (simd16uint16 thresh) const le_mask + faiss::simd16uint16::le_mask simd16uint16 thresh @@ -609,6 +644,7 @@ uint32_t faiss::simd16uint16::gt_mask (simd16uint16 thresh) const gt_mask + faiss::simd16uint16::gt_mask simd16uint16 thresh @@ -626,6 +662,7 @@ bool faiss::simd16uint16::all_gt (simd16uint16 thresh) const all_gt + faiss::simd16uint16::all_gt simd16uint16 thresh @@ -643,6 +680,7 @@ uint16_t faiss::simd16uint16::operator[] (int i) const operator[] + faiss::simd16uint16::operator[] int i @@ -660,6 +698,7 @@ void faiss::simd16uint16::accu_min (simd16uint16 incoming) accu_min + faiss::simd16uint16::accu_min simd16uint16 incoming @@ -677,6 +716,7 @@ void faiss::simd16uint16::accu_max (simd16uint16 incoming) accu_max + faiss::simd16uint16::accu_max simd16uint16 incoming @@ -694,6 +734,7 @@ faiss::simd16uint16::simd16uint16 () simd16uint16 + faiss::simd16uint16::simd16uint16 @@ -707,6 +748,7 @@ faiss::simd16uint16::simd16uint16 (int x) simd16uint16 + faiss::simd16uint16::simd16uint16 int x @@ -724,6 +766,7 @@ faiss::simd16uint16::simd16uint16 (uint16_t x) simd16uint16 + faiss::simd16uint16::simd16uint16 uint16_t x @@ -741,6 +784,7 @@ faiss::simd16uint16::simd16uint16 (const simd256bit &x) simd16uint16 + faiss::simd16uint16::simd16uint16 const simd256bit & x @@ -758,6 +802,7 @@ faiss::simd16uint16::simd16uint16 (const uint16_t *x) simd16uint16 + faiss::simd16uint16::simd16uint16 const uint16_t * x @@ -775,6 +820,7 @@ faiss::simd16uint16::simd16uint16 (uint16_t u0, uint16_t u1, uint16_t u2, uint16_t u3, uint16_t u4, uint16_t u5, uint16_t u6, uint16_t u7, uint16_t u8, uint16_t u9, uint16_t u10, uint16_t u11, uint16_t u12, uint16_t u13, uint16_t u14, uint16_t u15) simd16uint16 + faiss::simd16uint16::simd16uint16 uint16_t u0 @@ -852,6 +898,7 @@ std::string faiss::simd16uint16::elements_to_string (const char *fmt) const elements_to_string + faiss::simd16uint16::elements_to_string const char * fmt @@ -869,6 +916,7 @@ std::string faiss::simd16uint16::hex () const hex + faiss::simd16uint16::hex @@ -882,6 +930,7 @@ std::string faiss::simd16uint16::dec () const dec + faiss::simd16uint16::dec @@ -895,6 +944,7 @@ void faiss::simd16uint16::set1 (uint16_t x) set1 + faiss::simd16uint16::set1 uint16_t x @@ -912,6 +962,7 @@ simd16uint16 faiss::simd16uint16::operator* (const simd16uint16 &other) const operator* + faiss::simd16uint16::operator* const simd16uint16 & other @@ -929,6 +980,7 @@ simd16uint16 faiss::simd16uint16::operator>> (const int shift) const operator>> + faiss::simd16uint16::operator>> const int shift @@ -946,6 +998,7 @@ simd16uint16 faiss::simd16uint16::operator<< (const int shift) const operator<< + faiss::simd16uint16::operator<< const int shift @@ -963,6 +1016,7 @@ simd16uint16 faiss::simd16uint16::operator+= (const simd16uint16 &other) operator+= + faiss::simd16uint16::operator+= const simd16uint16 & other @@ -980,6 +1034,7 @@ simd16uint16 faiss::simd16uint16::operator-= (const simd16uint16 &other) operator-= + faiss::simd16uint16::operator-= const simd16uint16 & other @@ -997,6 +1052,7 @@ simd16uint16 faiss::simd16uint16::operator+ (const simd16uint16 &other) const operator+ + faiss::simd16uint16::operator+ const simd16uint16 & other @@ -1014,6 +1070,7 @@ simd16uint16 faiss::simd16uint16::operator- (const simd16uint16 &other) const operator- + faiss::simd16uint16::operator- const simd16uint16 & other @@ -1031,6 +1088,7 @@ simd16uint16 faiss::simd16uint16::operator& (const simd256bit &other) const operator& + faiss::simd16uint16::operator& const simd256bit & other @@ -1048,6 +1106,7 @@ simd16uint16 faiss::simd16uint16::operator| (const simd256bit &other) const operator| + faiss::simd16uint16::operator| const simd256bit & other @@ -1065,6 +1124,7 @@ simd16uint16 faiss::simd16uint16::operator^ (const simd256bit &other) const operator^ + faiss::simd16uint16::operator^ const simd256bit & other @@ -1082,6 +1142,7 @@ simd16uint16 faiss::simd16uint16::operator== (const simd16uint16 &other) const operator== + faiss::simd16uint16::operator== const simd16uint16 & other @@ -1099,6 +1160,7 @@ simd16uint16 faiss::simd16uint16::operator~ () const operator~ + faiss::simd16uint16::operator~ @@ -1112,6 +1174,7 @@ uint16_t faiss::simd16uint16::get_scalar_0 () const get_scalar_0 + faiss::simd16uint16::get_scalar_0 @@ -1125,6 +1188,7 @@ uint32_t faiss::simd16uint16::ge_mask (const simd16uint16 &thresh) const ge_mask + faiss::simd16uint16::ge_mask const simd16uint16 & thresh @@ -1142,6 +1206,7 @@ uint32_t faiss::simd16uint16::le_mask (const simd16uint16 &thresh) const le_mask + faiss::simd16uint16::le_mask const simd16uint16 & thresh @@ -1159,6 +1224,7 @@ uint32_t faiss::simd16uint16::gt_mask (const simd16uint16 &thresh) const gt_mask + faiss::simd16uint16::gt_mask const simd16uint16 & thresh @@ -1176,6 +1242,7 @@ bool faiss::simd16uint16::all_gt (const simd16uint16 &thresh) const all_gt + faiss::simd16uint16::all_gt const simd16uint16 & thresh @@ -1193,6 +1260,7 @@ uint16_t faiss::simd16uint16::operator[] (int i) const operator[] + faiss::simd16uint16::operator[] int i @@ -1210,6 +1278,7 @@ void faiss::simd16uint16::accu_min (const simd16uint16 &incoming) accu_min + faiss::simd16uint16::accu_min const simd16uint16 & incoming @@ -1227,6 +1296,7 @@ void faiss::simd16uint16::accu_max (const simd16uint16 &incoming) accu_max + faiss::simd16uint16::accu_max const simd16uint16 & incoming @@ -1244,6 +1314,7 @@ faiss::simd16uint16::simd16uint16 ()=default simd16uint16 + faiss::simd16uint16::simd16uint16 @@ -1257,6 +1328,7 @@ faiss::simd16uint16::simd16uint16 (int x) simd16uint16 + faiss::simd16uint16::simd16uint16 int x @@ -1274,6 +1346,7 @@ faiss::simd16uint16::simd16uint16 (uint16_t x) simd16uint16 + faiss::simd16uint16::simd16uint16 uint16_t x @@ -1291,6 +1364,7 @@ faiss::simd16uint16::simd16uint16 (const uint16x8x2_t &v) simd16uint16 + faiss::simd16uint16::simd16uint16 const uint16x8x2_t & v @@ -1308,6 +1382,7 @@ faiss::simd16uint16::simd16uint16 (uint16_t u0, uint16_t u1, uint16_t u2, uint16_t u3, uint16_t u4, uint16_t u5, uint16_t u6, uint16_t u7, uint16_t u8, uint16_t u9, uint16_t u10, uint16_t u11, uint16_t u12, uint16_t u13, uint16_t u14, uint16_t u15) simd16uint16 + faiss::simd16uint16::simd16uint16 uint16_t u0 @@ -1394,6 +1469,7 @@ faiss::simd16uint16::simd16uint16 (const T &x) simd16uint16 + faiss::simd16uint16::simd16uint16 const T & x @@ -1411,6 +1487,7 @@ faiss::simd16uint16::simd16uint16 (const uint16_t *x) simd16uint16 + faiss::simd16uint16::simd16uint16 const uint16_t * x @@ -1428,6 +1505,7 @@ void faiss::simd16uint16::clear () clear + faiss::simd16uint16::clear @@ -1441,6 +1519,7 @@ void faiss::simd16uint16::storeu (uint16_t *ptr) const storeu + faiss::simd16uint16::storeu uint16_t * ptr @@ -1458,6 +1537,7 @@ void faiss::simd16uint16::loadu (const uint16_t *ptr) loadu + faiss::simd16uint16::loadu const uint16_t * ptr @@ -1475,6 +1555,7 @@ void faiss::simd16uint16::store (uint16_t *ptr) const store + faiss::simd16uint16::store uint16_t * ptr @@ -1492,6 +1573,7 @@ void faiss::simd16uint16::bin (char bits[257]) const bin + faiss::simd16uint16::bin char bits @@ -1510,6 +1592,7 @@ std::string faiss::simd16uint16::bin () const bin + faiss::simd16uint16::bin @@ -1523,6 +1606,7 @@ std::string faiss::simd16uint16::elements_to_string (const char *fmt) const elements_to_string + faiss::simd16uint16::elements_to_string const char * fmt @@ -1540,6 +1624,7 @@ std::string faiss::simd16uint16::hex () const hex + faiss::simd16uint16::hex @@ -1553,6 +1638,7 @@ std::string faiss::simd16uint16::dec () const dec + faiss::simd16uint16::dec @@ -1566,6 +1652,7 @@ void faiss::simd16uint16::set1 (uint16_t x) set1 + faiss::simd16uint16::set1 uint16_t x @@ -1583,6 +1670,7 @@ simd16uint16 faiss::simd16uint16::operator* (const simd16uint16 &other) const operator* + faiss::simd16uint16::operator* const simd16uint16 & other @@ -1600,6 +1688,7 @@ simd16uint16 faiss::simd16uint16::operator>> (const int shift) const operator>> + faiss::simd16uint16::operator>> const int shift @@ -1617,6 +1706,7 @@ simd16uint16 faiss::simd16uint16::operator<< (const int shift) const operator<< + faiss::simd16uint16::operator<< const int shift @@ -1634,6 +1724,7 @@ simd16uint16 faiss::simd16uint16::operator+= (const simd16uint16 &other) operator+= + faiss::simd16uint16::operator+= const simd16uint16 & other @@ -1651,6 +1742,7 @@ simd16uint16 faiss::simd16uint16::operator-= (const simd16uint16 &other) operator-= + faiss::simd16uint16::operator-= const simd16uint16 & other @@ -1668,6 +1760,7 @@ simd16uint16 faiss::simd16uint16::operator+ (const simd16uint16 &other) const operator+ + faiss::simd16uint16::operator+ const simd16uint16 & other @@ -1685,6 +1778,7 @@ simd16uint16 faiss::simd16uint16::operator- (const simd16uint16 &other) const operator- + faiss::simd16uint16::operator- const simd16uint16 & other @@ -1711,6 +1805,7 @@ simd16uint16 faiss::simd16uint16::operator& (const T &other) const operator& + faiss::simd16uint16::operator& const T & other @@ -1737,6 +1832,7 @@ simd16uint16 faiss::simd16uint16::operator| (const T &other) const operator| + faiss::simd16uint16::operator| const T & other @@ -1763,6 +1859,7 @@ simd16uint16 faiss::simd16uint16::operator^ (const T &other) const operator^ + faiss::simd16uint16::operator^ const T & other @@ -1780,6 +1877,7 @@ simd16uint16 faiss::simd16uint16::operator== (const simd16uint16 &other) const operator== + faiss::simd16uint16::operator== const simd16uint16 & other @@ -1802,6 +1900,7 @@ bool faiss::simd16uint16::is_same_as (T other) const is_same_as + faiss::simd16uint16::is_same_as T other @@ -1819,6 +1918,7 @@ simd16uint16 faiss::simd16uint16::operator~ () const operator~ + faiss::simd16uint16::operator~ @@ -1832,6 +1932,7 @@ uint16_t faiss::simd16uint16::get_scalar_0 () const get_scalar_0 + faiss::simd16uint16::get_scalar_0 @@ -1845,6 +1946,7 @@ uint32_t faiss::simd16uint16::ge_mask (const simd16uint16 &thresh) const ge_mask + faiss::simd16uint16::ge_mask const simd16uint16 & thresh @@ -1862,6 +1964,7 @@ uint32_t faiss::simd16uint16::le_mask (const simd16uint16 &thresh) const le_mask + faiss::simd16uint16::le_mask const simd16uint16 & thresh @@ -1879,6 +1982,7 @@ uint32_t faiss::simd16uint16::gt_mask (const simd16uint16 &thresh) const gt_mask + faiss::simd16uint16::gt_mask const simd16uint16 & thresh @@ -1896,6 +2000,7 @@ bool faiss::simd16uint16::all_gt (const simd16uint16 &thresh) const all_gt + faiss::simd16uint16::all_gt const simd16uint16 & thresh @@ -1913,6 +2018,7 @@ uint16_t faiss::simd16uint16::operator[] (int i) const operator[] + faiss::simd16uint16::operator[] int i @@ -1930,6 +2036,7 @@ void faiss::simd16uint16::accu_min (const simd16uint16 &incoming) accu_min + faiss::simd16uint16::accu_min const simd16uint16 & incoming @@ -1947,6 +2054,7 @@ void faiss::simd16uint16::accu_max (const simd16uint16 &incoming) accu_max + faiss::simd16uint16::accu_max const simd16uint16 & incoming @@ -1964,6 +2072,7 @@ faiss::simd16uint16::simd16uint16 () simd16uint16 + faiss::simd16uint16::simd16uint16 @@ -1977,6 +2086,7 @@ faiss::simd16uint16::simd16uint16 (int x) simd16uint16 + faiss::simd16uint16::simd16uint16 int x @@ -1994,6 +2104,7 @@ faiss::simd16uint16::simd16uint16 (uint16_t x) simd16uint16 + faiss::simd16uint16::simd16uint16 uint16_t x @@ -2011,6 +2122,7 @@ faiss::simd16uint16::simd16uint16 (const simd256bit &x) simd16uint16 + faiss::simd16uint16::simd16uint16 const simd256bit & x @@ -2028,6 +2140,7 @@ faiss::simd16uint16::simd16uint16 (const uint16_t *x) simd16uint16 + faiss::simd16uint16::simd16uint16 const uint16_t * x @@ -2045,6 +2158,7 @@ faiss::simd16uint16::simd16uint16 (uint16_t u0, uint16_t u1, uint16_t u2, uint16_t u3, uint16_t u4, uint16_t u5, uint16_t u6, uint16_t u7, uint16_t u8, uint16_t u9, uint16_t u10, uint16_t u11, uint16_t u12, uint16_t u13, uint16_t u14, uint16_t u15) simd16uint16 + faiss::simd16uint16::simd16uint16 uint16_t u0 @@ -2122,6 +2236,7 @@ std::string faiss::simd16uint16::elements_to_string (const char *fmt) const elements_to_string + faiss::simd16uint16::elements_to_string const char * fmt @@ -2139,6 +2254,7 @@ std::string faiss::simd16uint16::hex () const hex + faiss::simd16uint16::hex @@ -2152,6 +2268,7 @@ std::string faiss::simd16uint16::dec () const dec + faiss::simd16uint16::dec @@ -2165,6 +2282,7 @@ void faiss::simd16uint16::set1 (uint16_t x) set1 + faiss::simd16uint16::set1 uint16_t x @@ -2182,6 +2300,7 @@ simd16uint16 faiss::simd16uint16::operator* (const simd16uint16 &other) const operator* + faiss::simd16uint16::operator* const simd16uint16 & other @@ -2199,6 +2318,7 @@ simd16uint16 faiss::simd16uint16::operator>> (const int shift) const operator>> + faiss::simd16uint16::operator>> const int shift @@ -2216,6 +2336,7 @@ simd16uint16 faiss::simd16uint16::operator<< (const int shift) const operator<< + faiss::simd16uint16::operator<< const int shift @@ -2233,6 +2354,7 @@ simd16uint16 faiss::simd16uint16::operator+= (const simd16uint16 &other) operator+= + faiss::simd16uint16::operator+= const simd16uint16 & other @@ -2250,6 +2372,7 @@ simd16uint16 faiss::simd16uint16::operator-= (const simd16uint16 &other) operator-= + faiss::simd16uint16::operator-= const simd16uint16 & other @@ -2267,6 +2390,7 @@ simd16uint16 faiss::simd16uint16::operator+ (const simd16uint16 &other) const operator+ + faiss::simd16uint16::operator+ const simd16uint16 & other @@ -2284,6 +2408,7 @@ simd16uint16 faiss::simd16uint16::operator- (const simd16uint16 &other) const operator- + faiss::simd16uint16::operator- const simd16uint16 & other @@ -2301,6 +2426,7 @@ simd16uint16 faiss::simd16uint16::operator& (const simd256bit &other) const operator& + faiss::simd16uint16::operator& const simd256bit & other @@ -2318,6 +2444,7 @@ simd16uint16 faiss::simd16uint16::operator| (const simd256bit &other) const operator| + faiss::simd16uint16::operator| const simd256bit & other @@ -2335,6 +2462,7 @@ simd16uint16 faiss::simd16uint16::operator^ (const simd256bit &other) const operator^ + faiss::simd16uint16::operator^ const simd256bit & other @@ -2352,6 +2480,7 @@ simd16uint16 faiss::simd16uint16::operator== (const simd16uint16 &other) const operator== + faiss::simd16uint16::operator== const simd16uint16 & other @@ -2369,6 +2498,7 @@ simd16uint16 faiss::simd16uint16::operator~ () const operator~ + faiss::simd16uint16::operator~ @@ -2382,6 +2512,7 @@ uint16_t faiss::simd16uint16::get_scalar_0 () const get_scalar_0 + faiss::simd16uint16::get_scalar_0 @@ -2395,6 +2526,7 @@ uint32_t faiss::simd16uint16::ge_mask (const simd16uint16 &thresh) const ge_mask + faiss::simd16uint16::ge_mask const simd16uint16 & thresh @@ -2412,6 +2544,7 @@ uint32_t faiss::simd16uint16::le_mask (const simd16uint16 &thresh) const le_mask + faiss::simd16uint16::le_mask const simd16uint16 & thresh @@ -2429,6 +2562,7 @@ uint32_t faiss::simd16uint16::gt_mask (const simd16uint16 &thresh) const gt_mask + faiss::simd16uint16::gt_mask const simd16uint16 & thresh @@ -2446,6 +2580,7 @@ bool faiss::simd16uint16::all_gt (const simd16uint16 &thresh) const all_gt + faiss::simd16uint16::all_gt const simd16uint16 & thresh @@ -2463,6 +2598,7 @@ uint16_t faiss::simd16uint16::operator[] (int i) const operator[] + faiss::simd16uint16::operator[] int i @@ -2480,6 +2616,7 @@ void faiss::simd16uint16::accu_min (const simd16uint16 &incoming) accu_min + faiss::simd16uint16::accu_min const simd16uint16 & incoming @@ -2497,6 +2634,7 @@ void faiss::simd16uint16::accu_max (const simd16uint16 &incoming) accu_max + faiss::simd16uint16::accu_max const simd16uint16 & incoming @@ -2514,6 +2652,7 @@ void faiss::simd256bit::storeu (void *ptr) const storeu + faiss::simd256bit::storeu void * ptr @@ -2531,6 +2670,7 @@ void faiss::simd256bit::loadu (const void *ptr) loadu + faiss::simd256bit::loadu const void * ptr @@ -2548,6 +2688,7 @@ void faiss::simd256bit::store (void *ptr) const store + faiss::simd256bit::store void * ptr @@ -2565,6 +2706,7 @@ bool faiss::simd256bit::is_same_as (simd256bit other) const is_same_as + faiss::simd256bit::is_same_as simd256bit other @@ -2577,13 +2719,14 @@ - - + + simd16uint16 simd16uint16 operator== (const simd256bit lhs, const simd256bit rhs) operator== + faiss::simd16uint16::operator== const simd256bit lhs @@ -2600,8 +2743,8 @@ - - + + @@ -2612,6 +2755,7 @@ static simd16uint16 faiss::simd16uint16::unary_func (const simd16uint16 &a, F &&f) unary_func + faiss::simd16uint16::unary_func const simd16uint16 & a @@ -2638,6 +2782,7 @@ static simd16uint16 faiss::simd16uint16::binary_func (const simd16uint16 &a, const simd16uint16 &b, F &&f) binary_func + faiss::simd16uint16::binary_func const simd16uint16 & a @@ -2668,6 +2813,7 @@ static simd16uint16 faiss::simd16uint16::unary_func (const simd16uint16 &a, F &&f) unary_func + faiss::simd16uint16::unary_func const simd16uint16 & a @@ -2694,6 +2840,7 @@ static simd16uint16 faiss::simd16uint16::binary_func (const simd16uint16 &a, const simd16uint16 &b, F &&f) binary_func + faiss::simd16uint16::binary_func const simd16uint16 & a @@ -2714,17 +2861,13 @@ - + vector of 16 elements in uint16 - - - - @@ -2735,12 +2878,12 @@ - - + + @@ -2751,6 +2894,10 @@ + + + + diff --git a/xml/structfaiss_1_1simd256bit.xml b/xml/structfaiss_1_1simd256bit.xml index 3c0fdfd156..d7722a1848 100644 --- a/xml/structfaiss_1_1simd256bit.xml +++ b/xml/structfaiss_1_1simd256bit.xml @@ -1,5 +1,5 @@ - + faiss::simd256bit faiss::simd16uint16 @@ -15,12 +15,13 @@ faiss::simd8uint32 faiss::simd8uint32 simdlib_avx2.h - + __m256i __m256i faiss::simd256bit::i i + faiss::simd256bit::i @@ -34,6 +35,7 @@ __m256 faiss::simd256bit::f f + faiss::simd256bit::f @@ -43,10 +45,11 @@ - union faiss::simd256bit::@0 - union faiss::simd256bit::@0 faiss::simd256bit::@1 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @1 + + faiss::simd256bit @@ -60,6 +63,7 @@ uint8_t faiss::simd256bit::u8[32] [32] u8 + faiss::simd256bit::u8 @@ -73,6 +77,7 @@ uint16_t faiss::simd256bit::u16[16] [16] u16 + faiss::simd256bit::u16 @@ -86,6 +91,7 @@ uint32_t faiss::simd256bit::u32[8] [8] u32 + faiss::simd256bit::u32 @@ -99,6 +105,7 @@ float faiss::simd256bit::f32[8] [8] f32 + faiss::simd256bit::f32 @@ -108,10 +115,11 @@ - union faiss::simd256bit::@4 - union faiss::simd256bit::@4 faiss::simd256bit::@5 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @5 + + faiss::simd256bit @@ -121,10 +129,11 @@ - union faiss::simd256bit::@6 - union faiss::simd256bit::@6 faiss::simd256bit::@7 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @7 + + faiss::simd256bit @@ -133,13 +142,14 @@ - - + + faiss::simd256bit::simd256bit () simd256bit + faiss::simd256bit::simd256bit @@ -153,6 +163,7 @@ faiss::simd256bit::simd256bit (__m256i i) simd256bit + faiss::simd256bit::simd256bit __m256i i @@ -170,6 +181,7 @@ faiss::simd256bit::simd256bit (__m256 f) simd256bit + faiss::simd256bit::simd256bit __m256 f @@ -187,6 +199,7 @@ faiss::simd256bit::simd256bit (const void *x) simd256bit + faiss::simd256bit::simd256bit const void * x @@ -204,6 +217,7 @@ void faiss::simd256bit::clear () clear + faiss::simd256bit::clear @@ -217,6 +231,7 @@ void faiss::simd256bit::storeu (void *ptr) const storeu + faiss::simd256bit::storeu void * ptr @@ -234,6 +249,7 @@ void faiss::simd256bit::loadu (const void *ptr) loadu + faiss::simd256bit::loadu const void * ptr @@ -251,6 +267,7 @@ void faiss::simd256bit::store (void *ptr) const store + faiss::simd256bit::store void * ptr @@ -268,6 +285,7 @@ void faiss::simd256bit::bin (char bits[257]) const bin + faiss::simd256bit::bin char bits @@ -286,6 +304,7 @@ std::string faiss::simd256bit::bin () const bin + faiss::simd256bit::bin @@ -299,6 +318,7 @@ bool faiss::simd256bit::is_same_as (simd256bit other) const is_same_as + faiss::simd256bit::is_same_as simd256bit other @@ -316,6 +336,7 @@ faiss::simd256bit::simd256bit () simd256bit + faiss::simd256bit::simd256bit @@ -329,6 +350,7 @@ faiss::simd256bit::simd256bit (const void *x) simd256bit + faiss::simd256bit::simd256bit const void * x @@ -346,6 +368,7 @@ void faiss::simd256bit::clear () clear + faiss::simd256bit::clear @@ -359,6 +382,7 @@ void faiss::simd256bit::storeu (void *ptr) const storeu + faiss::simd256bit::storeu void * ptr @@ -376,6 +400,7 @@ void faiss::simd256bit::loadu (const void *ptr) loadu + faiss::simd256bit::loadu const void * ptr @@ -393,6 +418,7 @@ void faiss::simd256bit::store (void *ptr) const store + faiss::simd256bit::store void * ptr @@ -410,6 +436,7 @@ void faiss::simd256bit::bin (char bits[257]) const bin + faiss::simd256bit::bin char bits @@ -428,6 +455,7 @@ std::string faiss::simd256bit::bin () const bin + faiss::simd256bit::bin @@ -441,6 +469,7 @@ bool faiss::simd256bit::is_same_as (simd256bit other) const is_same_as + faiss::simd256bit::is_same_as simd256bit other @@ -458,6 +487,7 @@ faiss::simd256bit::simd256bit () simd256bit + faiss::simd256bit::simd256bit @@ -471,6 +501,7 @@ faiss::simd256bit::simd256bit (const void *x) simd256bit + faiss::simd256bit::simd256bit const void * x @@ -488,6 +519,7 @@ void faiss::simd256bit::clear () clear + faiss::simd256bit::clear @@ -501,6 +533,7 @@ void faiss::simd256bit::storeu (void *ptr) const storeu + faiss::simd256bit::storeu void * ptr @@ -518,6 +551,7 @@ void faiss::simd256bit::loadu (const void *ptr) loadu + faiss::simd256bit::loadu const void * ptr @@ -535,6 +569,7 @@ void faiss::simd256bit::store (void *ptr) const store + faiss::simd256bit::store void * ptr @@ -552,6 +587,7 @@ void faiss::simd256bit::bin (char bits[257]) const bin + faiss::simd256bit::bin char bits @@ -570,6 +606,7 @@ std::string faiss::simd256bit::bin () const bin + faiss::simd256bit::bin @@ -583,6 +620,7 @@ bool faiss::simd256bit::is_same_as (simd256bit other) const is_same_as + faiss::simd256bit::is_same_as simd256bit other @@ -595,7 +633,7 @@ - + 256-bit representation without interpretation as a vector @@ -604,19 +642,9 @@ The objective is to separate the different interpretations of the same registers (as a vector of uint8, uint16 or uint32), to provide printing functions, and to give more readable names to the AVX intrinsics. It does not pretend to be exhausitve, functions are added as needed. - - - - - - - - - - - - - + + + @@ -628,9 +656,9 @@ - - - + + + @@ -648,6 +676,16 @@ + + + + + + + + + + diff --git a/xml/structfaiss_1_1simd32uint16.xml b/xml/structfaiss_1_1simd32uint16.xml index 1881d78525..38a82e973c 100644 --- a/xml/structfaiss_1_1simd32uint16.xml +++ b/xml/structfaiss_1_1simd32uint16.xml @@ -1,15 +1,16 @@ - + faiss::simd32uint16 faiss::simd512bit simdlib_avx512.h - + faiss::simd32uint16::simd32uint16 () simd32uint16 + faiss::simd32uint16::simd32uint16 @@ -23,6 +24,7 @@ faiss::simd32uint16::simd32uint16 (__m512i i) simd32uint16 + faiss::simd32uint16::simd32uint16 __m512i i @@ -40,6 +42,7 @@ faiss::simd32uint16::simd32uint16 (int x) simd32uint16 + faiss::simd32uint16::simd32uint16 int x @@ -57,6 +60,7 @@ faiss::simd32uint16::simd32uint16 (uint16_t x) simd32uint16 + faiss::simd32uint16::simd32uint16 uint16_t x @@ -74,6 +78,7 @@ faiss::simd32uint16::simd32uint16 (simd512bit x) simd32uint16 + faiss::simd32uint16::simd32uint16 simd512bit x @@ -91,6 +96,7 @@ faiss::simd32uint16::simd32uint16 (const uint16_t *x) simd32uint16 + faiss::simd32uint16::simd32uint16 const uint16_t * x @@ -108,6 +114,7 @@ faiss::simd32uint16::simd32uint16 (simd256bit lo) simd32uint16 + faiss::simd32uint16::simd32uint16 simd256bit lo @@ -125,6 +132,7 @@ faiss::simd32uint16::simd32uint16 (simd256bit lo, simd256bit hi) simd32uint16 + faiss::simd32uint16::simd32uint16 simd256bit lo @@ -146,6 +154,7 @@ std::string faiss::simd32uint16::elements_to_string (const char *fmt) const elements_to_string + faiss::simd32uint16::elements_to_string const char * fmt @@ -163,6 +172,7 @@ std::string faiss::simd32uint16::hex () const hex + faiss::simd32uint16::hex @@ -176,6 +186,7 @@ std::string faiss::simd32uint16::dec () const dec + faiss::simd32uint16::dec @@ -189,6 +200,7 @@ void faiss::simd32uint16::set1 (uint16_t x) set1 + faiss::simd32uint16::set1 uint16_t x @@ -206,6 +218,7 @@ simd32uint16 faiss::simd32uint16::operator* (const simd32uint16 &other) const operator* + faiss::simd32uint16::operator* const simd32uint16 & other @@ -223,6 +236,7 @@ simd32uint16 faiss::simd32uint16::operator>> (const int shift) const operator>> + faiss::simd32uint16::operator>> const int shift @@ -240,6 +254,7 @@ simd32uint16 faiss::simd32uint16::operator<< (const int shift) const operator<< + faiss::simd32uint16::operator<< const int shift @@ -257,6 +272,7 @@ simd32uint16 faiss::simd32uint16::operator+= (simd32uint16 other) operator+= + faiss::simd32uint16::operator+= simd32uint16 other @@ -274,6 +290,7 @@ simd32uint16 faiss::simd32uint16::operator-= (simd32uint16 other) operator-= + faiss::simd32uint16::operator-= simd32uint16 other @@ -291,6 +308,7 @@ simd32uint16 faiss::simd32uint16::operator+ (simd32uint16 other) const operator+ + faiss::simd32uint16::operator+ simd32uint16 other @@ -308,6 +326,7 @@ simd32uint16 faiss::simd32uint16::operator- (simd32uint16 other) const operator- + faiss::simd32uint16::operator- simd32uint16 other @@ -325,6 +344,7 @@ simd32uint16 faiss::simd32uint16::operator& (simd512bit other) const operator& + faiss::simd32uint16::operator& simd512bit other @@ -342,6 +362,7 @@ simd32uint16 faiss::simd32uint16::operator| (simd512bit other) const operator| + faiss::simd32uint16::operator| simd512bit other @@ -359,6 +380,7 @@ simd32uint16 faiss::simd32uint16::operator^ (simd512bit other) const operator^ + faiss::simd32uint16::operator^ simd512bit other @@ -376,6 +398,7 @@ simd32uint16 faiss::simd32uint16::operator~ () const operator~ + faiss::simd32uint16::operator~ @@ -389,6 +412,7 @@ simd16uint16 faiss::simd32uint16::low () const low + faiss::simd32uint16::low @@ -402,6 +426,7 @@ simd16uint16 faiss::simd32uint16::high () const high + faiss::simd32uint16::high @@ -415,6 +440,7 @@ uint16_t faiss::simd32uint16::operator[] (int i) const operator[] + faiss::simd32uint16::operator[] int i @@ -432,6 +458,7 @@ void faiss::simd32uint16::accu_min (simd32uint16 incoming) accu_min + faiss::simd32uint16::accu_min simd32uint16 incoming @@ -449,6 +476,7 @@ void faiss::simd32uint16::accu_max (simd32uint16 incoming) accu_max + faiss::simd32uint16::accu_max simd32uint16 incoming @@ -466,6 +494,7 @@ void faiss::simd512bit::clear () clear + faiss::simd512bit::clear @@ -479,6 +508,7 @@ void faiss::simd512bit::storeu (void *ptr) const storeu + faiss::simd512bit::storeu void * ptr @@ -496,6 +526,7 @@ void faiss::simd512bit::loadu (const void *ptr) loadu + faiss::simd512bit::loadu const void * ptr @@ -513,6 +544,7 @@ void faiss::simd512bit::store (void *ptr) const store + faiss::simd512bit::store void * ptr @@ -530,6 +562,7 @@ void faiss::simd512bit::bin (char bits[513]) const bin + faiss::simd512bit::bin char bits @@ -548,6 +581,7 @@ std::string faiss::simd512bit::bin () const bin + faiss::simd512bit::bin @@ -556,13 +590,14 @@ - - + + __m512i __m512i faiss::simd512bit::i i + faiss::simd512bit::i @@ -576,6 +611,7 @@ __m512 faiss::simd512bit::f f + faiss::simd512bit::f @@ -585,10 +621,11 @@ - union faiss::simd512bit::@2 - union faiss::simd512bit::@2 faiss::simd512bit::@3 + union faiss::simd512bit + union faiss::simd512bit faiss::simd512bit - @3 + + faiss::simd512bit @@ -597,35 +634,35 @@ - + vector of 32 elements in uint16 - - - - - - + + + + + + diff --git a/xml/structfaiss_1_1simd32uint8.xml b/xml/structfaiss_1_1simd32uint8.xml index 1e03b2fdd6..28a4bbeffc 100644 --- a/xml/structfaiss_1_1simd32uint8.xml +++ b/xml/structfaiss_1_1simd32uint8.xml @@ -1,16 +1,17 @@ - + faiss::simd32uint8 faiss::simd256bit faiss::simd256bit faiss::simd256bit - + uint8x16x2_t uint8x16x2_t faiss::simd32uint8::data data + faiss::simd32uint8::data @@ -24,6 +25,7 @@ __m256i faiss::simd256bit::i i + faiss::simd256bit::i @@ -37,6 +39,7 @@ __m256 faiss::simd256bit::f f + faiss::simd256bit::f @@ -46,10 +49,11 @@ - union faiss::simd256bit::@0 - union faiss::simd256bit::@0 faiss::simd256bit::@1 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @1 + + faiss::simd256bit @@ -63,6 +67,7 @@ uint8_t faiss::simd256bit::u8[32] [32] u8 + faiss::simd256bit::u8 @@ -76,6 +81,7 @@ uint16_t faiss::simd256bit::u16[16] [16] u16 + faiss::simd256bit::u16 @@ -89,6 +95,7 @@ uint32_t faiss::simd256bit::u32[8] [8] u32 + faiss::simd256bit::u32 @@ -102,6 +109,7 @@ float faiss::simd256bit::f32[8] [8] f32 + faiss::simd256bit::f32 @@ -111,10 +119,11 @@ - union faiss::simd256bit::@4 - union faiss::simd256bit::@4 faiss::simd256bit::@5 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @5 + + faiss::simd256bit @@ -124,10 +133,11 @@ - union faiss::simd256bit::@6 - union faiss::simd256bit::@6 faiss::simd256bit::@7 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @7 + + faiss::simd256bit @@ -136,13 +146,14 @@ - - + + faiss::simd32uint8::simd32uint8 () simd32uint8 + faiss::simd32uint8::simd32uint8 @@ -156,6 +167,7 @@ faiss::simd32uint8::simd32uint8 (__m256i i) simd32uint8 + faiss::simd32uint8::simd32uint8 __m256i i @@ -173,6 +185,7 @@ faiss::simd32uint8::simd32uint8 (int x) simd32uint8 + faiss::simd32uint8::simd32uint8 int x @@ -190,6 +203,7 @@ faiss::simd32uint8::simd32uint8 (uint8_t x) simd32uint8 + faiss::simd32uint8::simd32uint8 uint8_t x @@ -207,6 +221,7 @@ faiss::simd32uint8::simd32uint8 (simd256bit x) simd32uint8 + faiss::simd32uint8::simd32uint8 simd256bit x @@ -224,6 +239,7 @@ faiss::simd32uint8::simd32uint8 (const uint8_t *x) simd32uint8 + faiss::simd32uint8::simd32uint8 const uint8_t * x @@ -241,6 +257,7 @@ std::string faiss::simd32uint8::elements_to_string (const char *fmt) const elements_to_string + faiss::simd32uint8::elements_to_string const char * fmt @@ -258,6 +275,7 @@ std::string faiss::simd32uint8::hex () const hex + faiss::simd32uint8::hex @@ -271,6 +289,7 @@ std::string faiss::simd32uint8::dec () const dec + faiss::simd32uint8::dec @@ -284,6 +303,7 @@ void faiss::simd32uint8::set1 (uint8_t x) set1 + faiss::simd32uint8::set1 uint8_t x @@ -301,6 +321,7 @@ simd32uint8 faiss::simd32uint8::operator& (simd256bit other) const operator& + faiss::simd32uint8::operator& simd256bit other @@ -318,6 +339,7 @@ simd32uint8 faiss::simd32uint8::operator+ (simd32uint8 other) const operator+ + faiss::simd32uint8::operator+ simd32uint8 other @@ -335,6 +357,7 @@ simd32uint8 faiss::simd32uint8::lookup_2_lanes (simd32uint8 idx) const lookup_2_lanes + faiss::simd32uint8::lookup_2_lanes simd32uint8 idx @@ -352,6 +375,7 @@ simd16uint16 faiss::simd32uint8::lane0_as_uint16 () const lane0_as_uint16 + faiss::simd32uint8::lane0_as_uint16 @@ -365,6 +389,7 @@ simd16uint16 faiss::simd32uint8::lane1_as_uint16 () const lane1_as_uint16 + faiss::simd32uint8::lane1_as_uint16 @@ -378,6 +403,7 @@ simd32uint8 faiss::simd32uint8::operator+= (simd32uint8 other) operator+= + faiss::simd32uint8::operator+= simd32uint8 other @@ -395,6 +421,7 @@ uint8_t faiss::simd32uint8::operator[] (int i) const operator[] + faiss::simd32uint8::operator[] int i @@ -412,6 +439,7 @@ faiss::simd32uint8::simd32uint8 () simd32uint8 + faiss::simd32uint8::simd32uint8 @@ -425,6 +453,7 @@ faiss::simd32uint8::simd32uint8 (int x) simd32uint8 + faiss::simd32uint8::simd32uint8 int x @@ -442,6 +471,7 @@ faiss::simd32uint8::simd32uint8 (uint8_t x) simd32uint8 + faiss::simd32uint8::simd32uint8 uint8_t x @@ -459,6 +489,7 @@ faiss::simd32uint8::simd32uint8 (const simd256bit &x) simd32uint8 + faiss::simd32uint8::simd32uint8 const simd256bit & x @@ -476,6 +507,7 @@ faiss::simd32uint8::simd32uint8 (const uint8_t *x) simd32uint8 + faiss::simd32uint8::simd32uint8 const uint8_t * x @@ -493,6 +525,7 @@ std::string faiss::simd32uint8::elements_to_string (const char *fmt) const elements_to_string + faiss::simd32uint8::elements_to_string const char * fmt @@ -510,6 +543,7 @@ std::string faiss::simd32uint8::hex () const hex + faiss::simd32uint8::hex @@ -523,6 +557,7 @@ std::string faiss::simd32uint8::dec () const dec + faiss::simd32uint8::dec @@ -536,6 +571,7 @@ void faiss::simd32uint8::set1 (uint8_t x) set1 + faiss::simd32uint8::set1 uint8_t x @@ -553,6 +589,7 @@ simd32uint8 faiss::simd32uint8::operator& (const simd256bit &other) const operator& + faiss::simd32uint8::operator& const simd256bit & other @@ -570,6 +607,7 @@ simd32uint8 faiss::simd32uint8::operator+ (const simd32uint8 &other) const operator+ + faiss::simd32uint8::operator+ const simd32uint8 & other @@ -587,6 +625,7 @@ simd32uint8 faiss::simd32uint8::lookup_2_lanes (const simd32uint8 &idx) const lookup_2_lanes + faiss::simd32uint8::lookup_2_lanes const simd32uint8 & idx @@ -604,6 +643,7 @@ simd32uint8 faiss::simd32uint8::operator+= (const simd32uint8 &other) operator+= + faiss::simd32uint8::operator+= const simd32uint8 & other @@ -621,6 +661,7 @@ uint8_t faiss::simd32uint8::operator[] (int i) const operator[] + faiss::simd32uint8::operator[] int i @@ -638,6 +679,7 @@ faiss::simd32uint8::simd32uint8 ()=default simd32uint8 + faiss::simd32uint8::simd32uint8 @@ -651,6 +693,7 @@ faiss::simd32uint8::simd32uint8 (int x) simd32uint8 + faiss::simd32uint8::simd32uint8 int x @@ -668,6 +711,7 @@ faiss::simd32uint8::simd32uint8 (uint8_t x) simd32uint8 + faiss::simd32uint8::simd32uint8 uint8_t x @@ -685,6 +729,7 @@ faiss::simd32uint8::simd32uint8 (const uint8x16x2_t &v) simd32uint8 + faiss::simd32uint8::simd32uint8 const uint8x16x2_t & v @@ -711,6 +756,7 @@ faiss::simd32uint8::simd32uint8 (const T &x) simd32uint8 + faiss::simd32uint8::simd32uint8 const T & x @@ -728,6 +774,7 @@ faiss::simd32uint8::simd32uint8 (const uint8_t *x) simd32uint8 + faiss::simd32uint8::simd32uint8 const uint8_t * x @@ -745,6 +792,7 @@ void faiss::simd32uint8::clear () clear + faiss::simd32uint8::clear @@ -758,6 +806,7 @@ void faiss::simd32uint8::storeu (uint8_t *ptr) const storeu + faiss::simd32uint8::storeu uint8_t * ptr @@ -775,6 +824,7 @@ void faiss::simd32uint8::loadu (const uint8_t *ptr) loadu + faiss::simd32uint8::loadu const uint8_t * ptr @@ -792,6 +842,7 @@ void faiss::simd32uint8::store (uint8_t *ptr) const store + faiss::simd32uint8::store uint8_t * ptr @@ -809,6 +860,7 @@ void faiss::simd32uint8::bin (char bits[257]) const bin + faiss::simd32uint8::bin char bits @@ -827,6 +879,7 @@ std::string faiss::simd32uint8::bin () const bin + faiss::simd32uint8::bin @@ -840,6 +893,7 @@ std::string faiss::simd32uint8::elements_to_string (const char *fmt) const elements_to_string + faiss::simd32uint8::elements_to_string const char * fmt @@ -857,6 +911,7 @@ std::string faiss::simd32uint8::hex () const hex + faiss::simd32uint8::hex @@ -870,6 +925,7 @@ std::string faiss::simd32uint8::dec () const dec + faiss::simd32uint8::dec @@ -883,6 +939,7 @@ void faiss::simd32uint8::set1 (uint8_t x) set1 + faiss::simd32uint8::set1 uint8_t x @@ -909,6 +966,7 @@ simd32uint8 faiss::simd32uint8::operator& (const T &other) const operator& + faiss::simd32uint8::operator& const T & other @@ -926,6 +984,7 @@ simd32uint8 faiss::simd32uint8::operator+ (const simd32uint8 &other) const operator+ + faiss::simd32uint8::operator+ const simd32uint8 & other @@ -943,6 +1002,7 @@ simd32uint8 faiss::simd32uint8::lookup_2_lanes (const simd32uint8 &idx) const lookup_2_lanes + faiss::simd32uint8::lookup_2_lanes const simd32uint8 & idx @@ -960,6 +1020,7 @@ simd32uint8 faiss::simd32uint8::operator+= (const simd32uint8 &other) operator+= + faiss::simd32uint8::operator+= const simd32uint8 & other @@ -977,6 +1038,7 @@ uint8_t faiss::simd32uint8::operator[] (int i) const operator[] + faiss::simd32uint8::operator[] int i @@ -999,6 +1061,7 @@ bool faiss::simd32uint8::is_same_as (T other) const is_same_as + faiss::simd32uint8::is_same_as T other @@ -1016,6 +1079,7 @@ faiss::simd32uint8::simd32uint8 () simd32uint8 + faiss::simd32uint8::simd32uint8 @@ -1029,6 +1093,7 @@ faiss::simd32uint8::simd32uint8 (int x) simd32uint8 + faiss::simd32uint8::simd32uint8 int x @@ -1046,6 +1111,7 @@ faiss::simd32uint8::simd32uint8 (uint8_t x) simd32uint8 + faiss::simd32uint8::simd32uint8 uint8_t x @@ -1063,6 +1129,7 @@ faiss::simd32uint8::simd32uint8 (const simd256bit &x) simd32uint8 + faiss::simd32uint8::simd32uint8 const simd256bit & x @@ -1080,6 +1147,7 @@ faiss::simd32uint8::simd32uint8 (const uint8_t *x) simd32uint8 + faiss::simd32uint8::simd32uint8 const uint8_t * x @@ -1097,6 +1165,7 @@ std::string faiss::simd32uint8::elements_to_string (const char *fmt) const elements_to_string + faiss::simd32uint8::elements_to_string const char * fmt @@ -1114,6 +1183,7 @@ std::string faiss::simd32uint8::hex () const hex + faiss::simd32uint8::hex @@ -1127,6 +1197,7 @@ std::string faiss::simd32uint8::dec () const dec + faiss::simd32uint8::dec @@ -1140,6 +1211,7 @@ void faiss::simd32uint8::set1 (uint8_t x) set1 + faiss::simd32uint8::set1 uint8_t x @@ -1157,6 +1229,7 @@ simd32uint8 faiss::simd32uint8::operator& (const simd256bit &other) const operator& + faiss::simd32uint8::operator& const simd256bit & other @@ -1174,6 +1247,7 @@ simd32uint8 faiss::simd32uint8::operator+ (const simd32uint8 &other) const operator+ + faiss::simd32uint8::operator+ const simd32uint8 & other @@ -1191,6 +1265,7 @@ simd32uint8 faiss::simd32uint8::lookup_2_lanes (const simd32uint8 &idx) const lookup_2_lanes + faiss::simd32uint8::lookup_2_lanes const simd32uint8 & idx @@ -1208,6 +1283,7 @@ simd32uint8 faiss::simd32uint8::operator+= (const simd32uint8 &other) operator+= + faiss::simd32uint8::operator+= const simd32uint8 & other @@ -1225,6 +1301,7 @@ uint8_t faiss::simd32uint8::operator[] (int i) const operator[] + faiss::simd32uint8::operator[] int i @@ -1242,6 +1319,7 @@ void faiss::simd256bit::storeu (void *ptr) const storeu + faiss::simd256bit::storeu void * ptr @@ -1259,6 +1337,7 @@ void faiss::simd256bit::loadu (const void *ptr) loadu + faiss::simd256bit::loadu const void * ptr @@ -1276,6 +1355,7 @@ void faiss::simd256bit::store (void *ptr) const store + faiss::simd256bit::store void * ptr @@ -1293,6 +1373,7 @@ bool faiss::simd256bit::is_same_as (simd256bit other) const is_same_as + faiss::simd256bit::is_same_as simd256bit other @@ -1305,8 +1386,8 @@ - - + + @@ -1474,6 +1555,7 @@ static simd32uint8 faiss::simd32uint8::create () create + faiss::simd32uint8::create @@ -1649,6 +1731,7 @@ static simd32uint8 faiss::simd32uint8::create () create + faiss::simd32uint8::create @@ -1667,6 +1750,7 @@ static simd32uint8 faiss::simd32uint8::binary_func (const simd32uint8 &a, const simd32uint8 &b, F &&f) binary_func + faiss::simd32uint8::binary_func const simd32uint8 & a @@ -1854,6 +1938,7 @@ static simd32uint8 faiss::simd32uint8::create () create + faiss::simd32uint8::create @@ -2029,6 +2114,7 @@ static simd32uint8 faiss::simd32uint8::create () create + faiss::simd32uint8::create @@ -2047,6 +2133,7 @@ static simd32uint8 faiss::simd32uint8::binary_func (const simd32uint8 &a, const simd32uint8 &b, F &&f) binary_func + faiss::simd32uint8::binary_func const simd32uint8 & a @@ -2067,12 +2154,16 @@ - + + + + + @@ -2083,12 +2174,12 @@ + + - - @@ -2099,10 +2190,6 @@ - - - - diff --git a/xml/structfaiss_1_1simd512bit.xml b/xml/structfaiss_1_1simd512bit.xml index 311cf48df5..c6b10a7655 100644 --- a/xml/structfaiss_1_1simd512bit.xml +++ b/xml/structfaiss_1_1simd512bit.xml @@ -1,16 +1,17 @@ - + faiss::simd512bit faiss::simd32uint16 faiss::simd64uint8 simdlib_avx512.h - + __m512i __m512i faiss::simd512bit::i i + faiss::simd512bit::i @@ -24,6 +25,7 @@ __m512 faiss::simd512bit::f f + faiss::simd512bit::f @@ -33,10 +35,11 @@ - union faiss::simd512bit::@2 - union faiss::simd512bit::@2 faiss::simd512bit::@3 + union faiss::simd512bit + union faiss::simd512bit faiss::simd512bit - @3 + + faiss::simd512bit @@ -45,13 +48,14 @@ - - + + faiss::simd512bit::simd512bit () simd512bit + faiss::simd512bit::simd512bit @@ -65,6 +69,7 @@ faiss::simd512bit::simd512bit (__m512i i) simd512bit + faiss::simd512bit::simd512bit __m512i i @@ -82,6 +87,7 @@ faiss::simd512bit::simd512bit (__m512 f) simd512bit + faiss::simd512bit::simd512bit __m512 f @@ -99,6 +105,7 @@ faiss::simd512bit::simd512bit (const void *x) simd512bit + faiss::simd512bit::simd512bit const void * x @@ -116,6 +123,7 @@ faiss::simd512bit::simd512bit (simd256bit lo) simd512bit + faiss::simd512bit::simd512bit simd256bit lo @@ -133,6 +141,7 @@ faiss::simd512bit::simd512bit (simd256bit lo, simd256bit hi) simd512bit + faiss::simd512bit::simd512bit simd256bit lo @@ -154,6 +163,7 @@ void faiss::simd512bit::clear () clear + faiss::simd512bit::clear @@ -167,6 +177,7 @@ void faiss::simd512bit::storeu (void *ptr) const storeu + faiss::simd512bit::storeu void * ptr @@ -184,6 +195,7 @@ void faiss::simd512bit::loadu (const void *ptr) loadu + faiss::simd512bit::loadu const void * ptr @@ -201,6 +213,7 @@ void faiss::simd512bit::store (void *ptr) const store + faiss::simd512bit::store void * ptr @@ -218,6 +231,7 @@ void faiss::simd512bit::bin (char bits[513]) const bin + faiss::simd512bit::bin char bits @@ -236,6 +250,7 @@ std::string faiss::simd512bit::bin () const bin + faiss::simd512bit::bin @@ -244,7 +259,7 @@ - + 512-bit representation without interpretation as a vector @@ -253,6 +268,12 @@ The objective is to separate the different interpretations of the same registers (as a vector of uint8, uint16 or uint32), to provide printing functions, and to give more readable names to the AVX intrinsics. It does not pretend to be exhausitve, functions are added as needed. + + + + + + @@ -263,12 +284,6 @@ - - - - - - diff --git a/xml/structfaiss_1_1simd64uint8.xml b/xml/structfaiss_1_1simd64uint8.xml index 1b29367e5f..99211ddfe5 100644 --- a/xml/structfaiss_1_1simd64uint8.xml +++ b/xml/structfaiss_1_1simd64uint8.xml @@ -1,14 +1,15 @@ - + faiss::simd64uint8 faiss::simd512bit - + faiss::simd64uint8::simd64uint8 () simd64uint8 + faiss::simd64uint8::simd64uint8 @@ -22,6 +23,7 @@ faiss::simd64uint8::simd64uint8 (__m512i i) simd64uint8 + faiss::simd64uint8::simd64uint8 __m512i i @@ -39,6 +41,7 @@ faiss::simd64uint8::simd64uint8 (int x) simd64uint8 + faiss::simd64uint8::simd64uint8 int x @@ -56,6 +59,7 @@ faiss::simd64uint8::simd64uint8 (uint8_t x) simd64uint8 + faiss::simd64uint8::simd64uint8 uint8_t x @@ -73,6 +77,7 @@ faiss::simd64uint8::simd64uint8 (simd256bit lo) simd64uint8 + faiss::simd64uint8::simd64uint8 simd256bit lo @@ -90,6 +95,7 @@ faiss::simd64uint8::simd64uint8 (simd256bit lo, simd256bit hi) simd64uint8 + faiss::simd64uint8::simd64uint8 simd256bit lo @@ -111,6 +117,7 @@ faiss::simd64uint8::simd64uint8 (simd512bit x) simd64uint8 + faiss::simd64uint8::simd64uint8 simd512bit x @@ -128,6 +135,7 @@ faiss::simd64uint8::simd64uint8 (const uint8_t *x) simd64uint8 + faiss::simd64uint8::simd64uint8 const uint8_t * x @@ -145,6 +153,7 @@ std::string faiss::simd64uint8::elements_to_string (const char *fmt) const elements_to_string + faiss::simd64uint8::elements_to_string const char * fmt @@ -162,6 +171,7 @@ std::string faiss::simd64uint8::hex () const hex + faiss::simd64uint8::hex @@ -175,6 +185,7 @@ std::string faiss::simd64uint8::dec () const dec + faiss::simd64uint8::dec @@ -188,6 +199,7 @@ void faiss::simd64uint8::set1 (uint8_t x) set1 + faiss::simd64uint8::set1 uint8_t x @@ -205,6 +217,7 @@ simd64uint8 faiss::simd64uint8::operator& (simd512bit other) const operator& + faiss::simd64uint8::operator& simd512bit other @@ -222,6 +235,7 @@ simd64uint8 faiss::simd64uint8::operator+ (simd64uint8 other) const operator+ + faiss::simd64uint8::operator+ simd64uint8 other @@ -239,6 +253,7 @@ simd64uint8 faiss::simd64uint8::lookup_4_lanes (simd64uint8 idx) const lookup_4_lanes + faiss::simd64uint8::lookup_4_lanes simd64uint8 idx @@ -256,6 +271,7 @@ simd32uint16 faiss::simd64uint8::lane0_as_uint16 () const lane0_as_uint16 + faiss::simd64uint8::lane0_as_uint16 @@ -269,6 +285,7 @@ simd32uint16 faiss::simd64uint8::lane1_as_uint16 () const lane1_as_uint16 + faiss::simd64uint8::lane1_as_uint16 @@ -282,6 +299,7 @@ simd64uint8 faiss::simd64uint8::operator+= (simd64uint8 other) operator+= + faiss::simd64uint8::operator+= simd64uint8 other @@ -299,6 +317,7 @@ uint8_t faiss::simd64uint8::operator[] (int i) const operator[] + faiss::simd64uint8::operator[] int i @@ -316,6 +335,7 @@ void faiss::simd512bit::clear () clear + faiss::simd512bit::clear @@ -329,6 +349,7 @@ void faiss::simd512bit::storeu (void *ptr) const storeu + faiss::simd512bit::storeu void * ptr @@ -346,6 +367,7 @@ void faiss::simd512bit::loadu (const void *ptr) loadu + faiss::simd512bit::loadu const void * ptr @@ -363,6 +385,7 @@ void faiss::simd512bit::store (void *ptr) const store + faiss::simd512bit::store void * ptr @@ -380,6 +403,7 @@ void faiss::simd512bit::bin (char bits[513]) const bin + faiss::simd512bit::bin char bits @@ -398,6 +422,7 @@ std::string faiss::simd512bit::bin () const bin + faiss::simd512bit::bin @@ -406,13 +431,14 @@ - - + + __m512i __m512i faiss::simd512bit::i i + faiss::simd512bit::i @@ -426,6 +452,7 @@ __m512 faiss::simd512bit::f f + faiss::simd512bit::f @@ -435,10 +462,11 @@ - union faiss::simd512bit::@2 - union faiss::simd512bit::@2 faiss::simd512bit::@3 + union faiss::simd512bit + union faiss::simd512bit faiss::simd512bit - @3 + + faiss::simd512bit @@ -447,7 +475,7 @@ - + diff --git a/xml/structfaiss_1_1simd8float32.xml b/xml/structfaiss_1_1simd8float32.xml index 73bb398652..6638f4b264 100644 --- a/xml/structfaiss_1_1simd8float32.xml +++ b/xml/structfaiss_1_1simd8float32.xml @@ -1,16 +1,17 @@ - + faiss::simd8float32 faiss::simd256bit faiss::simd256bit faiss::simd256bit - + float32x4x2_t float32x4x2_t faiss::simd8float32::data data + faiss::simd8float32::data @@ -24,6 +25,7 @@ __m256i faiss::simd256bit::i i + faiss::simd256bit::i @@ -37,6 +39,7 @@ __m256 faiss::simd256bit::f f + faiss::simd256bit::f @@ -46,10 +49,11 @@ - union faiss::simd256bit::@0 - union faiss::simd256bit::@0 faiss::simd256bit::@1 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @1 + + faiss::simd256bit @@ -63,6 +67,7 @@ uint8_t faiss::simd256bit::u8[32] [32] u8 + faiss::simd256bit::u8 @@ -76,6 +81,7 @@ uint16_t faiss::simd256bit::u16[16] [16] u16 + faiss::simd256bit::u16 @@ -89,6 +95,7 @@ uint32_t faiss::simd256bit::u32[8] [8] u32 + faiss::simd256bit::u32 @@ -102,6 +109,7 @@ float faiss::simd256bit::f32[8] [8] f32 + faiss::simd256bit::f32 @@ -111,10 +119,11 @@ - union faiss::simd256bit::@4 - union faiss::simd256bit::@4 faiss::simd256bit::@5 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @5 + + faiss::simd256bit @@ -124,10 +133,11 @@ - union faiss::simd256bit::@6 - union faiss::simd256bit::@6 faiss::simd256bit::@7 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @7 + + faiss::simd256bit @@ -136,13 +146,14 @@ - - + + faiss::simd8float32::simd8float32 () simd8float32 + faiss::simd8float32::simd8float32 @@ -156,6 +167,7 @@ faiss::simd8float32::simd8float32 (simd256bit x) simd8float32 + faiss::simd8float32::simd8float32 simd256bit x @@ -173,6 +185,7 @@ faiss::simd8float32::simd8float32 (__m256 x) simd8float32 + faiss::simd8float32::simd8float32 __m256 x @@ -190,6 +203,7 @@ faiss::simd8float32::simd8float32 (float x) simd8float32 + faiss::simd8float32::simd8float32 float x @@ -207,6 +221,7 @@ faiss::simd8float32::simd8float32 (const float *x) simd8float32 + faiss::simd8float32::simd8float32 const float * x @@ -224,6 +239,7 @@ faiss::simd8float32::simd8float32 (float f0, float f1, float f2, float f3, float f4, float f5, float f6, float f7) simd8float32 + faiss::simd8float32::simd8float32 float f0 @@ -269,6 +285,7 @@ simd8float32 faiss::simd8float32::operator* (simd8float32 other) const operator* + faiss::simd8float32::operator* simd8float32 other @@ -286,6 +303,7 @@ simd8float32 faiss::simd8float32::operator+ (simd8float32 other) const operator+ + faiss::simd8float32::operator+ simd8float32 other @@ -303,6 +321,7 @@ simd8float32 faiss::simd8float32::operator- (simd8float32 other) const operator- + faiss::simd8float32::operator- simd8float32 other @@ -315,11 +334,12 @@ - + simd8float32 & - simd8float32& faiss::simd8float32::operator+= + simd8float32 & faiss::simd8float32::operator+= (const simd8float32 &other) operator+= + faiss::simd8float32::operator+= const simd8float32 & other @@ -337,6 +357,7 @@ bool faiss::simd8float32::operator== (simd8float32 other) const operator== + faiss::simd8float32::operator== simd8float32 other @@ -354,6 +375,7 @@ bool faiss::simd8float32::operator!= (simd8float32 other) const operator!= + faiss::simd8float32::operator!= simd8float32 other @@ -371,6 +393,7 @@ std::string faiss::simd8float32::tostring () const tostring + faiss::simd8float32::tostring @@ -384,6 +407,7 @@ faiss::simd8float32::simd8float32 () simd8float32 + faiss::simd8float32::simd8float32 @@ -397,6 +421,7 @@ faiss::simd8float32::simd8float32 (const simd256bit &x) simd8float32 + faiss::simd8float32::simd8float32 const simd256bit & x @@ -414,6 +439,7 @@ faiss::simd8float32::simd8float32 (float x) simd8float32 + faiss::simd8float32::simd8float32 float x @@ -431,6 +457,7 @@ faiss::simd8float32::simd8float32 (const float *x) simd8float32 + faiss::simd8float32::simd8float32 const float * x @@ -448,6 +475,7 @@ void faiss::simd8float32::set1 (float x) set1 + faiss::simd8float32::set1 float x @@ -465,6 +493,7 @@ faiss::simd8float32::simd8float32 (float f0, float f1, float f2, float f3, float f4, float f5, float f6, float f7) simd8float32 + faiss::simd8float32::simd8float32 float f0 @@ -510,6 +539,7 @@ simd8float32 faiss::simd8float32::operator* (const simd8float32 &other) const operator* + faiss::simd8float32::operator* const simd8float32 & other @@ -527,6 +557,7 @@ simd8float32 faiss::simd8float32::operator+ (const simd8float32 &other) const operator+ + faiss::simd8float32::operator+ const simd8float32 & other @@ -544,6 +575,7 @@ simd8float32 faiss::simd8float32::operator- (const simd8float32 &other) const operator- + faiss::simd8float32::operator- const simd8float32 & other @@ -556,11 +588,12 @@ - + simd8float32 & - simd8float32& faiss::simd8float32::operator+= + simd8float32 & faiss::simd8float32::operator+= (const simd8float32 &other) operator+= + faiss::simd8float32::operator+= const simd8float32 & other @@ -578,6 +611,7 @@ bool faiss::simd8float32::operator== (simd8float32 other) const operator== + faiss::simd8float32::operator== simd8float32 other @@ -595,6 +629,7 @@ bool faiss::simd8float32::operator!= (simd8float32 other) const operator!= + faiss::simd8float32::operator!= simd8float32 other @@ -612,6 +647,7 @@ std::string faiss::simd8float32::tostring () const tostring + faiss::simd8float32::tostring @@ -625,6 +661,7 @@ faiss::simd8float32::simd8float32 ()=default simd8float32 + faiss::simd8float32::simd8float32 @@ -638,6 +675,7 @@ faiss::simd8float32::simd8float32 (float x) simd8float32 + faiss::simd8float32::simd8float32 float x @@ -655,6 +693,7 @@ faiss::simd8float32::simd8float32 (const float32x4x2_t &v) simd8float32 + faiss::simd8float32::simd8float32 const float32x4x2_t & v @@ -681,6 +720,7 @@ faiss::simd8float32::simd8float32 (const T &x) simd8float32 + faiss::simd8float32::simd8float32 const T & x @@ -698,6 +738,7 @@ faiss::simd8float32::simd8float32 (const float *x) simd8float32 + faiss::simd8float32::simd8float32 const float * x @@ -715,6 +756,7 @@ faiss::simd8float32::simd8float32 (float f0, float f1, float f2, float f3, float f4, float f5, float f6, float f7) simd8float32 + faiss::simd8float32::simd8float32 float f0 @@ -760,6 +802,7 @@ void faiss::simd8float32::clear () clear + faiss::simd8float32::clear @@ -773,6 +816,7 @@ void faiss::simd8float32::storeu (float *ptr) const storeu + faiss::simd8float32::storeu float * ptr @@ -790,6 +834,7 @@ void faiss::simd8float32::loadu (const float *ptr) loadu + faiss::simd8float32::loadu const float * ptr @@ -807,6 +852,7 @@ void faiss::simd8float32::store (float *ptr) const store + faiss::simd8float32::store float * ptr @@ -824,6 +870,7 @@ void faiss::simd8float32::bin (char bits[257]) const bin + faiss::simd8float32::bin char bits @@ -842,6 +889,7 @@ std::string faiss::simd8float32::bin () const bin + faiss::simd8float32::bin @@ -855,6 +903,7 @@ simd8float32 faiss::simd8float32::operator* (const simd8float32 &other) const operator* + faiss::simd8float32::operator* const simd8float32 & other @@ -872,6 +921,7 @@ simd8float32 faiss::simd8float32::operator+ (const simd8float32 &other) const operator+ + faiss::simd8float32::operator+ const simd8float32 & other @@ -889,6 +939,7 @@ simd8float32 faiss::simd8float32::operator- (const simd8float32 &other) const operator- + faiss::simd8float32::operator- const simd8float32 & other @@ -901,11 +952,12 @@ - + simd8float32 & - simd8float32& faiss::simd8float32::operator+= + simd8float32 & faiss::simd8float32::operator+= (const simd8float32 &other) operator+= + faiss::simd8float32::operator+= const simd8float32 & other @@ -923,6 +975,7 @@ simd8uint32 faiss::simd8float32::operator== (simd8float32 other) const operator== + faiss::simd8float32::operator== simd8float32 other @@ -940,6 +993,7 @@ simd8uint32 faiss::simd8float32::operator!= (simd8float32 other) const operator!= + faiss::simd8float32::operator!= simd8float32 other @@ -962,6 +1016,7 @@ bool faiss::simd8float32::is_same_as (T other) const is_same_as + faiss::simd8float32::is_same_as T other @@ -979,6 +1034,7 @@ std::string faiss::simd8float32::tostring () const tostring + faiss::simd8float32::tostring @@ -992,6 +1048,7 @@ faiss::simd8float32::simd8float32 () simd8float32 + faiss::simd8float32::simd8float32 @@ -1005,6 +1062,7 @@ faiss::simd8float32::simd8float32 (const simd256bit &x) simd8float32 + faiss::simd8float32::simd8float32 const simd256bit & x @@ -1022,6 +1080,7 @@ faiss::simd8float32::simd8float32 (float x) simd8float32 + faiss::simd8float32::simd8float32 float x @@ -1039,6 +1098,7 @@ faiss::simd8float32::simd8float32 (const float *x) simd8float32 + faiss::simd8float32::simd8float32 const float * x @@ -1056,6 +1116,7 @@ void faiss::simd8float32::set1 (float x) set1 + faiss::simd8float32::set1 float x @@ -1073,6 +1134,7 @@ faiss::simd8float32::simd8float32 (float f0, float f1, float f2, float f3, float f4, float f5, float f6, float f7) simd8float32 + faiss::simd8float32::simd8float32 float f0 @@ -1118,6 +1180,7 @@ simd8float32 faiss::simd8float32::operator* (const simd8float32 &other) const operator* + faiss::simd8float32::operator* const simd8float32 & other @@ -1135,6 +1198,7 @@ simd8float32 faiss::simd8float32::operator+ (const simd8float32 &other) const operator+ + faiss::simd8float32::operator+ const simd8float32 & other @@ -1152,6 +1216,7 @@ simd8float32 faiss::simd8float32::operator- (const simd8float32 &other) const operator- + faiss::simd8float32::operator- const simd8float32 & other @@ -1164,11 +1229,12 @@ - + simd8float32 & - simd8float32& faiss::simd8float32::operator+= + simd8float32 & faiss::simd8float32::operator+= (const simd8float32 &other) operator+= + faiss::simd8float32::operator+= const simd8float32 & other @@ -1186,6 +1252,7 @@ bool faiss::simd8float32::operator== (simd8float32 other) const operator== + faiss::simd8float32::operator== simd8float32 other @@ -1203,6 +1270,7 @@ bool faiss::simd8float32::operator!= (simd8float32 other) const operator!= + faiss::simd8float32::operator!= simd8float32 other @@ -1220,6 +1288,7 @@ std::string faiss::simd8float32::tostring () const tostring + faiss::simd8float32::tostring @@ -1233,6 +1302,7 @@ void faiss::simd256bit::storeu (void *ptr) const storeu + faiss::simd256bit::storeu void * ptr @@ -1250,6 +1320,7 @@ void faiss::simd256bit::loadu (const void *ptr) loadu + faiss::simd256bit::loadu const void * ptr @@ -1267,6 +1338,7 @@ void faiss::simd256bit::store (void *ptr) const store + faiss::simd256bit::store void * ptr @@ -1284,6 +1356,7 @@ bool faiss::simd256bit::is_same_as (simd256bit other) const is_same_as + faiss::simd256bit::is_same_as simd256bit other @@ -1296,8 +1369,8 @@ - - + + @@ -1308,6 +1381,7 @@ static simd8float32 faiss::simd8float32::binary_func (const simd8float32 &a, const simd8float32 &b, F &&f) binary_func + faiss::simd8float32::binary_func const simd8float32 & a @@ -1338,6 +1412,7 @@ static simd8float32 faiss::simd8float32::binary_func (const simd8float32 &a, const simd8float32 &b, F &&f) binary_func + faiss::simd8float32::binary_func const simd8float32 & a @@ -1358,7 +1433,7 @@ - + @@ -1422,10 +1497,10 @@ faiss::simd8float32operator+ faiss::simd8float32operator+ faiss::simd8float32operator+ - faiss::simd8float32operator+= - faiss::simd8float32operator+= - faiss::simd8float32operator+= - faiss::simd8float32operator+= + faiss::simd8float32operator+= + faiss::simd8float32operator+= + faiss::simd8float32operator+= + faiss::simd8float32operator+= faiss::simd8float32operator- faiss::simd8float32operator- faiss::simd8float32operator- diff --git a/xml/structfaiss_1_1simd8uint32.xml b/xml/structfaiss_1_1simd8uint32.xml index 5e451c28ed..c2a6ba76eb 100644 --- a/xml/structfaiss_1_1simd8uint32.xml +++ b/xml/structfaiss_1_1simd8uint32.xml @@ -1,17 +1,18 @@ - + faiss::simd8uint32 faiss::simd256bit faiss::simd256bit faiss::simd256bit simdlib_avx2.h - + uint32x4x2_t uint32x4x2_t faiss::simd8uint32::data data + faiss::simd8uint32::data @@ -25,6 +26,7 @@ __m256i faiss::simd256bit::i i + faiss::simd256bit::i @@ -38,6 +40,7 @@ __m256 faiss::simd256bit::f f + faiss::simd256bit::f @@ -47,10 +50,11 @@ - union faiss::simd256bit::@0 - union faiss::simd256bit::@0 faiss::simd256bit::@1 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @1 + + faiss::simd256bit @@ -64,6 +68,7 @@ uint8_t faiss::simd256bit::u8[32] [32] u8 + faiss::simd256bit::u8 @@ -77,6 +82,7 @@ uint16_t faiss::simd256bit::u16[16] [16] u16 + faiss::simd256bit::u16 @@ -90,6 +96,7 @@ uint32_t faiss::simd256bit::u32[8] [8] u32 + faiss::simd256bit::u32 @@ -103,6 +110,7 @@ float faiss::simd256bit::f32[8] [8] f32 + faiss::simd256bit::f32 @@ -112,10 +120,11 @@ - union faiss::simd256bit::@4 - union faiss::simd256bit::@4 faiss::simd256bit::@5 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @5 + + faiss::simd256bit @@ -125,10 +134,11 @@ - union faiss::simd256bit::@6 - union faiss::simd256bit::@6 faiss::simd256bit::@7 + union faiss::simd256bit + union faiss::simd256bit faiss::simd256bit - @7 + + faiss::simd256bit @@ -137,13 +147,14 @@ - - + + faiss::simd8uint32::simd8uint32 () simd8uint32 + faiss::simd8uint32::simd8uint32 @@ -157,6 +168,7 @@ faiss::simd8uint32::simd8uint32 (__m256i i) simd8uint32 + faiss::simd8uint32::simd8uint32 __m256i i @@ -174,6 +186,7 @@ faiss::simd8uint32::simd8uint32 (uint32_t x) simd8uint32 + faiss::simd8uint32::simd8uint32 uint32_t x @@ -191,6 +204,7 @@ faiss::simd8uint32::simd8uint32 (simd256bit x) simd8uint32 + faiss::simd8uint32::simd8uint32 simd256bit x @@ -208,6 +222,7 @@ faiss::simd8uint32::simd8uint32 (const uint8_t *x) simd8uint32 + faiss::simd8uint32::simd8uint32 const uint8_t * x @@ -225,6 +240,7 @@ faiss::simd8uint32::simd8uint32 (uint32_t u0, uint32_t u1, uint32_t u2, uint32_t u3, uint32_t u4, uint32_t u5, uint32_t u6, uint32_t u7) simd8uint32 + faiss::simd8uint32::simd8uint32 uint32_t u0 @@ -270,6 +286,7 @@ simd8uint32 faiss::simd8uint32::operator+ (simd8uint32 other) const operator+ + faiss::simd8uint32::operator+ simd8uint32 other @@ -287,6 +304,7 @@ simd8uint32 faiss::simd8uint32::operator- (simd8uint32 other) const operator- + faiss::simd8uint32::operator- simd8uint32 other @@ -299,11 +317,12 @@ - + simd8uint32 & - simd8uint32& faiss::simd8uint32::operator+= + simd8uint32 & faiss::simd8uint32::operator+= (const simd8uint32 &other) operator+= + faiss::simd8uint32::operator+= const simd8uint32 & other @@ -321,6 +340,7 @@ bool faiss::simd8uint32::operator== (simd8uint32 other) const operator== + faiss::simd8uint32::operator== simd8uint32 other @@ -338,6 +358,7 @@ bool faiss::simd8uint32::operator!= (simd8uint32 other) const operator!= + faiss::simd8uint32::operator!= simd8uint32 other @@ -355,6 +376,7 @@ std::string faiss::simd8uint32::elements_to_string (const char *fmt) const elements_to_string + faiss::simd8uint32::elements_to_string const char * fmt @@ -372,6 +394,7 @@ std::string faiss::simd8uint32::hex () const hex + faiss::simd8uint32::hex @@ -385,6 +408,7 @@ std::string faiss::simd8uint32::dec () const dec + faiss::simd8uint32::dec @@ -398,6 +422,7 @@ void faiss::simd8uint32::set1 (uint32_t x) set1 + faiss::simd8uint32::set1 uint32_t x @@ -415,6 +440,7 @@ simd8uint32 faiss::simd8uint32::unzip () const unzip + faiss::simd8uint32::unzip @@ -428,6 +454,7 @@ faiss::simd8uint32::simd8uint32 () simd8uint32 + faiss::simd8uint32::simd8uint32 @@ -441,6 +468,7 @@ faiss::simd8uint32::simd8uint32 (uint32_t x) simd8uint32 + faiss::simd8uint32::simd8uint32 uint32_t x @@ -458,6 +486,7 @@ faiss::simd8uint32::simd8uint32 (const simd256bit &x) simd8uint32 + faiss::simd8uint32::simd8uint32 const simd256bit & x @@ -475,6 +504,7 @@ faiss::simd8uint32::simd8uint32 (const uint32_t *x) simd8uint32 + faiss::simd8uint32::simd8uint32 const uint32_t * x @@ -492,6 +522,7 @@ faiss::simd8uint32::simd8uint32 (uint32_t u0, uint32_t u1, uint32_t u2, uint32_t u3, uint32_t u4, uint32_t u5, uint32_t u6, uint32_t u7) simd8uint32 + faiss::simd8uint32::simd8uint32 uint32_t u0 @@ -537,6 +568,7 @@ simd8uint32 faiss::simd8uint32::operator+ (simd8uint32 other) const operator+ + faiss::simd8uint32::operator+ simd8uint32 other @@ -554,6 +586,7 @@ simd8uint32 faiss::simd8uint32::operator- (simd8uint32 other) const operator- + faiss::simd8uint32::operator- simd8uint32 other @@ -566,11 +599,12 @@ - + simd8uint32 & - simd8uint32& faiss::simd8uint32::operator+= + simd8uint32 & faiss::simd8uint32::operator+= (const simd8uint32 &other) operator+= + faiss::simd8uint32::operator+= const simd8uint32 & other @@ -588,6 +622,7 @@ bool faiss::simd8uint32::operator== (simd8uint32 other) const operator== + faiss::simd8uint32::operator== simd8uint32 other @@ -605,6 +640,7 @@ bool faiss::simd8uint32::operator!= (simd8uint32 other) const operator!= + faiss::simd8uint32::operator!= simd8uint32 other @@ -622,6 +658,7 @@ std::string faiss::simd8uint32::elements_to_string (const char *fmt) const elements_to_string + faiss::simd8uint32::elements_to_string const char * fmt @@ -639,6 +676,7 @@ std::string faiss::simd8uint32::hex () const hex + faiss::simd8uint32::hex @@ -652,6 +690,7 @@ std::string faiss::simd8uint32::dec () const dec + faiss::simd8uint32::dec @@ -665,6 +704,7 @@ void faiss::simd8uint32::set1 (uint32_t x) set1 + faiss::simd8uint32::set1 uint32_t x @@ -682,6 +722,7 @@ simd8uint32 faiss::simd8uint32::unzip () const unzip + faiss::simd8uint32::unzip @@ -695,6 +736,7 @@ faiss::simd8uint32::simd8uint32 ()=default simd8uint32 + faiss::simd8uint32::simd8uint32 @@ -708,6 +750,7 @@ faiss::simd8uint32::simd8uint32 (uint32_t x) simd8uint32 + faiss::simd8uint32::simd8uint32 uint32_t x @@ -725,6 +768,7 @@ faiss::simd8uint32::simd8uint32 (const uint32x4x2_t &v) simd8uint32 + faiss::simd8uint32::simd8uint32 const uint32x4x2_t & v @@ -751,6 +795,7 @@ faiss::simd8uint32::simd8uint32 (const T &x) simd8uint32 + faiss::simd8uint32::simd8uint32 const T & x @@ -768,6 +813,7 @@ faiss::simd8uint32::simd8uint32 (const uint8_t *x) simd8uint32 + faiss::simd8uint32::simd8uint32 const uint8_t * x @@ -785,6 +831,7 @@ faiss::simd8uint32::simd8uint32 (uint32_t u0, uint32_t u1, uint32_t u2, uint32_t u3, uint32_t u4, uint32_t u5, uint32_t u6, uint32_t u7) simd8uint32 + faiss::simd8uint32::simd8uint32 uint32_t u0 @@ -830,6 +877,7 @@ simd8uint32 faiss::simd8uint32::operator+ (simd8uint32 other) const operator+ + faiss::simd8uint32::operator+ simd8uint32 other @@ -847,6 +895,7 @@ simd8uint32 faiss::simd8uint32::operator- (simd8uint32 other) const operator- + faiss::simd8uint32::operator- simd8uint32 other @@ -859,11 +908,12 @@ - + simd8uint32 & - simd8uint32& faiss::simd8uint32::operator+= + simd8uint32 & faiss::simd8uint32::operator+= (const simd8uint32 &other) operator+= + faiss::simd8uint32::operator+= const simd8uint32 & other @@ -881,6 +931,7 @@ simd8uint32 faiss::simd8uint32::operator== (simd8uint32 other) const operator== + faiss::simd8uint32::operator== simd8uint32 other @@ -898,6 +949,7 @@ simd8uint32 faiss::simd8uint32::operator~ () const operator~ + faiss::simd8uint32::operator~ @@ -911,6 +963,7 @@ simd8uint32 faiss::simd8uint32::operator!= (simd8uint32 other) const operator!= + faiss::simd8uint32::operator!= simd8uint32 other @@ -933,6 +986,7 @@ bool faiss::simd8uint32::is_same_as (T other) const is_same_as + faiss::simd8uint32::is_same_as T other @@ -950,6 +1004,7 @@ void faiss::simd8uint32::clear () clear + faiss::simd8uint32::clear @@ -963,6 +1018,7 @@ void faiss::simd8uint32::storeu (uint32_t *ptr) const storeu + faiss::simd8uint32::storeu uint32_t * ptr @@ -980,6 +1036,7 @@ void faiss::simd8uint32::loadu (const uint32_t *ptr) loadu + faiss::simd8uint32::loadu const uint32_t * ptr @@ -997,6 +1054,7 @@ void faiss::simd8uint32::store (uint32_t *ptr) const store + faiss::simd8uint32::store uint32_t * ptr @@ -1014,6 +1072,7 @@ void faiss::simd8uint32::bin (char bits[257]) const bin + faiss::simd8uint32::bin char bits @@ -1032,6 +1091,7 @@ std::string faiss::simd8uint32::bin () const bin + faiss::simd8uint32::bin @@ -1045,6 +1105,7 @@ std::string faiss::simd8uint32::elements_to_string (const char *fmt) const elements_to_string + faiss::simd8uint32::elements_to_string const char * fmt @@ -1062,6 +1123,7 @@ std::string faiss::simd8uint32::hex () const hex + faiss::simd8uint32::hex @@ -1075,6 +1137,7 @@ std::string faiss::simd8uint32::dec () const dec + faiss::simd8uint32::dec @@ -1088,6 +1151,7 @@ void faiss::simd8uint32::set1 (uint32_t x) set1 + faiss::simd8uint32::set1 uint32_t x @@ -1105,6 +1169,7 @@ simd8uint32 faiss::simd8uint32::unzip () const unzip + faiss::simd8uint32::unzip @@ -1118,6 +1183,7 @@ faiss::simd8uint32::simd8uint32 () simd8uint32 + faiss::simd8uint32::simd8uint32 @@ -1131,6 +1197,7 @@ faiss::simd8uint32::simd8uint32 (uint32_t x) simd8uint32 + faiss::simd8uint32::simd8uint32 uint32_t x @@ -1148,6 +1215,7 @@ faiss::simd8uint32::simd8uint32 (const simd256bit &x) simd8uint32 + faiss::simd8uint32::simd8uint32 const simd256bit & x @@ -1165,6 +1233,7 @@ faiss::simd8uint32::simd8uint32 (const uint32_t *x) simd8uint32 + faiss::simd8uint32::simd8uint32 const uint32_t * x @@ -1182,6 +1251,7 @@ faiss::simd8uint32::simd8uint32 (uint32_t u0, uint32_t u1, uint32_t u2, uint32_t u3, uint32_t u4, uint32_t u5, uint32_t u6, uint32_t u7) simd8uint32 + faiss::simd8uint32::simd8uint32 uint32_t u0 @@ -1227,6 +1297,7 @@ simd8uint32 faiss::simd8uint32::operator+ (simd8uint32 other) const operator+ + faiss::simd8uint32::operator+ simd8uint32 other @@ -1244,6 +1315,7 @@ simd8uint32 faiss::simd8uint32::operator- (simd8uint32 other) const operator- + faiss::simd8uint32::operator- simd8uint32 other @@ -1256,11 +1328,12 @@ - + simd8uint32 & - simd8uint32& faiss::simd8uint32::operator+= + simd8uint32 & faiss::simd8uint32::operator+= (const simd8uint32 &other) operator+= + faiss::simd8uint32::operator+= const simd8uint32 & other @@ -1278,6 +1351,7 @@ bool faiss::simd8uint32::operator== (simd8uint32 other) const operator== + faiss::simd8uint32::operator== simd8uint32 other @@ -1295,6 +1369,7 @@ bool faiss::simd8uint32::operator!= (simd8uint32 other) const operator!= + faiss::simd8uint32::operator!= simd8uint32 other @@ -1312,6 +1387,7 @@ std::string faiss::simd8uint32::elements_to_string (const char *fmt) const elements_to_string + faiss::simd8uint32::elements_to_string const char * fmt @@ -1329,6 +1405,7 @@ std::string faiss::simd8uint32::hex () const hex + faiss::simd8uint32::hex @@ -1342,6 +1419,7 @@ std::string faiss::simd8uint32::dec () const dec + faiss::simd8uint32::dec @@ -1355,6 +1433,7 @@ void faiss::simd8uint32::set1 (uint32_t x) set1 + faiss::simd8uint32::set1 uint32_t x @@ -1372,6 +1451,7 @@ simd8uint32 faiss::simd8uint32::unzip () const unzip + faiss::simd8uint32::unzip @@ -1385,6 +1465,7 @@ void faiss::simd256bit::storeu (void *ptr) const storeu + faiss::simd256bit::storeu void * ptr @@ -1402,6 +1483,7 @@ void faiss::simd256bit::loadu (const void *ptr) loadu + faiss::simd256bit::loadu const void * ptr @@ -1419,6 +1501,7 @@ void faiss::simd256bit::store (void *ptr) const store + faiss::simd256bit::store void * ptr @@ -1436,6 +1519,7 @@ bool faiss::simd256bit::is_same_as (simd256bit other) const is_same_as + faiss::simd256bit::is_same_as simd256bit other @@ -1448,13 +1532,17 @@ - + vector of 8 unsigned 32-bit integers + + + + @@ -1465,12 +1553,12 @@ + + - - @@ -1481,10 +1569,6 @@ - - - - @@ -1519,10 +1603,10 @@ faiss::simd8uint32operator+ faiss::simd8uint32operator+ faiss::simd8uint32operator+ - faiss::simd8uint32operator+= - faiss::simd8uint32operator+= - faiss::simd8uint32operator+= - faiss::simd8uint32operator+= + faiss::simd8uint32operator+= + faiss::simd8uint32operator+= + faiss::simd8uint32operator+= + faiss::simd8uint32operator+= faiss::simd8uint32operator- faiss::simd8uint32operator- faiss::simd8uint32operator- diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1DummyResultHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1DummyResultHandler.xml index a00d15732b..aa2d448f0e 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1DummyResultHandler.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1DummyResultHandler.xml @@ -1,15 +1,16 @@ - + faiss::simd_result_handlers::DummyResultHandler faiss::SIMDResultHandler simd_result_handlers.h - + size_t size_t faiss::simd_result_handlers::DummyResultHandler::cs cs + faiss::simd_result_handlers::DummyResultHandler::cs = 0 @@ -24,6 +25,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -38,6 +40,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -52,6 +55,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -61,13 +65,14 @@ - - + + void void faiss::simd_result_handlers::DummyResultHandler::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1) final handle + faiss::simd_result_handlers::DummyResultHandler::handle handle size_t @@ -99,6 +104,7 @@ void faiss::simd_result_handlers::DummyResultHandler::set_block_origin (size_t, size_t) final set_block_origin + faiss::simd_result_handlers::DummyResultHandler::set_block_origin set_block_origin size_t @@ -122,6 +128,7 @@ faiss::simd_result_handlers::DummyResultHandler::~DummyResultHandler () ~DummyResultHandler + faiss::simd_result_handlers::DummyResultHandler::~DummyResultHandler @@ -130,35 +137,35 @@ - + Dummy structure that just computes a chqecksum on results (to avoid the computation to be optimized away) + + + + + + - - - - - - diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler.xml index 65369ecaa1..6be89ba370 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1FixedStorageHandler.xml @@ -1,5 +1,5 @@ - + faiss::simd_result_handlers::FixedStorageHandler faiss::SIMDResultHandler @@ -16,12 +16,13 @@ BB - + simd16uint16 simd16uint16 faiss::simd_result_handlers::FixedStorageHandler< NQ, BB >::dis[NQ][BB] [NQ][BB] dis + faiss::simd_result_handlers::FixedStorageHandler::dis @@ -35,6 +36,7 @@ int faiss::simd_result_handlers::FixedStorageHandler< NQ, BB >::i0 i0 + faiss::simd_result_handlers::FixedStorageHandler::i0 = 0 @@ -49,6 +51,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -63,6 +66,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -77,6 +81,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -86,13 +91,14 @@ - - + + void void faiss::simd_result_handlers::FixedStorageHandler< NQ, BB >::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1) final handle + faiss::simd_result_handlers::FixedStorageHandler::handle handle size_t @@ -124,6 +130,7 @@ void faiss::simd_result_handlers::FixedStorageHandler< NQ, BB >::set_block_origin (size_t i0_in, size_t j0_in) final set_block_origin + faiss::simd_result_handlers::FixedStorageHandler::set_block_origin set_block_origin size_t @@ -152,6 +159,7 @@ void faiss::simd_result_handlers::FixedStorageHandler< NQ, BB >::to_other_handler (OtherResultHandler &other) const to_other_handler + faiss::simd_result_handlers::FixedStorageHandler::to_other_handler OtherResultHandler & other @@ -169,6 +177,7 @@ virtual faiss::simd_result_handlers::FixedStorageHandler< NQ, BB >::~FixedStorageHandler () ~FixedStorageHandler + faiss::simd_result_handlers::FixedStorageHandler::~FixedStorageHandler @@ -177,37 +186,28 @@ - + stores results in fixed-size matrix. - - - - - - - - - - dis - - - - + + + + + @@ -219,9 +219,18 @@ - - - + + + + + + + + + + + dis + diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1HeapHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1HeapHandler.xml index acffba8d43..0b7a427540 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1HeapHandler.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1HeapHandler.xml @@ -1,5 +1,5 @@ - + faiss::simd_result_handlers::HeapHandler faiss::simd_result_handlers::ResultHandlerCompare< C, false > @@ -15,12 +15,13 @@ false - + typename C::T using faiss::simd_result_handlers::HeapHandler< C, with_id_map >::T = typename C::T T + faiss::simd_result_handlers::HeapHandler::T @@ -34,6 +35,7 @@ using faiss::simd_result_handlers::HeapHandler< C, with_id_map >::TI = typename C::TI TI + faiss::simd_result_handlers::HeapHandler::TI @@ -47,6 +49,7 @@ using faiss::simd_result_handlers::HeapHandler< C, with_id_map >::RHC = ResultHandlerCompare<C, with_id_map> RHC + faiss::simd_result_handlers::HeapHandler::RHC @@ -55,13 +58,14 @@ - - + + std::vector< uint16_t > std::vector<uint16_t> faiss::simd_result_handlers::HeapHandler< C, with_id_map >::idis idis + faiss::simd_result_handlers::HeapHandler::idis @@ -75,6 +79,7 @@ std::vector<TI> faiss::simd_result_handlers::HeapHandler< C, with_id_map >::iids iids + faiss::simd_result_handlers::HeapHandler::iids @@ -88,6 +93,7 @@ float* faiss::simd_result_handlers::HeapHandler< C, with_id_map >::dis dis + faiss::simd_result_handlers::HeapHandler::dis @@ -101,6 +107,7 @@ int64_t* faiss::simd_result_handlers::HeapHandler< C, with_id_map >::ids ids + faiss::simd_result_handlers::HeapHandler::ids @@ -114,6 +121,7 @@ int64_t faiss::simd_result_handlers::HeapHandler< C, with_id_map >::k k + faiss::simd_result_handlers::HeapHandler::k @@ -127,6 +135,8 @@ bool faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::disable disable + faiss::simd_result_handlers::ResultHandlerCompare::disable + = false @@ -140,6 +150,8 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::i0 i0 + faiss::simd_result_handlers::ResultHandlerCompare::i0 + = 0 @@ -153,6 +165,8 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::j0 j0 + faiss::simd_result_handlers::ResultHandlerCompare::j0 + = 0 @@ -166,6 +180,7 @@ const IDSelector* faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::sel sel + faiss::simd_result_handlers::ResultHandlerCompare::sel @@ -179,6 +194,7 @@ size_t faiss::SIMDResultHandlerToFloat::nq nq + faiss::SIMDResultHandlerToFloat::nq @@ -192,6 +208,7 @@ size_t faiss::SIMDResultHandlerToFloat::ntotal ntotal + faiss::SIMDResultHandlerToFloat::ntotal @@ -205,6 +222,7 @@ const idx_t* faiss::SIMDResultHandlerToFloat::id_map id_map + faiss::SIMDResultHandlerToFloat::id_map = nullptr these fields are used mainly for the IVF variants (with_id_map=true) @@ -220,6 +238,7 @@ const int* faiss::SIMDResultHandlerToFloat::q_map q_map + faiss::SIMDResultHandlerToFloat::q_map = nullptr @@ -234,6 +253,7 @@ const uint16_t* faiss::SIMDResultHandlerToFloat::dbias dbias + faiss::SIMDResultHandlerToFloat::dbias = nullptr @@ -249,6 +269,7 @@ const float* faiss::SIMDResultHandlerToFloat::normalizers normalizers + faiss::SIMDResultHandlerToFloat::normalizers = nullptr @@ -263,6 +284,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -277,6 +299,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -291,6 +314,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -300,13 +324,14 @@ - - + + faiss::simd_result_handlers::HeapHandler< C, with_id_map >::HeapHandler (size_t nq, size_t ntotal, int64_t k, float *dis, int64_t *ids, const IDSelector *sel_in) HeapHandler + faiss::simd_result_handlers::HeapHandler::HeapHandler size_t nq @@ -344,6 +369,7 @@ void faiss::simd_result_handlers::HeapHandler< C, with_id_map >::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1) final handle + faiss::simd_result_handlers::HeapHandler::handle handle size_t @@ -375,6 +401,7 @@ void faiss::simd_result_handlers::HeapHandler< C, with_id_map >::end () override end + faiss::simd_result_handlers::HeapHandler::end end @@ -389,14 +416,15 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::set_block_origin (size_t i0_in, size_t j0_in) final set_block_origin + faiss::simd_result_handlers::ResultHandlerCompare::set_block_origin set_block_origin size_t - i0_in + i0 size_t - j0_in + j0 set the sub-matrix that is being computed @@ -412,6 +440,7 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_with_origin (size_t &q, simd16uint16 &d0, simd16uint16 &d1) adjust_with_origin + faiss::simd_result_handlers::ResultHandlerCompare::adjust_with_origin size_t & q @@ -437,6 +466,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_id (size_t b, size_t j) adjust_id + faiss::simd_result_handlers::ResultHandlerCompare::adjust_id size_t b @@ -458,6 +488,7 @@ uint32_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::get_lt_mask (uint16_t thr, size_t b, simd16uint16 d0, simd16uint16 d1) get_lt_mask + faiss::simd_result_handlers::ResultHandlerCompare::get_lt_mask uint16_t thr @@ -488,6 +519,7 @@ virtual void faiss::SIMDResultHandlerToFloat::begin (const float *norms) begin + faiss::SIMDResultHandlerToFloat::begin begin begin @@ -502,17 +534,21 @@ - + Structure that collects results in a min- or max-heap - - - - + + + + + + + + @@ -521,22 +557,26 @@ - - - - + + + + + + + + + + - - - - - - + + + + @@ -545,15 +585,14 @@ - - - - + + + + + + + sel - - - - diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1PartialRangeHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1PartialRangeHandler.xml index 588a0f37f4..d33de2343f 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1PartialRangeHandler.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1PartialRangeHandler.xml @@ -1,5 +1,5 @@ - + faiss::simd_result_handlers::PartialRangeHandler faiss::simd_result_handlers::RangeHandler< C, false > @@ -14,12 +14,13 @@ false - + typename C::T using faiss::simd_result_handlers::PartialRangeHandler< C, with_id_map >::T = typename C::T T + faiss::simd_result_handlers::PartialRangeHandler::T @@ -33,6 +34,7 @@ using faiss::simd_result_handlers::PartialRangeHandler< C, with_id_map >::TI = typename C::TI TI + faiss::simd_result_handlers::PartialRangeHandler::TI @@ -46,6 +48,7 @@ using faiss::simd_result_handlers::PartialRangeHandler< C, with_id_map >::RHC = RangeHandler<C, with_id_map> RHC + faiss::simd_result_handlers::PartialRangeHandler::RHC @@ -54,13 +57,14 @@ - - + + RangeSearchPartialResult & RangeSearchPartialResult& faiss::simd_result_handlers::PartialRangeHandler< C, with_id_map >::pres pres + faiss::simd_result_handlers::PartialRangeHandler::pres @@ -74,6 +78,7 @@ size_t faiss::simd_result_handlers::RangeHandler< C, with_id_map >::q0 q0 + faiss::simd_result_handlers::PartialRangeHandler::q0 @@ -83,10 +88,11 @@ - std::vector< Triplet > + std::vector< Triplet > std::vector<Triplet> faiss::simd_result_handlers::RangeHandler< C, with_id_map >::triplets triplets + faiss::simd_result_handlers::PartialRangeHandler::triplets @@ -100,6 +106,7 @@ std::vector<size_t> faiss::simd_result_handlers::RangeHandler< C, with_id_map >::n_per_query n_per_query + faiss::simd_result_handlers::PartialRangeHandler::n_per_query @@ -113,6 +120,7 @@ RangeSearchResult& faiss::simd_result_handlers::RangeHandler< C, with_id_map >::rres rres + faiss::simd_result_handlers::RangeHandler::rres @@ -126,6 +134,7 @@ float faiss::simd_result_handlers::RangeHandler< C, with_id_map >::radius radius + faiss::simd_result_handlers::RangeHandler::radius @@ -139,6 +148,7 @@ std::vector<uint16_t> faiss::simd_result_handlers::RangeHandler< C, with_id_map >::thresholds thresholds + faiss::simd_result_handlers::RangeHandler::thresholds @@ -152,6 +162,7 @@ bool faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::disable disable + faiss::simd_result_handlers::ResultHandlerCompare::disable = false @@ -166,6 +177,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::i0 i0 + faiss::simd_result_handlers::ResultHandlerCompare::i0 = 0 @@ -180,6 +192,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::j0 j0 + faiss::simd_result_handlers::ResultHandlerCompare::j0 = 0 @@ -194,6 +207,7 @@ const IDSelector* faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::sel sel + faiss::simd_result_handlers::ResultHandlerCompare::sel @@ -207,6 +221,7 @@ size_t faiss::SIMDResultHandlerToFloat::nq nq + faiss::SIMDResultHandlerToFloat::nq @@ -220,6 +235,7 @@ size_t faiss::SIMDResultHandlerToFloat::ntotal ntotal + faiss::SIMDResultHandlerToFloat::ntotal @@ -233,6 +249,7 @@ const idx_t* faiss::SIMDResultHandlerToFloat::id_map id_map + faiss::SIMDResultHandlerToFloat::id_map = nullptr these fields are used mainly for the IVF variants (with_id_map=true) @@ -248,6 +265,7 @@ const int* faiss::SIMDResultHandlerToFloat::q_map q_map + faiss::SIMDResultHandlerToFloat::q_map = nullptr @@ -262,6 +280,7 @@ const uint16_t* faiss::SIMDResultHandlerToFloat::dbias dbias + faiss::SIMDResultHandlerToFloat::dbias = nullptr @@ -277,6 +296,7 @@ const float* faiss::SIMDResultHandlerToFloat::normalizers normalizers + faiss::SIMDResultHandlerToFloat::normalizers = nullptr @@ -291,6 +311,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -305,6 +326,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -319,6 +341,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -328,13 +351,14 @@ - - + + faiss::simd_result_handlers::PartialRangeHandler< C, with_id_map >::PartialRangeHandler (RangeSearchPartialResult &pres, float radius, size_t ntotal, size_t q0, size_t q1, const IDSelector *sel_in) PartialRangeHandler + faiss::simd_result_handlers::PartialRangeHandler::PartialRangeHandler RangeSearchPartialResult & pres @@ -372,6 +396,7 @@ void faiss::simd_result_handlers::PartialRangeHandler< C, with_id_map >::shift_n_per_query () shift_n_per_query + faiss::simd_result_handlers::PartialRangeHandler::shift_n_per_query @@ -385,6 +410,7 @@ void faiss::simd_result_handlers::PartialRangeHandler< C, with_id_map >::end () override end + faiss::simd_result_handlers::PartialRangeHandler::end end @@ -399,6 +425,7 @@ virtual void faiss::simd_result_handlers::RangeHandler< C, with_id_map >::begin (const float *norms) override begin + faiss::simd_result_handlers::RangeHandler::begin begin const float * @@ -417,6 +444,7 @@ void faiss::simd_result_handlers::RangeHandler< C, with_id_map >::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1) final handle + faiss::simd_result_handlers::RangeHandler::handle handle size_t @@ -437,7 +465,7 @@ -called when 32 distances are computed and provided in two simd16uint16. (q, b) indicate which entry it is in the block. +called when 32 distances are computed and provided in two simd16uint16. (q, b) indicate which entry it is in the block. @@ -448,6 +476,7 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::set_block_origin (size_t i0_in, size_t j0_in) final set_block_origin + faiss::simd_result_handlers::ResultHandlerCompare::set_block_origin set_block_origin size_t @@ -471,6 +500,7 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_with_origin (size_t &q, simd16uint16 &d0, simd16uint16 &d1) adjust_with_origin + faiss::simd_result_handlers::ResultHandlerCompare::adjust_with_origin size_t & q @@ -496,6 +526,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_id (size_t b, size_t j) adjust_id + faiss::simd_result_handlers::ResultHandlerCompare::adjust_id size_t b @@ -517,6 +548,7 @@ uint32_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::get_lt_mask (uint16_t thr, size_t b, simd16uint16 d0, simd16uint16 d1) get_lt_mask + faiss::simd_result_handlers::ResultHandlerCompare::get_lt_mask uint16_t thr @@ -542,16 +574,20 @@ - + - - - - + + + + + + + + @@ -560,39 +596,49 @@ + + + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + - rres + res + + + + + + + + + + + + + + @@ -604,9 +650,14 @@ pres - - - + + + + + + + rres + @@ -617,25 +668,6 @@ sel - - - - - - - - - - - - - - - - - res - - diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1RangeHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1RangeHandler.xml index 30ddb2a546..d46383f316 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1RangeHandler.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1RangeHandler.xml @@ -1,8 +1,9 @@ - + faiss::simd_result_handlers::RangeHandler faiss::simd_result_handlers::ResultHandlerCompare< C, false > + faiss::simd_result_handlers::PartialRangeHandler< C, with_id_map > simd_result_handlers.h faiss::simd_result_handlers::RangeHandler::Triplet @@ -16,12 +17,13 @@ false - + typename C::T using faiss::simd_result_handlers::RangeHandler< C, with_id_map >::T = typename C::T T + faiss::simd_result_handlers::RangeHandler::T @@ -35,6 +37,7 @@ using faiss::simd_result_handlers::RangeHandler< C, with_id_map >::TI = typename C::TI TI + faiss::simd_result_handlers::RangeHandler::TI @@ -48,6 +51,7 @@ using faiss::simd_result_handlers::RangeHandler< C, with_id_map >::RHC = ResultHandlerCompare<C, with_id_map> RHC + faiss::simd_result_handlers::RangeHandler::RHC @@ -56,13 +60,14 @@ - - + + RangeSearchResult & RangeSearchResult& faiss::simd_result_handlers::RangeHandler< C, with_id_map >::rres rres + faiss::simd_result_handlers::RangeHandler::rres @@ -76,6 +81,7 @@ float faiss::simd_result_handlers::RangeHandler< C, with_id_map >::radius radius + faiss::simd_result_handlers::RangeHandler::radius @@ -89,6 +95,7 @@ std::vector<uint16_t> faiss::simd_result_handlers::RangeHandler< C, with_id_map >::thresholds thresholds + faiss::simd_result_handlers::RangeHandler::thresholds @@ -102,6 +109,7 @@ std::vector<size_t> faiss::simd_result_handlers::RangeHandler< C, with_id_map >::n_per_query n_per_query + faiss::simd_result_handlers::RangeHandler::n_per_query @@ -115,6 +123,7 @@ size_t faiss::simd_result_handlers::RangeHandler< C, with_id_map >::q0 q0 + faiss::simd_result_handlers::RangeHandler::q0 = 0 @@ -129,6 +138,7 @@ std::vector<Triplet> faiss::simd_result_handlers::RangeHandler< C, with_id_map >::triplets triplets + faiss::simd_result_handlers::RangeHandler::triplets @@ -142,6 +152,8 @@ bool faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::disable disable + faiss::simd_result_handlers::ResultHandlerCompare::disable + = false @@ -155,6 +167,8 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::i0 i0 + faiss::simd_result_handlers::ResultHandlerCompare::i0 + = 0 @@ -168,6 +182,8 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::j0 j0 + faiss::simd_result_handlers::ResultHandlerCompare::j0 + = 0 @@ -181,6 +197,7 @@ const IDSelector* faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::sel sel + faiss::simd_result_handlers::ResultHandlerCompare::sel @@ -194,6 +211,7 @@ size_t faiss::SIMDResultHandlerToFloat::nq nq + faiss::SIMDResultHandlerToFloat::nq @@ -207,6 +225,7 @@ size_t faiss::SIMDResultHandlerToFloat::ntotal ntotal + faiss::SIMDResultHandlerToFloat::ntotal @@ -220,6 +239,7 @@ const idx_t* faiss::SIMDResultHandlerToFloat::id_map id_map + faiss::SIMDResultHandlerToFloat::id_map = nullptr these fields are used mainly for the IVF variants (with_id_map=true) @@ -235,6 +255,7 @@ const int* faiss::SIMDResultHandlerToFloat::q_map q_map + faiss::SIMDResultHandlerToFloat::q_map = nullptr @@ -249,6 +270,7 @@ const uint16_t* faiss::SIMDResultHandlerToFloat::dbias dbias + faiss::SIMDResultHandlerToFloat::dbias = nullptr @@ -264,6 +286,7 @@ const float* faiss::SIMDResultHandlerToFloat::normalizers normalizers + faiss::SIMDResultHandlerToFloat::normalizers = nullptr @@ -278,6 +301,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -292,6 +316,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -306,6 +331,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -315,13 +341,14 @@ - - + + faiss::simd_result_handlers::RangeHandler< C, with_id_map >::RangeHandler (RangeSearchResult &rres, float radius, size_t ntotal, const IDSelector *sel_in) RangeHandler + faiss::simd_result_handlers::RangeHandler::RangeHandler RangeSearchResult & rres @@ -351,6 +378,7 @@ virtual void faiss::simd_result_handlers::RangeHandler< C, with_id_map >::begin (const float *norms) override begin + faiss::simd_result_handlers::RangeHandler::begin begin const float * @@ -369,6 +397,7 @@ void faiss::simd_result_handlers::RangeHandler< C, with_id_map >::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1) final handle + faiss::simd_result_handlers::RangeHandler::handle handle size_t @@ -400,6 +429,7 @@ void faiss::simd_result_handlers::RangeHandler< C, with_id_map >::end () override end + faiss::simd_result_handlers::RangeHandler::end end @@ -414,14 +444,15 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::set_block_origin (size_t i0_in, size_t j0_in) final set_block_origin + faiss::simd_result_handlers::ResultHandlerCompare::set_block_origin set_block_origin size_t - i0_in + i0 size_t - j0_in + j0 set the sub-matrix that is being computed @@ -437,6 +468,7 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_with_origin (size_t &q, simd16uint16 &d0, simd16uint16 &d1) adjust_with_origin + faiss::simd_result_handlers::ResultHandlerCompare::adjust_with_origin size_t & q @@ -462,6 +494,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_id (size_t b, size_t j) adjust_id + faiss::simd_result_handlers::ResultHandlerCompare::adjust_id size_t b @@ -483,6 +516,7 @@ uint32_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::get_lt_mask (uint16_t thr, size_t b, simd16uint16 d0, simd16uint16 d1) get_lt_mask + faiss::simd_result_handlers::ResultHandlerCompare::get_lt_mask uint16_t thr @@ -508,13 +542,29 @@ - + Result handler for range search. The difficulty is that the range distances have to be scaled using the scaler. + + + + + + + + + + + + + + + + @@ -522,52 +572,49 @@ - + - - - - - - - - - - + + + + + + + + + + + + + + - + rres - + - - - - - + + sel - - - - diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1RangeHandler_1_1Triplet.xml b/xml/structfaiss_1_1simd__result__handlers_1_1RangeHandler_1_1Triplet.xml index f9b1d7553d..9f19e0a17b 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1RangeHandler_1_1Triplet.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1RangeHandler_1_1Triplet.xml @@ -1,13 +1,14 @@ - + faiss::simd_result_handlers::RangeHandler::Triplet - + idx_t idx_t faiss::simd_result_handlers::RangeHandler< C, with_id_map >::Triplet::q q + faiss::simd_result_handlers::RangeHandler::Triplet::q @@ -21,6 +22,7 @@ idx_t faiss::simd_result_handlers::RangeHandler< C, with_id_map >::Triplet::b b + faiss::simd_result_handlers::RangeHandler::Triplet::b @@ -34,6 +36,7 @@ uint16_t faiss::simd_result_handlers::RangeHandler< C, with_id_map >::Triplet::dis dis + faiss::simd_result_handlers::RangeHandler::Triplet::dis @@ -42,7 +45,7 @@ - + diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1ReservoirHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1ReservoirHandler.xml index f750607c9a..10337db166 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1ReservoirHandler.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1ReservoirHandler.xml @@ -1,5 +1,5 @@ - + faiss::simd_result_handlers::ReservoirHandler faiss::simd_result_handlers::ResultHandlerCompare< C, false > @@ -15,12 +15,13 @@ false - + typename C::T using faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::T = typename C::T T + faiss::simd_result_handlers::ReservoirHandler::T @@ -34,6 +35,7 @@ using faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::TI = typename C::TI TI + faiss::simd_result_handlers::ReservoirHandler::TI @@ -47,6 +49,7 @@ using faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::RHC = ResultHandlerCompare<C, with_id_map> RHC + faiss::simd_result_handlers::ReservoirHandler::RHC @@ -55,13 +58,14 @@ - - + + size_t size_t faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::capacity capacity + faiss::simd_result_handlers::ReservoirHandler::capacity @@ -75,6 +79,7 @@ float* faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::dis dis + faiss::simd_result_handlers::ReservoirHandler::dis @@ -88,6 +93,7 @@ int64_t* faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::ids ids + faiss::simd_result_handlers::ReservoirHandler::ids @@ -101,6 +107,7 @@ std::vector<TI> faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::all_ids all_ids + faiss::simd_result_handlers::ReservoirHandler::all_ids @@ -114,6 +121,7 @@ AlignedTable<T> faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::all_vals all_vals + faiss::simd_result_handlers::ReservoirHandler::all_vals @@ -127,6 +135,7 @@ std::vector<ReservoirTopN<C> > faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::reservoirs reservoirs + faiss::simd_result_handlers::ReservoirHandler::reservoirs @@ -140,6 +149,8 @@ bool faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::disable disable + faiss::simd_result_handlers::ResultHandlerCompare::disable + = false @@ -153,6 +164,8 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::i0 i0 + faiss::simd_result_handlers::ResultHandlerCompare::i0 + = 0 @@ -166,6 +179,8 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::j0 j0 + faiss::simd_result_handlers::ResultHandlerCompare::j0 + = 0 @@ -179,6 +194,7 @@ const IDSelector* faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::sel sel + faiss::simd_result_handlers::ResultHandlerCompare::sel @@ -192,6 +208,7 @@ size_t faiss::SIMDResultHandlerToFloat::nq nq + faiss::SIMDResultHandlerToFloat::nq @@ -205,6 +222,7 @@ size_t faiss::SIMDResultHandlerToFloat::ntotal ntotal + faiss::SIMDResultHandlerToFloat::ntotal @@ -218,6 +236,7 @@ const idx_t* faiss::SIMDResultHandlerToFloat::id_map id_map + faiss::SIMDResultHandlerToFloat::id_map = nullptr these fields are used mainly for the IVF variants (with_id_map=true) @@ -233,6 +252,7 @@ const int* faiss::SIMDResultHandlerToFloat::q_map q_map + faiss::SIMDResultHandlerToFloat::q_map = nullptr @@ -247,6 +267,7 @@ const uint16_t* faiss::SIMDResultHandlerToFloat::dbias dbias + faiss::SIMDResultHandlerToFloat::dbias = nullptr @@ -262,6 +283,7 @@ const float* faiss::SIMDResultHandlerToFloat::normalizers normalizers + faiss::SIMDResultHandlerToFloat::normalizers = nullptr @@ -276,6 +298,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -290,6 +313,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -304,6 +328,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -313,13 +338,14 @@ - - + + faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::ReservoirHandler (size_t nq, size_t ntotal, size_t k, size_t cap, float *dis, int64_t *ids, const IDSelector *sel_in) ReservoirHandler + faiss::simd_result_handlers::ReservoirHandler::ReservoirHandler size_t nq @@ -361,6 +387,7 @@ void faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1) final handle + faiss::simd_result_handlers::ReservoirHandler::handle handle size_t @@ -392,6 +419,7 @@ void faiss::simd_result_handlers::ReservoirHandler< C, with_id_map >::end () override end + faiss::simd_result_handlers::ReservoirHandler::end end @@ -406,14 +434,15 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::set_block_origin (size_t i0_in, size_t j0_in) final set_block_origin + faiss::simd_result_handlers::ResultHandlerCompare::set_block_origin set_block_origin size_t - i0_in + i0 size_t - j0_in + j0 set the sub-matrix that is being computed @@ -429,6 +458,7 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_with_origin (size_t &q, simd16uint16 &d0, simd16uint16 &d1) adjust_with_origin + faiss::simd_result_handlers::ResultHandlerCompare::adjust_with_origin size_t & q @@ -454,6 +484,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_id (size_t b, size_t j) adjust_id + faiss::simd_result_handlers::ResultHandlerCompare::adjust_id size_t b @@ -475,6 +506,7 @@ uint32_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::get_lt_mask (uint16_t thr, size_t b, simd16uint16 d0, simd16uint16 d1) get_lt_mask + faiss::simd_result_handlers::ResultHandlerCompare::get_lt_mask uint16_t thr @@ -505,6 +537,7 @@ virtual void faiss::SIMDResultHandlerToFloat::begin (const float *norms) begin + faiss::SIMDResultHandlerToFloat::begin begin begin @@ -519,7 +552,7 @@ - + @@ -527,10 +560,14 @@ Results are stored when they are below the threshold until the capacity is reached. Then a partition sort is used to update the threshold. Handler built from several ReservoirTopN (one per query) - - - - + + + + + + + + @@ -539,22 +576,26 @@ - - - - + + + + + + + + + + - - - - - - + + + + @@ -563,15 +604,14 @@ - - - - + + + + + + + sel - - - - diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1ResultHandlerCompare.xml b/xml/structfaiss_1_1simd__result__handlers_1_1ResultHandlerCompare.xml index 3a98c28236..17a67d4335 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1ResultHandlerCompare.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1ResultHandlerCompare.xml @@ -1,9 +1,13 @@ - + faiss::simd_result_handlers::ResultHandlerCompare faiss::SIMDResultHandlerToFloat faiss::simd_result_handlers::RangeHandler< C, false > + faiss::simd_result_handlers::HeapHandler< C, with_id_map > + faiss::simd_result_handlers::RangeHandler< C, with_id_map > + faiss::simd_result_handlers::ReservoirHandler< C, with_id_map > + faiss::simd_result_handlers::SingleResultHandler< C, with_id_map > simd_result_handlers.h @@ -15,12 +19,13 @@ with_id_map - + typename C::TI using faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::TI = typename C::TI TI + faiss::simd_result_handlers::ResultHandlerCompare::TI @@ -29,13 +34,14 @@ - - + + bool bool faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::disable disable + faiss::simd_result_handlers::ResultHandlerCompare::disable = false @@ -50,6 +56,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::i0 i0 + faiss::simd_result_handlers::ResultHandlerCompare::i0 = 0 @@ -64,6 +71,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::j0 j0 + faiss::simd_result_handlers::ResultHandlerCompare::j0 = 0 @@ -78,6 +86,7 @@ const IDSelector* faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::sel sel + faiss::simd_result_handlers::ResultHandlerCompare::sel @@ -91,6 +100,7 @@ size_t faiss::SIMDResultHandlerToFloat::nq nq + faiss::SIMDResultHandlerToFloat::nq @@ -104,6 +114,7 @@ size_t faiss::SIMDResultHandlerToFloat::ntotal ntotal + faiss::SIMDResultHandlerToFloat::ntotal @@ -117,6 +128,7 @@ const idx_t* faiss::SIMDResultHandlerToFloat::id_map id_map + faiss::SIMDResultHandlerToFloat::id_map = nullptr these fields are used mainly for the IVF variants (with_id_map=true) @@ -132,6 +144,7 @@ const int* faiss::SIMDResultHandlerToFloat::q_map q_map + faiss::SIMDResultHandlerToFloat::q_map = nullptr @@ -146,6 +159,7 @@ const uint16_t* faiss::SIMDResultHandlerToFloat::dbias dbias + faiss::SIMDResultHandlerToFloat::dbias = nullptr @@ -161,6 +175,7 @@ const float* faiss::SIMDResultHandlerToFloat::normalizers normalizers + faiss::SIMDResultHandlerToFloat::normalizers = nullptr @@ -175,6 +190,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -189,6 +205,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -203,6 +220,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -212,13 +230,14 @@ - - + + faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::ResultHandlerCompare (size_t nq, size_t ntotal, const IDSelector *sel_in) ResultHandlerCompare + faiss::simd_result_handlers::ResultHandlerCompare::ResultHandlerCompare size_t nq @@ -244,6 +263,7 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::set_block_origin (size_t i0_in, size_t j0_in) final set_block_origin + faiss::simd_result_handlers::ResultHandlerCompare::set_block_origin set_block_origin size_t @@ -267,6 +287,7 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_with_origin (size_t &q, simd16uint16 &d0, simd16uint16 &d1) adjust_with_origin + faiss::simd_result_handlers::ResultHandlerCompare::adjust_with_origin size_t & q @@ -292,6 +313,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_id (size_t b, size_t j) adjust_id + faiss::simd_result_handlers::ResultHandlerCompare::adjust_id size_t b @@ -313,6 +335,7 @@ uint32_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::get_lt_mask (uint16_t thr, size_t b, simd16uint16 d0, simd16uint16 d1) get_lt_mask + faiss::simd_result_handlers::ResultHandlerCompare::get_lt_mask uint16_t thr @@ -343,6 +366,7 @@ virtual faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::~ResultHandlerCompare () ~ResultHandlerCompare + faiss::simd_result_handlers::ResultHandlerCompare::~ResultHandlerCompare @@ -356,6 +380,7 @@ virtual void faiss::SIMDResultHandlerToFloat::begin (const float *norms) begin + faiss::SIMDResultHandlerToFloat::begin begin begin @@ -375,6 +400,7 @@ virtual void faiss::SIMDResultHandlerToFloat::end () end + faiss::SIMDResultHandlerToFloat::end end end end @@ -394,6 +420,7 @@ virtual void faiss::SIMDResultHandler::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1)=0 handle + faiss::SIMDResultHandler::handle handle handle handle @@ -427,7 +454,7 @@ - + @@ -440,10 +467,38 @@ + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + @@ -452,22 +507,28 @@ - - - - + + + + - - - - + + + + + + + + + + @@ -477,16 +538,6 @@ sel - - - - - - - - - - diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1SingleResultHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1SingleResultHandler.xml index 0efac82f8c..ab209005b4 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1SingleResultHandler.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1SingleResultHandler.xml @@ -1,5 +1,5 @@ - + faiss::simd_result_handlers::SingleResultHandler faiss::simd_result_handlers::ResultHandlerCompare< C, false > @@ -15,12 +15,13 @@ false - + typename C::T using faiss::simd_result_handlers::SingleResultHandler< C, with_id_map >::T = typename C::T T + faiss::simd_result_handlers::SingleResultHandler::T @@ -34,6 +35,7 @@ using faiss::simd_result_handlers::SingleResultHandler< C, with_id_map >::TI = typename C::TI TI + faiss::simd_result_handlers::SingleResultHandler::TI @@ -47,6 +49,7 @@ using faiss::simd_result_handlers::SingleResultHandler< C, with_id_map >::RHC = ResultHandlerCompare<C, with_id_map> RHC + faiss::simd_result_handlers::SingleResultHandler::RHC @@ -55,13 +58,14 @@ - - + + std::vector< int16_t > std::vector<int16_t> faiss::simd_result_handlers::SingleResultHandler< C, with_id_map >::idis idis + faiss::simd_result_handlers::SingleResultHandler::idis @@ -75,6 +79,7 @@ float* faiss::simd_result_handlers::SingleResultHandler< C, with_id_map >::dis dis + faiss::simd_result_handlers::SingleResultHandler::dis @@ -88,6 +93,7 @@ int64_t* faiss::simd_result_handlers::SingleResultHandler< C, with_id_map >::ids ids + faiss::simd_result_handlers::SingleResultHandler::ids @@ -101,6 +107,8 @@ bool faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::disable disable + faiss::simd_result_handlers::ResultHandlerCompare::disable + = false @@ -114,6 +122,8 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::i0 i0 + faiss::simd_result_handlers::ResultHandlerCompare::i0 + = 0 @@ -127,6 +137,8 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::j0 j0 + faiss::simd_result_handlers::ResultHandlerCompare::j0 + = 0 @@ -140,6 +152,7 @@ const IDSelector* faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::sel sel + faiss::simd_result_handlers::ResultHandlerCompare::sel @@ -153,6 +166,7 @@ size_t faiss::SIMDResultHandlerToFloat::nq nq + faiss::SIMDResultHandlerToFloat::nq @@ -166,6 +180,7 @@ size_t faiss::SIMDResultHandlerToFloat::ntotal ntotal + faiss::SIMDResultHandlerToFloat::ntotal @@ -179,6 +194,7 @@ const idx_t* faiss::SIMDResultHandlerToFloat::id_map id_map + faiss::SIMDResultHandlerToFloat::id_map = nullptr these fields are used mainly for the IVF variants (with_id_map=true) @@ -194,6 +210,7 @@ const int* faiss::SIMDResultHandlerToFloat::q_map q_map + faiss::SIMDResultHandlerToFloat::q_map = nullptr @@ -208,6 +225,7 @@ const uint16_t* faiss::SIMDResultHandlerToFloat::dbias dbias + faiss::SIMDResultHandlerToFloat::dbias = nullptr @@ -223,6 +241,7 @@ const float* faiss::SIMDResultHandlerToFloat::normalizers normalizers + faiss::SIMDResultHandlerToFloat::normalizers = nullptr @@ -237,6 +256,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -251,6 +271,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -265,6 +286,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -274,13 +296,14 @@ - - + + faiss::simd_result_handlers::SingleResultHandler< C, with_id_map >::SingleResultHandler (size_t nq, size_t ntotal, float *dis, int64_t *ids, const IDSelector *sel_in) SingleResultHandler + faiss::simd_result_handlers::SingleResultHandler::SingleResultHandler size_t nq @@ -314,6 +337,7 @@ void faiss::simd_result_handlers::SingleResultHandler< C, with_id_map >::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1) final handle + faiss::simd_result_handlers::SingleResultHandler::handle handle size_t @@ -345,6 +369,7 @@ void faiss::simd_result_handlers::SingleResultHandler< C, with_id_map >::end () end + faiss::simd_result_handlers::SingleResultHandler::end end @@ -359,14 +384,15 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::set_block_origin (size_t i0_in, size_t j0_in) final set_block_origin + faiss::simd_result_handlers::ResultHandlerCompare::set_block_origin set_block_origin size_t - i0_in + i0 size_t - j0_in + j0 set the sub-matrix that is being computed @@ -382,6 +408,7 @@ void faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_with_origin (size_t &q, simd16uint16 &d0, simd16uint16 &d1) adjust_with_origin + faiss::simd_result_handlers::ResultHandlerCompare::adjust_with_origin size_t & q @@ -407,6 +434,7 @@ int64_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::adjust_id (size_t b, size_t j) adjust_id + faiss::simd_result_handlers::ResultHandlerCompare::adjust_id size_t b @@ -428,6 +456,7 @@ uint32_t faiss::simd_result_handlers::ResultHandlerCompare< C, with_id_map >::get_lt_mask (uint16_t thr, size_t b, simd16uint16 d0, simd16uint16 d1) get_lt_mask + faiss::simd_result_handlers::ResultHandlerCompare::get_lt_mask uint16_t thr @@ -458,6 +487,7 @@ virtual void faiss::SIMDResultHandlerToFloat::begin (const float *norms) begin + faiss::SIMDResultHandlerToFloat::begin begin begin @@ -472,18 +502,16 @@ - + Special version for k=1 - - - - - + + + @@ -491,9 +519,11 @@ - - - + + + + + @@ -503,11 +533,13 @@ - - - - - + + + + + + + @@ -515,9 +547,14 @@ - - - + + + + + + + sel + diff --git a/xml/structfaiss_1_1simd__result__handlers_1_1StoreResultHandler.xml b/xml/structfaiss_1_1simd__result__handlers_1_1StoreResultHandler.xml index 0e1324cc57..11e551aae9 100644 --- a/xml/structfaiss_1_1simd__result__handlers_1_1StoreResultHandler.xml +++ b/xml/structfaiss_1_1simd__result__handlers_1_1StoreResultHandler.xml @@ -1,15 +1,16 @@ - + faiss::simd_result_handlers::StoreResultHandler faiss::SIMDResultHandler simd_result_handlers.h - + uint16_t * uint16_t* faiss::simd_result_handlers::StoreResultHandler::data data + faiss::simd_result_handlers::StoreResultHandler::data @@ -23,6 +24,7 @@ size_t faiss::simd_result_handlers::StoreResultHandler::ld ld + faiss::simd_result_handlers::StoreResultHandler::ld @@ -36,6 +38,7 @@ size_t faiss::simd_result_handlers::StoreResultHandler::i0 i0 + faiss::simd_result_handlers::StoreResultHandler::i0 = 0 @@ -50,6 +53,7 @@ size_t faiss::simd_result_handlers::StoreResultHandler::j0 j0 + faiss::simd_result_handlers::StoreResultHandler::j0 = 0 @@ -64,6 +68,7 @@ bool faiss::SIMDResultHandler::is_CMax is_CMax + faiss::SIMDResultHandler::is_CMax = false @@ -78,6 +83,7 @@ uint8_t faiss::SIMDResultHandler::sizeof_ids sizeof_ids + faiss::SIMDResultHandler::sizeof_ids = 0 @@ -92,6 +98,7 @@ bool faiss::SIMDResultHandler::with_fields with_fields + faiss::SIMDResultHandler::with_fields = false @@ -101,13 +108,14 @@ - - + + faiss::simd_result_handlers::StoreResultHandler::StoreResultHandler (uint16_t *data, size_t ld) StoreResultHandler + faiss::simd_result_handlers::StoreResultHandler::StoreResultHandler uint16_t * data @@ -129,6 +137,7 @@ void faiss::simd_result_handlers::StoreResultHandler::handle (size_t q, size_t b, simd16uint16 d0, simd16uint16 d1) final handle + faiss::simd_result_handlers::StoreResultHandler::handle handle size_t @@ -160,6 +169,7 @@ void faiss::simd_result_handlers::StoreResultHandler::set_block_origin (size_t i0_in, size_t j0_in) final set_block_origin + faiss::simd_result_handlers::StoreResultHandler::set_block_origin set_block_origin size_t @@ -178,7 +188,7 @@ - + @@ -186,28 +196,28 @@ j0 is the current upper-left block of the matrix + + + + + + - - - - - - diff --git a/xml/transpose-avx2-inl_8h.xml b/xml/transpose-avx2-inl_8h.xml index b6d4a20de0..012e57d9fb 100644 --- a/xml/transpose-avx2-inl_8h.xml +++ b/xml/transpose-avx2-inl_8h.xml @@ -1,5 +1,5 @@ - + transpose-avx2-inl.h diff --git a/xml/transpose-avx512-inl_8h.xml b/xml/transpose-avx512-inl_8h.xml index 25c70ad6f5..9f60794c43 100644 --- a/xml/transpose-avx512-inl_8h.xml +++ b/xml/transpose-avx512-inl_8h.xml @@ -1,5 +1,5 @@ - + transpose-avx512-inl.h diff --git a/xml/utils_8h.xml b/xml/utils_8h.xml index 594ea69fc7..6fc5790a46 100644 --- a/xml/utils_8h.xml +++ b/xml/utils_8h.xml @@ -1,5 +1,5 @@ - + utils.h stdint.h @@ -8,15 +8,12 @@ vector faiss/impl/platform_macros.h faiss/utils/Heap.h - faiss/impl/LocalSearchQuantizer.h faiss/IndexBinaryHNSW.h faiss/IndexHNSW.h faiss/IndexNNDescent.h faiss/IndexNSG.h + faiss/impl/LocalSearchQuantizer.h - - - @@ -25,30 +22,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - @@ -81,15 +54,6 @@ - - - - - - - - - @@ -106,95 +70,131 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - - - - - - - - - + - - - - + + + + - + - + - - - - - - - - - - - - - + - + - - - + + + + + + + + + - - + + + + + + - - - - - - + + + + - + - - - - + + + + + + + + + + - - - + + + + + + + + + + + + + faiss::CombinerRangeKNN @@ -337,7 +337,7 @@ *@paramseedrandomseedtouseforsampling *@returnxoranarrayallocatedwithnew[]with*nvectors */ -constfloat*fvecs_maybe_subsample( +constfloat*fvecs_maybe_subsample( size_td, size_t*n, size_tnmax,