Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_util_1_1_small_float.html
blob: 7776cf4c86a0f74e0825dc4d5c4ec59cede0c597 [file] [log] [blame]
<!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.3"/>
<title>Lucene.Net: Lucene.Net.Util.SmallFloat 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_util.html">Util</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_small_float.html">SmallFloat</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_util_1_1_small_float-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Util.SmallFloat Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Floating point numbers smaller than 32 bits.
<a href="class_lucene_1_1_net_1_1_util_1_1_small_float.html#details">More...</a></p>
<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:a2005feda9230e0b7298f22b546abb971"><td class="memItemLeft" align="right" valign="top">static sbyte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_small_float.html#a2005feda9230e0b7298f22b546abb971">FloatToByte</a> (float f, int numMantissaBits, int zeroExp)</td></tr>
<tr class="memdesc:a2005feda9230e0b7298f22b546abb971"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a 32 bit float to an 8 bit float. <br/>
Values less than zero are all mapped to zero. <br/>
Values are truncated (rounded down) to the nearest 8 bit value. <br/>
Values between zero and the smallest representable value are rounded up. <a href="#a2005feda9230e0b7298f22b546abb971"></a><br/></td></tr>
<tr class="separator:a2005feda9230e0b7298f22b546abb971"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78e659be3bd6157edb4c35f49b242c7d"><td class="memItemLeft" align="right" valign="top">static float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_small_float.html#a78e659be3bd6157edb4c35f49b242c7d">ByteToFloat</a> (byte b, int numMantissaBits, int zeroExp)</td></tr>
<tr class="memdesc:a78e659be3bd6157edb4c35f49b242c7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an 8 bit float to a 32 bit float. <a href="#a78e659be3bd6157edb4c35f49b242c7d"></a><br/></td></tr>
<tr class="separator:a78e659be3bd6157edb4c35f49b242c7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bf32abe2058e30ba9fa3a3593f1dd90"><td class="memItemLeft" align="right" valign="top">static sbyte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_small_float.html#a6bf32abe2058e30ba9fa3a3593f1dd90">FloatToByte315</a> (float f)</td></tr>
<tr class="memdesc:a6bf32abe2058e30ba9fa3a3593f1dd90"><td class="mdescLeft">&#160;</td><td class="mdescRight">floatToByte(b, mantissaBits=3, zeroExponent=15) <br/>
smallest non-zero value = 5.820766E-10 <br/>
largest value = 7.5161928E9 <br/>
epsilon = 0.125 <a href="#a6bf32abe2058e30ba9fa3a3593f1dd90"></a><br/></td></tr>
<tr class="separator:a6bf32abe2058e30ba9fa3a3593f1dd90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a080e3cd4ea85b3a6f3eabe9a45da23eb"><td class="memItemLeft" align="right" valign="top">static float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_small_float.html#a080e3cd4ea85b3a6f3eabe9a45da23eb">Byte315ToFloat</a> (byte b)</td></tr>
<tr class="memdesc:a080e3cd4ea85b3a6f3eabe9a45da23eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">byteToFloat(b, mantissaBits=3, zeroExponent=15) <a href="#a080e3cd4ea85b3a6f3eabe9a45da23eb"></a><br/></td></tr>
<tr class="separator:a080e3cd4ea85b3a6f3eabe9a45da23eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a455f6f4772f85f68a5c9fdc29f9fbc00"><td class="memItemLeft" align="right" valign="top">static sbyte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_small_float.html#a455f6f4772f85f68a5c9fdc29f9fbc00">FloatToByte52</a> (float f)</td></tr>
<tr class="memdesc:a455f6f4772f85f68a5c9fdc29f9fbc00"><td class="mdescLeft">&#160;</td><td class="mdescRight">floatToByte(b, mantissaBits=5, zeroExponent=2) <br/>
smallest nonzero value = 0.033203125 <br/>
largest value = 1984.0 <br/>
epsilon = 0.03125 <a href="#a455f6f4772f85f68a5c9fdc29f9fbc00"></a><br/></td></tr>
<tr class="separator:a455f6f4772f85f68a5c9fdc29f9fbc00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57517b4added3e11420d7e4f772f9330"><td class="memItemLeft" align="right" valign="top">static float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_small_float.html#a57517b4added3e11420d7e4f772f9330">Byte52ToFloat</a> (byte b)</td></tr>
<tr class="memdesc:a57517b4added3e11420d7e4f772f9330"><td class="mdescLeft">&#160;</td><td class="mdescRight">byteToFloat(b, mantissaBits=5, zeroExponent=2) <a href="#a57517b4added3e11420d7e4f772f9330"></a><br/></td></tr>
<tr class="separator:a57517b4added3e11420d7e4f772f9330"><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>Floating point numbers smaller than 32 bits. </p>
<p>&lt;version&gt; $Id$ &lt;/version&gt; </p>
<p>Definition at line <a class="el" href="_small_float_8cs_source.html#l00029">29</a> of file <a class="el" href="_small_float_8cs_source.html">SmallFloat.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a080e3cd4ea85b3a6f3eabe9a45da23eb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static float Lucene.Net.Util.SmallFloat.Byte315ToFloat </td>
<td>(</td>
<td class="paramtype">byte&#160;</td>
<td class="paramname"><em>b</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>byteToFloat(b, mantissaBits=3, zeroExponent=15) </p>
<p>Definition at line <a class="el" href="_small_float_8cs_source.html#l00108">108</a> of file <a class="el" href="_small_float_8cs_source.html">SmallFloat.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a57517b4added3e11420d7e4f772f9330"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static float Lucene.Net.Util.SmallFloat.Byte52ToFloat </td>
<td>(</td>
<td class="paramtype">byte&#160;</td>
<td class="paramname"><em>b</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>byteToFloat(b, mantissaBits=5, zeroExponent=2) </p>
<p>Definition at line <a class="el" href="_small_float_8cs_source.html#l00141">141</a> of file <a class="el" href="_small_float_8cs_source.html">SmallFloat.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a78e659be3bd6157edb4c35f49b242c7d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static float Lucene.Net.Util.SmallFloat.ByteToFloat </td>
<td>(</td>
<td class="paramtype">byte&#160;</td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>numMantissaBits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>zeroExp</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>Converts an 8 bit float to a 32 bit float. </p>
<p>Definition at line <a class="el" href="_small_float_8cs_source.html#l00069">69</a> of file <a class="el" href="_small_float_8cs_source.html">SmallFloat.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2005feda9230e0b7298f22b546abb971"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static sbyte Lucene.Net.Util.SmallFloat.FloatToByte </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>numMantissaBits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>zeroExp</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>Converts a 32 bit float to an 8 bit float. <br/>
Values less than zero are all mapped to zero. <br/>
Values are truncated (rounded down) to the nearest 8 bit value. <br/>
Values between zero and the smallest representable value are rounded up. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>the 32 bit float to be converted to an 8 bit float (byte) </td></tr>
<tr><td class="paramname">numMantissaBits</td><td>the number of mantissa bits to use in the byte, with the remainder to be used in the exponent </td></tr>
<tr><td class="paramname">zeroExp</td><td>the zero-point in the range of exponent values </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the 8 bit float representation </dd></dl>
<p>Definition at line <a class="el" href="_small_float_8cs_source.html#l00047">47</a> of file <a class="el" href="_small_float_8cs_source.html">SmallFloat.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6bf32abe2058e30ba9fa3a3593f1dd90"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static sbyte Lucene.Net.Util.SmallFloat.FloatToByte315 </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>f</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>floatToByte(b, mantissaBits=3, zeroExponent=15) <br/>
smallest non-zero value = 5.820766E-10 <br/>
largest value = 7.5161928E9 <br/>
epsilon = 0.125 </p>
<p>Definition at line <a class="el" href="_small_float_8cs_source.html#l00092">92</a> of file <a class="el" href="_small_float_8cs_source.html">SmallFloat.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a455f6f4772f85f68a5c9fdc29f9fbc00"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static sbyte Lucene.Net.Util.SmallFloat.FloatToByte52 </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>f</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>floatToByte(b, mantissaBits=5, zeroExponent=2) <br/>
smallest nonzero value = 0.033203125 <br/>
largest value = 1984.0 <br/>
epsilon = 0.03125 </p>
<p>Definition at line <a class="el" href="_small_float_8cs_source.html#l00125">125</a> of file <a class="el" href="_small_float_8cs_source.html">SmallFloat.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Util/<a class="el" href="_small_float_8cs_source.html">SmallFloat.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:59 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>