172 lines
14 KiB
HTML
172 lines
14 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::SQDis 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_1SQDis.html">SQDis</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_1SQDis-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::SQDis Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for faiss::SQDis:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="structfaiss_1_1SQDis.png" usemap="#faiss::SQDis_map" alt=""/>
|
|
<map id="faiss::SQDis_map" name="faiss::SQDis_map">
|
|
<area href="structfaiss_1_1HNSW_1_1DistanceComputer.html" alt="faiss::HNSW::DistanceComputer" shape="rect" coords="0,0,190,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:ab9a2132f93e4eb9c8875bf3454364bad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9a2132f93e4eb9c8875bf3454364bad"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><b>operator()</b> (storage_idx_t i) override</td></tr>
|
|
<tr class="separator:ab9a2132f93e4eb9c8875bf3454364bad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04b015ad436b3457929c74d2bf273168"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04b015ad436b3457929c74d2bf273168"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><b>symmetric_dis</b> (storage_idx_t i, storage_idx_t j) override</td></tr>
|
|
<tr class="separator:a04b015ad436b3457929c74d2bf273168"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16545f39ee55dc99de2def137429c2ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16545f39ee55dc99de2def137429c2ae"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>SQDis</b> (const <a class="el" href="structfaiss_1_1IndexScalarQuantizer.html">IndexScalarQuantizer</a> &storage, const float *q=nullptr)</td></tr>
|
|
<tr class="separator:a16545f39ee55dc99de2def137429c2ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67cd2b8275b5983de5709ec4767feb13"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67cd2b8275b5983de5709ec4767feb13"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1SQDis.html#a67cd2b8275b5983de5709ec4767feb13">set_query</a> (const float *x) override</td></tr>
|
|
<tr class="memdesc:a67cd2b8275b5983de5709ec4767feb13"><td class="mdescLeft"> </td><td class="mdescRight">called before computing distances <br/></td></tr>
|
|
<tr class="separator:a67cd2b8275b5983de5709ec4767feb13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structfaiss_1_1HNSW_1_1DistanceComputer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1HNSW_1_1DistanceComputer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1HNSW_1_1DistanceComputer.html">faiss::HNSW::DistanceComputer</a></td></tr>
|
|
<tr class="memitem:ac3394f35cb68cb901a5078920bd46a2f inherit pub_methods_structfaiss_1_1HNSW_1_1DistanceComputer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3394f35cb68cb901a5078920bd46a2f"></a>
|
|
virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1HNSW_1_1DistanceComputer.html#ac3394f35cb68cb901a5078920bd46a2f">operator()</a> (<a class="el" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">storage_idx_t</a> i)=0</td></tr>
|
|
<tr class="memdesc:ac3394f35cb68cb901a5078920bd46a2f inherit pub_methods_structfaiss_1_1HNSW_1_1DistanceComputer"><td class="mdescLeft"> </td><td class="mdescRight">compute distance of vector i to current query <br/></td></tr>
|
|
<tr class="separator:ac3394f35cb68cb901a5078920bd46a2f inherit pub_methods_structfaiss_1_1HNSW_1_1DistanceComputer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acaa9a112486a82fd2abfbcd250d058b2 inherit pub_methods_structfaiss_1_1HNSW_1_1DistanceComputer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acaa9a112486a82fd2abfbcd250d058b2"></a>
|
|
virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1HNSW_1_1DistanceComputer.html#acaa9a112486a82fd2abfbcd250d058b2">symmetric_dis</a> (<a class="el" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">storage_idx_t</a> i, <a class="el" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">storage_idx_t</a> j)=0</td></tr>
|
|
<tr class="memdesc:acaa9a112486a82fd2abfbcd250d058b2 inherit pub_methods_structfaiss_1_1HNSW_1_1DistanceComputer"><td class="mdescLeft"> </td><td class="mdescRight">compute distance between two stored vectors <br/></td></tr>
|
|
<tr class="separator:acaa9a112486a82fd2abfbcd250d058b2 inherit pub_methods_structfaiss_1_1HNSW_1_1DistanceComputer"><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:a08e60e441f9d3de4dfb832f273b97f2d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08e60e441f9d3de4dfb832f273b97f2d"></a>
|
|
<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> </td><td class="memItemRight" valign="bottom"><b>nb</b></td></tr>
|
|
<tr class="separator:a08e60e441f9d3de4dfb832f273b97f2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc46159095fd1e2a240c613b9b45d195"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc46159095fd1e2a240c613b9b45d195"></a>
|
|
const uint8_t * </td><td class="memItemRight" valign="bottom"><b>codes</b></td></tr>
|
|
<tr class="separator:acc46159095fd1e2a240c613b9b45d195"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa461481780996c2b80327533d7e68951"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa461481780996c2b80327533d7e68951"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>code_size</b></td></tr>
|
|
<tr class="separator:aa461481780996c2b80327533d7e68951"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9210ac96d2c9d478a02a517addb008f1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9210ac96d2c9d478a02a517addb008f1"></a>
|
|
const <a class="el" href="structfaiss_1_1ScalarQuantizer.html">ScalarQuantizer</a> & </td><td class="memItemRight" valign="bottom"><b>sq</b></td></tr>
|
|
<tr class="separator:a9210ac96d2c9d478a02a517addb008f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8052372dd5663b41d8d37591daaff03"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8052372dd5663b41d8d37591daaff03"></a>
|
|
const float * </td><td class="memItemRight" valign="bottom"><b>q</b></td></tr>
|
|
<tr class="separator:ad8052372dd5663b41d8d37591daaff03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a776022d4eada6198e9254cd27d82193e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a776022d4eada6198e9254cd27d82193e"></a>
|
|
<a class="el" href="structfaiss_1_1ScalarQuantizer_1_1DistanceComputer.html">ScalarQuantizer::DistanceComputer</a> * </td><td class="memItemRight" valign="bottom"><b>dc</b></td></tr>
|
|
<tr class="separator:a776022d4eada6198e9254cd27d82193e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_structfaiss_1_1HNSW_1_1DistanceComputer"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1HNSW_1_1DistanceComputer')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1HNSW_1_1DistanceComputer.html">faiss::HNSW::DistanceComputer</a></td></tr>
|
|
<tr class="memitem:a7d8d851ccb584bb4d5af779ad0c10978 inherit pub_attribs_structfaiss_1_1HNSW_1_1DistanceComputer"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d8d851ccb584bb4d5af779ad0c10978"></a>
|
|
<a class="el" href="structfaiss_1_1HNSW.html#a153fa41ad41a4905aa60683360a3cdf0">idx_t</a> </td><td class="memItemRight" valign="bottom"><b>d</b></td></tr>
|
|
<tr class="separator:a7d8d851ccb584bb4d5af779ad0c10978 inherit pub_attribs_structfaiss_1_1HNSW_1_1DistanceComputer"><td class="memSeparator" colspan="2"> </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="IndexHNSW_8cpp_source.html#l01752">1752</a> of file <a class="el" href="IndexHNSW_8cpp_source.html">IndexHNSW.cpp</a>.</p>
|
|
</div><hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="IndexHNSW_8cpp_source.html">IndexHNSW.cpp</a></li>
|
|
</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>
|