2018-12-19 17:48:35 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.5" / >
2019-05-28 16:17:22 +02:00
< title > Faiss: /data/users/hoss/faiss/IndexBinaryHNSW.h Source File< / title >
2018-12-19 17:48:35 +01:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > Faiss
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "namespaces.html" > < span > Namespaces< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Classes< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< div id = "navrow2" class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "files.html" > < span > File  List< / span > < / a > < / li >
< / ul >
< / div >
< / div > <!-- top -->
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(0)" > < span class = "SelectionMark" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Classes< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Namespaces< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < span class = "SelectionMark" >   < / span > Friends< / a > < / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "headertitle" >
2019-05-28 16:17:22 +02:00
< div class = "title" > /data/users/hoss/faiss/IndexBinaryHNSW.h< / div > < / div >
2018-12-19 17:48:35 +01:00
< / div > <!-- header -->
< div class = "contents" >
< div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < span class = "comment" > /**< / span > < / div >
2019-05-28 16:17:22 +02:00
< div class = "line" > < a name = "l00002" > < / a > < span class = "lineno" > 2< / span >   < span class = "comment" > * Copyright (c) Facebook, Inc. and its affiliates.< / span > < / div >
< div class = "line" > < a name = "l00003" > < / a > < span class = "lineno" > 3< / span >   < span class = "comment" > *< / span > < / div >
< div class = "line" > < a name = "l00004" > < / a > < span class = "lineno" > 4< / span >   < span class = "comment" > * This source code is licensed under the MIT license found in the< / span > < / div >
< div class = "line" > < a name = "l00005" > < / a > < span class = "lineno" > 5< / span >   < span class = "comment" > * LICENSE file in the root directory of this source tree.< / span > < / div >
< div class = "line" > < a name = "l00006" > < / a > < span class = "lineno" > 6< / span >   < span class = "comment" > */< / span > < / div >
< div class = "line" > < a name = "l00007" > < / a > < span class = "lineno" > 7< / span >   < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "comment" > // -*- c++ -*-< / span > < / div >
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < / div >
< div class = "line" > < a name = "l00010" > < / a > < span class = "lineno" > 10< / span >   < span class = "preprocessor" > #pragma once< / span > < / div >
< div class = "line" > < a name = "l00011" > < / a > < span class = "lineno" > 11< / span >   < span class = "preprocessor" > < / span > < / div >
< div class = "line" > < a name = "l00012" > < / a > < span class = "lineno" > 12< / span >   < span class = "preprocessor" > #include " HNSW.h" < / span > < / div >
< div class = "line" > < a name = "l00013" > < / a > < span class = "lineno" > 13< / span >   < span class = "preprocessor" > #include " IndexBinaryFlat.h" < / span > < / div >
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > 14< / span >   < span class = "preprocessor" > #include " utils.h" < / span > < / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < / div >
2018-12-19 17:48:35 +01:00
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < / div >
2019-05-28 16:17:22 +02:00
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "keyword" > namespace < / span > faiss {< / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < / div >
< div class = "line" > < a name = "l00019" > < / a > < span class = "lineno" > 19< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < span class = "comment" > /** The HNSW index is a normal random-access index with a HNSW< / span > < / div >
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < span class = "comment" > * link structure built on top */< / span > < / div >
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   < / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1IndexBinaryHNSW.html" > 23< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html" > IndexBinaryHNSW< / a > : < a class = "code" href = "structfaiss_1_1IndexBinary.html" > IndexBinary< / a > {< / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < span class = "keyword" > typedef< / span > < a class = "code" href = "structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74" > HNSW::storage_idx_t< / a > storage_idx_t;< / div >
< div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < / div >
< div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > 26< / span >   < span class = "comment" > // the link strcuture< / span > < / div >
< div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > 27< / span >   < a class = "code" href = "structfaiss_1_1HNSW.html" > HNSW< / a > hnsw;< / div >
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   < / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   < span class = "comment" > // the sequential storage< / span > < / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   < span class = "keywordtype" > bool< / span > own_fields;< / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   < a class = "code" href = "structfaiss_1_1IndexBinary.html" > IndexBinary< / a > *storage;< / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   < / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > 33< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html" > IndexBinaryHNSW< / a > ();< / div >
< div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html" > IndexBinaryHNSW< / a > (< span class = "keywordtype" > int< / span > < a class = "code" href = "structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88" > d< / a > , < span class = "keywordtype" > int< / span > M = 32);< / div >
< div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html" > IndexBinaryHNSW< / a > (< a class = "code" href = "structfaiss_1_1IndexBinary.html" > IndexBinary< / a > *storage, < span class = "keywordtype" > int< / span > M = 32);< / div >
< div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > 36< / span >   < / div >
< div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > 37< / span >   ~< a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html" > IndexBinaryHNSW< / a > () < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   < / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   < a class = "code" href = "structfaiss_1_1DistanceComputer.html" > DistanceComputer< / a > *get_distance_computer() < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   < / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html#aca2c449410d48edb72228016463aed5d" > add< / a > (< a class = "code" href = "structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c" > idx_t< / a > n, < span class = "keyword" > const< / span > uint8_t *x) < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < span class = "comment" > /// Trains the storage if needed< / span > < / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   < span class = "comment" > < / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html#afc2793b3b3c53e5acd8315dfea500e68" > train< / a > (< a class = "code" href = "structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c" > idx_t< / a > n, < span class = "keyword" > const< / span > uint8_t* x) < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > 45< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   < span class = "comment" > /// entry point for search< / span > < / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < span class = "comment" > < / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html#ae387b8e7094bfe584ef873c377a13af0" > search< / a > (< a class = "code" href = "structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c" > idx_t< / a > n, < span class = "keyword" > const< / span > uint8_t *x, < a class = "code" href = "structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c" > idx_t< / a > k,< / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   int32_t *distances, < a class = "code" href = "structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c" > idx_t< / a > *labels) < span class = "keyword" > const override< / span > ;< / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   < / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html#af509e0e2a6194a270a4887e20f54d866" > reconstruct< / a > (< a class = "code" href = "structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c" > idx_t< / a > key, uint8_t* recons) < span class = "keyword" > const override< / span > ;< / div >
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   < / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "structfaiss_1_1IndexBinaryHNSW.html#a7bab1a84623e4b9531263c4935315ca9" > reset< / a > () < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   };< / div >
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > 54< / span >   < / div >
2018-12-19 17:48:35 +01:00
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   < / div >
2019-05-28 16:17:22 +02:00
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   } < span class = "comment" > // namespace faiss< / span > < / div >
< div class = "ttc" id = "structfaiss_1_1DistanceComputer_html" > < div class = "ttname" > < a href = "structfaiss_1_1DistanceComputer.html" > faiss::DistanceComputer< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00231" > AuxIndexStructures.h:231< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IndexBinaryHNSW_html_aca2c449410d48edb72228016463aed5d" > < div class = "ttname" > < a href = "structfaiss_1_1IndexBinaryHNSW.html#aca2c449410d48edb72228016463aed5d" > faiss::IndexBinaryHNSW::add< / a > < / div > < div class = "ttdeci" > void add(idx_t n, const uint8_t *x) override< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "IndexBinaryHNSW_8cpp_source.html#l00226" > IndexBinaryHNSW.cpp:226< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IndexBinary_html_a01749bbdbd3b7ec6bb9390257ab16c5c" > < div class = "ttname" > < a href = "structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c" > faiss::IndexBinary::idx_t< / a > < / div > < div class = "ttdeci" > Index::idx_t idx_t< / div > < div class = "ttdoc" > all indices are this type < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "IndexBinary_8h_source.html#l00037" > IndexBinary.h:37< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IndexBinary_html_a0e485a7189eec2675032486d3b12cf88" > < div class = "ttname" > < a href = "structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88" > faiss::IndexBinary::d< / a > < / div > < div class = "ttdeci" > int d< / div > < div class = "ttdoc" > vector dimension < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "IndexBinary_8h_source.html#l00041" > IndexBinary.h:41< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IndexBinaryHNSW_html_af509e0e2a6194a270a4887e20f54d866" > < div class = "ttname" > < a href = "structfaiss_1_1IndexBinaryHNSW.html#af509e0e2a6194a270a4887e20f54d866" > faiss::IndexBinaryHNSW::reconstruct< / a > < / div > < div class = "ttdeci" > void reconstruct(idx_t key, uint8_t *recons) const override< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "IndexBinaryHNSW_8cpp_source.html#l00244" > IndexBinaryHNSW.cpp:244< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IndexBinaryHNSW_html" > < div class = "ttname" > < a href = "structfaiss_1_1IndexBinaryHNSW.html" > faiss::IndexBinaryHNSW< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "IndexBinaryHNSW_8h_source.html#l00023" > IndexBinaryHNSW.h:23< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1HNSW_html" > < div class = "ttname" > < a href = "structfaiss_1_1HNSW.html" > faiss::HNSW< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "HNSW_8h_source.html#l00046" > HNSW.h:46< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IndexBinaryHNSW_html_afc2793b3b3c53e5acd8315dfea500e68" > < div class = "ttname" > < a href = "structfaiss_1_1IndexBinaryHNSW.html#afc2793b3b3c53e5acd8315dfea500e68" > faiss::IndexBinaryHNSW::train< / a > < / div > < div class = "ttdeci" > void train(idx_t n, const uint8_t *x) override< / div > < div class = "ttdoc" > Trains the storage if needed. < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "IndexBinaryHNSW_8cpp_source.html#l00191" > IndexBinaryHNSW.cpp:191< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IndexBinary_html" > < div class = "ttname" > < a href = "structfaiss_1_1IndexBinary.html" > faiss::IndexBinary< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "IndexBinary_8h_source.html#l00036" > IndexBinary.h:36< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IndexBinaryHNSW_html_ae387b8e7094bfe584ef873c377a13af0" > < div class = "ttname" > < a href = "structfaiss_1_1IndexBinaryHNSW.html#ae387b8e7094bfe584ef873c377a13af0" > faiss::IndexBinaryHNSW::search< / a > < / div > < div class = "ttdeci" > void search(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels) const override< / div > < div class = "ttdoc" > entry point for search < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "IndexBinaryHNSW_8cpp_source.html#l00198" > IndexBinaryHNSW.cpp:198< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1HNSW_html_ae1342fc2f07c325598a73b733e88ee74" > < div class = "ttname" > < a href = "structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74" > faiss::HNSW::storage_idx_t< / a > < / div > < div class = "ttdeci" > int storage_idx_t< / div > < div class = "ttdoc" > internal storage of vectors (32 bits: this is expensive) < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "HNSW_8h_source.html#l00048" > HNSW.h:48< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IndexBinaryHNSW_html_a7bab1a84623e4b9531263c4935315ca9" > < div class = "ttname" > < a href = "structfaiss_1_1IndexBinaryHNSW.html#a7bab1a84623e4b9531263c4935315ca9" > faiss::IndexBinaryHNSW::reset< / a > < / div > < div class = "ttdeci" > void reset() override< / div > < div class = "ttdoc" > Removes all elements from the database. < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "IndexBinaryHNSW_8cpp_source.html#l00237" > IndexBinaryHNSW.cpp:237< / a > < / div > < / div >
2018-12-19 17:48:35 +01:00
< / div > <!-- fragment --> < / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
Generated by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.5
< / small > < / address >
< / body >
< / html >
