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
<!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::PCAMatrix 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_1PCAMatrix.html">PCAMatrix</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_1PCAMatrix-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::PCAMatrix Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="VectorTransform_8h_source.html">VectorTransform.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for faiss::PCAMatrix:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1PCAMatrix.png" usemap="#faiss::PCAMatrix_map" alt=""/>
<map id="faiss::PCAMatrix_map" name="faiss::PCAMatrix_map">
<area href="structfaiss_1_1LinearTransform.html" alt="faiss::LinearTransform" shape="rect" coords="0,56,139,80"/>
<area href="structfaiss_1_1VectorTransform.html" alt="faiss::VectorTransform" shape="rect" coords="0,0,139,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:a0c234bc06b073970af406d8877f67989"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c234bc06b073970af406d8877f67989"></a>
 </td><td class="memItemRight" valign="bottom"><b>PCAMatrix</b> (int d_in=0, int <a class="el" href="structfaiss_1_1VectorTransform.html#a589d612f7b1773614619a0cbecd728a9">d_out</a>=0, float <a class="el" href="structfaiss_1_1PCAMatrix.html#a4e48e801f98ba2cf57c03b0913d6fafc">eigen_power</a>=0, bool <a class="el" href="structfaiss_1_1PCAMatrix.html#af111f055b7571703a3aa270d89e99321">random_rotation</a>=false)</td></tr>
<tr class="separator:a0c234bc06b073970af406d8877f67989"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f2dd12da8dce3cbeb22da9c5d4ec3e7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#a8f2dd12da8dce3cbeb22da9c5d4ec3e7">train</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> n, const float *x) override</td></tr>
<tr class="separator:a8f2dd12da8dce3cbeb22da9c5d4ec3e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf427521a66cbfaaf0b7aae16bcb6e93"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#abf427521a66cbfaaf0b7aae16bcb6e93">reverse_transform</a> (idx_t n, const float *xt, float *x) const override</td></tr>
<tr class="separator:abf427521a66cbfaaf0b7aae16bcb6e93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae586dc89db6c57753c687473417742a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae586dc89db6c57753c687473417742a6"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#ae586dc89db6c57753c687473417742a6">copy_from</a> (const <a class="el" href="structfaiss_1_1PCAMatrix.html">PCAMatrix</a> &other)</td></tr>
<tr class="memdesc:ae586dc89db6c57753c687473417742a6"><td class="mdescLeft"> </td><td class="mdescRight">copy pre-trained PCA matrix <br/></td></tr>
<tr class="separator:ae586dc89db6c57753c687473417742a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a117a70b8fca6d125725fe49fddebf97b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a117a70b8fca6d125725fe49fddebf97b"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#a117a70b8fca6d125725fe49fddebf97b">prepare_Ab</a> ()</td></tr>
<tr class="memdesc:a117a70b8fca6d125725fe49fddebf97b"><td class="mdescLeft"> </td><td class="mdescRight">called after mean, PCAMat and eigenvalues are computed <br/></td></tr>
<tr class="separator:a117a70b8fca6d125725fe49fddebf97b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_structfaiss_1_1LinearTransform"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1LinearTransform')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1LinearTransform.html">faiss::LinearTransform</a></td></tr>
<tr class="memitem:a2fffd6064defb7c3fdaf143c0c4a9bc7 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fffd6064defb7c3fdaf143c0c4a9bc7"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1LinearTransform.html#a2fffd6064defb7c3fdaf143c0c4a9bc7">LinearTransform</a> (int d_in=0, int <a class="el" href="structfaiss_1_1VectorTransform.html#a589d612f7b1773614619a0cbecd728a9">d_out</a>=0, bool have_bias=false)</td></tr>
<tr class="memdesc:a2fffd6064defb7c3fdaf143c0c4a9bc7 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="mdescLeft"> </td><td class="mdescRight">both d_in > d_out and d_out < d_in are supported <br/></td></tr>
<tr class="separator:a2fffd6064defb7c3fdaf143c0c4a9bc7 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1467253297ce7a3838a71769b3c86aa inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1467253297ce7a3838a71769b3c86aa"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1LinearTransform.html#ab1467253297ce7a3838a71769b3c86aa">apply_noalloc</a> (idx_t n, const float *x, float *xt) const </td></tr>
<tr class="memdesc:ab1467253297ce7a3838a71769b3c86aa inherit pub_methods_structfaiss_1_1LinearTransform"><td class="mdescLeft"> </td><td class="mdescRight">same as apply, but result is pre-allocated <br/></td></tr>
<tr class="separator:ab1467253297ce7a3838a71769b3c86aa inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1642efca4f5eb524c29722b0441c4d13 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1LinearTransform.html#a1642efca4f5eb524c29722b0441c4d13">transform_transpose</a> (idx_t n, const float *y, float *x) const </td></tr>
<tr class="separator:a1642efca4f5eb524c29722b0441c4d13 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_structfaiss_1_1VectorTransform"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1VectorTransform')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1VectorTransform.html">faiss::VectorTransform</a></td></tr>
<tr class="memitem:a137f48bab695736f0b1d79a50cddc858 inherit pub_methods_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a137f48bab695736f0b1d79a50cddc858"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VectorTransform.html#a137f48bab695736f0b1d79a50cddc858">VectorTransform</a> (int d_in=0, int <a class="el" href="structfaiss_1_1VectorTransform.html#a589d612f7b1773614619a0cbecd728a9">d_out</a>=0)</td></tr>
<tr class="memdesc:a137f48bab695736f0b1d79a50cddc858 inherit pub_methods_structfaiss_1_1VectorTransform"><td class="mdescLeft"> </td><td class="mdescRight">! output dimension <br/></td></tr>
<tr class="separator:a137f48bab695736f0b1d79a50cddc858 inherit pub_methods_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3b3a8bf95911f4b28128001c83f91a5 inherit pub_methods_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top">float * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VectorTransform.html#af3b3a8bf95911f4b28128001c83f91a5">apply</a> (idx_t n, const float *x) const </td></tr>
<tr class="separator:af3b3a8bf95911f4b28128001c83f91a5 inherit pub_methods_structfaiss_1_1VectorTransform"><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:a4e48e801f98ba2cf57c03b0913d6fafc"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#a4e48e801f98ba2cf57c03b0913d6fafc">eigen_power</a></td></tr>
<tr class="separator:a4e48e801f98ba2cf57c03b0913d6fafc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af111f055b7571703a3aa270d89e99321"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af111f055b7571703a3aa270d89e99321"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#af111f055b7571703a3aa270d89e99321">random_rotation</a></td></tr>
<tr class="memdesc:af111f055b7571703a3aa270d89e99321"><td class="mdescLeft"> </td><td class="mdescRight">random rotation after PCA <br/></td></tr>
<tr class="separator:af111f055b7571703a3aa270d89e99321"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdce90f57a3c4401f5230f03da901e0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abdce90f57a3c4401f5230f03da901e0d"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#abdce90f57a3c4401f5230f03da901e0d">max_points_per_d</a></td></tr>
<tr class="memdesc:abdce90f57a3c4401f5230f03da901e0d"><td class="mdescLeft"> </td><td class="mdescRight">ratio between # training vectors and dimension <br/></td></tr>
<tr class="separator:abdce90f57a3c4401f5230f03da901e0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9a4c97b5861081dfd8ca5881bb1a677"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9a4c97b5861081dfd8ca5881bb1a677"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#ac9a4c97b5861081dfd8ca5881bb1a677">balanced_bins</a></td></tr>
<tr class="memdesc:ac9a4c97b5861081dfd8ca5881bb1a677"><td class="mdescLeft"> </td><td class="mdescRight">try to distribute output eigenvectors in this many bins <br/></td></tr>
<tr class="separator:ac9a4c97b5861081dfd8ca5881bb1a677"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a721c338c1df5c99471db82e6d3dc8f93"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a721c338c1df5c99471db82e6d3dc8f93"></a>
std::vector< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#a721c338c1df5c99471db82e6d3dc8f93">mean</a></td></tr>
<tr class="memdesc:a721c338c1df5c99471db82e6d3dc8f93"><td class="mdescLeft"> </td><td class="mdescRight">Mean, size d_in. <br/></td></tr>
<tr class="separator:a721c338c1df5c99471db82e6d3dc8f93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae80e130c0667b66cea608c4926d7d561"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae80e130c0667b66cea608c4926d7d561"></a>
std::vector< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#ae80e130c0667b66cea608c4926d7d561">eigenvalues</a></td></tr>
<tr class="memdesc:ae80e130c0667b66cea608c4926d7d561"><td class="mdescLeft"> </td><td class="mdescRight">eigenvalues of covariance matrix (= squared singular values) <br/></td></tr>
<tr class="separator:ae80e130c0667b66cea608c4926d7d561"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef5c130774e5d4f697a3e1c82647bfd3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef5c130774e5d4f697a3e1c82647bfd3"></a>
std::vector< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1PCAMatrix.html#aef5c130774e5d4f697a3e1c82647bfd3">PCAMat</a></td></tr>
<tr class="memdesc:aef5c130774e5d4f697a3e1c82647bfd3"><td class="mdescLeft"> </td><td class="mdescRight">PCA matrix, size d_in * d_in. <br/></td></tr>
<tr class="separator:aef5c130774e5d4f697a3e1c82647bfd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_attribs_structfaiss_1_1LinearTransform"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1LinearTransform')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1LinearTransform.html">faiss::LinearTransform</a></td></tr>
<tr class="memitem:a322401ba80cb96ac1e7846401f2bef24 inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a322401ba80cb96ac1e7846401f2bef24"></a>
bool </td><td class="memItemRight" valign="bottom"><b>have_bias</b></td></tr>
<tr class="separator:a322401ba80cb96ac1e7846401f2bef24 inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa40e156ef57fe206cd5f3a58ec0660da inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top">std::vector< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1LinearTransform.html#aa40e156ef57fe206cd5f3a58ec0660da">A</a></td></tr>
<tr class="memdesc:aa40e156ef57fe206cd5f3a58ec0660da inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="mdescLeft"> </td><td class="mdescRight">! whether to use the bias term <a href="#aa40e156ef57fe206cd5f3a58ec0660da">More...</a><br/></td></tr>
<tr class="separator:aa40e156ef57fe206cd5f3a58ec0660da inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0383f690aeb823876e9143febad1a87 inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0383f690aeb823876e9143febad1a87"></a>
std::vector< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1LinearTransform.html#ab0383f690aeb823876e9143febad1a87">b</a></td></tr>
<tr class="memdesc:ab0383f690aeb823876e9143febad1a87 inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="mdescLeft"> </td><td class="mdescRight">bias vector, size d_out <br/></td></tr>
<tr class="separator:ab0383f690aeb823876e9143febad1a87 inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae351ccd1155b71ac9d2fbd8d11b7082a inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae351ccd1155b71ac9d2fbd8d11b7082a"></a>
bool </td><td class="memItemRight" valign="bottom"><b>verbose</b></td></tr>
<tr class="separator:ae351ccd1155b71ac9d2fbd8d11b7082a inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_attribs_structfaiss_1_1VectorTransform"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1VectorTransform')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1VectorTransform.html">faiss::VectorTransform</a></td></tr>
<tr class="memitem:afdf56cbd261a571cf6b8872be5bd43b6 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdf56cbd261a571cf6b8872be5bd43b6"></a>
int </td><td class="memItemRight" valign="bottom"><b>d_in</b></td></tr>
<tr class="separator:afdf56cbd261a571cf6b8872be5bd43b6 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a589d612f7b1773614619a0cbecd728a9 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a589d612f7b1773614619a0cbecd728a9"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VectorTransform.html#a589d612f7b1773614619a0cbecd728a9">d_out</a></td></tr>
<tr class="memdesc:a589d612f7b1773614619a0cbecd728a9 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="mdescLeft"> </td><td class="mdescRight">! input dimension <br/></td></tr>
<tr class="separator:a589d612f7b1773614619a0cbecd728a9 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab511f1ddf608c00204555881ca28cb02 inherit pub_attribs_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VectorTransform.html#ab511f1ddf608c00204555881ca28cb02">is_trained</a></td></tr>
<tr class="separator:ab511f1ddf608c00204555881ca28cb02 inherit pub_attribs_structfaiss_1_1VectorTransform"><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_1VectorTransform"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1VectorTransform')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="structfaiss_1_1VectorTransform.html">faiss::VectorTransform</a></td></tr>
<tr class="memitem:a410516b4efdae041546d87f6bef2e422 inherit pub_types_structfaiss_1_1VectorTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a410516b4efdae041546d87f6bef2e422"></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:a410516b4efdae041546d87f6bef2e422 inherit pub_types_structfaiss_1_1VectorTransform"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Applies a principal component analysis on a set of vectors, with optionally whitening and random rotation. </p>
<p>Definition at line <a class="el" href="VectorTransform_8h_source.html#l00131">131</a> of file <a class="el" href="VectorTransform_8h_source.html">VectorTransform.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abf427521a66cbfaaf0b7aae16bcb6e93"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PCAMatrix::reverse_transform </td>
<td>(</td>
<td class="paramtype">idx_t </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float * </td>
<td class="paramname"><em>xt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>x</em> </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>reverse transformation. May not be implemented or may return approximate result </p>
<p>Reimplemented from <a class="el" href="structfaiss_1_1VectorTransform.html#a101ce54f1c60df19478801aa942470d9">faiss::VectorTransform</a>.</p>
<p>Definition at line <a class="el" href="VectorTransform_8cpp_source.html#l00424">424</a> of file <a class="el" href="VectorTransform_8cpp_source.html">VectorTransform.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8f2dd12da8dce3cbeb22da9c5d4ec3e7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PCAMatrix::train </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float * </td>
<td class="paramname"><em>x</em> </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. Does nothing by default.</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 </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="structfaiss_1_1VectorTransform.html#a7350d4dd28d60866d55ba4f75d2da84c">faiss::VectorTransform</a>.</p>
<p>Definition at line <a class="el" href="VectorTransform_8cpp_source.html#l00206">206</a> of file <a class="el" href="VectorTransform_8cpp_source.html">VectorTransform.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a4e48e801f98ba2cf57c03b0913d6fafc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float faiss::PCAMatrix::eigen_power</td>
</tr>
</table>
</div><div class="memdoc">
<p>after transformation the components are multiplied by eigenvalues^eigen_power</p>
<p>=0: no whitening =-2: full whitening </p>
<p>Definition at line <a class="el" href="VectorTransform_8h_source.html#l00139">139</a> of file <a class="el" href="VectorTransform_8h_source.html">VectorTransform.h</a>.</p>
</div>
</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="VectorTransform_8h_source.html">VectorTransform.h</a></li>
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="VectorTransform_8cpp_source.html">VectorTransform.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>