Skip to content

F
faiss
Switch branch/tag
Find file
BlameHistoryPermalink
structfaiss_1_1IndexBinaryFromFloat.html 29.2 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 
<!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::IndexBinaryFromFloat 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"><a class="el" href="structfaiss_1_1IndexBinaryFromFloat.html">IndexBinaryFromFloat</a></li>  </ul>
</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="structfaiss_1_1IndexBinaryFromFloat-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">faiss::IndexBinaryFromFloat Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="IndexBinaryFromFloat_8h_source.html">IndexBinaryFromFloat.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for faiss::IndexBinaryFromFloat:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structfaiss_1_1IndexBinaryFromFloat.png" usemap="#faiss::IndexBinaryFromFloat_map" alt=""/>
  <map id="faiss::IndexBinaryFromFloat_map" name="faiss::IndexBinaryFromFloat_map">
<area href="structfaiss_1_1IndexBinary.html" alt="faiss::IndexBinary" shape="rect" coords="0,0,168,24"/>
</map>
 </div></div>
<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:acec0f2bd11dc4b8f84a4c65c58c99dbc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acec0f2bd11dc4b8f84a4c65c58c99dbc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>IndexBinaryFromFloat</b> (<a class="el" href="structfaiss_1_1Index.html">Index</a> *index)</td></tr>
<tr class="separator:acec0f2bd11dc4b8f84a4c65c58c99dbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4f01196a335a9b2433e5c16396c1fd7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryFromFloat.html#ac4f01196a335a9b2433e5c16396c1fd7">add</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> n, const uint8_t *x) override</td></tr>
<tr class="separator:ac4f01196a335a9b2433e5c16396c1fd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a487be675843e3146ee15bef3ee004a85"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a487be675843e3146ee15bef3ee004a85"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryFromFloat.html#a487be675843e3146ee15bef3ee004a85">reset</a> () override</td></tr>
<tr class="memdesc:a487be675843e3146ee15bef3ee004a85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes all elements from the database. <br/></td></tr>
<tr class="separator:a487be675843e3146ee15bef3ee004a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af92913a782c65843fbf7a65e017d6f5f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryFromFloat.html#af92913a782c65843fbf7a65e017d6f5f">search</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> n, const uint8_t *x, <a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> k, int32_t *distances, <a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> *labels) const override</td></tr>
<tr class="separator:af92913a782c65843fbf7a65e017d6f5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7de4bb8e82f0dae621c87b44cfb64404"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryFromFloat.html#a7de4bb8e82f0dae621c87b44cfb64404">train</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> n, const uint8_t *x) override</td></tr>
<tr class="separator:a7de4bb8e82f0dae621c87b44cfb64404"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structfaiss_1_1IndexBinary"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1IndexBinary')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td></tr>
<tr class="memitem:a2a76f22851e42963b6a42c6d39e93b4b inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a76f22851e42963b6a42c6d39e93b4b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>IndexBinary</b> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> <a class="el" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a>=0, <a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric=METRIC_L2)</td></tr>
<tr class="separator:a2a76f22851e42963b6a42c6d39e93b4b inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68a24abdf241eb98372b7d6fbd8d3891 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a68a24abdf241eb98372b7d6fbd8d3891">add_with_ids</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> n, const uint8_t *x, const long *xids)</td></tr>
<tr class="separator:a68a24abdf241eb98372b7d6fbd8d3891 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adec414108d34c63e4a06b6d3f9a3fa35 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#adec414108d34c63e4a06b6d3f9a3fa35">range_search</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> n, const uint8_t *x, int radius, <a class="el" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> *result) const </td></tr>
<tr class="separator:adec414108d34c63e4a06b6d3f9a3fa35 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27c32414471c57138b248583fc0c5f8c inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a27c32414471c57138b248583fc0c5f8c">assign</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> n, const uint8_t *x, <a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> *labels, <a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> k=1)</td></tr>
<tr class="separator:a27c32414471c57138b248583fc0c5f8c inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2b85e2cad27acb06cb9d6d8e600ae02 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">virtual long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#ae2b85e2cad27acb06cb9d6d8e600ae02">remove_ids</a> (const <a class="el" href="structfaiss_1_1IDSelector.html">IDSelector</a> &amp;sel)</td></tr>
<tr class="separator:ae2b85e2cad27acb06cb9d6d8e600ae02 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60180e1c6b363c287b6e55191455a82f inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a60180e1c6b363c287b6e55191455a82f">reconstruct</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> key, uint8_t *recons) const </td></tr>
<tr class="separator:a60180e1c6b363c287b6e55191455a82f inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5885ba0cbd91cf6c5fe2f53bb5650c3 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#ab5885ba0cbd91cf6c5fe2f53bb5650c3">reconstruct_n</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> i0, <a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> ni, uint8_t *recons) const </td></tr>
<tr class="separator:ab5885ba0cbd91cf6c5fe2f53bb5650c3 inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae99e8745fc02ffac2cfdb431951eeabf inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#ae99e8745fc02ffac2cfdb431951eeabf">search_and_reconstruct</a> (<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> n, const uint8_t *x, <a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> k, int32_t *distances, <a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> *labels, uint8_t *recons) const </td></tr>
<tr class="separator:ae99e8745fc02ffac2cfdb431951eeabf inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d722545b95badd251f3e8770b9bb9b inherit pub_methods_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a63d722545b95badd251f3e8770b9bb9b">display</a> () const </td></tr>
<tr class="separator:a63d722545b95badd251f3e8770b9bb9b inherit pub_methods_structfaiss_1_1IndexBinary"><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:a1346bf356aabe668a22944ded824808f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1346bf356aabe668a22944ded824808f"></a>
<a class="el" href="structfaiss_1_1Index.html">Index</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>index</b> = nullptr</td></tr>
<tr class="separator:a1346bf356aabe668a22944ded824808f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7311fc4d11169f7bc668c16b027336ba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7311fc4d11169f7bc668c16b027336ba"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinaryFromFloat.html#a7311fc4d11169f7bc668c16b027336ba">own_fields</a> = false</td></tr>
<tr class="memdesc:a7311fc4d11169f7bc668c16b027336ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether object owns the index pointer. <br/></td></tr>
<tr class="separator:a7311fc4d11169f7bc668c16b027336ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structfaiss_1_1IndexBinary"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1IndexBinary')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td></tr>
<tr class="memitem:a0e485a7189eec2675032486d3b12cf88 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e485a7189eec2675032486d3b12cf88"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a></td></tr>
<tr class="memdesc:a0e485a7189eec2675032486d3b12cf88 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">vector dimension <br/></td></tr>
<tr class="separator:a0e485a7189eec2675032486d3b12cf88 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a277c2645b8def11c5d982384098c5380 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a277c2645b8def11c5d982384098c5380"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a277c2645b8def11c5d982384098c5380">code_size</a></td></tr>
<tr class="memdesc:a277c2645b8def11c5d982384098c5380 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">number of bytes per vector ( = d / 8 ) <br/></td></tr>
<tr class="separator:a277c2645b8def11c5d982384098c5380 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41b6759d127475d5fcd2b3982a8f355e inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a41b6759d127475d5fcd2b3982a8f355e"></a>
<a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a41b6759d127475d5fcd2b3982a8f355e">ntotal</a></td></tr>
<tr class="memdesc:a41b6759d127475d5fcd2b3982a8f355e inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">total nb of indexed vectors <br/></td></tr>
<tr class="separator:a41b6759d127475d5fcd2b3982a8f355e inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1656c00d77d55999becd71e3d8ea6dd7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1656c00d77d55999becd71e3d8ea6dd7"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a1656c00d77d55999becd71e3d8ea6dd7">verbose</a></td></tr>
<tr class="memdesc:a1656c00d77d55999becd71e3d8ea6dd7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">verbosity level <br/></td></tr>
<tr class="separator:a1656c00d77d55999becd71e3d8ea6dd7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a132119ae93e240b54621c5c669853c7f inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a132119ae93e240b54621c5c669853c7f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a132119ae93e240b54621c5c669853c7f">is_trained</a></td></tr>
<tr class="memdesc:a132119ae93e240b54621c5c669853c7f inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">set if the <a class="el" href="structfaiss_1_1Index.html">Index</a> does not require training, or if training is done already <br/></td></tr>
<tr class="separator:a132119ae93e240b54621c5c669853c7f inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a344529c829717012b530ef9c13b145b7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a344529c829717012b530ef9c13b145b7"></a>
<a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#a344529c829717012b530ef9c13b145b7">metric_type</a></td></tr>
<tr class="memdesc:a344529c829717012b530ef9c13b145b7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">type of metric this index uses for search <br/></td></tr>
<tr class="separator:a344529c829717012b530ef9c13b145b7 inherit pub_attribs_structfaiss_1_1IndexBinary"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_structfaiss_1_1IndexBinary"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1IndexBinary')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td></tr>
<tr class="memitem:ace45f4c385c2faaaa1617bb81b26e91b inherit pub_types_structfaiss_1_1IndexBinary"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace45f4c385c2faaaa1617bb81b26e91b"></a>
typedef long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a></td></tr>
<tr class="memdesc:ace45f4c385c2faaaa1617bb81b26e91b inherit pub_types_structfaiss_1_1IndexBinary"><td class="mdescLeft">&#160;</td><td class="mdescRight">all indices are this type <br/></td></tr>
<tr class="separator:ace45f4c385c2faaaa1617bb81b26e91b inherit pub_types_structfaiss_1_1IndexBinary"><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><a class="el" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> backed by a float <a class="el" href="structfaiss_1_1Index.html">Index</a>.</p>
<p>Supports adding vertices and searching them.</p>
<p>All queries are symmetric because there is no distinction between codes and vectors. </p>

<p>Definition at line <a class="el" href="IndexBinaryFromFloat_8h_source.html#l00029">29</a> of file <a class="el" href="IndexBinaryFromFloat_8h_source.html">IndexBinaryFromFloat.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac4f01196a335a9b2433e5c16396c1fd7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryFromFloat::add </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>x</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Add n vectors of dimension d to the index.</p>
<p>Vectors are implicitly assigned labels ntotal .. ntotal + n - 1 </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>input matrix, size n * d / 8 </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="structfaiss_1_1IndexBinary.html#af04b1093cdebfea189e0e04da68794d7">faiss::IndexBinary</a>.</p>

<p>Definition at line <a class="el" href="IndexBinaryFromFloat_8cpp_source.html#l00035">35</a> of file <a class="el" href="IndexBinaryFromFloat_8cpp_source.html">IndexBinaryFromFloat.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="af92913a782c65843fbf7a65e017d6f5f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryFromFloat::search </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a>&#160;</td>
          <td class="paramname"><em>k</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t *&#160;</td>
          <td class="paramname"><em>distances</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a> *&#160;</td>
          <td class="paramname"><em>labels</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Query n vectors of dimension d to the index.</p>
<p>return at most k vectors. If there are not enough results for a query, the result array is padded with -1s.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>input vectors to search, size n * d / 8 </td></tr>
    <tr><td class="paramname">labels</td><td>output labels of the NNs, size n*k </td></tr>
    <tr><td class="paramname">distances</td><td>output pairwise distances, size n*k </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="structfaiss_1_1IndexBinary.html#a48cdd06037d1fb8ce827e7522ba05fb8">faiss::IndexBinary</a>.</p>

<p>Definition at line <a class="el" href="IndexBinaryFromFloat_8cpp_source.html#l00053">53</a> of file <a class="el" href="IndexBinaryFromFloat_8cpp_source.html">IndexBinaryFromFloat.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a7de4bb8e82f0dae621c87b44cfb64404"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void faiss::IndexBinaryFromFloat::train </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structfaiss_1_1IndexBinary.html#ace45f4c385c2faaaa1617bb81b26e91b">idx_t</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>x</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Perform training on a representative set of vectors.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">n</td><td>nb of training vectors </td></tr>
    <tr><td class="paramname">x</td><td>training vecors, size n * d / 8 </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexBinary.html#a34b7f0f358259d858135555967c6bc79">faiss::IndexBinary</a>.</p>

<p>Definition at line <a class="el" href="IndexBinaryFromFloat_8cpp_source.html#l00070">70</a> of file <a class="el" href="IndexBinaryFromFloat_8cpp_source.html">IndexBinaryFromFloat.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/tmp/faiss/<a class="el" href="IndexBinaryFromFloat_8h_source.html">IndexBinaryFromFloat.h</a></li>
<li>/tmp/faiss/<a class="el" href="IndexBinaryFromFloat_8cpp_source.html">IndexBinaryFromFloat.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>