Math.Gmp.Native/docs/html/1555cd52-98d2-6253-214a-d342a539bfb5.htm

70 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_sec_add_1 Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="mpn_sec_add_1 method" /><meta name="System.Keywords" content="gmp_lib.mpn_sec_add_1 method" /><meta name="Microsoft.Help.F1" content="Math.Gmp.Native.gmp_lib.mpn_sec_add_1" /><meta name="Microsoft.Help.Id" content="M:Math.Gmp.Native.gmp_lib.mpn_sec_add_1(Math.Gmp.Native.mp_ptr,Math.Gmp.Native.mp_ptr,Math.Gmp.Native.mp_size_t,Math.Gmp.Native.mp_limb_t,Math.Gmp.Native.mp_ptr)" /><meta name="Description" content="Set R to A + b, where R = {, }, A = {, }, and is a single limb." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Math.Gmp.Native" /><meta name="file" content="1555cd52-98d2-6253-214a-d342a539bfb5" /><meta name="guid" content="1555cd52-98d2-6253-214a-d342a539bfb5" /><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
2017-11-08 01:29:10 +01:00
Set R to A + b, where R = {<span class="parameter">rp</span>, <span class="parameter">n</span>}, A = {<span class="parameter">ap</span>, <span class="parameter">n</span>}, and <span class="parameter">b</span> is a single limb.
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_limb_t</span> <span class="identifier">mpn_sec_add_1</span>(
<span class="identifier">mp_ptr</span> <span class="parameter">rp</span>,
<span class="identifier">mp_ptr</span> <span class="parameter">ap</span>,
<span class="identifier">mp_size_t</span> <span class="parameter">n</span>,
<span class="identifier">mp_limb_t</span> <span class="parameter">b</span>,
<span class="identifier">mp_ptr</span> <span class="parameter">tp</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_sec_add_1</span> (
<span class="parameter">rp</span> <span class="keyword">As</span> <span class="identifier">mp_ptr</span>,
<span class="parameter">ap</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">b</span> <span class="keyword">As</span> <span class="identifier">mp_limb_t</span>,
<span class="parameter">tp</span> <span class="keyword">As</span> <span class="identifier">mp_ptr</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_sec_add_1</span>(
<span class="identifier">mp_ptr</span>^ <span class="parameter">rp</span>,
<span class="identifier">mp_ptr</span>^ <span class="parameter">ap</span>,
<span class="identifier">mp_size_t</span> <span class="parameter">n</span>,
<span class="identifier">mp_limb_t</span> <span class="parameter">b</span>,
<span class="identifier">mp_ptr</span>^ <span class="parameter">tp</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_sec_add_1</span> :
<span class="parameter">rp</span> : <span class="identifier">mp_ptr</span> *
<span class="parameter">ap</span> : <span class="identifier">mp_ptr</span> *
<span class="parameter">n</span> : <span class="identifier">mp_size_t</span> *
<span class="parameter">b</span> : <span class="identifier">mp_limb_t</span> *
<span class="parameter">tp</span> : <span class="identifier">mp_ptr</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="LST62D7D033_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST62D7D033_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_ptr</a><br />The result integer.</dd><dt><span class="parameter">ap</span></dt><dd>Type: <a href="4609ac5e-5cf9-cd20-2fa9-8040101c165c.htm">Math.Gmp.Native<span id="LST62D7D033_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST62D7D033_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="LST62D7D033_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST62D7D033_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_size_t</a><br />The number of limbs of <span class="parameter">ap</span> and <span class="parameter">rp</span>.</dd><dt><span class="parameter">b</span></dt><dd>Type: <a href="bf1f694d-f9b2-6413-12e5-ebae603d5b49.htm">Math.Gmp.Native<span id="LST62D7D033_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST62D7D033_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_limb_t</a><br />The second operand integer.</dd><dt><span class="parameter">tp</span></dt><dd>Type: <a href="4609ac5e-5cf9-cd20-2fa9-8040101c165c.htm">Math.Gmp.Native<span id="LST62D7D033_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST62D7D033_5?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_ptr</a><br />The scratch operand integer.</dd></dl><h4 class="subHeading">Return Value</h4>Type: <a href="bf1f694d-f9b2-6413-12e5-ebae603d5b49.htm">mp_limb_t</a><br />Returns carry, 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" />Remarks</span></div><div id="ID2RBSection" class="collapsibleSection"><p>
2017-12-15 02:18:55 +01:00
This function takes O(N) time, unlike the leaky functions <a href="5562b14f-48a4-be75-2eb0-6a129cd0d5ab.htm">mpn_add_1</a> which is O(1) on average.
It requires scratch space of <a href="87bbc39f-b11a-76d9-f31d-f5dcf365a67d.htm">mpn_sec_add_1_itch</a>(n) limbs, to be passed in the <span class="parameter">tp</span> parameter.
2017-11-04 16:02:37 +01:00
The scratch space requirements are guaranteed to be at most <span class="parameter">n</span> limbs, and increase monotonously in the operand size.
</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, and expected result.</span>
mp_ptr ap = <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 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">0x00000000</span>, <span class="highlight-number">0x00000000</span> });
mp_ptr rp = <span class="highlight-keyword">new</span> mp_ptr(result.Size);
<span class="highlight-comment">// Create scratch space.</span>
mp_size_t size = gmp_lib.mpn_sec_add_1_itch(ap.Size);
mp_ptr tp = <span class="highlight-keyword">new</span> mp_ptr(size);
<span class="highlight-comment">// Set rp = ap + 1.</span>
mp_limb_t carry = gmp_lib.mpn_sec_add_1(rp, ap, ap.Size, <span class="highlight-number">1</span>, tp);
<span class="highlight-comment">// Assert result of operation.</span>
Assert.IsTrue(carry == <span class="highlight-number">1</span>);
Assert.IsTrue(rp.SequenceEqual(result));
<span class="highlight-comment">// Release unmanaged memory.</span>
gmp_lib.free(rp, ap, tp, 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> ap <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> 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;H0</span>, <span class="highlight-number">&amp;H0</span>})
<span class="highlight-keyword">Dim</span> rp <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> mp_ptr(result.Size)
<span class="highlight-comment">' Create scratch space.</span>
<span class="highlight-keyword">Dim</span> size <span class="highlight-keyword">As</span> mp_size_t = gmp_lib.mpn_sec_add_1_itch(ap.Size)
<span class="highlight-keyword">Dim</span> tp <span class="highlight-keyword">As</span> <span class="highlight-keyword">New</span> mp_ptr(size)
<span class="highlight-comment">' Set rp = ap + 1.</span>
<span class="highlight-keyword">Dim</span> carry <span class="highlight-keyword">As</span> mp_limb_t = gmp_lib.mpn_sec_add_1(rp, ap, ap.Size, <span class="highlight-number">1</span>, tp)
<span class="highlight-comment">' Assert result of operation.</span>
Assert.IsTrue(carry = <span class="highlight-number">1</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, ap, tp, 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('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="27902901-3a7d-b5b3-d3fc-3900f754bff1.htm">mpn_cnd_add_n</a></div><div class="seeAlsoStyle"><a href="b82bad6a-f8f0-db53-a6d3-ed6002046257.htm">mpn_cnd_sub_n</a></div><div class="seeAlsoStyle"><a href="87bbc39f-b11a-76d9-f31d-f5dcf365a67d.htm">mpn_sec_add_1_itch</a></div><div class="seeAlsoStyle"><a href="9137a632-abd2-7963-1991-85e6d753bf13.htm">mpn_sec_sub_1</a></div><div class="seeAlsoStyle"><a href="f0985ccc-17da-8a0b-066c-53df9b1921a1.htm">mpn_cnd_swap</a></div><div class="seeAlsoStyle"><a href="028e92d4-3699-77ff-e8da-9ff4c367f5b3.htm">mpn_sec_mul</a></div><div class="seeAlsoStyle"><a href="bfe1e9b5-6fc1-95f2-d5b6-137fe87c071a.htm">mpn_sec_sqr</a></div><div class="seeAlsoStyle"><a href="a38b87c5-c6ac-fa68-6d58-c45793bf933e.htm">mpn_sec_powm</a></div><div class="seeAlsoStyle"><a href="3588cf60-567a-6182-20e8-5e2836498f49.htm">mpn_sec_tabselect</a></div><div class="seeAlsoStyle"><a href="6f1dca2b-39f4-3acd-71fb-4f1e5a0d04e6.htm">mpn_sec_div_qr</a></div><div class="seeAlsoStyle"><a href="094ea390-8cc8-bac7-35c3-3616775736de.htm">mpn_sec_div_r</a></div><div class="seeAlsoStyle"><a href="62ffb793-b32f-e0dc-a399-f20fe708a803.htm">mpn_sec_invert</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_for_cryptography">Low-level functions for cryptography</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>