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
<!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::IntersectionCriterion 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_1IntersectionCriterion.html">IntersectionCriterion</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_1IntersectionCriterion-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::IntersectionCriterion Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for faiss::IntersectionCriterion:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1IntersectionCriterion.png" usemap="#faiss::IntersectionCriterion_map" alt=""/>
<map id="faiss::IntersectionCriterion_map" name="faiss::IntersectionCriterion_map">
<area href="structfaiss_1_1AutoTuneCriterion.html" alt="faiss::AutoTuneCriterion" shape="rect" coords="0,0,158,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:a786f743984105ff940a780fe3ba85040"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a786f743984105ff940a780fe3ba85040"></a>
 </td><td class="memItemRight" valign="bottom"><b>IntersectionCriterion</b> (idx_t <a class="el" href="structfaiss_1_1AutoTuneCriterion.html#adcfaafb3f1b3449e2cfd553f0f603a5b">nq</a>, idx_t R)</td></tr>
<tr class="separator:a786f743984105ff940a780fe3ba85040"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6f7aef25852931b22298f7bb4c358791"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f7aef25852931b22298f7bb4c358791"></a>
double </td><td class="memItemRight" valign="bottom"><b>evaluate</b> (const float *D, const idx_t *I) const override</td></tr>
<tr class="separator:a6f7aef25852931b22298f7bb4c358791"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_structfaiss_1_1AutoTuneCriterion"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1AutoTuneCriterion')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1AutoTuneCriterion.html">faiss::AutoTuneCriterion</a></td></tr>
<tr class="memitem:abd85ee0d09e9f4958330c42e867e432b inherit pub_methods_structfaiss_1_1AutoTuneCriterion"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd85ee0d09e9f4958330c42e867e432b"></a>
 </td><td class="memItemRight" valign="bottom"><b>AutoTuneCriterion</b> (idx_t <a class="el" href="structfaiss_1_1AutoTuneCriterion.html#adcfaafb3f1b3449e2cfd553f0f603a5b">nq</a>, idx_t <a class="el" href="structfaiss_1_1AutoTuneCriterion.html#a3bb11e873707a812999f8391869aafab">nnn</a>)</td></tr>
<tr class="separator:abd85ee0d09e9f4958330c42e867e432b inherit pub_methods_structfaiss_1_1AutoTuneCriterion"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a174f0de8e6fd01905f5fa2170f5039d8 inherit pub_methods_structfaiss_1_1AutoTuneCriterion"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1AutoTuneCriterion.html#a174f0de8e6fd01905f5fa2170f5039d8">set_groundtruth</a> (int <a class="el" href="structfaiss_1_1AutoTuneCriterion.html#a9b3a2242729a0873d255c1684881bbd4">gt_nnn</a>, const float *gt_D_in, const idx_t *gt_I_in)</td></tr>
<tr class="separator:a174f0de8e6fd01905f5fa2170f5039d8 inherit pub_methods_structfaiss_1_1AutoTuneCriterion"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9084449e216b331c5f753a10c6de6a47 inherit pub_methods_structfaiss_1_1AutoTuneCriterion"><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1AutoTuneCriterion.html#a9084449e216b331c5f753a10c6de6a47">evaluate</a> (const float *D, const idx_t *I) const =0</td></tr>
<tr class="separator:a9084449e216b331c5f753a10c6de6a47 inherit pub_methods_structfaiss_1_1AutoTuneCriterion"><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:a9ccad002c0cf0272a2cc0e02d2a37384"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ccad002c0cf0272a2cc0e02d2a37384"></a>
idx_t </td><td class="memItemRight" valign="bottom"><b>R</b></td></tr>
<tr class="separator:a9ccad002c0cf0272a2cc0e02d2a37384"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_attribs_structfaiss_1_1AutoTuneCriterion"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1AutoTuneCriterion')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1AutoTuneCriterion.html">faiss::AutoTuneCriterion</a></td></tr>
<tr class="memitem:adcfaafb3f1b3449e2cfd553f0f603a5b inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adcfaafb3f1b3449e2cfd553f0f603a5b"></a>
idx_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1AutoTuneCriterion.html#adcfaafb3f1b3449e2cfd553f0f603a5b">nq</a></td></tr>
<tr class="memdesc:adcfaafb3f1b3449e2cfd553f0f603a5b inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="mdescLeft"> </td><td class="mdescRight">nb of queries this criterion is evaluated on <br/></td></tr>
<tr class="separator:adcfaafb3f1b3449e2cfd553f0f603a5b inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bb11e873707a812999f8391869aafab inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3bb11e873707a812999f8391869aafab"></a>
idx_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1AutoTuneCriterion.html#a3bb11e873707a812999f8391869aafab">nnn</a></td></tr>
<tr class="memdesc:a3bb11e873707a812999f8391869aafab inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="mdescLeft"> </td><td class="mdescRight">nb of NNs that the query should request <br/></td></tr>
<tr class="separator:a3bb11e873707a812999f8391869aafab inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b3a2242729a0873d255c1684881bbd4 inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b3a2242729a0873d255c1684881bbd4"></a>
idx_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1AutoTuneCriterion.html#a9b3a2242729a0873d255c1684881bbd4">gt_nnn</a></td></tr>
<tr class="memdesc:a9b3a2242729a0873d255c1684881bbd4 inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="mdescLeft"> </td><td class="mdescRight">nb of GT NNs required to evaluate crterion <br/></td></tr>
<tr class="separator:a9b3a2242729a0873d255c1684881bbd4 inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40e91caa9232a597c16fc946d0befd9b inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40e91caa9232a597c16fc946d0befd9b"></a>
std::vector< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1AutoTuneCriterion.html#a40e91caa9232a597c16fc946d0befd9b">gt_D</a></td></tr>
<tr class="memdesc:a40e91caa9232a597c16fc946d0befd9b inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="mdescLeft"> </td><td class="mdescRight">Ground-truth distances (size nq * gt_nnn) <br/></td></tr>
<tr class="separator:a40e91caa9232a597c16fc946d0befd9b inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af915fc4df215e3c8d9f71ff42d526144 inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af915fc4df215e3c8d9f71ff42d526144"></a>
std::vector< idx_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1AutoTuneCriterion.html#af915fc4df215e3c8d9f71ff42d526144">gt_I</a></td></tr>
<tr class="memdesc:af915fc4df215e3c8d9f71ff42d526144 inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="mdescLeft"> </td><td class="mdescRight">Ground-truth indexes (size nq * gt_nnn) <br/></td></tr>
<tr class="separator:af915fc4df215e3c8d9f71ff42d526144 inherit pub_attribs_structfaiss_1_1AutoTuneCriterion"><td class="memSeparator" colspan="2"> </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_1AutoTuneCriterion"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1AutoTuneCriterion')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="structfaiss_1_1AutoTuneCriterion.html">faiss::AutoTuneCriterion</a></td></tr>
<tr class="memitem:a7873f86515af86a77eaaea1f6b13e982 inherit pub_types_structfaiss_1_1AutoTuneCriterion"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7873f86515af86a77eaaea1f6b13e982"></a>
typedef <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> </td><td class="memItemRight" valign="bottom"><b>idx_t</b></td></tr>
<tr class="separator:a7873f86515af86a77eaaea1f6b13e982 inherit pub_types_structfaiss_1_1AutoTuneCriterion"><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="AutoTune_8h_source.html#l00069">69</a> of file <a class="el" href="AutoTune_8h_source.html">AutoTune.h</a>.</p>
</div><hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="AutoTune_8h_source.html">AutoTune.h</a></li>
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="AutoTune_8cpp_source.html">AutoTune.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>