289 lines
27 KiB
HTML
289 lines
27 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::OPQMatrix 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_1OPQMatrix.html">OPQMatrix</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_1OPQMatrix-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::OPQMatrix 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::OPQMatrix:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="structfaiss_1_1OPQMatrix.png" usemap="#faiss::OPQMatrix_map" alt=""/>
|
|
<map id="faiss::OPQMatrix_map" name="faiss::OPQMatrix_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:a6eb9d18ff15b1c598d3aa3bc9ab84519"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6eb9d18ff15b1c598d3aa3bc9ab84519"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1OPQMatrix.html#a6eb9d18ff15b1c598d3aa3bc9ab84519">OPQMatrix</a> (int d=0, int <a class="el" href="structfaiss_1_1OPQMatrix.html#a07ad0c0c84f96a6880c1c8eaf09596e3">M</a>=1, int d2=-1)</td></tr>
|
|
<tr class="memdesc:a6eb9d18ff15b1c598d3aa3bc9ab84519"><td class="mdescLeft"> </td><td class="mdescRight">if d2 != -1, output vectors of this dimension <br/></td></tr>
|
|
<tr class="separator:a6eb9d18ff15b1c598d3aa3bc9ab84519"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e314577db0c6cd4a709503f73eb71e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1OPQMatrix.html#a1e314577db0c6cd4a709503f73eb71e2">train</a> (<a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> n, const float *x) override</td></tr>
|
|
<tr class="separator:a1e314577db0c6cd4a709503f73eb71e2"><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:af9c20b4ae67691b5713489884ca9f80f inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9c20b4ae67691b5713489884ca9f80f"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1LinearTransform.html#af9c20b4ae67691b5713489884ca9f80f">apply_noalloc</a> (idx_t n, const float *x, float *xt) const override</td></tr>
|
|
<tr class="memdesc:af9c20b4ae67691b5713489884ca9f80f 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:af9c20b4ae67691b5713489884ca9f80f 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="memitem:a078caa663cf329de13851ebb026fb5d5 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a078caa663cf329de13851ebb026fb5d5"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1LinearTransform.html#a078caa663cf329de13851ebb026fb5d5">reverse_transform</a> (idx_t n, const float *xt, float *x) const override</td></tr>
|
|
<tr class="memdesc:a078caa663cf329de13851ebb026fb5d5 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="mdescLeft"> </td><td class="mdescRight">works only if is_orthonormal <br/></td></tr>
|
|
<tr class="separator:a078caa663cf329de13851ebb026fb5d5 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca77897ef5c27c69374b4d9555e5b332 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca77897ef5c27c69374b4d9555e5b332"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1LinearTransform.html#aca77897ef5c27c69374b4d9555e5b332">set_is_orthonormal</a> ()</td></tr>
|
|
<tr class="memdesc:aca77897ef5c27c69374b4d9555e5b332 inherit pub_methods_structfaiss_1_1LinearTransform"><td class="mdescLeft"> </td><td class="mdescRight">compute A^T * A to set the is_orthonormal flag <br/></td></tr>
|
|
<tr class="separator:aca77897ef5c27c69374b4d9555e5b332 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:a07ad0c0c84f96a6880c1c8eaf09596e3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07ad0c0c84f96a6880c1c8eaf09596e3"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1OPQMatrix.html#a07ad0c0c84f96a6880c1c8eaf09596e3">M</a></td></tr>
|
|
<tr class="memdesc:a07ad0c0c84f96a6880c1c8eaf09596e3"><td class="mdescLeft"> </td><td class="mdescRight">nb of subquantizers <br/></td></tr>
|
|
<tr class="separator:a07ad0c0c84f96a6880c1c8eaf09596e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12cb3e05989dee37592b682070c31000"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12cb3e05989dee37592b682070c31000"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1OPQMatrix.html#a12cb3e05989dee37592b682070c31000">niter</a></td></tr>
|
|
<tr class="memdesc:a12cb3e05989dee37592b682070c31000"><td class="mdescLeft"> </td><td class="mdescRight">Number of outer training iterations. <br/></td></tr>
|
|
<tr class="separator:a12cb3e05989dee37592b682070c31000"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab88c87a3931ec356904abf5f1f797a83"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab88c87a3931ec356904abf5f1f797a83"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1OPQMatrix.html#ab88c87a3931ec356904abf5f1f797a83">niter_pq</a></td></tr>
|
|
<tr class="memdesc:ab88c87a3931ec356904abf5f1f797a83"><td class="mdescLeft"> </td><td class="mdescRight">Number of training iterations for the PQ. <br/></td></tr>
|
|
<tr class="separator:ab88c87a3931ec356904abf5f1f797a83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6406e97b05c831cc19b9343be3b43a1f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6406e97b05c831cc19b9343be3b43a1f"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1OPQMatrix.html#a6406e97b05c831cc19b9343be3b43a1f">niter_pq_0</a></td></tr>
|
|
<tr class="memdesc:a6406e97b05c831cc19b9343be3b43a1f"><td class="mdescLeft"> </td><td class="mdescRight">same, for the first outer iteration <br/></td></tr>
|
|
<tr class="separator:a6406e97b05c831cc19b9343be3b43a1f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdd5b2c74d19ccc5c7a6e0199333321a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdd5b2c74d19ccc5c7a6e0199333321a"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1OPQMatrix.html#afdd5b2c74d19ccc5c7a6e0199333321a">max_train_points</a></td></tr>
|
|
<tr class="memdesc:afdd5b2c74d19ccc5c7a6e0199333321a"><td class="mdescLeft"> </td><td class="mdescRight">if there are too many training points, resample <br/></td></tr>
|
|
<tr class="separator:afdd5b2c74d19ccc5c7a6e0199333321a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf181dd944511a81803abba538ecc4b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf181dd944511a81803abba538ecc4b5"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>verbose</b></td></tr>
|
|
<tr class="separator:abf181dd944511a81803abba538ecc4b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01d3736c8e725f596b99440324544a59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfaiss_1_1ProductQuantizer.html">ProductQuantizer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1OPQMatrix.html#a01d3736c8e725f596b99440324544a59">pq</a></td></tr>
|
|
<tr class="separator:a01d3736c8e725f596b99440324544a59"><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:a8a67a0178eab513cf87545f5d12d9569 inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1LinearTransform.html#a8a67a0178eab513cf87545f5d12d9569">is_orthonormal</a></td></tr>
|
|
<tr class="memdesc:a8a67a0178eab513cf87545f5d12d9569 inherit pub_attribs_structfaiss_1_1LinearTransform"><td class="mdescLeft"> </td><td class="mdescRight">! whether to use the bias term <a href="#a8a67a0178eab513cf87545f5d12d9569">More...</a><br/></td></tr>
|
|
<tr class="separator:a8a67a0178eab513cf87545f5d12d9569 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"><a class="anchor" id="aa40e156ef57fe206cd5f3a58ec0660da"></a>
|
|
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">Transformation matrix, size d_out * d_in. <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#ad3f0d3071f987baabbdd3da4500c87ea">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 rotation to align the dimensions with a PQ to minimize the reconstruction error. Can be used before an <a class="el" href="structfaiss_1_1IndexPQ.html">IndexPQ</a> or an <a class="el" href="structfaiss_1_1IndexIVFPQ.html">IndexIVFPQ</a>. The method is the non-parametric version described in:</p>
|
|
<p>"Optimized Product Quantization for Approximate Nearest Neighbor Search" Tiezheng Ge, Kaiming He, Qifa Ke, Jian Sun, CVPR'13 </p>
|
|
|
|
<p>Definition at line <a class="el" href="VectorTransform_8h_source.html#l00188">188</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="a1e314577db0c6cd4a709503f73eb71e2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OPQMatrix::train </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">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#l00598">598</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="a01d3736c8e725f596b99440324544a59"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfaiss_1_1ProductQuantizer.html">ProductQuantizer</a>* faiss::OPQMatrix::pq</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>if non-NULL, use this product quantizer for training should be constructed with (d_out, M, _) </p>
|
|
|
|
<p>Definition at line <a class="el" href="VectorTransform_8h_source.html#l00201">201</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/hoss/faiss/<a class="el" href="VectorTransform_8h_source.html">VectorTransform.h</a></li>
|
|
<li>/data/users/hoss/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>
|