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::ivflib::SlidingIndexWindow 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" > < b > ivflib< / b > < / li > < li class = "navelem" > < a class = "el" href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow.html" > SlidingIndexWindow< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
< a href = "#pub-attribs" > Public Attributes< / a > |
< a href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > faiss::ivflib::SlidingIndexWindow Struct Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < < a class = "el" href = "IVFlib_8h_source.html" > IVFlib.h< / a > > < / code > < / p >
< 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:a6347809123313ca945defdc7ddcd1465" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a6347809123313ca945defdc7ddcd1465" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow.html#a6347809123313ca945defdc7ddcd1465" > SlidingIndexWindow< / a > (< a class = "el" href = "structfaiss_1_1Index.html" > Index< / a > *< a class = "el" href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow.html#a2aae96a9373173e22686951e85b31aa1" > index< / a > )< / td > < / tr >
< tr class = "memdesc:a6347809123313ca945defdc7ddcd1465" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > index should be initially empty and trained < br / > < / td > < / tr >
< tr class = "separator:a6347809123313ca945defdc7ddcd1465" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:accf1c7b8de188b74de0d6827beceac7c" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow.html#accf1c7b8de188b74de0d6827beceac7c" > step< / a > (const < a class = "el" href = "structfaiss_1_1Index.html" > Index< / a > *sub_index, bool remove_oldest)< / td > < / tr >
< tr class = "separator:accf1c7b8de188b74de0d6827beceac7c" > < 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:a2aae96a9373173e22686951e85b31aa1" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a2aae96a9373173e22686951e85b31aa1" > < / a >
< a class = "el" href = "structfaiss_1_1Index.html" > Index< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow.html#a2aae96a9373173e22686951e85b31aa1" > index< / a > < / td > < / tr >
< tr class = "memdesc:a2aae96a9373173e22686951e85b31aa1" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > common index that contains the sliding window < br / > < / td > < / tr >
< tr class = "separator:a2aae96a9373173e22686951e85b31aa1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a10d876a9c750bc95986a22a57cf4fdc7" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a10d876a9c750bc95986a22a57cf4fdc7" > < / a >
< a class = "el" href = "structfaiss_1_1ArrayInvertedLists.html" > ArrayInvertedLists< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow.html#a10d876a9c750bc95986a22a57cf4fdc7" > ils< / a > < / td > < / tr >
< tr class = "memdesc:a10d876a9c750bc95986a22a57cf4fdc7" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > < a class = "el" href = "structfaiss_1_1InvertedLists.html" > InvertedLists< / a > of index. < br / > < / td > < / tr >
< tr class = "separator:a10d876a9c750bc95986a22a57cf4fdc7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a8defa5121e371e64071c0eb956ad20d1" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a8defa5121e371e64071c0eb956ad20d1" > < / a >
int  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow.html#a8defa5121e371e64071c0eb956ad20d1" > n_slice< / a > < / td > < / tr >
< tr class = "memdesc:a8defa5121e371e64071c0eb956ad20d1" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > number of slices currently in index < br / > < / td > < / tr >
< tr class = "separator:a8defa5121e371e64071c0eb956ad20d1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ac124372fd2b67bb901f0c71235165216" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ac124372fd2b67bb901f0c71235165216" > < / a >
size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow.html#ac124372fd2b67bb901f0c71235165216" > nlist< / a > < / td > < / tr >
< tr class = "memdesc:ac124372fd2b67bb901f0c71235165216" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > same as index-> nlist < br / > < / td > < / tr >
< tr class = "separator:ac124372fd2b67bb901f0c71235165216" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a6dfc430601d194c428c2a25e3afa4492" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a6dfc430601d194c428c2a25e3afa4492" > < / a >
std::vector< std::vector< br class = "typebreak" / >
< size_t > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ivflib_1_1SlidingIndexWindow.html#a6dfc430601d194c428c2a25e3afa4492" > sizes< / a > < / td > < / tr >
< tr class = "memdesc:a6dfc430601d194c428c2a25e3afa4492" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > cumulative list sizes at each slice < br / > < / td > < / tr >
< tr class = "separator:a6dfc430601d194c428c2a25e3afa4492" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > A set of IndexIVFs concatenated together in a FIFO fashion. at each "step", the oldest index slice is removed and a new index is added. < / p >
2019-05-28 22:17:22 +08:00
< p > Definition at line < a class = "el" href = "IVFlib_8h_source.html#l00083" > 83< / a > of file < a class = "el" href = "IVFlib_8h_source.html" > IVFlib.h< / a > .< / p >
2018-12-20 00:48:35 +08:00
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
< a class = "anchor" id = "accf1c7b8de188b74de0d6827beceac7c" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void faiss::ivflib::SlidingIndexWindow::step < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "structfaiss_1_1Index.html" > Index< / a > *  < / td >
< td class = "paramname" > < em > sub_index< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > remove_oldest< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Add one index to the current index and remove the oldest one.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > sub_index< / td > < td > slice to swap in (can be NULL) < / td > < / tr >
< tr > < td class = "paramname" > remove_oldest< / td > < td > if true, remove the oldest slices < / td > < / tr >
< / table >
< / dd >
< / dl >
2019-05-28 22:17:22 +08:00
< p > Definition at line < a class = "el" href = "IVFlib_8cpp_source.html#l00190" > 190< / a > of file < a class = "el" href = "IVFlib_8cpp_source.html" > IVFlib.cpp< / a > .< / p >
2018-12-20 00:48:35 +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 = "IVFlib_8h_source.html" > IVFlib.h< / a > < / li >
< li > /data/users/hoss/faiss/< a class = "el" href = "IVFlib_8cpp_source.html" > IVFlib.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 >
