geos_390_docs/classgeos_1_1precision_1_1C...

421 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>GEOS: geos::precision::CommonBits Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GEOS
&#160;<span id="projectnumber">3.9.1dev</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegeos.html">geos</a></li><li class="navelem"><a class="el" href="namespacegeos_1_1precision.html">precision</a></li><li class="navelem"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html">CommonBits</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgeos_1_1precision_1_1CommonBits-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">geos::precision::CommonBits Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Determines the maximum number of common most-significant bits in the mantissa of one or numbers.
<a href="classgeos_1_1precision_1_1CommonBits.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="CommonBits_8h_source.html">CommonBits.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1dd4d613eac93680e91f14141ad0a03f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#a1dd4d613eac93680e91f14141ad0a03f">CommonBits</a> ()</td></tr>
<tr class="separator:a1dd4d613eac93680e91f14141ad0a03f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae35c2c9b6b224394eba7857660150cf2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#ae35c2c9b6b224394eba7857660150cf2">add</a> (double num)</td></tr>
<tr class="separator:ae35c2c9b6b224394eba7857660150cf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad534127f8b773d447407755626875b12"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#ad534127f8b773d447407755626875b12">getCommon</a> ()</td></tr>
<tr class="separator:ad534127f8b773d447407755626875b12"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:acd2915c5248f5c5212f8bb6f0c392bcd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#acd2915c5248f5c5212f8bb6f0c392bcd">signExpBits</a> (<a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> num)</td></tr>
<tr class="memdesc:acd2915c5248f5c5212f8bb6f0c392bcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the bit pattern for the sign and exponent of a double-precision number. <a href="#acd2915c5248f5c5212f8bb6f0c392bcd">More...</a><br /></td></tr>
<tr class="separator:acd2915c5248f5c5212f8bb6f0c392bcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d84e408acf9c7999315d528e8a5c7fe"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#a0d84e408acf9c7999315d528e8a5c7fe">numCommonMostSigMantissaBits</a> (<a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> num1, <a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> num2)</td></tr>
<tr class="memdesc:a0d84e408acf9c7999315d528e8a5c7fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">This computes the number of common most-significant bits in the mantissas of two double-precision numbers. <a href="#a0d84e408acf9c7999315d528e8a5c7fe">More...</a><br /></td></tr>
<tr class="separator:a0d84e408acf9c7999315d528e8a5c7fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34fdd6bccb7d15b1d39650c23c289cdb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#a34fdd6bccb7d15b1d39650c23c289cdb">zeroLowerBits</a> (<a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> bits, int nBits)</td></tr>
<tr class="memdesc:a34fdd6bccb7d15b1d39650c23c289cdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Zeroes the lower n bits of a bitstring. <a href="#a34fdd6bccb7d15b1d39650c23c289cdb">More...</a><br /></td></tr>
<tr class="separator:a34fdd6bccb7d15b1d39650c23c289cdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2dd5813222adb4f5feaeff3e2b9aac6d"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#a2dd5813222adb4f5feaeff3e2b9aac6d">getBit</a> (<a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> bits, int i)</td></tr>
<tr class="memdesc:a2dd5813222adb4f5feaeff3e2b9aac6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts the i'th bit of a bitstring. <a href="#a2dd5813222adb4f5feaeff3e2b9aac6d">More...</a><br /></td></tr>
<tr class="separator:a2dd5813222adb4f5feaeff3e2b9aac6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a2cadaeaf8a3cf65423b139ecd47ee0bc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#a2cadaeaf8a3cf65423b139ecd47ee0bc">isFirst</a></td></tr>
<tr class="separator:a2cadaeaf8a3cf65423b139ecd47ee0bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7462ef0d9660f9e85141ef7ce415117e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#a7462ef0d9660f9e85141ef7ce415117e">commonMantissaBitsCount</a></td></tr>
<tr class="separator:a7462ef0d9660f9e85141ef7ce415117e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82ba0dd713287225bf11c19c97f2ebaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#a82ba0dd713287225bf11c19c97f2ebaa">commonBits</a></td></tr>
<tr class="separator:a82ba0dd713287225bf11c19c97f2ebaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77ecb814b5b63d77a13783bc499fcc63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgeos_1_1precision_1_1CommonBits.html#a77ecb814b5b63d77a13783bc499fcc63">commonSignExp</a></td></tr>
<tr class="separator:a77ecb814b5b63d77a13783bc499fcc63"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Determines the maximum number of common most-significant bits in the mantissa of one or numbers. </p>
<p>Can be used to compute the double-precision number which is represented by the common bits. If there are no common bits, the number computed is 0.0. </p>
<p>Definition at line <a class="el" href="CommonBits_8h_source.html#l00033">33</a> of file <a class="el" href="CommonBits_8h_source.html">CommonBits.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1dd4d613eac93680e91f14141ad0a03f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">geos::precision::CommonBits::CommonBits </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae35c2c9b6b224394eba7857660150cf2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geos::precision::CommonBits::add </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>num</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2dd5813222adb4f5feaeff3e2b9aac6d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int geos::precision::CommonBits::getBit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td>
<td class="paramname"><em>bits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the i'th bit of a bitstring. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bits</td><td>the bitstring to extract from </td></tr>
<tr><td class="paramname">i</td><td>the bit to extract </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value of the extracted bit </dd></dl>
</div>
</div>
<a class="anchor" id="ad534127f8b773d447407755626875b12"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double geos::precision::CommonBits::getCommon </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0d84e408acf9c7999315d528e8a5c7fe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int geos::precision::CommonBits::numCommonMostSigMantissaBits </td>
<td>(</td>
<td class="paramtype"><a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td>
<td class="paramname"><em>num1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td>
<td class="paramname"><em>num2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This computes the number of common most-significant bits in the mantissas of two double-precision numbers. </p>
<p>It does not count the hidden bit, which is always 1. It does not determine whether the numbers have the same exponent - if they do not, the value computed by this function is meaningless. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num1</td><td></td></tr>
<tr><td class="paramname">num2</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of common most-significant mantissa bits </dd></dl>
</div>
</div>
<a class="anchor" id="acd2915c5248f5c5212f8bb6f0c392bcd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> geos::precision::CommonBits::signExpBits </td>
<td>(</td>
<td class="paramtype"><a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td>
<td class="paramname"><em>num</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes the bit pattern for the sign and exponent of a double-precision number. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">num</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the bit pattern for the sign and exponent </dd></dl>
</div>
</div>
<a class="anchor" id="a34fdd6bccb7d15b1d39650c23c289cdb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> geos::precision::CommonBits::zeroLowerBits </td>
<td>(</td>
<td class="paramtype"><a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a>&#160;</td>
<td class="paramname"><em>bits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nBits</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Zeroes the lower n bits of a bitstring. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bits</td><td>the bitstring to alter </td></tr>
<tr><td class="paramname">nBits</td><td>the number of bits to zero </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the zeroed bitstring </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a82ba0dd713287225bf11c19c97f2ebaa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> geos::precision::CommonBits::commonBits</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CommonBits_8h_source.html#l00041">41</a> of file <a class="el" href="CommonBits_8h_source.html">CommonBits.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7462ef0d9660f9e85141ef7ce415117e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int geos::precision::CommonBits::commonMantissaBitsCount</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CommonBits_8h_source.html#l00039">39</a> of file <a class="el" href="CommonBits_8h_source.html">CommonBits.h</a>.</p>
</div>
</div>
<a class="anchor" id="a77ecb814b5b63d77a13783bc499fcc63"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="constants_8h.html#a7cde0074dfd288f2d70c0e035dacb28a">int64</a> geos::precision::CommonBits::commonSignExp</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CommonBits_8h_source.html#l00043">43</a> of file <a class="el" href="CommonBits_8h_source.html">CommonBits.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2cadaeaf8a3cf65423b139ecd47ee0bc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool geos::precision::CommonBits::isFirst</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CommonBits_8h_source.html#l00037">37</a> of file <a class="el" href="CommonBits_8h_source.html">CommonBits.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="CommonBits_8h_source.html">CommonBits.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>