faiss/docs/html/structfaiss_1_1ReproduceDis...

176 lines
13 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::ReproduceDistancesObjective 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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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_1ReproduceDistancesObjective.html">ReproduceDistancesObjective</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfaiss_1_1ReproduceDistancesObjective-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::ReproduceDistancesObjective Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for faiss::ReproduceDistancesObjective:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1ReproduceDistancesObjective.png" usemap="#faiss::ReproduceDistancesObjective_map" alt=""/>
<map id="faiss::ReproduceDistancesObjective_map" name="faiss::ReproduceDistancesObjective_map">
<area href="structfaiss_1_1PermutationObjective.html" title="abstract class for the loss function " alt="faiss::PermutationObjective" shape="rect" coords="0,0,215,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:ac73b13be6987441980029441c7e47c5a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac73b13be6987441980029441c7e47c5a"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>dis_weight</b> (double x) const </td></tr>
<tr class="separator:ac73b13be6987441980029441c7e47c5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a293957f71ead88c9bb591a4f1d3fa446"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a293957f71ead88c9bb591a4f1d3fa446"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>get_source_dis</b> (int i, int j) const </td></tr>
<tr class="separator:a293957f71ead88c9bb591a4f1d3fa446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d100606c9d4ede9fbb0e169ded94c48"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d100606c9d4ede9fbb0e169ded94c48"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>compute_cost</b> (const int *perm) const override</td></tr>
<tr class="separator:a2d100606c9d4ede9fbb0e169ded94c48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc77e29c06e64613b49509b619f39562"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc77e29c06e64613b49509b619f39562"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>cost_update</b> (const int *perm, int iw, int jw) const override</td></tr>
<tr class="separator:afc77e29c06e64613b49509b619f39562"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a591ea5b89e4251dc2f815b8dfec565e6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a591ea5b89e4251dc2f815b8dfec565e6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ReproduceDistancesObjective</b> (int n, const double *source_dis_in, const double *target_dis_in, double dis_weight_factor)</td></tr>
<tr class="separator:a591ea5b89e4251dc2f815b8dfec565e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af675185da58506f690bed932d39ad8e4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af675185da58506f690bed932d39ad8e4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>set_affine_target_dis</b> (const double *source_dis_in)</td></tr>
<tr class="separator:af675185da58506f690bed932d39ad8e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a487163847843e09da40939bd0044ab41"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a487163847843e09da40939bd0044ab41"></a>
static double&#160;</td><td class="memItemRight" valign="bottom"><b>sqr</b> (double x)</td></tr>
<tr class="separator:a487163847843e09da40939bd0044ab41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7e3f8d3ebeaca3b8d88601c2ebd37c1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7e3f8d3ebeaca3b8d88601c2ebd37c1"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>compute_mean_stdev</b> (const double *tab, size_t n2, double *mean_out, double *stddev_out)</td></tr>
<tr class="separator:af7e3f8d3ebeaca3b8d88601c2ebd37c1"><td class="memSeparator" colspan="2">&#160;</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:a96a76020f14210f5f161565bacda84ab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96a76020f14210f5f161565bacda84ab"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>dis_weight_factor</b></td></tr>
<tr class="separator:a96a76020f14210f5f161565bacda84ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6681846eb7751b32a907d075fff6770b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6681846eb7751b32a907d075fff6770b"></a>
std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ReproduceDistancesObjective.html#a6681846eb7751b32a907d075fff6770b">source_dis</a></td></tr>
<tr class="memdesc:a6681846eb7751b32a907d075fff6770b"><td class="mdescLeft">&#160;</td><td class="mdescRight">"real" corrected distances (size n^2) <br/></td></tr>
<tr class="separator:a6681846eb7751b32a907d075fff6770b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac99d739f81e13e841ba7d81d90629aef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac99d739f81e13e841ba7d81d90629aef"></a>
const double *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ReproduceDistancesObjective.html#ac99d739f81e13e841ba7d81d90629aef">target_dis</a></td></tr>
<tr class="memdesc:ac99d739f81e13e841ba7d81d90629aef"><td class="mdescLeft">&#160;</td><td class="mdescRight">wanted distances (size n^2) <br/></td></tr>
<tr class="separator:ac99d739f81e13e841ba7d81d90629aef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a982332b44ff32b9ae9694e374acd0aff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a982332b44ff32b9ae9694e374acd0aff"></a>
std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ReproduceDistancesObjective.html#a982332b44ff32b9ae9694e374acd0aff">weights</a></td></tr>
<tr class="memdesc:a982332b44ff32b9ae9694e374acd0aff"><td class="mdescLeft">&#160;</td><td class="mdescRight">weights for each distance (size n^2) <br/></td></tr>
<tr class="separator:a982332b44ff32b9ae9694e374acd0aff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structfaiss_1_1PermutationObjective"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1PermutationObjective')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structfaiss_1_1PermutationObjective.html">faiss::PermutationObjective</a></td></tr>
<tr class="memitem:a81657be192b4589b13a3f51fc0765c2f inherit pub_attribs_structfaiss_1_1PermutationObjective"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81657be192b4589b13a3f51fc0765c2f"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>n</b></td></tr>
<tr class="separator:a81657be192b4589b13a3f51fc0765c2f inherit pub_attribs_structfaiss_1_1PermutationObjective"><td class="memSeparator" colspan="2">&#160;</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="PolysemousTraining_8h_source.html#l00054">54</a> of file <a class="el" href="PolysemousTraining_8h_source.html">PolysemousTraining.h</a>.</p>
</div><hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/hoss/faiss/<a class="el" href="PolysemousTraining_8h_source.html">PolysemousTraining.h</a></li>
<li>/data/users/hoss/faiss/<a class="el" href="PolysemousTraining_8cpp_source.html">PolysemousTraining.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>