2017-02-23 06:26:44 +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" / >
2018-12-20 00:48:35 +08:00
< title > Faiss: /tmp/faiss/AuxIndexStructures.h Source File< / title >
2017-02-23 06:26:44 +08: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" >
2018-12-20 00:48:35 +08:00
< div class = "title" > /tmp/faiss/AuxIndexStructures.h< / div > < / div >
2017-02-23 06:26:44 +08:00
< / div > <!-- header -->
< div class = "contents" >
2017-06-21 21:54:28 +08:00
< div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < span class = "comment" > /**< / span > < / div >
< div class = "line" > < a name = "l00002" > < / a > < span class = "lineno" > 2< / span >   < span class = "comment" > * Copyright (c) 2015-present, Facebook, Inc.< / span > < / div >
< div class = "line" > < a name = "l00003" > < / a > < span class = "lineno" > 3< / span >   < span class = "comment" > * All rights reserved.< / span > < / div >
< div class = "line" > < a name = "l00004" > < / a > < span class = "lineno" > 4< / span >   < span class = "comment" > *< / span > < / div >
2017-07-30 15:18:45 +08:00
< div class = "line" > < a name = "l00005" > < / a > < span class = "lineno" > 5< / span >   < span class = "comment" > * This source code is licensed under the BSD+Patents license found in the< / span > < / div >
2017-06-21 21:54:28 +08:00
< div class = "line" > < a name = "l00006" > < / a > < span class = "lineno" > 6< / span >   < span class = "comment" > * LICENSE file in the root directory of this source tree.< / span > < / div >
< div class = "line" > < a name = "l00007" > < / a > < span class = "lineno" > 7< / span >   < span class = "comment" > */< / span > < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < / div >
2018-12-20 00:48:35 +08:00
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < span class = "comment" > // -*- c++ -*-< / span > < / div >
< div class = "line" > < a name = "l00010" > < / a > < span class = "lineno" > 10< / span >   < / div >
2017-06-21 21:54:28 +08:00
< div class = "line" > < a name = "l00011" > < / a > < span class = "lineno" > 11< / span >   < span class = "comment" > // Auxiliary index structures, that are used in indexes but that can< / span > < / div >
< div class = "line" > < a name = "l00012" > < / a > < span class = "lineno" > 12< / span >   < span class = "comment" > // be forward-declared< / span > < / div >
< div class = "line" > < a name = "l00013" > < / a > < span class = "lineno" > 13< / span >   < / div >
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > 14< / span >   < span class = "preprocessor" > #ifndef FAISS_AUX_INDEX_STRUCTURES_H< / span > < / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define FAISS_AUX_INDEX_STRUCTURES_H< / span > < / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < span class = "preprocessor" > < / span > < / div >
2018-12-20 00:48:35 +08:00
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "preprocessor" > #include < stdint.h> < / span > < / 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 = "preprocessor" > #include < vector> < / span > < / div >
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < span class = "preprocessor" > #include < unordered_set> < / span > < / div >
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < / div >
2017-07-18 17:43:35 +08:00
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   < / div >
2018-12-20 00:48:35 +08:00
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   < span class = "preprocessor" > #include " Index.h" < / span > < / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < / div >
< div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < span class = "keyword" > namespace < / span > faiss {< / div >
< div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > 26< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > 27< / span >   < span class = "comment" > /** The objective is to have a simple result structure while< / span > < / div >
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   < span class = "comment" > * minimizing the number of mem copies in the result. The method< / span > < / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   < span class = "comment" > * do_allocation can be overloaded to allocate the result tables in< / span > < / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   < span class = "comment" > * the matrix type of a scripting language like Lua or Python. */< / span > < / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1RangeSearchResult.html" > 31< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1RangeSearchResult.html" > RangeSearchResult< / a > {< / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90" > 32< / a > < / span >   < span class = "keywordtype" > size_t< / span > < a class = "code" href = "structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90" > nq< / a > ; < span class = "comment" > ///< nb of queries< / span > < / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1RangeSearchResult.html#aef57f9db99ca470c01bcdce0366cb6ff" > 33< / a > < / span >   < span class = "comment" > < / span > < span class = "keywordtype" > size_t< / span > *< a class = "code" href = "structfaiss_1_1RangeSearchResult.html#aef57f9db99ca470c01bcdce0366cb6ff" > lims< / a > ; < span class = "comment" > ///< size (nq + 1)< / span > < / div >
< div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   < span class = "keyword" > typedef< / span > < a class = "code" href = "structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4" > Index::idx_t< / a > idx_t;< / div >
< div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > 36< / span >   < / div >
< div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1RangeSearchResult.html#aa8ff848474a4cc16c5464cc4ec187824" > 37< / a > < / span >   idx_t *< a class = "code" href = "structfaiss_1_1RangeSearchResult.html#aa8ff848474a4cc16c5464cc4ec187824" > labels< / a > ; < span class = "comment" > ///< result for query i is labels[lims[i]:lims[i+1]]< / span > < / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1RangeSearchResult.html#a944a93aecc7b51d8f9f35444280aa919" > 38< / a > < / span >   < span class = "comment" > < / span > < span class = "keywordtype" > float< / span > *< a class = "code" href = "structfaiss_1_1RangeSearchResult.html#a944a93aecc7b51d8f9f35444280aa919" > distances< / a > ; < span class = "comment" > ///< corresponding distances (not sorted)< / span > < / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1RangeSearchResult.html#a39342ad2e9ad8b90f6e95dafd3287f49" > 40< / a > < / span >   < span class = "keywordtype" > size_t< / span > < a class = "code" href = "structfaiss_1_1RangeSearchResult.html#a39342ad2e9ad8b90f6e95dafd3287f49" > buffer_size< / a > ; < span class = "comment" > ///< size of the result buffers used< / span > < / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < span class = "comment" > < / span > < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   < span class = "comment" > /// lims must be allocated on input to range_search.< / span > < / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < span class = "comment" > < / span > < span class = "keyword" > explicit< / span > < a class = "code" href = "structfaiss_1_1RangeSearchResult.html#a56dca2b151bcf16f5d488aff321b9501" > RangeSearchResult< / a > (idx_t < a class = "code" href = "structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90" > nq< / a > , < span class = "keywordtype" > bool< / span > alloc_lims=< span class = "keyword" > true< / span > );< / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > 45< / span >   < span class = "comment" > /// called when lims contains the nb of elements result entries< / span > < / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   < span class = "comment" > /// for each query< / span > < / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < span class = "comment" > < / span > < span class = "keyword" > virtual< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "structfaiss_1_1RangeSearchResult.html#a34c4ba599c0cec45972af19e1f98f22a" > do_allocation< / a > ();< / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   < / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   < span class = "keyword" > virtual< / span > ~< a class = "code" href = "structfaiss_1_1RangeSearchResult.html" > RangeSearchResult< / a > ();< / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / 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 = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   < span class = "comment" > /** Encapsulates a set of ids to remove. */< / span > < / div >
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1IDSelector.html" > 54< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1IDSelector.html" > IDSelector< / a > {< / div >
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   < span class = "keyword" > typedef< / span > < a class = "code" href = "structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4" > Index::idx_t< / a > idx_t;< / div >
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < span class = "keyword" > virtual< / span > < span class = "keywordtype" > bool< / span > is_member (idx_t < span class = "keywordtype" > id< / span > ) < span class = "keyword" > const< / span > = 0;< / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   < span class = "keyword" > virtual< / span > ~< a class = "code" href = "structfaiss_1_1IDSelector.html" > IDSelector< / a > () {}< / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   };< / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   < / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   < / div >
< div class = "line" > < a name = "l00061" > < / a > < span class = "lineno" > 61< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00062" > < / a > < span class = "lineno" > 62< / span >   < span class = "comment" > /** remove ids between [imni, imax) */< / span > < / div >
< div class = "line" > < a name = "l00063" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1IDSelectorRange.html" > 63< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1IDSelectorRange.html" > IDSelectorRange< / a > : < a class = "code" href = "structfaiss_1_1IDSelector.html" > IDSelector< / a > {< / div >
< div class = "line" > < a name = "l00064" > < / a > < span class = "lineno" > 64< / span >   idx_t imin, imax;< / div >
< div class = "line" > < a name = "l00065" > < / a > < span class = "lineno" > 65< / span >   < / div >
< div class = "line" > < a name = "l00066" > < / a > < span class = "lineno" > 66< / span >   < a class = "code" href = "structfaiss_1_1IDSelectorRange.html" > IDSelectorRange< / a > (idx_t imin, idx_t imax);< / div >
< div class = "line" > < a name = "l00067" > < / a > < span class = "lineno" > 67< / span >   < span class = "keywordtype" > bool< / span > is_member(idx_t < span class = "keywordtype" > id< / span > ) < span class = "keyword" > const override< / span > ;< / div >
< div class = "line" > < a name = "l00068" > < / a > < span class = "lineno" > 68< / span >   ~< a class = "code" href = "structfaiss_1_1IDSelectorRange.html" > IDSelectorRange< / a > ()< span class = "keyword" > override < / span > {}< / div >
< div class = "line" > < a name = "l00069" > < / a > < span class = "lineno" > 69< / span >   };< / div >
< div class = "line" > < a name = "l00070" > < / a > < span class = "lineno" > 70< / span >   < / div >
< div class = "line" > < a name = "l00071" > < / a > < span class = "lineno" > 71< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00072" > < / a > < span class = "lineno" > 72< / span >   < span class = "comment" > /** Remove ids from a set. Repetitions of ids in the indices set< / span > < / div >
< div class = "line" > < a name = "l00073" > < / a > < span class = "lineno" > 73< / span >   < span class = "comment" > * passed to the constructor does not hurt performance. The hash< / span > < / div >
< div class = "line" > < a name = "l00074" > < / a > < span class = "lineno" > 74< / span >   < span class = "comment" > * function used for the bloom filter and GCC' s implementation of< / span > < / div >
< div class = "line" > < a name = "l00075" > < / a > < span class = "lineno" > 75< / span >   < span class = "comment" > * unordered_set are just the least significant bits of the id. This< / span > < / div >
< div class = "line" > < a name = "l00076" > < / a > < span class = "lineno" > 76< / span >   < span class = "comment" > * works fine for random ids or ids in sequences but will produce many< / span > < / div >
< div class = "line" > < a name = "l00077" > < / a > < span class = "lineno" > 77< / span >   < span class = "comment" > * hash collisions if lsb' s are always the same */< / span > < / div >
< div class = "line" > < a name = "l00078" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1IDSelectorBatch.html" > 78< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1IDSelectorBatch.html" > IDSelectorBatch< / a > : < a class = "code" href = "structfaiss_1_1IDSelector.html" > IDSelector< / a > {< / div >
2017-07-18 17:43:35 +08:00
< div class = "line" > < a name = "l00079" > < / a > < span class = "lineno" > 79< / span >   < / div >
2018-12-20 00:48:35 +08:00
< div class = "line" > < a name = "l00080" > < / a > < span class = "lineno" > 80< / span >   std::unordered_set< idx_t> set;< / div >
< div class = "line" > < a name = "l00081" > < / a > < span class = "lineno" > 81< / span >   < / div >
< div class = "line" > < a name = "l00082" > < / a > < span class = "lineno" > 82< / span >   < span class = "keyword" > typedef< / span > < span class = "keywordtype" > unsigned< / span > < span class = "keywordtype" > char< / span > uint8_t;< / div >
< div class = "line" > < a name = "l00083" > < / a > < span class = "lineno" > 83< / span >   std::vector< uint8_t> bloom; < span class = "comment" > // assumes low bits of id are a good hash value< / span > < / div >
< div class = "line" > < a name = "l00084" > < / a > < span class = "lineno" > 84< / span >   < span class = "keywordtype" > int< / span > nbits;< / div >
< div class = "line" > < a name = "l00085" > < / a > < span class = "lineno" > 85< / span >   idx_t mask;< / div >
< div class = "line" > < a name = "l00086" > < / a > < span class = "lineno" > 86< / span >   < / div >
< div class = "line" > < a name = "l00087" > < / a > < span class = "lineno" > 87< / span >   < a class = "code" href = "structfaiss_1_1IDSelectorBatch.html" > IDSelectorBatch< / a > (< span class = "keywordtype" > long< / span > n, < span class = "keyword" > const< / span > idx_t *indices);< / div >
< div class = "line" > < a name = "l00088" > < / a > < span class = "lineno" > 88< / span >   < span class = "keywordtype" > bool< / span > is_member(idx_t < span class = "keywordtype" > id< / span > ) < span class = "keyword" > const override< / span > ;< / div >
< div class = "line" > < a name = "l00089" > < / a > < span class = "lineno" > 89< / span >   ~< a class = "code" href = "structfaiss_1_1IDSelectorBatch.html" > IDSelectorBatch< / a > ()< span class = "keyword" > override < / span > {}< / div >
< div class = "line" > < a name = "l00090" > < / a > < span class = "lineno" > 90< / span >   };< / div >
< div class = "line" > < a name = "l00091" > < / a > < span class = "lineno" > 91< / span >   < / div >
2017-07-18 17:43:35 +08:00
< div class = "line" > < a name = "l00092" > < / a > < span class = "lineno" > 92< / span >   < / div >
2018-12-20 00:48:35 +08:00
< div class = "line" > < a name = "l00093" > < / a > < span class = "lineno" > 93< / span >   < span class = "comment" > // Below are structures used only by Index implementations< / span > < / div >
< div class = "line" > < a name = "l00094" > < / a > < span class = "lineno" > 94< / span >   < / div >
< div class = "line" > < a name = "l00095" > < / a > < span class = "lineno" > 95< / span >   < / div >
< div class = "line" > < a name = "l00096" > < / a > < span class = "lineno" > 96< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00097" > < / a > < span class = "lineno" > 97< / span >   < span class = "comment" > /** List of temporary buffers used to store results before they are< / span > < / div >
< div class = "line" > < a name = "l00098" > < / a > < span class = "lineno" > 98< / span >   < span class = "comment" > * copied to the RangeSearchResult object. */< / span > < / div >
< div class = "line" > < a name = "l00099" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1BufferList.html" > 99< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1BufferList.html" > BufferList< / a > {< / div >
< div class = "line" > < a name = "l00100" > < / a > < span class = "lineno" > 100< / span >   < span class = "keyword" > typedef< / span > < a class = "code" href = "structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4" > Index::idx_t< / a > idx_t;< / div >
< div class = "line" > < a name = "l00101" > < / a > < span class = "lineno" > 101< / span >   < / div >
< div class = "line" > < a name = "l00102" > < / a > < span class = "lineno" > 102< / span >   < span class = "comment" > // buffer sizes in # entries< / span > < / div >
< div class = "line" > < a name = "l00103" > < / a > < span class = "lineno" > 103< / span >   < span class = "keywordtype" > size_t< / span > buffer_size;< / div >
< div class = "line" > < a name = "l00104" > < / a > < span class = "lineno" > 104< / span >   < / div >
< div class = "line" > < a name = "l00105" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1BufferList_1_1Buffer.html" > 105< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1BufferList_1_1Buffer.html" > Buffer< / a > {< / div >
< div class = "line" > < a name = "l00106" > < / a > < span class = "lineno" > 106< / span >   idx_t *ids;< / div >
< div class = "line" > < a name = "l00107" > < / a > < span class = "lineno" > 107< / span >   < span class = "keywordtype" > float< / span > *dis;< / div >
< div class = "line" > < a name = "l00108" > < / a > < span class = "lineno" > 108< / span >   };< / div >
< div class = "line" > < a name = "l00109" > < / a > < span class = "lineno" > 109< / span >   < / div >
< div class = "line" > < a name = "l00110" > < / a > < span class = "lineno" > 110< / span >   std::vector< Buffer> buffers;< / div >
< div class = "line" > < a name = "l00111" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9" > 111< / a > < / span >   < span class = "keywordtype" > size_t< / span > < a class = "code" href = "structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9" > wp< / a > ; < span class = "comment" > ///< write pointer in the last buffer.< / span > < / div >
< div class = "line" > < a name = "l00112" > < / a > < span class = "lineno" > 112< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00113" > < / a > < span class = "lineno" > 113< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "structfaiss_1_1BufferList.html" > BufferList< / a > (< span class = "keywordtype" > size_t< / span > buffer_size);< / div >
2017-07-18 17:43:35 +08:00
< div class = "line" > < a name = "l00114" > < / a > < span class = "lineno" > 114< / span >   < / div >
2018-12-20 00:48:35 +08:00
< div class = "line" > < a name = "l00115" > < / a > < span class = "lineno" > 115< / span >   ~< a class = "code" href = "structfaiss_1_1BufferList.html" > BufferList< / a > ();< / div >
< div class = "line" > < a name = "l00116" > < / a > < span class = "lineno" > 116< / span >   < / div >
< div class = "line" > < a name = "l00117" > < / a > < span class = "lineno" > 117< / span >   < span class = "comment" > // create a new buffer< / span > < / div >
< div class = "line" > < a name = "l00118" > < / a > < span class = "lineno" > 118< / span >   < span class = "keywordtype" > void< / span > append_buffer ();< / div >
< div class = "line" > < a name = "l00119" > < / a > < span class = "lineno" > 119< / span >   < / div >
< div class = "line" > < a name = "l00120" > < / a > < span class = "lineno" > 120< / span >   < span class = "keyword" > inline< / span > < span class = "keywordtype" > void< / span > add (idx_t < span class = "keywordtype" > id< / span > , < span class = "keywordtype" > float< / span > dis)< / div >
< div class = "line" > < a name = "l00121" > < / a > < span class = "lineno" > 121< / span >   {< / div >
< div class = "line" > < a name = "l00122" > < / a > < span class = "lineno" > 122< / span >   < span class = "keywordflow" > if< / span > (< a class = "code" href = "structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9" > wp< / a > == buffer_size) { < span class = "comment" > // need new buffer< / span > < / div >
< div class = "line" > < a name = "l00123" > < / a > < span class = "lineno" > 123< / span >   append_buffer();< / div >
< div class = "line" > < a name = "l00124" > < / a > < span class = "lineno" > 124< / span >   }< / div >
< div class = "line" > < a name = "l00125" > < / a > < span class = "lineno" > 125< / span >   Buffer & buf = buffers.back();< / div >
< div class = "line" > < a name = "l00126" > < / a > < span class = "lineno" > 126< / span >   buf.ids [< a class = "code" href = "structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9" > wp< / a > ] = id;< / div >
< div class = "line" > < a name = "l00127" > < / a > < span class = "lineno" > 127< / span >   buf.dis [< a class = "code" href = "structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9" > wp< / a > ] = dis;< / div >
< div class = "line" > < a name = "l00128" > < / a > < span class = "lineno" > 128< / span >   < a class = "code" href = "structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9" > wp< / a > ++;< / div >
< div class = "line" > < a name = "l00129" > < / a > < span class = "lineno" > 129< / span >   }< / div >
< div class = "line" > < a name = "l00130" > < / a > < span class = "lineno" > 130< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00131" > < / a > < span class = "lineno" > 131< / span >   < span class = "comment" > /// copy elemnts ofs:ofs+n-1 seen as linear data in the buffers to< / span > < / div >
< div class = "line" > < a name = "l00132" > < / a > < span class = "lineno" > 132< / span >   < span class = "comment" > /// tables dest_ids, dest_dis< / span > < / div >
< div class = "line" > < a name = "l00133" > < / a > < span class = "lineno" > 133< / span >   < span class = "comment" > < / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "structfaiss_1_1BufferList.html#a78b70417a9ba5b27553b3134f1190958" > copy_range< / a > (< span class = "keywordtype" > size_t< / span > ofs, < span class = "keywordtype" > size_t< / span > n,< / div >
< div class = "line" > < a name = "l00134" > < / a > < span class = "lineno" > 134< / span >   idx_t * dest_ids, < span class = "keywordtype" > float< / span > *dest_dis);< / div >
2017-07-18 17:43:35 +08:00
< div class = "line" > < a name = "l00135" > < / a > < span class = "lineno" > 135< / span >   < / div >
2018-12-20 00:48:35 +08:00
< div class = "line" > < a name = "l00136" > < / a > < span class = "lineno" > 136< / span >   };< / div >
< div class = "line" > < a name = "l00137" > < / a > < span class = "lineno" > 137< / span >   < / div >
< div class = "line" > < a name = "l00138" > < / a > < span class = "lineno" > 138< / span >   < / div >
< div class = "line" > < a name = "l00139" > < / a > < span class = "lineno" > 139< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00140" > < / a > < span class = "lineno" > 140< / span >   < span class = "comment" > /// the entries in the buffers are split per query< / span > < / div >
< div class = "line" > < a name = "l00141" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1RangeSearchPartialResult.html" > 141< / a > < / span >   < span class = "comment" > < / span > < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1RangeSearchPartialResult.html" > RangeSearchPartialResult< / a > : < a class = "code" href = "structfaiss_1_1BufferList.html" > BufferList< / a > {< / div >
< div class = "line" > < a name = "l00142" > < / a > < span class = "lineno" > 142< / span >   < a class = "code" href = "structfaiss_1_1RangeSearchResult.html" > RangeSearchResult< / a > * res;< / div >
< div class = "line" > < a name = "l00143" > < / a > < span class = "lineno" > 143< / span >   < / div >
< div class = "line" > < a name = "l00144" > < / a > < span class = "lineno" > 144< / span >   < span class = "keyword" > explicit< / span > < a class = "code" href = "structfaiss_1_1RangeSearchPartialResult.html" > RangeSearchPartialResult< / a > (< a class = "code" href = "structfaiss_1_1RangeSearchResult.html" > RangeSearchResult< / a > * res_in);< / div >
< div class = "line" > < a name = "l00145" > < / a > < span class = "lineno" > 145< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00146" > < / a > < span class = "lineno" > 146< / span >   < span class = "comment" > /// result structure for a single query< / span > < / div >
< div class = "line" > < a name = "l00147" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1RangeSearchPartialResult_1_1QueryResult.html" > 147< / a > < / span >   < span class = "comment" > < / span > < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1RangeSearchPartialResult_1_1QueryResult.html" > QueryResult< / a > {< / div >
< div class = "line" > < a name = "l00148" > < / a > < span class = "lineno" > 148< / span >   idx_t qno;< / div >
< div class = "line" > < a name = "l00149" > < / a > < span class = "lineno" > 149< / span >   < span class = "keywordtype" > size_t< / span > nres;< / div >
< div class = "line" > < a name = "l00150" > < / a > < span class = "lineno" > 150< / span >   < a class = "code" href = "structfaiss_1_1RangeSearchPartialResult.html" > RangeSearchPartialResult< / a > * pres;< / div >
< div class = "line" > < a name = "l00151" > < / a > < span class = "lineno" > 151< / span >   < span class = "keyword" > inline< / span > < span class = "keywordtype" > void< / span > add (< span class = "keywordtype" > float< / span > dis, idx_t < span class = "keywordtype" > id< / span > ) {< / div >
< div class = "line" > < a name = "l00152" > < / a > < span class = "lineno" > 152< / span >   nres++;< / div >
< div class = "line" > < a name = "l00153" > < / a > < span class = "lineno" > 153< / span >   pres-> add (< span class = "keywordtype" > id< / span > , dis);< / div >
< div class = "line" > < a name = "l00154" > < / a > < span class = "lineno" > 154< / span >   }< / div >
< div class = "line" > < a name = "l00155" > < / a > < span class = "lineno" > 155< / span >   };< / div >
< div class = "line" > < a name = "l00156" > < / a > < span class = "lineno" > 156< / span >   < / div >
< div class = "line" > < a name = "l00157" > < / a > < span class = "lineno" > 157< / span >   std::vector< QueryResult> queries;< / div >
< div class = "line" > < a name = "l00158" > < / a > < span class = "lineno" > 158< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00159" > < / a > < span class = "lineno" > 159< / span >   < span class = "comment" > /// begin a new result< / span > < / div >
< div class = "line" > < a name = "l00160" > < / a > < span class = "lineno" > 160< / span >   < span class = "comment" > < / span > < a class = "code" href = "structfaiss_1_1RangeSearchPartialResult_1_1QueryResult.html" > QueryResult< / a > & < a class = "code" href = "structfaiss_1_1RangeSearchPartialResult.html#a954c26beebb561a6c2b0f399c48a9db3" > new_result< / a > (idx_t qno);< / div >
< div class = "line" > < a name = "l00161" > < / a > < span class = "lineno" > 161< / span >   < / div >
< div class = "line" > < a name = "l00162" > < / a > < span class = "lineno" > 162< / span >   < span class = "keywordtype" > void< / span > finalize ();< / div >
2017-07-18 17:43:35 +08:00
< div class = "line" > < a name = "l00163" > < / a > < span class = "lineno" > 163< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00164" > < / a > < span class = "lineno" > 164< / span >   < span class = "comment" > /// called by range_search before do_allocation< / span > < / div >
< div class = "line" > < a name = "l00165" > < / a > < span class = "lineno" > 165< / span >   < span class = "comment" > < / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "structfaiss_1_1RangeSearchPartialResult.html#ab6a385008493c7b630e4e7bc56e3da74" > set_lims< / a > ();< / div >
< div class = "line" > < a name = "l00166" > < / a > < span class = "lineno" > 166< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00167" > < / a > < span class = "lineno" > 167< / span >   < span class = "comment" > /// called by range_search after do_allocation< / span > < / div >
< div class = "line" > < a name = "l00168" > < / a > < span class = "lineno" > 168< / span >   < span class = "comment" > < / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "structfaiss_1_1RangeSearchPartialResult.html#aa6639358995ac081f8a931a7790d0caf" > set_result< / a > (< span class = "keywordtype" > bool< / span > incremental = < span class = "keyword" > false< / span > );< / div >
2017-06-21 21:54:28 +08:00
< div class = "line" > < a name = "l00169" > < / a > < span class = "lineno" > 169< / span >   < / div >
2017-07-18 17:43:35 +08:00
< div class = "line" > < a name = "l00170" > < / a > < span class = "lineno" > 170< / span >   };< / div >
2017-02-23 06:26:44 +08:00
< div class = "line" > < a name = "l00171" > < / a > < span class = "lineno" > 171< / span >   < / div >
2018-12-20 00:48:35 +08:00
< div class = "line" > < a name = "l00172" > < / a > < span class = "lineno" > 172< / span >   < span class = "comment" > /***********************************************************< / span > < / div >
< div class = "line" > < a name = "l00173" > < / a > < span class = "lineno" > 173< / span >   < span class = "comment" > * Abstract I/O objects< / span > < / div >
< div class = "line" > < a name = "l00174" > < / a > < span class = "lineno" > 174< / span >   < span class = "comment" > ***********************************************************/< / span > < / div >
2017-07-18 17:43:35 +08:00
< div class = "line" > < a name = "l00175" > < / a > < span class = "lineno" > 175< / span >   < / div >
< div class = "line" > < a name = "l00176" > < / a > < span class = "lineno" > 176< / span >   < / div >
2018-12-20 00:48:35 +08:00
< div class = "line" > < a name = "l00177" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1IOReader.html" > 177< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1IOReader.html" > IOReader< / a > {< / div >
< div class = "line" > < a name = "l00178" > < / a > < span class = "lineno" > 178< / span >   < span class = "comment" > // name that can be used in error messages< / span > < / div >
< div class = "line" > < a name = "l00179" > < / a > < span class = "lineno" > 179< / span >   std::string name;< / div >
< div class = "line" > < a name = "l00180" > < / a > < span class = "lineno" > 180< / span >   < / div >
< div class = "line" > < a name = "l00181" > < / a > < span class = "lineno" > 181< / span >   < span class = "comment" > // fread< / span > < / div >
< div class = "line" > < a name = "l00182" > < / a > < span class = "lineno" > 182< / span >   < span class = "keyword" > virtual< / span > < span class = "keywordtype" > size_t< / span > operator()(< / div >
< div class = "line" > < a name = "l00183" > < / a > < span class = "lineno" > 183< / span >   < span class = "keywordtype" > void< / span > *ptr, < span class = "keywordtype" > size_t< / span > size, < span class = "keywordtype" > size_t< / span > nitems) = 0;< / div >
< div class = "line" > < a name = "l00184" > < / a > < span class = "lineno" > 184< / span >   < / div >
< div class = "line" > < a name = "l00185" > < / a > < span class = "lineno" > 185< / span >   < span class = "comment" > // return a file number that can be memory-mapped< / span > < / div >
< div class = "line" > < a name = "l00186" > < / a > < span class = "lineno" > 186< / span >   < span class = "keyword" > virtual< / span > < span class = "keywordtype" > int< / span > fileno ();< / div >
< div class = "line" > < a name = "l00187" > < / a > < span class = "lineno" > 187< / span >   < / div >
< div class = "line" > < a name = "l00188" > < / a > < span class = "lineno" > 188< / span >   < span class = "keyword" > virtual< / span > ~< a class = "code" href = "structfaiss_1_1IOReader.html" > IOReader< / a > () {}< / div >
< div class = "line" > < a name = "l00189" > < / a > < span class = "lineno" > 189< / span >   };< / div >
< div class = "line" > < a name = "l00190" > < / a > < span class = "lineno" > 190< / span >   < / div >
< div class = "line" > < a name = "l00191" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1IOWriter.html" > 191< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1IOWriter.html" > IOWriter< / a > {< / div >
< div class = "line" > < a name = "l00192" > < / a > < span class = "lineno" > 192< / span >   < span class = "comment" > // name that can be used in error messages< / span > < / div >
< div class = "line" > < a name = "l00193" > < / a > < span class = "lineno" > 193< / span >   std::string name;< / div >
< div class = "line" > < a name = "l00194" > < / a > < span class = "lineno" > 194< / span >   < / div >
< div class = "line" > < a name = "l00195" > < / a > < span class = "lineno" > 195< / span >   < span class = "comment" > // fwrite< / span > < / div >
< div class = "line" > < a name = "l00196" > < / a > < span class = "lineno" > 196< / span >   < span class = "keyword" > virtual< / span > < span class = "keywordtype" > size_t< / span > operator()(< / div >
< div class = "line" > < a name = "l00197" > < / a > < span class = "lineno" > 197< / span >   < span class = "keyword" > const< / span > < span class = "keywordtype" > void< / span > *ptr, < span class = "keywordtype" > size_t< / span > size, < span class = "keywordtype" > size_t< / span > nitems) = 0;< / div >
< div class = "line" > < a name = "l00198" > < / a > < span class = "lineno" > 198< / span >   < / div >
< div class = "line" > < a name = "l00199" > < / a > < span class = "lineno" > 199< / span >   < span class = "comment" > // return a file number that can be memory-mapped< / span > < / div >
< div class = "line" > < a name = "l00200" > < / a > < span class = "lineno" > 200< / span >   < span class = "keyword" > virtual< / span > < span class = "keywordtype" > int< / span > fileno ();< / div >
< div class = "line" > < a name = "l00201" > < / a > < span class = "lineno" > 201< / span >   < / div >
< div class = "line" > < a name = "l00202" > < / a > < span class = "lineno" > 202< / span >   < span class = "keyword" > virtual< / span > ~< a class = "code" href = "structfaiss_1_1IOWriter.html" > IOWriter< / a > () {}< / div >
< div class = "line" > < a name = "l00203" > < / a > < span class = "lineno" > 203< / span >   };< / div >
< div class = "line" > < a name = "l00204" > < / a > < span class = "lineno" > 204< / span >   < / div >
< div class = "line" > < a name = "l00205" > < / a > < span class = "lineno" > 205< / span >   < / div >
< div class = "line" > < a name = "l00206" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1VectorIOReader.html" > 206< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1VectorIOReader.html" > VectorIOReader< / a > :< a class = "code" href = "structfaiss_1_1IOReader.html" > IOReader< / a > {< / div >
< div class = "line" > < a name = "l00207" > < / a > < span class = "lineno" > 207< / span >   std::vector< uint8_t> data;< / div >
< div class = "line" > < a name = "l00208" > < / a > < span class = "lineno" > 208< / span >   < span class = "keywordtype" > size_t< / span > rp = 0;< / div >
< div class = "line" > < a name = "l00209" > < / a > < span class = "lineno" > 209< / span >   < span class = "keywordtype" > size_t< / span > operator()(< span class = "keywordtype" > void< / span > *ptr, < span class = "keywordtype" > size_t< / span > size, < span class = "keywordtype" > size_t< / span > nitems) < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00210" > < / a > < span class = "lineno" > 210< / span >   };< / div >
< div class = "line" > < a name = "l00211" > < / a > < span class = "lineno" > 211< / span >   < / div >
< div class = "line" > < a name = "l00212" > < / a > < span class = "lineno" > < a class = "line" href = "structfaiss_1_1VectorIOWriter.html" > 212< / a > < / span >   < span class = "keyword" > struct < / span > < a class = "code" href = "structfaiss_1_1VectorIOWriter.html" > VectorIOWriter< / a > :< a class = "code" href = "structfaiss_1_1IOWriter.html" > IOWriter< / a > {< / div >
< div class = "line" > < a name = "l00213" > < / a > < span class = "lineno" > 213< / span >   std::vector< uint8_t> data;< / div >
< div class = "line" > < a name = "l00214" > < / a > < span class = "lineno" > 214< / span >   < span class = "keywordtype" > size_t< / span > operator()(< span class = "keyword" > const< / span > < span class = "keywordtype" > void< / span > *ptr, < span class = "keywordtype" > size_t< / span > size, < span class = "keywordtype" > size_t< / span > nitems) < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00215" > < / a > < span class = "lineno" > 215< / span >   };< / div >
< div class = "line" > < a name = "l00216" > < / a > < span class = "lineno" > 216< / span >   < / div >
< div class = "line" > < a name = "l00217" > < / a > < span class = "lineno" > 217< / span >   < / div >
< div class = "line" > < a name = "l00218" > < / a > < span class = "lineno" > 218< / span >   < / div >
< div class = "line" > < a name = "l00219" > < / a > < span class = "lineno" > 219< / span >   }; < span class = "comment" > // namespace faiss< / span > < / div >
< div class = "line" > < a name = "l00220" > < / a > < span class = "lineno" > 220< / span >   < / div >
< div class = "line" > < a name = "l00221" > < / a > < span class = "lineno" > 221< / span >   < / div >
< div class = "line" > < a name = "l00222" > < / a > < span class = "lineno" > 222< / span >   < / div >
< div class = "line" > < a name = "l00223" > < / a > < span class = "lineno" > 223< / span >   < span class = "preprocessor" > #endif< / span > < / div >
< div class = "ttc" id = "structfaiss_1_1IDSelectorBatch_html" > < div class = "ttname" > < a href = "structfaiss_1_1IDSelectorBatch.html" > faiss::IDSelectorBatch< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00078" > AuxIndexStructures.h:78< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchResult_html_a29269b98c33af874d379ca4f62408b90" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchResult.html#a29269b98c33af874d379ca4f62408b90" > faiss::RangeSearchResult::nq< / a > < / div > < div class = "ttdeci" > size_t nq< / div > < div class = "ttdoc" > nb of queries < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00032" > AuxIndexStructures.h:32< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchPartialResult_1_1QueryResult_html" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchPartialResult_1_1QueryResult.html" > faiss::RangeSearchPartialResult::QueryResult< / a > < / div > < div class = "ttdoc" > result structure for a single query < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00147" > AuxIndexStructures.h:147< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1BufferList_html_a78b70417a9ba5b27553b3134f1190958" > < div class = "ttname" > < a href = "structfaiss_1_1BufferList.html#a78b70417a9ba5b27553b3134f1190958" > faiss::BufferList::copy_range< / a > < / div > < div class = "ttdeci" > void copy_range(size_t ofs, size_t n, idx_t *dest_ids, float *dest_dis)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8cpp_source.html#l00086" > AuxIndexStructures.cpp:86< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IDSelector_html" > < div class = "ttname" > < a href = "structfaiss_1_1IDSelector.html" > faiss::IDSelector< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00054" > AuxIndexStructures.h:54< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchPartialResult_html_aa6639358995ac081f8a931a7790d0caf" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchPartialResult.html#aa6639358995ac081f8a931a7790d0caf" > faiss::RangeSearchPartialResult::set_result< / a > < / div > < div class = "ttdeci" > void set_result(bool incremental=false)< / div > < div class = "ttdoc" > called by range_search after do_allocation < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8cpp_source.html#l00149" > AuxIndexStructures.cpp:149< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchPartialResult_html_ab6a385008493c7b630e4e7bc56e3da74" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchPartialResult.html#ab6a385008493c7b630e4e7bc56e3da74" > faiss::RangeSearchPartialResult::set_lims< / a > < / div > < div class = "ttdeci" > void set_lims()< / div > < div class = "ttdoc" > called by range_search before do_allocation < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8cpp_source.html#l00140" > AuxIndexStructures.cpp:140< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1VectorIOReader_html" > < div class = "ttname" > < a href = "structfaiss_1_1VectorIOReader.html" > faiss::VectorIOReader< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00206" > AuxIndexStructures.h:206< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchResult_html_a56dca2b151bcf16f5d488aff321b9501" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchResult.html#a56dca2b151bcf16f5d488aff321b9501" > faiss::RangeSearchResult::RangeSearchResult< / a > < / div > < div class = "ttdeci" > RangeSearchResult(idx_t nq, bool alloc_lims=true)< / div > < div class = "ttdoc" > lims must be allocated on input to range_search. < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8cpp_source.html#l00024" > AuxIndexStructures.cpp:24< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1BufferList_html_af4d7ddcd77f328a12a7da89d8febe5d9" > < div class = "ttname" > < a href = "structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9" > faiss::BufferList::wp< / a > < / div > < div class = "ttdeci" > size_t wp< / div > < div class = "ttdoc" > write pointer in the last buffer. < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00111" > AuxIndexStructures.h:111< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1VectorIOWriter_html" > < div class = "ttname" > < a href = "structfaiss_1_1VectorIOWriter.html" > faiss::VectorIOWriter< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00212" > AuxIndexStructures.h:212< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchResult_html_a944a93aecc7b51d8f9f35444280aa919" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchResult.html#a944a93aecc7b51d8f9f35444280aa919" > faiss::RangeSearchResult::distances< / a > < / div > < div class = "ttdeci" > float * distances< / div > < div class = "ttdoc" > corresponding distances (not sorted) < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00038" > AuxIndexStructures.h:38< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1Index_html_a040c6aed1f224f3ea7bf58eebc0c31a4" > < div class = "ttname" > < a href = "structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4" > faiss::Index::idx_t< / a > < / div > < div class = "ttdeci" > long idx_t< / div > < div class = "ttdoc" > all indices are this type < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "Index_8h_source.html#l00064" > Index.h:64< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IDSelectorRange_html" > < div class = "ttname" > < a href = "structfaiss_1_1IDSelectorRange.html" > faiss::IDSelectorRange< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00063" > AuxIndexStructures.h:63< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IOReader_html" > < div class = "ttname" > < a href = "structfaiss_1_1IOReader.html" > faiss::IOReader< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00177" > AuxIndexStructures.h:177< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchPartialResult_html_a954c26beebb561a6c2b0f399c48a9db3" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchPartialResult.html#a954c26beebb561a6c2b0f399c48a9db3" > faiss::RangeSearchPartialResult::new_result< / a > < / div > < div class = "ttdeci" > QueryResult & new_result(idx_t qno)< / div > < div class = "ttdoc" > begin a new result < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8cpp_source.html#l00118" > AuxIndexStructures.cpp:118< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchResult_html_a34c4ba599c0cec45972af19e1f98f22a" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchResult.html#a34c4ba599c0cec45972af19e1f98f22a" > faiss::RangeSearchResult::do_allocation< / a > < / div > < div class = "ttdeci" > virtual void do_allocation()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8cpp_source.html#l00038" > AuxIndexStructures.cpp:38< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchPartialResult_html" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchPartialResult.html" > faiss::RangeSearchPartialResult< / a > < / div > < div class = "ttdoc" > the entries in the buffers are split per query < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00141" > AuxIndexStructures.h:141< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchResult_html" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchResult.html" > faiss::RangeSearchResult< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00031" > AuxIndexStructures.h:31< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1BufferList_1_1Buffer_html" > < div class = "ttname" > < a href = "structfaiss_1_1BufferList_1_1Buffer.html" > faiss::BufferList::Buffer< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00105" > AuxIndexStructures.h:105< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1IOWriter_html" > < div class = "ttname" > < a href = "structfaiss_1_1IOWriter.html" > faiss::IOWriter< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00191" > AuxIndexStructures.h:191< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchResult_html_a39342ad2e9ad8b90f6e95dafd3287f49" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchResult.html#a39342ad2e9ad8b90f6e95dafd3287f49" > faiss::RangeSearchResult::buffer_size< / a > < / div > < div class = "ttdeci" > size_t buffer_size< / div > < div class = "ttdoc" > size of the result buffers used < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00040" > AuxIndexStructures.h:40< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchResult_html_aef57f9db99ca470c01bcdce0366cb6ff" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchResult.html#aef57f9db99ca470c01bcdce0366cb6ff" > faiss::RangeSearchResult::lims< / a > < / div > < div class = "ttdeci" > size_t * lims< / div > < div class = "ttdoc" > size (nq + 1) < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00033" > AuxIndexStructures.h:33< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1BufferList_html" > < div class = "ttname" > < a href = "structfaiss_1_1BufferList.html" > faiss::BufferList< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00099" > AuxIndexStructures.h:99< / a > < / div > < / div >
< div class = "ttc" id = "structfaiss_1_1RangeSearchResult_html_aa8ff848474a4cc16c5464cc4ec187824" > < div class = "ttname" > < a href = "structfaiss_1_1RangeSearchResult.html#aa8ff848474a4cc16c5464cc4ec187824" > faiss::RangeSearchResult::labels< / a > < / div > < div class = "ttdeci" > idx_t * labels< / div > < div class = "ttdoc" > result for query i is labels[lims[i]:lims[i+1]] < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "AuxIndexStructures_8h_source.html#l00037" > AuxIndexStructures.h:37< / a > < / div > < / div >
2017-02-23 06:26:44 +08: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 >
