Math.Gmp.Native/docs/html/480d1d15-b561-ac8f-b12a-f27ba075b3f2.htm

49 lines
95 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_scan1 Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="mpz_scan1 method" /><meta name="System.Keywords" content="gmp_lib.mpz_scan1 method" /><meta name="Microsoft.Help.F1" content="Math.Gmp.Native.gmp_lib.mpz_scan1" /><meta name="Microsoft.Help.Id" content="M:Math.Gmp.Native.gmp_lib.mpz_scan1(Math.Gmp.Native.mpz_t,Math.Gmp.Native.mp_bitcnt_t)" /><meta name="Description" content="Scan for 1 bit." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Math.Gmp.Native" /><meta name="file" content="480d1d15-b561-ac8f-b12a-f27ba075b3f2" /><meta name="guid" content="480d1d15-b561-ac8f-b12a-f27ba075b3f2" /><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 data-tochassubtree="false" href="fe6e46c3-8464-a080-b5fc-718589320cd5.htm" title="gmp_asprintf
2017-11-08 01:29:10 +01:00
Scan <span class="parameter">op</span> for 1 bit.
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="identifier">mp_bitcnt_t</span> <span class="identifier">mpz_scan1</span>(
<span class="identifier">mpz_t</span> <span class="parameter">op</span>,
<span class="identifier">mp_bitcnt_t</span> <span class="parameter">starting_bit</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">Function</span> <span class="identifier">mpz_scan1</span> (
<span class="parameter">op</span> <span class="keyword">As</span> <span class="identifier">mpz_t</span>,
<span class="parameter">starting_bit</span> <span class="keyword">As</span> <span class="identifier">mp_bitcnt_t</span>
) <span class="keyword">As</span> <span class="identifier">mp_bitcnt_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="identifier">mp_bitcnt_t</span> <span class="identifier">mpz_scan1</span>(
<span class="identifier">mpz_t</span>^ <span class="parameter">op</span>,
<span class="identifier">mp_bitcnt_t</span> <span class="parameter">starting_bit</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_scan1</span> :
<span class="parameter">op</span> : <span class="identifier">mpz_t</span> *
<span class="parameter">starting_bit</span> : <span class="identifier">mp_bitcnt_t</span> <span class="keyword">-&gt;</span> <span class="identifier">mp_bitcnt_t</span>
</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><h4 class="subHeading">Parameters</h4><dl><dt><span class="parameter">op</span></dt><dd>Type: <a href="8beda7fb-bbc4-b56f-fd1f-1459377ecb3b.htm">Math.Gmp.Native<span id="LSTC1BED726_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC1BED726_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mpz_t</a><br />The operand integer.</dd><dt><span class="parameter">starting_bit</span></dt><dd>Type: <a href="1b2b1d64-20c1-7a64-0278-d9ff58ee9cc3.htm">Math.Gmp.Native<span id="LSTC1BED726_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTC1BED726_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_bitcnt_t</a><br />The start bit index position.</dd></dl><h4 class="subHeading">Return Value</h4>Type: <a href="1b2b1d64-20c1-7a64-0278-d9ff58ee9cc3.htm">mp_bitcnt_t</a><br />Return the index of the found bit.</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>
Scan <span class="parameter">op</span>, starting from bit <span class="parameter">starting_bit</span>, towards more significant bits,
2017-11-08 01:29:10 +01:00
until the first 1 bit is found. Return the index of the found bit.
2017-11-04 16:02:37 +01:00
</p><p>
If the bit at <span class="parameter">starting_bit</span> is already whats sought,
then <span class="parameter">starting_bit</span> is returned.
</p><p>
If theres no bit found, then the largest possible <a href="1b2b1d64-20c1-7a64-0278-d9ff58ee9cc3.htm">mp_bitcnt_t</a> is returned.
2017-12-15 02:18:55 +01:00
This will happen in <a href="3e36be2b-14ed-eb7b-0546-af6d49e983fa.htm">mpz_scan0</a> past the end of a negative number,
or <span class="selflink">mpz_scan1</span> past the end of a nonnegative number.
2017-11-04 16:02:37 +01:00
</p><p>
The function behaves as if twos complement arithmetic were used (although sign-magnitude is the actual implementation).
2017-11-08 01:29:10 +01:00
The least significant bit is number 0.
2017-11-04 16:02:37 +01:00
</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 set the value of op to 70.</span>
mpz_t op = <span class="highlight-keyword">new</span> mpz_t();
gmp_lib.mpz_init_set_ui(op, <span class="highlight-number">70</span>U);
<span class="highlight-comment">// Assert that the first 1 bit starting from bit 3 in op is bit 6.</span>
Assert.IsTrue(gmp_lib.mpz_scan1(op, <span class="highlight-number">3</span>U) == <span class="highlight-number">6</span>U);
<span class="highlight-comment">// Release unmanaged memory allocated for op.</span>
gmp_lib.mpz_clear(op);</pre></div><div id="ID0EDAABA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="highlight-comment">' Create, initialize, and set the value of op to 70.</span>
<span class="highlight-keyword">Dim</span> op <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> mpz_t()
gmp_lib.mpz_init_set_ui(op, <span class="highlight-number">70</span>UI)
<span class="highlight-comment">' Assert that the first 1 bit starting from bit 3 in op is bit 6.</span>
Assert.IsTrue(gmp_lib.mpz_scan1(op, <span class="highlight-number">3</span>UI) = <span class="highlight-number">6</span>UI)
<span class="highlight-comment">' Release unmanaged memory allocated for op.</span>
2018-01-06 17:23:30 +01:00
gmp_lib.mpz_clear(op)</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="3e5268ed-796b-2880-93a3-8d17143f99b1.htm">mpz_and</a></div><div class="seeAlsoStyle"><a href="0ccb1bab-4817-1062-242d-41c181cacf77.htm">mpz_ior</a></div><div class="seeAlsoStyle"><a href="fd4c285a-e2e1-f8ba-97b3-08d4ae6a2ebf.htm">mpz_xor</a></div><div class="seeAlsoStyle"><a href="635ddf01-9c52-0d37-202e-c560b895fb7d.htm">mpz_com</a></div><div class="seeAlsoStyle"><a href="84bf95e4-d9d0-4ffe-f836-3650342de962.htm">mpz_popcount</a></div><div class="seeAlsoStyle"><a href="4dfb8bd5-8a6f-6919-7aa9-8c060d42b5d7.htm">mpz_hamdist</a></div><div class="seeAlsoStyle"><a href="3e36be2b-14ed-eb7b-0546-af6d49e983fa.htm">mpz_scan0</a></div><div class="seeAlsoStyle"><a href="f0caf821-320b-1a8b-87ff-84fcbdfd5801.htm">mpz_setbit</a></div><div class="seeAlsoStyle"><a href="8812c658-675a-b564-9159-2383971747b1.htm">mpz_clrbit</a></div><div class="seeAlsoStyle"><a href="4a959468-7670-9303-a5e7-3f1de8f17a62.htm">mpz_combit</a></div><div class="seeAlsoStyle"><a href="20a476ea-9a38-9ef3-1e23-da2b2eba69a9.htm">mpz_tstbit</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_Logic_and_Bit_Fiddling">Integer Logic and Bit Fiddling</a></a></div><div class="seeAlsoStyle"><a href="3af6b34c-3242-2b75-e7c7-ab79af8a4b0f.htm"><a href="https://gmplib.org/manual/Integer-Logic-and-Bit-Fiddling.html#Integer-Logic-and-Bit-Fiddling">GNU MP - Integer Logic and Bit Fiddling</a></a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>