faiss/docs/html/structfaiss_1_1gpu_1_1GpuCl...

170 lines
11 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: faiss::gpu::GpuClonerOptions 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacefaiss.html">faiss</a></li><li class="navelem"><b>gpu</b></li><li class="navelem"><a class="el" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html">GpuClonerOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfaiss_1_1gpu_1_1GpuClonerOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::gpu::GpuClonerOptions Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>set some options on how to copy to GPU
<a href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="GpuAutoTune_8h_source.html">GpuAutoTune.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for faiss::gpu::GpuClonerOptions:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1gpu_1_1GpuClonerOptions.png" usemap="#faiss::gpu::GpuClonerOptions_map" alt=""/>
<map id="faiss::gpu::GpuClonerOptions_map" name="faiss::gpu::GpuClonerOptions_map">
<area href="structfaiss_1_1gpu_1_1GpuMultipleClonerOptions.html" alt="faiss::gpu::GpuMultipleClonerOptions" shape="rect" coords="0,56,219,80"/>
<area href="structfaiss_1_1gpu_1_1ToGpuCloner.html" alt="faiss::gpu::ToGpuCloner" shape="rect" coords="229,56,448,80"/>
<area href="structfaiss_1_1gpu_1_1ToGpuClonerMultiple.html" alt="faiss::gpu::ToGpuClonerMultiple" shape="rect" coords="0,112,219,136"/>
</map>
</div></div>
<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:ad960ac51b7cc607fcb1a1b07efc32a9e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad960ac51b7cc607fcb1a1b07efc32a9e"></a>
IndicesOptions&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ad960ac51b7cc607fcb1a1b07efc32a9e">indicesOptions</a></td></tr>
<tr class="memdesc:ad960ac51b7cc607fcb1a1b07efc32a9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">how should indices be stored on <a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html" title="IVFPQ index for the GPU. ">GpuIndexIVFPQ</a>? <br/></td></tr>
<tr class="separator:ad960ac51b7cc607fcb1a1b07efc32a9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85f3093908b6e9a503c24bb226b17b1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85f3093908b6e9a503c24bb226b17b1b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#a85f3093908b6e9a503c24bb226b17b1b">useFloat16CoarseQuantizer</a></td></tr>
<tr class="memdesc:a85f3093908b6e9a503c24bb226b17b1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">is the coarse quantizer in float16? <br/></td></tr>
<tr class="separator:a85f3093908b6e9a503c24bb226b17b1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7cc57d6091d6a79ea6020bf8d1fbe27"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ac7cc57d6091d6a79ea6020bf8d1fbe27">useFloat16</a></td></tr>
<tr class="separator:ac7cc57d6091d6a79ea6020bf8d1fbe27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc9c607f2dfc9f23942a523fb49c63fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc9c607f2dfc9f23942a523fb49c63fe"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#abc9c607f2dfc9f23942a523fb49c63fe">usePrecomputed</a></td></tr>
<tr class="memdesc:abc9c607f2dfc9f23942a523fb49c63fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">use precomputed tables? <br/></td></tr>
<tr class="separator:abc9c607f2dfc9f23942a523fb49c63fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab60dd87e51af59373a48d73852573f04"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab60dd87e51af59373a48d73852573f04"></a>
long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1GpuClonerOptions.html#ab60dd87e51af59373a48d73852573f04">reserveVecs</a></td></tr>
<tr class="memdesc:ab60dd87e51af59373a48d73852573f04"><td class="mdescLeft">&#160;</td><td class="mdescRight">reserve vectors in the invfiles? <br/></td></tr>
<tr class="separator:ab60dd87e51af59373a48d73852573f04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a543141eeff6eaeaf607a19c95a50eda6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a543141eeff6eaeaf607a19c95a50eda6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>verbose</b></td></tr>
<tr class="separator:a543141eeff6eaeaf607a19c95a50eda6"><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>set some options on how to copy to GPU </p>
<p>Definition at line <a class="el" href="GpuAutoTune_8h_source.html#l00031">31</a> of file <a class="el" href="GpuAutoTune_8h_source.html">GpuAutoTune.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ac7cc57d6091d6a79ea6020bf8d1fbe27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool faiss::gpu::GpuClonerOptions::useFloat16</td>
</tr>
</table>
</div><div class="memdoc">
<p>for <a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFFlat.html">GpuIndexIVFFlat</a>, is storage in float16? for <a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html" title="IVFPQ index for the GPU. ">GpuIndexIVFPQ</a>, are intermediate calculations in float16? </p>
<p>Definition at line <a class="el" href="GpuAutoTune_8h_source.html#l00038">38</a> of file <a class="el" href="GpuAutoTune_8h_source.html">GpuAutoTune.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="GpuAutoTune_8h_source.html">GpuAutoTune.h</a></li>
<li><a class="el" href="GpuAutoTune_8cpp_source.html">GpuAutoTune.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>