175 lines
12 KiB
HTML
175 lines
12 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::RandomGenerator 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_1RandomGenerator.html">RandomGenerator</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="structfaiss_1_1RandomGenerator-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::RandomGenerator Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>random generator that can be used in multithreaded contexts
|
|
<a href="structfaiss_1_1RandomGenerator.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="utils_8h_source.html">utils.h</a>></code></p>
|
|
<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:a583f124ecacdbe037ac96e23a44dd420"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a583f124ecacdbe037ac96e23a44dd420"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RandomGenerator.html#a583f124ecacdbe037ac96e23a44dd420">rand_int</a> ()</td></tr>
|
|
<tr class="memdesc:a583f124ecacdbe037ac96e23a44dd420"><td class="mdescLeft"> </td><td class="mdescRight">random 31-bit positive integer <br/></td></tr>
|
|
<tr class="separator:a583f124ecacdbe037ac96e23a44dd420"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acbceaa8b017793ca4f8d90e644b0d7f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbceaa8b017793ca4f8d90e644b0d7f4"></a>
|
|
long </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RandomGenerator.html#acbceaa8b017793ca4f8d90e644b0d7f4">rand_long</a> ()</td></tr>
|
|
<tr class="memdesc:acbceaa8b017793ca4f8d90e644b0d7f4"><td class="mdescLeft"> </td><td class="mdescRight">random long < 2 ^ 62 <br/></td></tr>
|
|
<tr class="separator:acbceaa8b017793ca4f8d90e644b0d7f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa460b9bac2593cd1d71305e10ab51af6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RandomGenerator.html#aa460b9bac2593cd1d71305e10ab51af6">rand_int</a> (int max)</td></tr>
|
|
<tr class="memdesc:aa460b9bac2593cd1d71305e10ab51af6"><td class="mdescLeft"> </td><td class="mdescRight">generate random number between 0 and max-1 <a href="#aa460b9bac2593cd1d71305e10ab51af6">More...</a><br/></td></tr>
|
|
<tr class="separator:aa460b9bac2593cd1d71305e10ab51af6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac82a433d7bfa56d750907ba5cf74aed7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac82a433d7bfa56d750907ba5cf74aed7"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RandomGenerator.html#ac82a433d7bfa56d750907ba5cf74aed7">rand_float</a> ()</td></tr>
|
|
<tr class="memdesc:ac82a433d7bfa56d750907ba5cf74aed7"><td class="mdescLeft"> </td><td class="mdescRight">between 0 and 1 <br/></td></tr>
|
|
<tr class="separator:ac82a433d7bfa56d750907ba5cf74aed7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd824911e83a956b21d0168f8b4f2364"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd824911e83a956b21d0168f8b4f2364"></a>
|
|
double </td><td class="memItemRight" valign="bottom"><b>rand_double</b> ()</td></tr>
|
|
<tr class="separator:abd824911e83a956b21d0168f8b4f2364"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7633c373153f3b2824d2d99382ba20ab"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7633c373153f3b2824d2d99382ba20ab"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RandomGenerator.html#a7633c373153f3b2824d2d99382ba20ab">RandomGenerator</a> (long seed=1234)</td></tr>
|
|
<tr class="memdesc:a7633c373153f3b2824d2d99382ba20ab"><td class="mdescLeft"> </td><td class="mdescRight">initialize <br/></td></tr>
|
|
<tr class="separator:a7633c373153f3b2824d2d99382ba20ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16c42957c159dbd910c15856a6b135de"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16c42957c159dbd910c15856a6b135de"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1RandomGenerator.html#a16c42957c159dbd910c15856a6b135de">RandomGenerator</a> (const <a class="el" href="structfaiss_1_1RandomGenerator.html">RandomGenerator</a> &other)</td></tr>
|
|
<tr class="memdesc:a16c42957c159dbd910c15856a6b135de"><td class="mdescLeft"> </td><td class="mdescRight">default copy constructor messes up pointer in rand_data <br/></td></tr>
|
|
<tr class="separator:a16c42957c159dbd910c15856a6b135de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>random generator that can be used in multithreaded contexts </p>
|
|
|
|
<p>Definition at line <a class="el" href="utils_8h_source.html#l00048">48</a> of file <a class="el" href="utils_8h_source.html">utils.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="aa460b9bac2593cd1d71305e10ab51af6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int faiss::RandomGenerator::rand_int </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>max</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>generate random number between 0 and max-1 </p>
|
|
<p>The definition of random functions depends on the architecture:</p>
|
|
<ul>
|
|
<li>for Linux, we rely on re-entrant functions (random_r). This provides good quality reproducible random sequences.</li>
|
|
<li>for Apple, we use rand_r. Apple is trying so hard to deprecate this function that it removed its definition form stdlib.h, so we re-declare it below. Fortunately, since it is deprecated, its prototype should not change much in the forerseeable future.</li>
|
|
</ul>
|
|
<p>Unfortunately, system designers are more concerned with making the most unpredictable random sequences for cryptographic use, when in scientific contexts what acutally matters is having reproducible squences in multi-threaded contexts. </p>
|
|
|
|
<p>Definition at line <a class="el" href="utils_8cpp_source.html#l00201">201</a> of file <a class="el" href="utils_8cpp_source.html">utils.cpp</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="utils_8h_source.html">utils.h</a></li>
|
|
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="utils_8cpp_source.html">utils.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>
|