2018-12-20 00:48:35 +08: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" / >
< title > Faiss: faiss::InvertedListScanner Struct Reference< / title >
< 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 class = "current" > < a href = "annotated.html" > < span > Classes< / span > < / a > < / li >
< li > < 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 = "annotated.html" > < span > Class  List< / span > < / a > < / li >
< li > < a href = "classes.html" > < span > Class  Index< / span > < / a > < / li >
< li > < a href = "hierarchy.html" > < span > Class  Hierarchy< / span > < / a > < / li >
< li > < a href = "functions.html" > < span > Class  Members< / span > < / a > < / li >
< / ul >
< / div >
<!-- 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 id = "nav-path" class = "navpath" >
< ul >
< li class = "navelem" > < a class = "el" href = "namespacefaiss.html" > faiss< / a > < / li > < li class = "navelem" > < a class = "el" href = "structfaiss_1_1InvertedListScanner.html" > InvertedListScanner< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-types" > Public Types< / a > |
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "structfaiss_1_1InvertedListScanner-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > faiss::InvertedListScanner Struct Reference< span class = "mlabels" > < span class = "mlabel" > abstract< / span > < / span > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < < a class = "el" href = "IndexIVF_8h_source.html" > IndexIVF.h< / a > > < / code > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-types" > < / a >
Public Types< / h2 > < / td > < / tr >
< tr class = "memitem:a3839ad3afde506ac3cc7abdd69051759" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a3839ad3afde506ac3cc7abdd69051759" > < / a >
2019-05-28 22:17:22 +08:00
using  < / td > < td class = "memItemRight" valign = "bottom" > < b > idx_t< / b > = < a class = "el" href = "structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea" > Index::idx_t< / a > < / td > < / tr >
2018-12-20 00:48:35 +08:00
< tr class = "separator:a3839ad3afde506ac3cc7abdd69051759" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a97cab8fbf8203bdda6c42fc4b8f92319" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a97cab8fbf8203bdda6c42fc4b8f92319" > < / a >
virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1InvertedListScanner.html#a97cab8fbf8203bdda6c42fc4b8f92319" > set_query< / a > (const float *query_vector)=0< / td > < / tr >
< tr class = "memdesc:a97cab8fbf8203bdda6c42fc4b8f92319" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > from now on we handle this query. < br / > < / td > < / tr >
< tr class = "separator:a97cab8fbf8203bdda6c42fc4b8f92319" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ae801ea7ba0086a05ace3b779c3acf305" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ae801ea7ba0086a05ace3b779c3acf305" > < / a >
virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1InvertedListScanner.html#ae801ea7ba0086a05ace3b779c3acf305" > set_list< / a > (idx_t list_no, float coarse_dis)=0< / td > < / tr >
< tr class = "memdesc:ae801ea7ba0086a05ace3b779c3acf305" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > following codes come from this inverted list < br / > < / td > < / tr >
< tr class = "separator:ae801ea7ba0086a05ace3b779c3acf305" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ade9518f1b0ee00c2a43a2eb2ae350ae1" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ade9518f1b0ee00c2a43a2eb2ae350ae1" > < / a >
virtual float  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1InvertedListScanner.html#ade9518f1b0ee00c2a43a2eb2ae350ae1" > distance_to_code< / a > (const uint8_t *code) const =0< / td > < / tr >
< tr class = "memdesc:ade9518f1b0ee00c2a43a2eb2ae350ae1" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > compute a single query-to-code distance < br / > < / td > < / tr >
< tr class = "separator:ade9518f1b0ee00c2a43a2eb2ae350ae1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a218aeaf7cc45bf0bf27c3a8bfa44e303" > < td class = "memItemLeft" align = "right" valign = "top" > virtual size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1InvertedListScanner.html#a218aeaf7cc45bf0bf27c3a8bfa44e303" > scan_codes< / a > (size_t n, const uint8_t *codes, const idx_t *ids, float *distances, idx_t *labels, size_t k) const =0< / td > < / tr >
< tr class = "separator:a218aeaf7cc45bf0bf27c3a8bfa44e303" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-05-28 22:17:22 +08:00
< tr class = "memitem:a57b6dcddab11cc801ce6288e065e1fa1" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1InvertedListScanner.html#a57b6dcddab11cc801ce6288e065e1fa1" > scan_codes_range< / a > (size_t n, const uint8_t *codes, const idx_t *ids, float radius, < a class = "el" href = "structfaiss_1_1RangeQueryResult.html" > RangeQueryResult< / a > & result) const < / td > < / tr >
< tr class = "separator:a57b6dcddab11cc801ce6288e065e1fa1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2018-12-20 00:48:35 +08:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > 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 < / p >
2019-05-28 22:17:22 +08:00
< p > Definition at line < a class = "el" href = "IndexIVF_8h_source.html#l00272" > 272< / a > of file < a class = "el" href = "IndexIVF_8h_source.html" > IndexIVF.h< / a > .< / p >
2018-12-20 00:48:35 +08:00
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
< a class = "anchor" id = "a218aeaf7cc45bf0bf27c3a8bfa44e303" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > virtual size_t faiss::InvertedListScanner::scan_codes < / td >
< td > (< / td >
< td class = "paramtype" > size_t  < / td >
< td class = "paramname" > < em > n< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const uint8_t *  < / td >
< td class = "paramname" > < em > codes< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const idx_t *  < / td >
< td class = "paramname" > < em > ids< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > float *  < / td >
< td class = "paramname" > < em > distances< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > idx_t *  < / td >
< td class = "paramname" > < em > labels< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t  < / td >
< td class = "paramname" > < em > k< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > const< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > pure virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-05-28 22:17:22 +08:00
< p > scan a set of codes, compute distances to current query and update heap of results if necessary.< / p >
2018-12-20 00:48:35 +08:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > n< / td > < td > number of codes to scan < / td > < / tr >
< tr > < td class = "paramname" > codes< / td > < td > codes to scan (n * code_size) < / td > < / tr >
< tr > < td class = "paramname" > ids< / td > < td > corresponding ids (ignored if store_pairs) < / td > < / tr >
< tr > < td class = "paramname" > distances< / td > < td > heap distances (size k) < / td > < / tr >
< tr > < td class = "paramname" > labels< / td > < td > heap labels (size k) < / td > < / tr >
< tr > < td class = "paramname" > k< / td > < td > heap size < / td > < / tr >
< / table >
< / dd >
< / dl >
2019-05-28 22:17:22 +08:00
< dl class = "section return" > < dt > Returns< / dt > < dd > number of heap updates performed < / dd > < / dl >
2018-12-20 00:48:35 +08:00
< / div >
< / div >
2019-05-28 22:17:22 +08:00
< a class = "anchor" id = "a57b6dcddab11cc801ce6288e065e1fa1" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
< td class = "memname" > void faiss::InvertedListScanner::scan_codes_range < / td >
< td > (< / td >
< td class = "paramtype" > size_t  < / td >
< td class = "paramname" > < em > n< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const uint8_t *  < / td >
< td class = "paramname" > < em > codes< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const idx_t *  < / td >
< td class = "paramname" > < em > ids< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > float  < / td >
< td class = "paramname" > < em > radius< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "structfaiss_1_1RangeQueryResult.html" > RangeQueryResult< / a > &   < / td >
< td class = "paramname" > < em > result< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > const< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > scan a set of codes, compute distances to current query and update results if distances are below radius< / p >
< p > (default implementation fails) < / p >
< p > Definition at line < a class = "el" href = "IndexIVF_8cpp_source.html#l00830" > 830< / a > of file < a class = "el" href = "IndexIVF_8cpp_source.html" > IndexIVF.cpp< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this struct was generated from the following files:< ul >
< li > /data/users/hoss/faiss/< a class = "el" href = "IndexIVF_8h_source.html" > IndexIVF.h< / a > < / li >
< li > /data/users/hoss/faiss/< a class = "el" href = "IndexIVF_8cpp_source.html" > IndexIVF.cpp< / a > < / li >
2018-12-20 00:48:35 +08:00
< / ul >
< / 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 >
