upstream-man-pages/manglsl/xhtml/frexp.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>frexp - OpenGL Shading Language (GLSL)</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="frexp"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>frexp — split a floating point number</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><p><code class="funcdef">genType <b class="fsfunc">frexp</b>(</code>genType <var class="pdparam">x</var>, out genIType <var class="pdparam">exp</var><code>)</code>;</p><p><code class="funcdef">genDType <b class="fsfunc">frexp</b>(</code>genDType <var class="pdparam">x</var>, out genIType <var class="pdparam">exp</var><code>)</code>;</p></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>x</code></em></span></dt><dd><p>
   5                     Specifies the value from which significand and exponent are to be extracted.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>out exp</code></em></span></dt><dd><p>
   7                     Specifies the variable into which to place the exponent
   8                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   9             <code class="function">frexp</code> extracts <em class="parameter"><code>x</code></em> into a floating-point significand
  10             in the range [0.5, 1.0) and in integral exponent of two, such that:
  11         </p><p>
  12             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  13                 <mml:mi>x</mml:mi>
  14                 <mml:mo>=</mml:mo>
  15                 <mml:mi>significand</mml:mi>
  16                 <mml:mo lspace="2px" rspace="2px">⋅</mml:mo>
  17                 <mml:msup>
  18                 <mml:mn>2</mml:mn>
  19                 <mml:mi>exponent</mml:mi>
  20                 </mml:msup>
  21             </mml:math>
  22         </p><p>
  23             The significand is returned by the function and the exponent is returned in the output
  24             parameter <em class="parameter"><code>exp</code></em>. For a floating-point value of zero, the
  25             significand and exponent are both zero. For a floating-point value that is an
  26             infinity or a floating-point NaN, the results are undefined.
  27         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="versions"></a><h2>Version Support</h2><div class="informaltable"><table border="1"><colgroup><col align="left" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /></colgroup><thead><tr><th align="left"><span class="bold"><strong>Function</strong></span></th><th align="left"><span class="bold"><strong>Version 1.10</strong></span></th><th align="left"><span class="bold"><strong>Version 1.20</strong></span></th><th align="left"><span class="bold"><strong>Version 1.30</strong></span></th><th align="left"><span class="bold"><strong>Version 1.40</strong></span></th><th align="left"><span class="bold"><strong>Version 1.50</strong></span></th><th align="left"><span class="bold"><strong>Version 3.30</strong></span></th><th align="left"><span class="bold"><strong>Version 4.00</strong></span></th><th align="left"><span class="bold"><strong>Version 4.10</strong></span></th><th align="left"><span class="bold"><strong>Version 4.20</strong></span></th><th align="center"><span class="bold"><strong>Version 4.30</strong></span></th></tr><tr><th align="left">frexp (genType)</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr><tr><th align="left">frexp (genDType)</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr></thead></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  28             <a href="ldexp.xml"><span class="citerefentry"><span class="refentrytitle">ldexp</span></span></a>
  29         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  30             Copyright <span class="trademark"></span>© 2011 Khronos Group.
  31             This material may be distributed subject to the terms and conditions set forth in
  32             the Open Publication License, v 1.0, 8 June 1999.
  33             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  34         </p></div></div></body></html>