Math.Gmp.Native/docs/html/9a68645a-d8d6-f4c1-f706-0dc217f9809a.htm

75 lines
99 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.mpn_set_str Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="mpn_set_str method" /><meta name="System.Keywords" content="gmp_lib.mpn_set_str method" /><meta name="Microsoft.Help.F1" content="Math.Gmp.Native.gmp_lib.mpn_set_str" /><meta name="Microsoft.Help.Id" content="M:Math.Gmp.Native.gmp_lib.mpn_set_str(Math.Gmp.Native.mp_ptr,Math.Gmp.Native.char_ptr,Math.Gmp.Native.size_t,System.Int32)" /><meta name="Description" content="Convert bytes {, } in the given to limbs at ." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Math.Gmp.Native" /><meta name="file" content="9a68645a-d8d6-f4c1-f706-0dc217f9809a" /><meta name="guid" content="9a68645a-d8d6-f4c1-f706-0dc217f9809a" /><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="
2017-11-04 16:02:37 +01:00
Convert bytes {<span class="parameter">str</span>, <span class="parameter">strsize</span>} in the given <span class="parameter">base</span> to limbs at <span class="parameter">rp</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">mp_size_t</span> <span class="identifier">mpn_set_str</span>(
<span class="identifier">mp_ptr</span> <span class="parameter">rp</span>,
<span class="identifier">char_ptr</span> <span class="parameter">str</span>,
<span class="identifier">size_t</span> <span class="parameter">strsize</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">mpn_set_str</span> (
<span class="parameter">rp</span> <span class="keyword">As</span> <span class="identifier">mp_ptr</span>,
<span class="parameter">str</span> <span class="keyword">As</span> <span class="identifier">char_ptr</span>,
<span class="parameter">strsize</span> <span class="keyword">As</span> <span class="identifier">size_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">mp_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">mp_size_t</span> <span class="identifier">mpn_set_str</span>(
<span class="identifier">mp_ptr</span>^ <span class="parameter">rp</span>,
<span class="identifier">char_ptr</span> <span class="parameter">str</span>,
<span class="identifier">size_t</span> <span class="parameter">strsize</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">mpn_set_str</span> :
<span class="parameter">rp</span> : <span class="identifier">mp_ptr</span> *
<span class="parameter">str</span> : <span class="identifier">char_ptr</span> *
<span class="parameter">strsize</span> : <span class="identifier">size_t</span> *
<span class="parameter">base</span> : <span class="identifier">int</span> <span class="keyword">-&gt;</span> <span class="identifier">mp_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">rp</span></dt><dd>Type: <a href="4609ac5e-5cf9-cd20-2fa9-8040101c165c.htm">Math.Gmp.Native<span id="LSTF9A8C1A6_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF9A8C1A6_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_ptr</a><br />The result integer.</dd><dt><span class="parameter">str</span></dt><dd>Type: <a href="06249483-9daf-95f9-32c7-30195550bbcc.htm">Math.Gmp.Native<span id="LSTF9A8C1A6_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF9A8C1A6_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>char_ptr</a><br />The operand string.</dd><dt><span class="parameter">strsize</span></dt><dd>Type: <a href="d9761bfb-1882-59d2-e89b-c6460141f9a6.htm">Math.Gmp.Native<span id="LSTF9A8C1A6_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF9A8C1A6_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>size_t</a><br />The length of <span class="parameter">str</span>.</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="LSTF9A8C1A6_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF9A8C1A6_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Int32</a><br /></dd></dl><h4 class="subHeading">Return Value</h4>Type: <a href="4b58a584-7a0e-b600-18fa-ebd493861eb3.htm">mp_size_t</a><br />The number of limbs of <span class="parameter">rp</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">str</span>[0] is the most significant input byte and
<span class="parameter">str</span>[<span class="parameter">strsize</span> - 1] is the least significant input byte.
Each byte should be a value in the range 0 to <span class="parameter">base</span> - 1,
not an ASCII character. base can vary from 2 to 256.
2017-11-04 16:02:37 +01:00
</p><p>
2017-11-08 01:29:10 +01:00
The converted value is {<span class="parameter">rp</span>, rn} where rn is the return value.
If the most significant input byte <span class="parameter">str</span>[0] is non-zero,
then <span class="parameter">rp</span>[rn - 1] will be non-zero,
else <span class="parameter">rp</span>[rn - 1] and some number of subsequent limbs may be zero.
2017-11-04 16:02:37 +01:00
</p><p>
The area at <span class="parameter">rp</span> has to have space for the largest possible number with
<span class="parameter">strsize</span> digits in the chosen <span class="parameter">base</span>, plus one extra limb.
</p><p>
The input must have at least one byte, and no overlap is permitted
between {<span class="parameter">str</span>, <span class="parameter">strsize</span>} and the result at <span class="parameter">rp</span>.
</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 multi-precision operands.</span>
mp_ptr rp = <span class="highlight-keyword">new</span> mp_ptr(<span class="highlight-keyword">new</span> <span class="highlight-keyword">uint</span>[<span class="highlight-number">2</span>]);
<span class="highlight-keyword">byte</span>[] s = <span class="highlight-keyword">new</span> <span class="highlight-keyword">byte</span>[] { <span class="highlight-number">1</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">1</span> };
mp_ptr result = <span class="highlight-keyword">new</span> mp_ptr(<span class="highlight-keyword">new</span> <span class="highlight-keyword">uint</span>[] { <span class="highlight-number">0x00000001</span>, <span class="highlight-number">0x00000001</span> });
char_ptr str = <span class="highlight-keyword">new</span> char_ptr(<span class="highlight-literal">"xxxxxxxxxxxxxxxxx"</span>);
Marshal.Copy(s, <span class="highlight-number">0</span>, str.ToIntPtr(), <span class="highlight-number">9</span>);
<span class="highlight-comment">// Convert rp from str in hex base.</span>
mp_size_t count = gmp_lib.mpn_set_str(rp, str, <span class="highlight-number">9</span>, <span class="highlight-number">16</span>);
<span class="highlight-comment">// Assert the non-ASCII, hex representation of s1p.</span>
Assert.IsTrue(count == rp.Size);
Assert.IsTrue(rp.SequenceEqual(result));
<span class="highlight-comment">// Release unmanaged memory.</span>
gmp_lib.free(rp);
gmp_lib.free(str);</pre></div><div id="ID0EDAABA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="highlight-comment">' Create multi-precision operands.</span>
<span class="highlight-keyword">Dim</span> rp <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> mp_ptr(<span class="highlight-keyword">New</span> <span class="highlight-keyword">UInteger</span>(<span class="highlight-number">1</span>) { })
<span class="highlight-keyword">Dim</span> s <span class="highlight-keyword">As</span> <span class="highlight-keyword">Byte</span>() = <span class="highlight-keyword">New</span> <span class="highlight-keyword">Byte</span>() { <span class="highlight-number">1</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">0</span>, <span class="highlight-number">1</span>}
<span class="highlight-keyword">Dim</span> result <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> mp_ptr(<span class="highlight-keyword">New</span> <span class="highlight-keyword">UInteger</span>() { <span class="highlight-number">&amp;H1</span>, <span class="highlight-number">&amp;H1</span>})
<span class="highlight-keyword">Dim</span> str <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> char_ptr(<span class="highlight-literal">"xxxxxxxxxxxxxxxxx"</span>)
Marshal.Copy(s, <span class="highlight-number">0</span>, str.ToIntPtr(), <span class="highlight-number">9</span>)
<span class="highlight-comment">' Convert rp from str in hex base.</span>
<span class="highlight-keyword">Dim</span> count <span class="highlight-keyword">As</span> mp_size_t = gmp_lib.mpn_set_str(rp, str, <span class="highlight-number">9</span>, <span class="highlight-number">16</span>)
<span class="highlight-comment">' Assert the non-ASCII, hex representation of s1p.</span>
Assert.IsTrue(count = rp.Size)
Assert.IsTrue(rp.SequenceEqual(result))
<span class="highlight-comment">' Release unmanaged memory.</span>
gmp_lib.free(rp)
2018-01-06 17:23:30 +01:00
gmp_lib.free(str)</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="1e9cacd7-32b3-7f3b-659a-efdb3e064092.htm">mpn_get_str</a></div><div class="seeAlsoStyle"><a href="fb2d29b4-f7e2-e3d6-6fcb-920f2e86c0d7.htm">mpn_sizeinbase</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#Low_level_Functions">Low-level Functions</a></a></div><div class="seeAlsoStyle"><a href="3af6b34c-3242-2b75-e7c7-ab79af8a4b0f.htm"><a href="https://gmplib.org/manual/Low_002dlevel-Functions.html#Low_002dlevel-Functions">GNU MP - Low-level Functions</a></a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>