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
<!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::GenericDistanceComputer 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_1GenericDistanceComputer.html">GenericDistanceComputer</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_1GenericDistanceComputer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::GenericDistanceComputer Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for faiss::GenericDistanceComputer:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1GenericDistanceComputer.png" usemap="#faiss::GenericDistanceComputer_map" alt=""/>
<map id="faiss::GenericDistanceComputer_map" name="faiss::GenericDistanceComputer_map">
<area href="structfaiss_1_1HNSW_1_1DistanceComputer.html" alt="faiss::HNSW::DistanceComputer" shape="rect" coords="0,0,192,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:a18714ea7776d7a9d1672118afd08c0d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18714ea7776d7a9d1672118afd08c0d0"></a>
 </td><td class="memItemRight" valign="bottom"><b>GenericDistanceComputer</b> (const <a class="el" href="structfaiss_1_1Index.html">Index</a> &storage)</td></tr>
<tr class="separator:a18714ea7776d7a9d1672118afd08c0d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61295c70df649eb44c0354a05c2145fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61295c70df649eb44c0354a05c2145fe"></a>
float </td><td class="memItemRight" valign="bottom"><b>operator()</b> (storage_idx_t i) override</td></tr>
<tr class="separator:a61295c70df649eb44c0354a05c2145fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8173aa902aa95a9aa5445fc3eaf5ca8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8173aa902aa95a9aa5445fc3eaf5ca8e"></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:a8173aa902aa95a9aa5445fc3eaf5ca8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07cbd7cd0ed73eae3d0487f2f25b748c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07cbd7cd0ed73eae3d0487f2f25b748c"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1GenericDistanceComputer.html#a07cbd7cd0ed73eae3d0487f2f25b748c">set_query</a> (const float *x) override</td></tr>
<tr class="memdesc:a07cbd7cd0ed73eae3d0487f2f25b748c"><td class="mdescLeft"> </td><td class="mdescRight">called before computing distances <br/></td></tr>
<tr class="separator:a07cbd7cd0ed73eae3d0487f2f25b748c"><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:adb678a1d836b31ee3812ecef02ec370f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb678a1d836b31ee3812ecef02ec370f"></a>
const <a class="el" href="structfaiss_1_1Index.html">Index</a> & </td><td class="memItemRight" valign="bottom"><b>storage</b></td></tr>
<tr class="separator:adb678a1d836b31ee3812ecef02ec370f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d1ea94d38970f56a1b0cd4f2a1c660b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d1ea94d38970f56a1b0cd4f2a1c660b"></a>
std::vector< float > </td><td class="memItemRight" valign="bottom"><b>buf</b></td></tr>
<tr class="separator:a5d1ea94d38970f56a1b0cd4f2a1c660b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab639ceb68ee289924a0537b031a5719f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab639ceb68ee289924a0537b031a5719f"></a>
const float * </td><td class="memItemRight" valign="bottom"><b>q</b></td></tr>
<tr class="separator:ab639ceb68ee289924a0537b031a5719f"><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#l01322">1322</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>