Math.Gmp.Native/docs/html/37c88d6c-8d02-2330-ad77-f20...

44 lines
20 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<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>mpf_t Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="mpf_t class" /><meta name="System.Keywords" content="Math.Gmp.Native.mpf_t class" /><meta name="System.Keywords" content="mpf_t class, about mpf_t class" /><meta name="Microsoft.Help.F1" content="Math.Gmp.Native.mpf_t" /><meta name="Microsoft.Help.Id" content="T:Math.Gmp.Native.mpf_t" /><meta name="Description" content="Represents a multiple precision floating-point number." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="Math.Gmp.Native" /><meta name="file" content="37c88d6c-8d02-2330-ad77-f20fb73d1677" /><meta name="guid" content="37c88d6c-8d02-2330-ad77-f20fb73d1677" /><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="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="37c88d6c-8d02-2330-ad77-f20fb73d1677.htm" title="mpf_t Class" tocid="37c88d6c-8d02-2330-ad77-f20fb73d1677">mpf_t Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="0e0a10d5-52ab-1821-6fe1-97514e009418.htm" title="mpf_t Constructor " tocid="0e0a10d5-52ab-1821-6fe1-97514e009418">mpf_t Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="44d8440b-0daa-0393-510e-a0ace6d299f7.htm" title="mpf_t Properties" tocid="44d8440b-0daa-0393-510e-a0ace6d299f7">mpf_t Properties</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="2583789b-09c3-0f9a-fbf9-4d362bd9129a.htm" title="mpf_t Methods" tocid="2583789b-09c3-0f9a-fbf9-4d362bd9129a">mpf_t Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="3ca44c9f-677e-d5fa-5414-399843506633.htm" title="mpf_t Type Conversions" tocid="3ca44c9f-677e-d5fa-5414-399843506633">mpf_t Type Conversions</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="373cd52b-c12c-bae1-1a8c-b7627903d709.htm" title="mpf_t Fields" tocid="373cd52b-c12c-bae1-1a8c-b7627903d709">mpf_t Fields</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn">mpf_t Class</td></tr></table><span class="introStyle"></span> <div class="summary">
Represents a multiple precision floating-point number.
</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LST9BA7085B_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST9BA7085B_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <a href="8f3c572b-8133-bccc-b838-9d22e3467898.htm">Math.Gmp.Native<span id="LST9BA7085B_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST9BA7085B_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mp_base</a><br />    <span class="selflink">Math.Gmp.Native<span id="LST9BA7085B_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST9BA7085B_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>mpf_t</span><br /></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('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cs','1','4');return false;">C#</a></div><div id="ID1EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','vb','2','4');return false;">VB</a></div><div id="ID1EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cpp','3','4');return false;">C++</a></div><div id="ID1EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EDCA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID1EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID1EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">mpf_t</span> : <span class="identifier">mp_base</span></pre></div><div id="ID1EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">mpf_t</span>
<span class="keyword">Inherits</span> <span class="identifier">mp_base</span></pre></div><div id="ID1EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">mpf_t</span> : <span class="keyword">public</span> <span class="identifier">mp_base</span></pre></div><div id="ID1EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">mpf_t</span> =
<span class="keyword">class</span>
<span class="keyword">inherit</span> <span class="identifier">mp_base</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <span class="selflink">mpf_t</span> type exposes the following members.</p><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" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table class="members" id="constructorList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="0e0a10d5-52ab-1821-6fe1-97514e009418.htm">mpf_t</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">mpf_t</span> class</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID4RBSection" class="collapsibleSection"><table class="members" id="propertyList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="db55f1a9-cd4c-b7e9-c831-4391c0497ef7.htm">_mp_d</a></td><td><div class="summary">
A pointer to an array of limbs which is the magnitude.
</div> (Inherited from <a href="8f3c572b-8133-bccc-b838-9d22e3467898.htm">mp_base</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="39182adf-3ed6-8c68-c2e7-05a9bfcef6ab.htm">_mp_d_intptr</a></td><td><div class="summary">
Gets or sets the pointer to the significand array of limbs of the floating-point number.
</div> (Overrides <a href="01baafdb-caf3-5653-428f-0ba9c42c3a9a.htm">mp_base<span id="LST9BA7085B_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST9BA7085B_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>_mp_d_intptr</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="f63ee104-afaa-e0b8-ff39-f60b9a934ea3.htm">_mp_exp</a></td><td><div class="summary">
The exponent, in limbs, determining the location of the implied radix point.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="772c3bd8-b9ec-225d-3d98-e17ae89d4294.htm">_mp_prec</a></td><td><div class="summary">
The precision of the mantissa, in limbs.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="9aa3bb30-32b3-b465-af05-9b048bb610f1.htm">_mp_size</a></td><td><div class="summary">
The number of limbs currently in use, or the negative of that when representing a negative value.
</div> (Overrides <a href="178d8d44-2485-2972-fe2f-eb9848059e6f.htm">mp_base<span id="LST9BA7085B_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST9BA7085B_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>_mp_size</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID5RBSection" class="collapsibleSection"><table class="members" id="methodList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">Determines whether the specified <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is equal to the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td><div class="summary">Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">Serves as a hash function for a particular type. </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td><div class="summary">Creates a shallow copy of the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="b77413f7-f862-7996-838a-f510fc3f69ed.htm">ToIntPtr</a></td><td><div class="summary">
Gets the unmanaged memory pointer of the multiple precision floating-point number.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="77eccd6b-888f-b3a8-0800-ead4af162af0.htm">ToString</a></td><td><div class="summary">
Return the string representation of the float.
</div> (Overrides <a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">Object<span id="LST9BA7085B_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST9BA7085B_5?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ToString<span id="LST9BA7085B_6"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST9BA7085B_6?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Operators</span></div><div id="ID6RBSection" class="collapsibleSection"><table class="members" id="operatorList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;static;declared;notNetfw;"><td><img src="../icons/puboperator.gif" alt="Public operator" title="Public operator" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="058e477a-0126-b073-ee83-77ed89a58351.htm"><span id="LST9BA7085B_7"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST9BA7085B_7?cs=Implicit|vb=Widening|cpp=Implicit|nu=Implicit|fs=Implicit");</script>(String to mpf_t)</a></td><td><div class="summary">
Converts a <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">string</a> value to an <span class="selflink">mpf_t</span> value.
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID7RB')" onkeypress="SectionExpandCollapse_CheckKey('ID7RB', event)" tabindex="0"><img id="ID7RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID7RBSection" class="collapsibleSection"><table class="members" id="fieldList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubfield.gif" alt="Public field" title="Public field" /></td><td><a href="8d76a7b0-6917-c5d0-3b4a-de767fd3ddd4.htm">Pointer</a></td><td><div class="summary">
Pointer to limbs in unmanaged memory.
</div> (Inherited from <a href="8f3c572b-8133-bccc-b838-9d22e3467898.htm">mp_base</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID8RB')" onkeypress="SectionExpandCollapse_CheckKey('ID8RB', event)" tabindex="0"><img id="ID8RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Remarks</span></div><div id="ID8RBSection" class="collapsibleSection"><p>
The floating point functions accept and return exponents in the C type <a href="e6a17880-791f-37d4-4942-cf26ce7d4cbf.htm">mp_exp_t</a>.
Currently this is usually a long, but on some systems its an int for efficiency.
</p><p>
In .NET, this is a 32-bit integer.
</p></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID9RB')" onkeypress="SectionExpandCollapse_CheckKey('ID9RB', event)" tabindex="0"><img id="ID9RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID9RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="d9c51b9f-0c54-770b-28ea-6eebd8fef368.htm">Math.Gmp.Native Namespace</a></div><div class="seeAlsoStyle"><a href="e6a17880-791f-37d4-4942-cf26ce7d4cbf.htm">mp_exp_t</a></div><div class="seeAlsoStyle"><a href="bf1f694d-f9b2-6413-12e5-ebae603d5b49.htm">mp_limb_t</a></div><div class="seeAlsoStyle"><a href="635f1879-5f85-881e-cca8-3222baf5045a.htm">mpq_t</a></div><div class="seeAlsoStyle"><a href="8beda7fb-bbc4-b56f-fd1f-1459377ecb3b.htm">mpz_t</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>