faiss/docs/html/structOptions.html

170 lines
12 KiB
HTML

<!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: Options 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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Options Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a066c3b0ad0555ec80e413d812c4df4a5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a066c3b0ad0555ec80e413d812c4df4a5"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>toString</b> () const </td></tr>
<tr class="separator:a066c3b0ad0555ec80e413d812c4df4a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a066c3b0ad0555ec80e413d812c4df4a5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a066c3b0ad0555ec80e413d812c4df4a5"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>toString</b> () const </td></tr>
<tr class="separator:a066c3b0ad0555ec80e413d812c4df4a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc5c3fdabe1a9f68db9602f6a429e2fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc5c3fdabe1a9f68db9602f6a429e2fe"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><b>getCompareEpsilon</b> () const </td></tr>
<tr class="separator:adc5c3fdabe1a9f68db9602f6a429e2fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e4769f8147b81478f953f93c7e11cff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e4769f8147b81478f953f93c7e11cff"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><b>getPctMaxDiff1</b> () const </td></tr>
<tr class="separator:a5e4769f8147b81478f953f93c7e11cff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac52667f688e4cfcb6e1d5428dd9cf068"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac52667f688e4cfcb6e1d5428dd9cf068"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><b>getPctMaxDiffN</b> () const </td></tr>
<tr class="separator:ac52667f688e4cfcb6e1d5428dd9cf068"><td class="memSeparator" colspan="2">&#160;</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:abc0e669d1136c33240949257499cdfbf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc0e669d1136c33240949257499cdfbf"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>numAdd</b></td></tr>
<tr class="separator:abc0e669d1136c33240949257499cdfbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d9631751ecc6113b36319ebdb0cd741"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d9631751ecc6113b36319ebdb0cd741"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>dim</b></td></tr>
<tr class="separator:a3d9631751ecc6113b36319ebdb0cd741"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bda49b1d68a76ef08a00a0a5c338d2d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3bda49b1d68a76ef08a00a0a5c338d2d"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>numCentroids</b></td></tr>
<tr class="separator:a3bda49b1d68a76ef08a00a0a5c338d2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c21e44dbf8b0821ad4cc64655f09478"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c21e44dbf8b0821ad4cc64655f09478"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>numTrain</b></td></tr>
<tr class="separator:a7c21e44dbf8b0821ad4cc64655f09478"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cbcda727e60281bfb6c221e6ba6d94d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cbcda727e60281bfb6c221e6ba6d94d"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>nprobe</b></td></tr>
<tr class="separator:a2cbcda727e60281bfb6c221e6ba6d94d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc9bfe8b22559f154140cc305b3444a2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc9bfe8b22559f154140cc305b3444a2"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>numQuery</b></td></tr>
<tr class="separator:acc9bfe8b22559f154140cc305b3444a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bfd580b90fd3bc71fc3fe4a0ce11bff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bfd580b90fd3bc71fc3fe4a0ce11bff"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>k</b></td></tr>
<tr class="separator:a0bfd580b90fd3bc71fc3fe4a0ce11bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97312cba0591f9ceab78e272cf6814e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97312cba0591f9ceab78e272cf6814e5"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>device</b></td></tr>
<tr class="separator:a97312cba0591f9ceab78e272cf6814e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a692a5b93c831b51dcb5d368109fd4806"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a692a5b93c831b51dcb5d368109fd4806"></a>
faiss::gpu::IndicesOptions&#160;</td><td class="memItemRight" valign="bottom"><b>indicesOpt</b></td></tr>
<tr class="separator:a692a5b93c831b51dcb5d368109fd4806"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c01d48b5466125091cff350fae87b65"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c01d48b5466125091cff350fae87b65"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>codes</b></td></tr>
<tr class="separator:a5c01d48b5466125091cff350fae87b65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61b62bdea5a502cd651cbc0aa1a12e8a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61b62bdea5a502cd651cbc0aa1a12e8a"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>bitsPerCode</b></td></tr>
<tr class="separator:a61b62bdea5a502cd651cbc0aa1a12e8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba405b7e5311f48c5c569bc43775398a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba405b7e5311f48c5c569bc43775398a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>usePrecomputed</b></td></tr>
<tr class="separator:aba405b7e5311f48c5c569bc43775398a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac46d8ed4f5fdf3382517a0953e50ea9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac46d8ed4f5fdf3382517a0953e50ea9b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>useFloat16</b></td></tr>
<tr class="separator:ac46d8ed4f5fdf3382517a0953e50ea9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="TestGpuIndexIVFFlat_8cpp_source.html#l00027">27</a> of file <a class="el" href="TestGpuIndexIVFFlat_8cpp_source.html">TestGpuIndexIVFFlat.cpp</a>.</p>
</div><hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/matthijs/github_faiss/faiss/gpu/test/<a class="el" href="TestGpuIndexIVFFlat_8cpp_source.html">TestGpuIndexIVFFlat.cpp</a></li>
<li>/data/users/matthijs/github_faiss/faiss/gpu/test/<a class="el" href="TestGpuIndexIVFPQ_8cpp_source.html">TestGpuIndexIVFPQ.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>