| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SmallSingle |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SmallSingle |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Util.SmallSingle"> |
| |
| |
| <h1 id="Lucene_Net_Util_SmallSingle" data-uid="Lucene.Net.Util.SmallSingle" class="text-break">Class SmallSingle |
| </h1> |
| <div class="markdown level0 summary"><p>Floating point numbers smaller than 32 bits. |
| <p> |
| NOTE: This was SmallFloat in Lucene |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">SmallSingle</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Util.html">Lucene.Net.Util</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Util_SmallSingle_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class SmallSingle</code></pre> |
| </div> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_Byte315ToSingle_System_Byte_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.Byte315ToSingle(System.Byte)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L169">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_Byte315ToSingle_" data-uid="Lucene.Net.Util.SmallSingle.Byte315ToSingle*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_Byte315ToSingle_System_Byte_" data-uid="Lucene.Net.Util.SmallSingle.Byte315ToSingle(System.Byte)">Byte315ToSingle(Byte)</h4> |
| <div class="markdown level1 summary"><p>ByteToSingle(b, mantissaBits=3, zeroExponent=15) |
| <p> |
| NOTE: This was byte315ToFloat() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float Byte315ToSingle(byte b)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span></td> |
| <td><span class="parametername">b</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_Byte52ToSingle_System_Byte_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.Byte52ToSingle(System.Byte)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L237">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_Byte52ToSingle_" data-uid="Lucene.Net.Util.SmallSingle.Byte52ToSingle*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_Byte52ToSingle_System_Byte_" data-uid="Lucene.Net.Util.SmallSingle.Byte52ToSingle(System.Byte)">Byte52ToSingle(Byte)</h4> |
| <div class="markdown level1 summary"><p>ByteToFloat(b, mantissaBits=5, zeroExponent=2) |
| <p> |
| NOTE: This was byte52ToFloat() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float Byte52ToSingle(byte b)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span></td> |
| <td><span class="parametername">b</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_ByteToSingle_System_Byte_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.ByteToSingle(System.Byte%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L95">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_ByteToSingle_" data-uid="Lucene.Net.Util.SmallSingle.ByteToSingle*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_ByteToSingle_System_Byte_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.SmallSingle.ByteToSingle(System.Byte,System.Int32,System.Int32)">ByteToSingle(Byte, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Converts an 8 bit <span class="xref">System.Single</span> to a 32 bit <span class="xref">System.Single</span>. |
| <p> |
| NOTE: This was byteToFloat() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float ByteToSingle(byte b, int numMantissaBits, int zeroExp)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span></td> |
| <td><span class="parametername">b</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">numMantissaBits</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">zeroExp</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_SByte315ToSingle_System_SByte_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.SByte315ToSingle(System.SByte)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L179">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_SByte315ToSingle_" data-uid="Lucene.Net.Util.SmallSingle.SByte315ToSingle*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_SByte315ToSingle_System_SByte_" data-uid="Lucene.Net.Util.SmallSingle.SByte315ToSingle(System.SByte)">SByte315ToSingle(SByte)</h4> |
| <div class="markdown level1 summary"><p>SByteToSingle(b, mantissaBits=3, zeroExponent=15) |
| <p> |
| NOTE: This was byte315ToFloat() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[CLSCompliant(false)] |
| public static float SByte315ToSingle(sbyte b)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.SByte</span></td> |
| <td><span class="parametername">b</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_SByte52ToSingle_System_SByte_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.SByte52ToSingle(System.SByte)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L247">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_SByte52ToSingle_" data-uid="Lucene.Net.Util.SmallSingle.SByte52ToSingle*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_SByte52ToSingle_System_SByte_" data-uid="Lucene.Net.Util.SmallSingle.SByte52ToSingle(System.SByte)">SByte52ToSingle(SByte)</h4> |
| <div class="markdown level1 summary"><p>SByteToFloat(b, mantissaBits=5, zeroExponent=2) |
| <p> |
| NOTE: This was byte52ToFloat() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[CLSCompliant(false)] |
| public static float SByte52ToSingle(sbyte b)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.SByte</span></td> |
| <td><span class="parametername">b</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_SByteToSingle_System_SByte_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.SByteToSingle(System.SByte%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L105">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_SByteToSingle_" data-uid="Lucene.Net.Util.SmallSingle.SByteToSingle*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_SByteToSingle_System_SByte_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.SmallSingle.SByteToSingle(System.SByte,System.Int32,System.Int32)">SByteToSingle(SByte, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Converts an 8 bit <span class="xref">System.Single</span> to a 32 bit <span class="xref">System.Single</span>. |
| <p> |
| NOTE: This was byteToFloat() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[CLSCompliant(false)] |
| public static float SByteToSingle(sbyte b, int numMantissaBits, int zeroExp)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.SByte</span></td> |
| <td><span class="parametername">b</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">numMantissaBits</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">zeroExp</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_SingleToByte_System_Single_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.SingleToByte(System.Single%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L49">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_SingleToByte_" data-uid="Lucene.Net.Util.SmallSingle.SingleToByte*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_SingleToByte_System_Single_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.SmallSingle.SingleToByte(System.Single,System.Int32,System.Int32)">SingleToByte(Single, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Converts a 32 bit <span class="xref">System.Single</span> to an 8 bit <span class="xref">System.Single</span>. |
| <p>Values less than zero are all mapped to zero. |
| <p>Values are truncated (rounded down) to the nearest 8 bit value. |
| <p>Values between zero and the smallest representable value |
| are rounded up.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static byte SingleToByte(float f, int numMantissaBits, int zeroExp)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">f</span></td> |
| <td><p>The 32 bit <span class="xref">System.Single</span> to be converted to an 8 bit <span class="xref">System.Single</span> (<span class="xref">System.Byte</span>). </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">numMantissaBits</span></td> |
| <td><p>The number of mantissa bits to use in the byte, with the remainder to be used in the exponent. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">zeroExp</span></td> |
| <td><p>The zero-point in the range of exponent values. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span></td> |
| <td><p>The 8 bit float representation. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_SingleToByte315_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.SingleToByte315(System.Single)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L134">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_SingleToByte315_" data-uid="Lucene.Net.Util.SmallSingle.SingleToByte315*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_SingleToByte315_System_Single_" data-uid="Lucene.Net.Util.SmallSingle.SingleToByte315(System.Single)">SingleToByte315(Single)</h4> |
| <div class="markdown level1 summary"><p>SingleToSByte((byte)b, mantissaBits=3, zeroExponent=15) |
| <p>smallest non-zero value = 5.820766E-10 |
| <p>largest value = 7.5161928E9 |
| <p>epsilon = 0.125 |
| <p> |
| NOTE: This was floatToByte315() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static byte SingleToByte315(float f)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">f</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_SingleToByte52_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.SingleToByte52(System.Single)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L202">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_SingleToByte52_" data-uid="Lucene.Net.Util.SmallSingle.SingleToByte52*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_SingleToByte52_System_Single_" data-uid="Lucene.Net.Util.SmallSingle.SingleToByte52(System.Single)">SingleToByte52(Single)</h4> |
| <div class="markdown level1 summary"><p>SingleToByte(b, mantissaBits=5, zeroExponent=2) |
| <p>smallest nonzero value = 0.033203125 |
| <p>largest value = 1984.0 |
| <p>epsilon = 0.03125 |
| <p> |
| NOTE: This was floatToByte52() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static byte SingleToByte52(float f)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">f</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_SingleToSByte_System_Single_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.SingleToSByte(System.Single%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L67">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_SingleToSByte_" data-uid="Lucene.Net.Util.SmallSingle.SingleToSByte*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_SingleToSByte_System_Single_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.SmallSingle.SingleToSByte(System.Single,System.Int32,System.Int32)">SingleToSByte(Single, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Converts a 32 bit <span class="xref">System.Single</span> to an 8 bit <span class="xref">System.Single</span>. |
| <p>Values less than zero are all mapped to zero. |
| <p>Values are truncated (rounded down) to the nearest 8 bit value. |
| <p>Values between zero and the smallest representable value |
| are rounded up. |
| <p> |
| NOTE: This was floatToByte() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[CLSCompliant(false)] |
| public static sbyte SingleToSByte(float f, int numMantissaBits, int zeroExp)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">f</span></td> |
| <td><p>The 32 bit <span class="xref">System.Single</span> to be converted to an 8 bit <span class="xref">System.Single</span> (<span class="xref">System.SByte</span>). </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">numMantissaBits</span></td> |
| <td><p>The number of mantissa bits to use in the byte, with the remainder to be used in the exponent. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">zeroExp</span></td> |
| <td><p>The zero-point in the range of exponent values. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.SByte</span></td> |
| <td><p>The 8 bit float representation. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_SingleToSByte315_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.SingleToSByte315(System.Single)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L147">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_SingleToSByte315_" data-uid="Lucene.Net.Util.SmallSingle.SingleToSByte315*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_SingleToSByte315_System_Single_" data-uid="Lucene.Net.Util.SmallSingle.SingleToSByte315(System.Single)">SingleToSByte315(Single)</h4> |
| <div class="markdown level1 summary"><p>SingleToSByte(b, mantissaBits=3, zeroExponent=15) |
| <p>smallest non-zero value = 5.820766E-10 |
| <p>largest value = 7.5161928E9 |
| <p>epsilon = 0.125 |
| <p> |
| NOTE: This was floatToByte315() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[CLSCompliant(false)] |
| public static sbyte SingleToSByte315(float f)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">f</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.SByte</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle_SingleToSByte52_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle.SingleToSByte52(System.Single)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L215">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_SmallSingle_SingleToSByte52_" data-uid="Lucene.Net.Util.SmallSingle.SingleToSByte52*"></a> |
| <h4 id="Lucene_Net_Util_SmallSingle_SingleToSByte52_System_Single_" data-uid="Lucene.Net.Util.SmallSingle.SingleToSByte52(System.Single)">SingleToSByte52(Single)</h4> |
| <div class="markdown level1 summary"><p>SingleToSByte(b, mantissaBits=5, zeroExponent=2) |
| <p>smallest nonzero value = 0.033203125 |
| <p>largest value = 1984.0 |
| <p>epsilon = 0.03125 |
| <p> |
| NOTE: This was floatToByte52() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[CLSCompliant(false)] |
| public static sbyte SingleToSByte52(float f)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">f</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.SByte</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_SmallSingle.md&value=---%0Auid%3A%20Lucene.Net.Util.SmallSingle%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/SmallFloat.cs/#L29" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
