Math.Gmp.Native/docs/html/ae3c6cf7-08a0-54dd-951f-b2f...

54 lines
98 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_sub_1 Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="mpn_sub_1 method" /><meta name="System.Keywords" content="gmp_lib.mpn_sub_1 method" /><meta name="Microsoft.Help.F1" content="Math.Gmp.Native.gmp_lib.mpn_sub_1" /><meta name="Microsoft.Help.Id" content="M:Math.Gmp.Native.gmp_lib.mpn_sub_1(Math.Gmp.Native.mp_ptr,Math.Gmp.Native.mp_ptr,Math.Gmp.Native.mp_size_t,Math.Gmp.Native.mp_limb_t)" /><meta name="Description" content="Subtract from {, }, and write the least significant limbs of the result to ." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Math.Gmp.Native" /><meta name="file" content="ae3c6cf7-08a0-54dd-951f-b2fe2112b8b0" /><meta name="guid" content="ae3c6cf7-08a0-54dd-951f-b2fe2112b8b0" /><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-t
2017-11-04 16:02:37 +01:00
Subtract <span class="parameter">s2limb</span> from {<span class="parameter">s1p</span>, <span class="parameter">n</span>}, and write the <span class="parameter">n</span> least significant limbs of the result to <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_limb_t</span> <span class="identifier">mpn_sub_1</span>(
<span class="identifier">mp_ptr</span> <span class="parameter">rp</span>,
<span class="identifier">mp_ptr</span> <span class="parameter">s1p</span>,
<span class="identifier">mp_size_t</span> <span class="parameter">n</span>,
<span class="identifier">mp_limb_t</span> <span class="parameter">s2limb</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_sub_1</span> (
<span class="parameter">rp</span> <span class="keyword">As</span> <span class="identifier">mp_ptr</span>,
<span class="parameter">s1p</span> <span class="keyword">As</span> <span class="identifier">mp_ptr</span>,
<span class="parameter">n</span> <span class="keyword">As</span> <span class="identifier">mp_size_t</span>,
<span class="parameter">s2limb</span> <span class="keyword">As</span> <span class="identifier">mp_limb_t</span>
) <span class="keyword">As</span> <span class="identifier">mp_limb_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_limb_t</span> <span class="identifier">mpn_sub_1</span>(
<span class="identifier">mp_ptr</span>^ <span class="parameter">rp</span>,
<span class="identifier">mp_ptr</span>^ <span class="parameter">s1p</span>,
<span class="identifier">mp_size_t</span> <span class="parameter">n</span>,
<span class="identifier">mp_limb_t</span> <span class="parameter">s2limb</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_sub_1</span> :
<span class="parameter">rp</span> : <span class="identifier">mp_ptr</span> *
<span class="parameter">s1p</span> : <span class="identifier">mp_ptr</span> *
<span class="parameter">n</span> : <span class="identifier">mp_size_t</span> *
<span class="parameter">s2limb</span> : <span class="identifier">mp_limb_t</span> <span class="keyword">-&gt;</span> <span class="identifier">mp_limb_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="LST69B8B46A_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST69B8B46A_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_ptr</a><br />The result integer.</dd><dt><span class="parameter">s1p</span></dt><dd>Type: <a href="4609ac5e-5cf9-cd20-2fa9-8040101c165c.htm">Math.Gmp.Native<span id="LST69B8B46A_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST69B8B46A_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_ptr</a><br />The first operand integer.</dd><dt><span class="parameter">n</span></dt><dd>Type: <a href="4b58a584-7a0e-b600-18fa-ebd493861eb3.htm">Math.Gmp.Native<span id="LST69B8B46A_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST69B8B46A_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_size_t</a><br />The numbe rof limbs of <span class="parameter">s1p</span>.</dd><dt><span class="parameter">s2limb</span></dt><dd>Type: <a href="bf1f694d-f9b2-6413-12e5-ebae603d5b49.htm">Math.Gmp.Native<span id="LST69B8B46A_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST69B8B46A_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_limb_t</a><br />The second operand integer.</dd></dl><h4 class="subHeading">Return Value</h4>Type: <a href="bf1f694d-f9b2-6413-12e5-ebae603d5b49.htm">mp_limb_t</a><br />Return borrow, either 0 or 1.</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" />Examples</span></div><div id="ID2RBSection" 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, and expected result.</span>
2017-11-04 16:02:37 +01:00
mp_ptr s1p = <span class="highlight-keyword">new</span> mp_ptr(<span class="highlight-keyword">new</span> <span class="highlight-keyword">uint</span>[] { <span class="highlight-number">0xffffffff</span>, <span class="highlight-number">0xffffffff</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>]);
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">0xfffffffe</span>, <span class="highlight-number">0xffffffff</span> });
<span class="highlight-comment">// Set rp = s1 - 1.</span>
mp_limb_t borrow = gmp_lib.mpn_sub_1(rp, s1p, s1p.Size, <span class="highlight-number">1</span>);
<span class="highlight-comment">// Assert result of operation.</span>
Assert.IsTrue(borrow == <span class="highlight-number">0</span>);
Assert.IsTrue(rp.SequenceEqual(result));
<span class="highlight-comment">// Release unmanaged memory.</span>
gmp_lib.free(rp, s1p, result);</pre></div><div id="ID0EDAABA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="highlight-comment">' Create multi-precision operands, and expected result.</span>
<span class="highlight-keyword">Dim</span> s1p <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;Hffffffff</span>UI, <span class="highlight-number">&amp;Hffffffff</span>UI})
<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> 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;Hfffffffe</span>UI, <span class="highlight-number">&amp;Hffffffff</span>UI})
<span class="highlight-comment">' Set rp = s1 - 1.</span>
<span class="highlight-keyword">Dim</span> borrow <span class="highlight-keyword">As</span> mp_limb_t = gmp_lib.mpn_sub_1(rp, s1p, s1p.Size, <span class="highlight-number">1</span>)
<span class="highlight-comment">' Assert result of operation.</span>
Assert.IsTrue(borrow = <span class="highlight-number">0</span>)
Assert.IsTrue(rp.SequenceEqual(result))
<span class="highlight-comment">' Release unmanaged memory.</span>
2018-01-06 17:23:30 +01:00
gmp_lib.free(rp, s1p, result)</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('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID3RBSection" 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="b9df04c4-224e-f2ad-8e90-fbb3b30bd76d.htm">mpn_add</a></div><div class="seeAlsoStyle"><a href="5562b14f-48a4-be75-2eb0-6a129cd0d5ab.htm">mpn_add_1</a></div><div class="seeAlsoStyle"><a href="339edb73-5781-7d73-97b6-9b73451a698f.htm">mpn_add_n</a></div><div class="seeAlsoStyle"><a href="77fdf32b-986d-4df3-3c76-022e3e3fbb98.htm">mpn_addmul_1</a></div><div class="seeAlsoStyle"><a href="1d6343a5-d42c-c362-714e-e10730e6a6d5.htm">mpn_divexact_1</a></div><div class="seeAlsoStyle"><a href="75f2a84e-44f3-b7cc-e6ad-392111d5b9cc.htm">mpn_divexact_by3</a></div><div class="seeAlsoStyle"><a href="c40ea3de-d1be-146b-fe7a-deff566ca817.htm">mpn_divexact_by3c</a></div><div class="seeAlsoStyle"><a href="9074a45b-0d68-cf18-75fe-076e720a9a61.htm">mpn_divmod_1</a></div><div class="seeAlsoStyle"><a href="f5c3f25d-1ad5-b3be-fc4b-280a62869912.htm">mpn_divrem_1</a></div><div class="seeAlsoStyle"><a href="9aa24cc8-8cf5-4b8a-cd1b-5ded400efa50.htm">mpn_mod_1</a></div><div class="seeAlsoStyle"><a href="68d3161d-2909-1909-cda7-e87949ee27ce.htm">mpn_mul</a></div><div class="seeAlsoStyle"><a href="b819fb3b-5d3e-ff23-1687-0e71af684bd7.htm">mpn_mul_1</a></div><div class="seeAlsoStyle"><a href="ee321a9a-852a-993e-f602-72ff2af02ff6.htm">mpn_mul_n</a></div><div class="seeAlsoStyle"><a href="9fb96802-e56e-8fd8-cef2-b44870d09a10.htm">mpn_neg</a></div><div class="seeAlsoStyle"><a href="87681f32-b766-3ce2-7c08-98b2d32cb5fa.htm">mpn_sub</a></div><div class="seeAlsoStyle"><a href="b104184e-cf49-dbdb-764a-9dee5cf7b2fd.htm">mpn_sub_n</a></div><div class="seeAlsoStyle"><a href="95e10fea-31c2-e900-c5b0-f48636e1d76e.htm">mpn_submul_1</a></div><div class="seeAlsoStyle"><a href="ff9c2930-ded2-c5b6-46dd-3ff9279cdc5e.htm">mpn_sqr</a></div><div class="seeAlsoStyle"><a href="ee31871c-38bd-fccc-77f5-e76909dd7a79.htm">mpn_sqrtrem</a></div><div class="seeAlsoStyle"><a href="9fe90631-f519-1cf3-5a20-701d2bae1d0d.htm">mpn_tdiv_qr</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>