Math.Gmp.Native/docs/html/981cfca4-f958-045f-84b7-01717fcd88d1.htm

70 lines
96 KiB
HTML
Raw Normal View History

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>gmp_lib.mpz_urandomm Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="mpz_urandomm method" /><meta name="System.Keywords" content="gmp_lib.mpz_urandomm method" /><meta name="Microsoft.Help.F1" content="Math.Gmp.Native.gmp_lib.mpz_urandomm" /><meta name="Microsoft.Help.Id" content="M:Math.Gmp.Native.gmp_lib.mpz_urandomm(Math.Gmp.Native.mpz_t,Math.Gmp.Native.gmp_randstate_t,Math.Gmp.Native.mpz_t)" /><meta name="Description" content="Generate a uniform random integer in the range 0 to - 1, inclusive." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Math.Gmp.Native" /><meta name="file" content="981cfca4-f958-045f-84b7-01717fcd88d1" /><meta name="guid" content="981cfca4-f958-045f-84b7-01717fcd88d1" /><link type="text/css" rel="stylesheet" href="../styles/highlight.css" /><script type="text/javascript" src="../scripts/highlight.js"> </script><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">GMP Native Interface for .NET<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="846f5c8a-6cba-433e-9f18-cde2ff5695cd.htm" title="GMP Native Interface for .NET" tocid="roottoc">GMP Native Interface for .NET</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="d9c51b9f-0c54-770b-28ea-6eebd8fef368.htm" title="Math.Gmp.Native" tocid="d9c51b9f-0c54-770b-28ea-6eebd8fef368">Math.Gmp.Native</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="3af6b34c-3242-2b75-e7c7-ab79af8a4b0f.htm" title="gmp_lib Class" tocid="3af6b34c-3242-2b75-e7c7-ab79af8a4b0f">gmp_lib Class</a></div><div class="toclevel1" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="0fa7cbf3-e8f4-6b14-d829-8aa663e77c74.htm" title="gmp_lib Methods" tocid="0fa7cbf3-e8f4-6b14-d829-8aa663e77c74">gmp_lib Methods</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="c9cb6a67-59b8-5c03-f31d-f252441c53f6.htm" title="_mpz_realloc Method " tocid="c9cb6a67-59b8-5c03-f31d-f252441c53f6">_mpz_realloc Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="2c68671c-cd5c-e2ec-52a2-65b0ca31c3d1.htm" title="allocate Method " tocid="2c68671c-cd5c-e2ec-52a2-65b0ca31c3d1">allocate Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="92160da3-b1af-e005-cb05-e3fb4dd524d8.htm" title="free Method " tocid="92160da3-b1af-e005-cb05-e3fb4dd524d8">free Method </a></div><div class="toclevel2" data-toclevel="2"><a d
2017-11-08 01:29:10 +01:00
Generate a uniform random integer in the range 0 to <span class="parameter">n</span> - 1, inclusive.
2017-11-04 16:02:37 +01:00
</div><p> </p>
<strong>Namespace:</strong>
 <a href="d9c51b9f-0c54-770b-28ea-6eebd8fef368.htm">Math.Gmp.Native</a><br />
<strong>Assembly:</strong>
 Math.Gmp.Native (in Math.Gmp.Native.dll) Version: 1.0.0.0 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cs','1','4');return false;">C#</a></div><div id="ID0EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','vb','2','4');return false;">VB</a></div><div id="ID0EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cpp','3','4');return false;">C++</a></div><div id="ID0EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EDCA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID0EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">mpz_urandomm</span>(
<span class="identifier">mpz_t</span> <span class="parameter">rop</span>,
<span class="identifier">gmp_randstate_t</span> <span class="parameter">state</span>,
<span class="identifier">mpz_t</span> <span class="parameter">n</span>
)</pre></div><div id="ID0EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Shared</span> <span class="keyword">Sub</span> <span class="identifier">mpz_urandomm</span> (
<span class="parameter">rop</span> <span class="keyword">As</span> <span class="identifier">mpz_t</span>,
<span class="parameter">state</span> <span class="keyword">As</span> <span class="identifier">gmp_randstate_t</span>,
<span class="parameter">n</span> <span class="keyword">As</span> <span class="identifier">mpz_t</span>
)</pre></div><div id="ID0EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span>:
<span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">mpz_urandomm</span>(
<span class="identifier">mpz_t</span>^ <span class="parameter">rop</span>,
<span class="identifier">gmp_randstate_t</span>^ <span class="parameter">state</span>,
<span class="identifier">mpz_t</span>^ <span class="parameter">n</span>
)</pre></div><div id="ID0EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">static</span> <span class="keyword">member</span> <span class="identifier">mpz_urandomm</span> :
<span class="parameter">rop</span> : <span class="identifier">mpz_t</span> *
<span class="parameter">state</span> : <span class="identifier">gmp_randstate_t</span> *
<span class="parameter">n</span> : <span class="identifier">mpz_t</span> <span class="keyword">-&gt;</span> <span class="keyword">unit</span>
</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><h4 class="subHeading">Parameters</h4><dl><dt><span class="parameter">rop</span></dt><dd>Type: <a href="8beda7fb-bbc4-b56f-fd1f-1459377ecb3b.htm">Math.Gmp.Native<span id="LSTAE5E36AB_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTAE5E36AB_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mpz_t</a><br />The result integer.</dd><dt><span class="parameter">state</span></dt><dd>Type: <a href="f7e5846d-548d-3bf3-74ac-219fde42a041.htm">Math.Gmp.Native<span id="LSTAE5E36AB_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTAE5E36AB_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>gmp_randstate_t</a><br />The random number generator state.</dd><dt><span class="parameter">n</span></dt><dd>Type: <a href="8beda7fb-bbc4-b56f-fd1f-1459377ecb3b.htm">Math.Gmp.Native<span id="LSTAE5E36AB_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTAE5E36AB_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mpz_t</a><br />The operand integer.</dd></dl></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Remarks</span></div><div id="ID2RBSection" class="collapsibleSection"><p>
The variable <span class="parameter">state</span> must be initialized by calling one of the <span class="code">gmp_randinit</span>
functions (<a href="https://gmplib.org/manual/Random-State-Initialization.html#Random-State-Initialization">GNU MP - Random State Initialization</a>) before invoking this function.
</p><p>
The random number functions of GMP come in two groups; older function that rely on a global state,
and newer functions that accept a state parameter that is read and modified.
Please see the <a href="https://gmplib.org/manual/Random-Number-Functions.html#Random-Number-Functions">GNU MP - Random Number Functions</a>
for more information on how to use and not to use random number functions.
</p></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Examples</span></div><div id="ID3RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EDAABA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDAABA','cs','1','4');return false;">C#</a></div><div id="ID0EDAABA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDAABA','vb','2','4');return false;">VB</a></div><div id="ID0EDAABA_tab3" class="codeSnippetContainerTabPhantom"><a href="#" onclick="javascript:ChangeTab('ID0EDAABA','cpp','3','4');return false;">C++</a></div><div id="ID0EDAABA_tab4" class="codeSnippetContainerTabPhantom"><a href="#" onclick="javascript:ChangeTab('ID0EDAABA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EDAABA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID0EDAABA');return false;" title="Copy">Copy</a></div></div><div id="ID0EDAABA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="highlight-comment">// Create, initialize, and seed a new random number generator.</span>
gmp_randstate_t state = <span class="highlight-keyword">new</span> gmp_randstate_t();
gmp_lib.gmp_randinit_mt(state);
gmp_lib.gmp_randseed_ui(state, <span class="highlight-number">100000</span>U);
<span class="highlight-comment">// Create, initialize, and set the value of rop to 0.</span>
mpz_t rop = <span class="highlight-keyword">new</span> mpz_t();
gmp_lib.mpz_init(rop);
<span class="highlight-comment">// Create, initialize, and set a large integer.</span>
mpz_t n = <span class="highlight-keyword">new</span> mpz_t();
char_ptr <span class="highlight-keyword">value</span> = <span class="highlight-keyword">new</span> char_ptr(<span class="highlight-literal">"123 456 789 012 345 678 901"</span>);
gmp_lib.mpz_init_set_str(n, <span class="highlight-keyword">value</span>, <span class="highlight-number">10</span>);
<span class="highlight-comment">// Generate a random integer in the range [0, n-1].</span>
gmp_lib.mpz_urandomm(rop, state, n);
<span class="highlight-comment">// Free all memory occupied by state, rop, and n.</span>
gmp_lib.gmp_randclear(state);
gmp_lib.mpz_clears(rop, n, <span class="highlight-keyword">null</span>);</pre></div><div id="ID0EDAABA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="highlight-comment">' Create, initialize, and seed a new random number generator.</span>
<span class="highlight-keyword">Dim</span> state <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> gmp_randstate_t()
gmp_lib.gmp_randinit_mt(state)
gmp_lib.gmp_randseed_ui(state, <span class="highlight-number">100000</span>UI)
<span class="highlight-comment">' Create, initialize, and set the value of rop to 0.</span>
<span class="highlight-keyword">Dim</span> rop <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> mpz_t()
gmp_lib.mpz_init(rop)
<span class="highlight-comment">' Create, initialize, and set a large integer.</span>
<span class="highlight-keyword">Dim</span> n <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> mpz_t()
<span class="highlight-keyword">Dim</span> value <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> char_ptr(<span class="highlight-literal">"123 456 789 012 345 678 901"</span>)
gmp_lib.mpz_init_set_str(n, value, <span class="highlight-number">10</span>)
<span class="highlight-comment">' Generate a random integer in the range [0, n-1].</span>
gmp_lib.mpz_urandomm(rop, state, n)
<span class="highlight-comment">' Free all memory occupied by state, rop, and n.</span>
gmp_lib.gmp_randclear(state)
2018-01-06 17:23:30 +01:00
gmp_lib.mpz_clears(rop, n, <span class="highlight-keyword">Nothing</span>)</pre></div><div id="ID0EDAABA_code_Div3" class="codeSnippetContainerCode" style="display: none"><p>No code example is currently available or this language may not be supported.</p></div><div id="ID0EDAABA_code_Div4" class="codeSnippetContainerCode" style="display: none"><p>No code example is currently available or this language may not be supported.</p></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDAABA");</script></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID4RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="3af6b34c-3242-2b75-e7c7-ab79af8a4b0f.htm">gmp_lib Class</a></div><div class="seeAlsoStyle"><a href="d9c51b9f-0c54-770b-28ea-6eebd8fef368.htm">Math.Gmp.Native Namespace</a></div><div class="seeAlsoStyle"><a href="c5fc473c-b8dc-8053-4199-e80d58a05230.htm">mpz_urandomb</a></div><div class="seeAlsoStyle"><a href="4be917d3-47c6-cb58-d768-6276e78f0afb.htm">mpz_rrandomb</a></div><div class="seeAlsoStyle"><a href="2b0da39e-331c-878e-26c7-bd6d81c7f8e0.htm">mpz_random</a></div><div class="seeAlsoStyle"><a href="cd88d27d-fb03-9e74-e353-4f0df7a38a96.htm">mpz_random2</a></div><div class="seeAlsoStyle"><a href="3af6b34c-3242-2b75-e7c7-ab79af8a4b0f.htm"><a href="/Math.Gmp.Native/html/3af6b34c-3242-2b75-e7c7-ab79af8a4b0f.htm#Integer_Random_Numbers">Integer Random Numbers</a></a></div><div class="seeAlsoStyle"><a href="3af6b34c-3242-2b75-e7c7-ab79af8a4b0f.htm"><a href="https://gmplib.org/manual/Integer-Random-Numbers.html#Integer-Random-Numbers">GNU MP - Integer Random Numbers</a></a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>