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" / >
< title > Faiss: faiss::BufferList 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_1BufferList.html" > BufferList< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Classes< / a > |
< a href = "#pub-types" > Public Types< / a > |
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pub-attribs" > Public Attributes< / a > |
< a href = "structfaiss_1_1BufferList-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > faiss::BufferList Struct Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < < a class = "el" href = "AuxIndexStructures_8h_source.html" > AuxIndexStructures.h< / a > > < / code > < / p >
< div class = "dynheader" >
Inheritance diagram for faiss::BufferList:< / div >
< div class = "dyncontent" >
< div class = "center" >
< img src = "structfaiss_1_1BufferList.png" usemap = "#faiss::BufferList_map" alt = "" / >
< map id = "faiss::BufferList_map" name = "faiss::BufferList_map" >
< area href = "structfaiss_1_1RangeSearchPartialResult.html" title = "the entries in the buffers are split per query " alt = "faiss::RangeSearchPartialResult" shape = "rect" coords = "0,56,191,80" / >
< / map >
< / div > < / div >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
Classes< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1BufferList_1_1Buffer.html" > Buffer< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < 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:a34f881c3691b14b7ed936374f4665d93" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a34f881c3691b14b7ed936374f4665d93" > < / a >
2019-05-28 22:17:22 +08:00
typedef < a class = "el" href = "structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea" > Index::idx_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < b > idx_t< / b > < / td > < / tr >
2017-02-23 06:26:44 +08:00
< tr class = "separator:a34f881c3691b14b7ed936374f4665d93" > < 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:a84f9e430297d10b693a7d0abbec20b9d" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a84f9e430297d10b693a7d0abbec20b9d" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > BufferList< / b > (size_t buffer_size)< / td > < / tr >
< tr class = "separator:a84f9e430297d10b693a7d0abbec20b9d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa124ff3a7e6a98960e12a8b32bdaec42" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aa124ff3a7e6a98960e12a8b32bdaec42" > < / a >
2019-05-28 22:17:22 +08:00
void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1BufferList.html#aa124ff3a7e6a98960e12a8b32bdaec42" > append_buffer< / a > ()< / td > < / tr >
< tr class = "memdesc:aa124ff3a7e6a98960e12a8b32bdaec42" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > create a new buffer < br / > < / td > < / tr >
2017-02-23 06:26:44 +08:00
< tr class = "separator:aa124ff3a7e6a98960e12a8b32bdaec42" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa17f17a53b45bb39b0724d6493ab33c9" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aa17f17a53b45bb39b0724d6493ab33c9" > < / a >
2019-05-28 22:17:22 +08:00
void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1BufferList.html#aa17f17a53b45bb39b0724d6493ab33c9" > add< / a > (idx_t id, float dis)< / td > < / tr >
< tr class = "memdesc:aa17f17a53b45bb39b0724d6493ab33c9" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > add one result, possibly appending a new buffer if needed < br / > < / td > < / tr >
2017-02-23 06:26:44 +08:00
< tr class = "separator:aa17f17a53b45bb39b0724d6493ab33c9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a78b70417a9ba5b27553b3134f1190958" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1BufferList.html#a78b70417a9ba5b27553b3134f1190958" > copy_range< / a > (size_t ofs, size_t n, idx_t *dest_ids, float *dest_dis)< / td > < / tr >
< tr class = "separator:a78b70417a9ba5b27553b3134f1190958" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-attribs" > < / a >
Public Attributes< / h2 > < / td > < / tr >
< tr class = "memitem:a5eb5086d4b0f3904a6e4ad7a3b93d96a" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a5eb5086d4b0f3904a6e4ad7a3b93d96a" > < / a >
size_t  < / td > < td class = "memItemRight" valign = "bottom" > < b > buffer_size< / b > < / td > < / tr >
< tr class = "separator:a5eb5086d4b0f3904a6e4ad7a3b93d96a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:abf92e38d902aabae3c6267e36e55f932" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "abf92e38d902aabae3c6267e36e55f932" > < / a >
std::vector< < a class = "el" href = "structfaiss_1_1BufferList_1_1Buffer.html" > Buffer< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < b > buffers< / b > < / td > < / tr >
< tr class = "separator:abf92e38d902aabae3c6267e36e55f932" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af4d7ddcd77f328a12a7da89d8febe5d9" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "af4d7ddcd77f328a12a7da89d8febe5d9" > < / a >
size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1BufferList.html#af4d7ddcd77f328a12a7da89d8febe5d9" > wp< / a > < / td > < / tr >
< tr class = "memdesc:af4d7ddcd77f328a12a7da89d8febe5d9" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > write pointer in the last buffer. < br / > < / td > < / tr >
< tr class = "separator:af4d7ddcd77f328a12a7da89d8febe5d9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > List of temporary buffers used to store results before they are copied to the < a class = "el" href = "structfaiss_1_1RangeSearchResult.html" > RangeSearchResult< / a > object. < / p >
2019-05-28 22:17:22 +08:00
< p > Definition at line < a class = "el" href = "AuxIndexStructures_8h_source.html#l00104" > 104< / a > of file < a class = "el" href = "AuxIndexStructures_8h_source.html" > AuxIndexStructures.h< / a > .< / p >
2017-02-23 06:26:44 +08:00
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
< a class = "anchor" id = "a78b70417a9ba5b27553b3134f1190958" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void faiss::BufferList::copy_range < / td >
< td > (< / td >
< td class = "paramtype" > size_t  < / td >
< td class = "paramname" > < em > ofs< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / 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" > idx_t *  < / td >
< td class = "paramname" > < em > dest_ids< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > float *  < / td >
< td class = "paramname" > < em > dest_dis< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > copy elemnts ofs:ofs+n-1 seen as linear data in the buffers to tables dest_ids, dest_dis < / p >
2019-05-28 22:17:22 +08:00
< p > Definition at line < a class = "el" href = "AuxIndexStructures_8cpp_source.html#l00099" > 99< / a > of file < a class = "el" href = "AuxIndexStructures_8cpp_source.html" > AuxIndexStructures.cpp< / a > .< / p >
2017-02-23 06:26:44 +08:00
< / div >
< / div >
< hr / > The documentation for this struct was generated from the following files:< ul >
2019-05-28 22:17:22 +08:00
< li > /data/users/hoss/faiss/< a class = "el" href = "AuxIndexStructures_8h_source.html" > AuxIndexStructures.h< / a > < / li >
< li > /data/users/hoss/faiss/< a class = "el" href = "AuxIndexStructures_8cpp_source.html" > AuxIndexStructures.cpp< / a > < / li >
2017-02-23 06:26:44 +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 >
