2017-02-23 06:26:44 +08:00
<!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 >
2019-05-28 22:17:22 +08:00
< tr class = "memitem:a8f2dd12da8dce3cbeb22da9c5d4ec3e7" > < td class = "memItemLeft" align = "right" valign = "top" > 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#ad3f0d3071f987baabbdd3da4500c87ea" > Index::idx_t< / a > n, const float *x) override< / td > < / tr >
2017-02-23 06:26:44 +08:00
< tr class = "separator:a8f2dd12da8dce3cbeb22da9c5d4ec3e7" > < 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 >
2017-06-21 21:54:28 +08:00
< 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 >
2017-02-23 06:26:44 +08:00
< 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 >
2018-01-09 22:44:43 +08:00
< 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 >
2017-02-23 06:26:44 +08:00
< 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 >
2017-03-21 01:33:21 +08:00
< 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 >
2017-02-23 06:26:44 +08:00
< 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 >
2018-01-09 22:44:43 +08:00
< 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 >
2017-02-23 06:26:44 +08:00
< 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 >
2019-05-28 22:17:22 +08:00
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 >
2017-02-23 06:26:44 +08:00
< 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 >
2019-05-28 22:17:22 +08:00
< p > Definition at line < a class = "el" href = "VectorTransform_8h_source.html#l00133" > 133< / a > of file < a class = "el" href = "VectorTransform_8h_source.html" > VectorTransform.h< / a > .< / p >
2017-02-23 06:26:44 +08:00
< / div > < h2 class = "groupheader" > Member Function Documentation< / h2 >
< 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 >
2019-05-28 22:17:22 +08:00
< td class = "paramtype" > < a class = "el" href = "structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea" > Index::idx_t< / a >   < / td >
2017-02-23 06:26:44 +08:00
< 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" >
2017-06-21 21:54:28 +08:00
< p > train on n vectors. If n < d_in then the eigenvector matrix will be completed with 0s < / p >
2017-02-23 06:26:44 +08:00
< p > Reimplemented from < a class = "el" href = "structfaiss_1_1VectorTransform.html#a7350d4dd28d60866d55ba4f75d2da84c" > faiss::VectorTransform< / a > .< / p >
2018-12-20 00:48:35 +08:00
< p > Definition at line < a class = "el" href = "VectorTransform_8cpp_source.html#l00325" > 325< / a > of file < a class = "el" href = "VectorTransform_8cpp_source.html" > VectorTransform.cpp< / a > .< / p >
2017-02-23 06:26:44 +08:00
< / 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 >
2018-12-20 00:48:35 +08:00
< p > =0: no whitening =-0.5: full whitening < / p >
2017-02-23 06:26:44 +08:00
2019-05-28 22:17:22 +08:00
< p > Definition at line < a class = "el" href = "VectorTransform_8h_source.html#l00141" > 141< / a > of file < a class = "el" href = "VectorTransform_8h_source.html" > VectorTransform.h< / a > .< / p >
2017-02-23 06:26:44 +08:00
< / div >
< / div >
< hr / > The documentation for this struct was generated from the following files:< ul >
2019-05-28 22:17:22 +08:00
< 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 >
2017-02-23 06:26:44 +08:00
< / 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 >
