2017-06-21 21:54:28 +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::ScalarQuantizer 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_1ScalarQuantizer.html" > ScalarQuantizer< / 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 = "#pub-attribs" > Public Attributes< / a > |
< a href = "structfaiss_1_1ScalarQuantizer-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > faiss::ScalarQuantizer Struct Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < < a class = "el" href = "IndexIVFScalarQuantizer_8h_source.html" > IndexIVFScalarQuantizer.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 >
2017-07-18 17:43:35 +08:00
< tr class = "memitem:a1201dbd1611fa5c10782ade5d0e4952e" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e" > QuantizerType< / a > { < br / >
    < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2" > QT_8bit< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b" > QT_4bit< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754" > QT_8bit_uniform< / a > ,
< b > QT_4bit_uniform< / b > ,
< br / >
    < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2" > QT_8bit< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b" > QT_4bit< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754" > QT_8bit_uniform< / a > ,
2017-06-21 21:54:28 +08:00
< b > QT_4bit_uniform< / b >
2017-07-18 17:43:35 +08:00
< br / >
2017-06-21 21:54:28 +08:00
}< / td > < / tr >
< tr class = "separator:a1201dbd1611fa5c10782ade5d0e4952e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-07-18 17:43:35 +08:00
< tr class = "memitem:a867ad0000e4ccfd40bbb1e01e7882d06" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06" > RangeStat< / a > { < br / >
    < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8" > RS_minmax< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c" > RS_meanstd< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7" > RS_quantiles< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7" > RS_optim< / a > ,
< br / >
    < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8" > RS_minmax< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c" > RS_meanstd< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7" > RS_quantiles< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7" > RS_optim< / a >
< br / >
}< / td > < / tr >
< tr class = "separator:a867ad0000e4ccfd40bbb1e01e7882d06" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1201dbd1611fa5c10782ade5d0e4952e" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e" > QuantizerType< / a > { < br / >
    < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2" > QT_8bit< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b" > QT_4bit< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754" > QT_8bit_uniform< / a > ,
< b > QT_4bit_uniform< / b > ,
< br / >
    < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2" > QT_8bit< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b" > QT_4bit< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754" > QT_8bit_uniform< / a > ,
< b > QT_4bit_uniform< / b >
< br / >
}< / td > < / tr >
< tr class = "separator:a1201dbd1611fa5c10782ade5d0e4952e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a867ad0000e4ccfd40bbb1e01e7882d06" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06" > RangeStat< / a > { < br / >
    < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8" > RS_minmax< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c" > RS_meanstd< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7" > RS_quantiles< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7" > RS_optim< / a > ,
< br / >
    < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8" > RS_minmax< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c" > RS_meanstd< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7" > RS_quantiles< / a > ,
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7" > RS_optim< / a >
< br / >
2017-06-21 21:54:28 +08:00
}< / td > < / tr >
< tr class = "separator:a867ad0000e4ccfd40bbb1e01e7882d06" > < 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:aa49b6ffd5a6b8a0029bc85ed5fa9504c" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aa49b6ffd5a6b8a0029bc85ed5fa9504c" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > ScalarQuantizer< / b > (size_t < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#acd88af01ad1d06560cecc30bc38aef49" > d< / a > , < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e" > QuantizerType< / a > qtype)< / td > < / tr >
< tr class = "separator:aa49b6ffd5a6b8a0029bc85ed5fa9504c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af1f21830fd85d5119cc36ee13fd1a92b" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "af1f21830fd85d5119cc36ee13fd1a92b" > < / a >
void  < / td > < td class = "memItemRight" valign = "bottom" > < b > train< / b > (size_t n, const float *x)< / td > < / tr >
< tr class = "separator:af1f21830fd85d5119cc36ee13fd1a92b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a2bccf276565c4f80fed3d0c715c58816" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a2bccf276565c4f80fed3d0c715c58816" > < / a >
void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a2bccf276565c4f80fed3d0c715c58816" > compute_codes< / a > (const float *x, uint8_t *codes, size_t n) const < / td > < / tr >
< tr class = "memdesc:a2bccf276565c4f80fed3d0c715c58816" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > same as compute_code for several vectors < br / > < / td > < / tr >
< tr class = "separator:a2bccf276565c4f80fed3d0c715c58816" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7ab9e9158da1777d45e6f9bf73bfd489" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a7ab9e9158da1777d45e6f9bf73bfd489" > < / a >
void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a7ab9e9158da1777d45e6f9bf73bfd489" > decode< / a > (const uint8_t *code, float *x, size_t n) const < / td > < / tr >
< tr class = "memdesc:a7ab9e9158da1777d45e6f9bf73bfd489" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > decode a vector from a given code (or n vectors if third argument) < br / > < / td > < / tr >
< tr class = "separator:a7ab9e9158da1777d45e6f9bf73bfd489" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-07-18 17:43:35 +08:00
< tr class = "memitem:aa49b6ffd5a6b8a0029bc85ed5fa9504c" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aa49b6ffd5a6b8a0029bc85ed5fa9504c" > < / a >
  < / td > < td class = "memItemRight" valign = "bottom" > < b > ScalarQuantizer< / b > (size_t < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#acd88af01ad1d06560cecc30bc38aef49" > d< / a > , < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e" > QuantizerType< / a > qtype)< / td > < / tr >
< tr class = "separator:aa49b6ffd5a6b8a0029bc85ed5fa9504c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af1f21830fd85d5119cc36ee13fd1a92b" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "af1f21830fd85d5119cc36ee13fd1a92b" > < / a >
void  < / td > < td class = "memItemRight" valign = "bottom" > < b > train< / b > (size_t n, const float *x)< / td > < / tr >
< tr class = "separator:af1f21830fd85d5119cc36ee13fd1a92b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a2bccf276565c4f80fed3d0c715c58816" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a2bccf276565c4f80fed3d0c715c58816" > < / a >
void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a2bccf276565c4f80fed3d0c715c58816" > compute_codes< / a > (const float *x, uint8_t *codes, size_t n) const < / td > < / tr >
< tr class = "memdesc:a2bccf276565c4f80fed3d0c715c58816" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > same as compute_code for several vectors < br / > < / td > < / tr >
< tr class = "separator:a2bccf276565c4f80fed3d0c715c58816" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7ab9e9158da1777d45e6f9bf73bfd489" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a7ab9e9158da1777d45e6f9bf73bfd489" > < / a >
void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a7ab9e9158da1777d45e6f9bf73bfd489" > decode< / a > (const uint8_t *code, float *x, size_t n) const < / td > < / tr >
< tr class = "memdesc:a7ab9e9158da1777d45e6f9bf73bfd489" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > decode a vector from a given code (or n vectors if third argument) < br / > < / td > < / tr >
< tr class = "separator:a7ab9e9158da1777d45e6f9bf73bfd489" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-06-21 21:54:28 +08:00
< / 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:a2696491a09e0ad3bbf48506592fb69de" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a2696491a09e0ad3bbf48506592fb69de" > < / a >
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e" > QuantizerType< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < b > qtype< / b > < / td > < / tr >
< tr class = "separator:a2696491a09e0ad3bbf48506592fb69de" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aea7d3bd87a6c82292aed03fcb7e5e265" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aea7d3bd87a6c82292aed03fcb7e5e265" > < / a >
< a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06" > RangeStat< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < b > rangestat< / b > < / td > < / tr >
< tr class = "separator:aea7d3bd87a6c82292aed03fcb7e5e265" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aacac5a2655b0dbf5d828dde8ab236b48" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aacac5a2655b0dbf5d828dde8ab236b48" > < / a >
float  < / td > < td class = "memItemRight" valign = "bottom" > < b > rangestat_arg< / b > < / td > < / tr >
< tr class = "separator:aacac5a2655b0dbf5d828dde8ab236b48" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:acd88af01ad1d06560cecc30bc38aef49" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "acd88af01ad1d06560cecc30bc38aef49" > < / a >
size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#acd88af01ad1d06560cecc30bc38aef49" > d< / a > < / td > < / tr >
< tr class = "memdesc:acd88af01ad1d06560cecc30bc38aef49" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > dimension of input vectors < br / > < / td > < / tr >
< tr class = "separator:acd88af01ad1d06560cecc30bc38aef49" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a647b8774e4cd8ca5623a194f5c7f8a33" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a647b8774e4cd8ca5623a194f5c7f8a33" > < / a >
size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a647b8774e4cd8ca5623a194f5c7f8a33" > code_size< / a > < / td > < / tr >
< tr class = "memdesc:a647b8774e4cd8ca5623a194f5c7f8a33" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > bytes per vector < br / > < / td > < / tr >
< tr class = "separator:a647b8774e4cd8ca5623a194f5c7f8a33" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-07-18 17:43:35 +08:00
< tr class = "memitem:a64d1560806e6746d6cd1fee089c6a13f" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a64d1560806e6746d6cd1fee089c6a13f" > < / a >
std::vector< float >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a64d1560806e6746d6cd1fee089c6a13f" > trained< / a > < / td > < / tr >
< tr class = "memdesc:a64d1560806e6746d6cd1fee089c6a13f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > trained values (including the range) < br / > < / td > < / tr >
< tr class = "separator:a64d1560806e6746d6cd1fee089c6a13f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-06-21 21:54:28 +08:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > An IVF implementation where the components of the residuals are encoded with a scalar uniform quantizer. All distance computations are asymmetric, so the encoded vectors are decoded and approximate distances are computed.< / p >
2017-07-18 17:43:35 +08:00
< p > The uniform quantizer has a range [vmin, vmax]. The range can be the same for all dimensions (uniform) or specific per dimension (default).< / p >
2017-06-21 21:54:28 +08:00
< p > The uniform quantizer has a range [vmin, vmax]. The range can be the same for all dimensions (uniform) or specific per dimension (default). < / p >
< p > Definition at line < a class = "el" href = "IndexIVFScalarQuantizer_8h_source.html#l00034" > 34< / a > of file < a class = "el" href = "IndexIVFScalarQuantizer_8h_source.html" > IndexIVFScalarQuantizer.h< / a > .< / p >
< / div > < h2 class = "groupheader" > Member Enumeration Documentation< / h2 >
< a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952e" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e" > faiss::ScalarQuantizer::QuantizerType< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< table class = "fieldtable" >
2017-07-18 17:43:35 +08:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2" > < / a > QT_8bit< / em > < / td > < td class = "fielddoc" >
< p > 8 bits per component < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b" > < / a > QT_4bit< / em > < / td > < td class = "fielddoc" >
< p > 4 bits per component < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754" > < / a > QT_8bit_uniform< / em > < / td > < td class = "fielddoc" >
< p > same, shared range for all dimensions < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2" > < / a > QT_8bit< / em > < / td > < td class = "fielddoc" >
< p > 8 bits per component < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b" > < / a > QT_4bit< / em > < / td > < td class = "fielddoc" >
< p > 4 bits per component < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754" > < / a > QT_8bit_uniform< / em > < / td > < td class = "fielddoc" >
< p > same, shared range for all dimensions < / p >
< / td > < / tr >
< / table >
< p > Definition at line < a class = "el" href = "IndexScalarQuantizer_8h_source.html#l00032" > 32< / a > of file < a class = "el" href = "IndexScalarQuantizer_8h_source.html" > IndexScalarQuantizer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952e" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a1201dbd1611fa5c10782ade5d0e4952e" > faiss::ScalarQuantizer::QuantizerType< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< table class = "fieldtable" >
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2" > < / a > QT_8bit< / em > < / td > < td class = "fielddoc" >
2017-06-21 21:54:28 +08:00
< p > 8 bits per component < / p >
< / td > < / tr >
2017-07-18 17:43:35 +08:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b" > < / a > QT_4bit< / em > < / td > < td class = "fielddoc" >
2017-06-21 21:54:28 +08:00
< p > 4 bits per component < / p >
< / td > < / tr >
2017-07-18 17:43:35 +08:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754" > < / a > QT_8bit_uniform< / em > < / td > < td class = "fielddoc" >
< p > same, shared range for all dimensions < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952eae2f5d4b1376630eb0ea76600c95bd9a2" > < / a > QT_8bit< / em > < / td > < td class = "fielddoc" >
< p > 8 bits per component < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952ea7cdbb1cb1c21f8f5866f28aa564b4c0b" > < / a > QT_4bit< / em > < / td > < td class = "fielddoc" >
< p > 4 bits per component < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a1201dbd1611fa5c10782ade5d0e4952eae121980fe6d146604e3086889ebc5754" > < / a > QT_8bit_uniform< / em > < / td > < td class = "fielddoc" >
2017-06-21 21:54:28 +08:00
< p > same, shared range for all dimensions < / p >
< / td > < / tr >
< / table >
< p > Definition at line < a class = "el" href = "IndexIVFScalarQuantizer_8h_source.html#l00036" > 36< / a > of file < a class = "el" href = "IndexIVFScalarQuantizer_8h_source.html" > IndexIVFScalarQuantizer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06" > faiss::ScalarQuantizer::RangeStat< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > The uniform encoder can estimate the range of representable values of the unform encoder using different statistics. Here rs = rangestat_arg < / p >
< table class = "fieldtable" >
2017-07-18 17:43:35 +08:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8" > < / a > RS_minmax< / em > < / td > < td class = "fielddoc" >
< p > [min - rs*(max-min), max + rs*(max-min)] < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c" > < / a > RS_meanstd< / em > < / td > < td class = "fielddoc" >
< p > [mean - std * rs, mean + std * rs] < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7" > < / a > RS_quantiles< / em > < / td > < td class = "fielddoc" >
< p > [Q(rs), Q(1-rs)] < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7" > < / a > RS_optim< / em > < / td > < td class = "fielddoc" >
< p > alternate optimization of reconstruction error < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8" > < / a > RS_minmax< / em > < / td > < td class = "fielddoc" >
< p > [min - rs*(max-min), max + rs*(max-min)] < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c" > < / a > RS_meanstd< / em > < / td > < td class = "fielddoc" >
< p > [mean - std * rs, mean + std * rs] < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7" > < / a > RS_quantiles< / em > < / td > < td class = "fielddoc" >
< p > [Q(rs), Q(1-rs)] < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7" > < / a > RS_optim< / em > < / td > < td class = "fielddoc" >
< p > alternate optimization of reconstruction error < / p >
< / td > < / tr >
< / table >
< p > Definition at line < a class = "el" href = "IndexScalarQuantizer_8h_source.html#l00046" > 46< / a > of file < a class = "el" href = "IndexScalarQuantizer_8h_source.html" > IndexScalarQuantizer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum < a class = "el" href = "structfaiss_1_1ScalarQuantizer.html#a867ad0000e4ccfd40bbb1e01e7882d06" > faiss::ScalarQuantizer::RangeStat< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > The uniform encoder can estimate the range of representable values of the unform encoder using different statistics. Here rs = rangestat_arg < / p >
< table class = "fieldtable" >
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8" > < / a > RS_minmax< / em > < / td > < td class = "fielddoc" >
< p > [min - rs*(max-min), max + rs*(max-min)] < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c" > < / a > RS_meanstd< / em > < / td > < td class = "fielddoc" >
< p > [mean - std * rs, mean + std * rs] < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7" > < / a > RS_quantiles< / em > < / td > < td class = "fielddoc" >
< p > [Q(rs), Q(1-rs)] < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7" > < / a > RS_optim< / em > < / td > < td class = "fielddoc" >
< p > alternate optimization of reconstruction error < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06a4c0f67a6585c03b1e4039a23825d7df8" > < / a > RS_minmax< / em > < / td > < td class = "fielddoc" >
2017-06-21 21:54:28 +08:00
< p > [min - rs*(max-min), max + rs*(max-min)] < / p >
< / td > < / tr >
2017-07-18 17:43:35 +08:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06ad64366c7a0eea89fb52b177f251e687c" > < / a > RS_meanstd< / em > < / td > < td class = "fielddoc" >
2017-06-21 21:54:28 +08:00
< p > [mean - std * rs, mean + std * rs] < / p >
< / td > < / tr >
2017-07-18 17:43:35 +08:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06a895bd1d41b5b36a1537df9a515a416f7" > < / a > RS_quantiles< / em > < / td > < td class = "fielddoc" >
2017-06-21 21:54:28 +08:00
< p > [Q(rs), Q(1-rs)] < / p >
< / td > < / tr >
2017-07-18 17:43:35 +08:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "a867ad0000e4ccfd40bbb1e01e7882d06af1df5f45cf110c5c235c413ca31797a7" > < / a > RS_optim< / em > < / td > < td class = "fielddoc" >
2017-06-21 21:54:28 +08:00
< p > alternate optimization of reconstruction error < / p >
< / td > < / tr >
< / table >
< p > Definition at line < a class = "el" href = "IndexIVFScalarQuantizer_8h_source.html#l00050" > 50< / a > of file < a class = "el" href = "IndexIVFScalarQuantizer_8h_source.html" > IndexIVFScalarQuantizer.h< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this struct was generated from the following files:< ul >
< li > /data/users/matthijs/github_faiss/faiss/< a class = "el" href = "IndexIVFScalarQuantizer_8h_source.html" > IndexIVFScalarQuantizer.h< / a > < / li >
2017-07-18 17:43:35 +08:00
< li > /data/users/matthijs/github_faiss/faiss/< a class = "el" href = "IndexScalarQuantizer_8h_source.html" > IndexScalarQuantizer.h< / a > < / li >
2017-06-21 21:54:28 +08:00
< li > /data/users/matthijs/github_faiss/faiss/< a class = "el" href = "IndexIVFScalarQuantizer_8cpp_source.html" > IndexIVFScalarQuantizer.cpp< / a > < / li >
2017-07-18 17:43:35 +08:00
< li > /data/users/matthijs/github_faiss/faiss/< a class = "el" href = "IndexScalarQuantizer_8cpp_source.html" > IndexScalarQuantizer.cpp< / a > < / li >
2017-06-21 21:54:28 +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 >
