Math.Gmp.Native/docs/html/7dfe367e-74d3-e782-860b-231...

56 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_sizeinbase Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="mpz_sizeinbase method" /><meta name="System.Keywords" content="gmp_lib.mpz_sizeinbase method" /><meta name="Microsoft.Help.F1" content="Math.Gmp.Native.gmp_lib.mpz_sizeinbase" /><meta name="Microsoft.Help.Id" content="M:Math.Gmp.Native.gmp_lib.mpz_sizeinbase(Math.Gmp.Native.mpz_t,System.Int32)" /><meta name="Description" content="Return the size of measured in number of digits in the given ." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Math.Gmp.Native" /><meta name="file" content="7dfe367e-74d3-e782-860b-2314da9c44cf" /><meta name="guid" content="7dfe367e-74d3-e782-860b-2314da9c44cf" /><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="fe6e
2017-11-04 16:02:37 +01:00
Return the size of <span class="parameter">op</span> measured in number of digits in the given <span class="parameter">base</span>.
</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">size_t</span> <span class="identifier">mpz_sizeinbase</span>(
<span class="identifier">mpz_t</span> <span class="parameter">op</span>,
<span class="identifier">int</span> <span class="parameter">base</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_sizeinbase</span> (
<span class="parameter">op</span> <span class="keyword">As</span> <span class="identifier">mpz_t</span>,
<span class="parameter">base</span> <span class="keyword">As</span> <span class="identifier">Integer</span>
) <span class="keyword">As</span> <span class="identifier">size_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">size_t</span> <span class="identifier">mpz_sizeinbase</span>(
<span class="identifier">mpz_t</span>^ <span class="parameter">op</span>,
<span class="identifier">int</span> <span class="parameter">base</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_sizeinbase</span> :
<span class="parameter">op</span> : <span class="identifier">mpz_t</span> *
<span class="parameter">base</span> : <span class="identifier">int</span> <span class="keyword">-&gt;</span> <span class="identifier">size_t</span>
2017-11-08 01:29:10 +01:00
</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="LSTFF84E507_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTFF84E507_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mpz_t</a><br />The operand integer</dd><dt><span class="parameter">base</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/td2s409d" target="_blank">System<span id="LSTFF84E507_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTFF84E507_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Int32</a><br />The base.</dd></dl><h4 class="subHeading">Return Value</h4>Type: <a href="d9761bfb-1882-59d2-e89b-c6460141f9a6.htm">size_t</a><br />The size of <span class="parameter">op</span> measured in number of digits in the given <span class="parameter">base</span>.</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><span class="parameter">base</span> can vary from 2 to 62.
2017-11-04 16:02:37 +01:00
The sign of <span class="parameter">op</span> is ignored, just the absolute value is used.
The result will be either exact or 1 too big.
If <span class="parameter">base</span> is a power of 2, the result is always exact.
2017-11-08 01:29:10 +01:00
If <span class="parameter">op</span> is zero the return value is always 1.
2017-11-04 16:02:37 +01:00
</p><p>
This function can be used to determine the space required when converting <span class="parameter">op</span> to a string.
2017-12-15 02:18:55 +01:00
The right amount of allocation is normally two more than the value returned by <span class="selflink">mpz_sizeinbase</span>,
2017-11-04 16:02:37 +01:00
one extra for a minus sign and one for the null-terminator.
</p><p>
2017-11-08 01:29:10 +01:00
It will be noted that mpz_sizeinbase(<span class="parameter">op</span>, 2) can be used to locate the most
significant 1 bit in <span class="parameter">op</span>, counting from 1.
(Unlike the bitwise functions which start from 0,
2017-11-04 16:02:37 +01:00
see <a href="https://gmplib.org/manual/Integer-Logic-and-Bit-Fiddling.html#Integer-Logic-and-Bit-Fiddling">GNU MP - Logical and Bit Manipulation Functions</a>.)
</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 10000.</span>
mpz_t op = <span class="highlight-keyword">new</span> mpz_t();
gmp_lib.mpz_init_set_si(op, <span class="highlight-number">10000</span>);
<span class="highlight-comment">// Assert size in different bases.</span>
Assert.IsTrue(gmp_lib.mpz_sizeinbase(op, <span class="highlight-number">2</span>) == <span class="highlight-number">14</span>);
Assert.IsTrue(gmp_lib.mpz_sizeinbase(op, <span class="highlight-number">8</span>) == <span class="highlight-number">5</span>);
Assert.IsTrue(gmp_lib.mpz_sizeinbase(op, <span class="highlight-number">10</span>) == <span class="highlight-number">5</span>);
Assert.IsTrue(gmp_lib.mpz_sizeinbase(op, <span class="highlight-number">16</span>) == <span class="highlight-number">4</span>);
<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 10000.</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_si(op, <span class="highlight-number">10000</span>)
<span class="highlight-comment">' Assert size in different bases.</span>
Assert.IsTrue(gmp_lib.mpz_sizeinbase(op, <span class="highlight-number">2</span>) = <span class="highlight-number">14</span>)
Assert.IsTrue(gmp_lib.mpz_sizeinbase(op, <span class="highlight-number">8</span>) = <span class="highlight-number">5</span>)
Assert.IsTrue(gmp_lib.mpz_sizeinbase(op, <span class="highlight-number">10</span>) = <span class="highlight-number">5</span>)
Assert.IsTrue(gmp_lib.mpz_sizeinbase(op, <span class="highlight-number">16</span>) = <span class="highlight-number">4</span>)
<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="fb9e7caf-b049-7884-b70c-185053972604.htm">mpz_fits_ulong_p</a></div><div class="seeAlsoStyle"><a href="cad028df-c3f1-12b6-d8dd-56c4968730e4.htm">mpz_fits_slong_p</a></div><div class="seeAlsoStyle"><a href="3ce0cc26-e888-90f8-a517-aad88332eec0.htm">mpz_fits_uint_p</a></div><div class="seeAlsoStyle"><a href="a066df5a-c312-3b00-6092-6f914c3ee248.htm">mpz_fits_sint_p</a></div><div class="seeAlsoStyle"><a href="6b85c6a3-d6c5-d1d2-829a-af000bae687e.htm">mpz_fits_ushort_p</a></div><div class="seeAlsoStyle"><a href="e07f3328-a28c-c75c-10a6-f21d05e6aec0.htm">mpz_fits_sshort_p</a></div><div class="seeAlsoStyle"><a href="6820d6c4-6ee1-53d7-7223-3f654a496ce4.htm">mpz_odd_p</a></div><div class="seeAlsoStyle"><a href="e6012778-c71b-b078-2ef3-9f9db90f1769.htm">mpz_even_p</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#Miscellaneous_Integer_Functions">Miscellaneous Integer Functions</a></a></div><div class="seeAlsoStyle"><a href="3af6b34c-3242-2b75-e7c7-ab79af8a4b0f.htm"><a href="https://gmplib.org/manual/Miscellaneous-Integer-Functions.html#Miscellaneous-Integer-Functions">GNU MP - Miscellaneous Integer Functions</a></a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>