upstream-man-pages/manglsl/frexp.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="frexp">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>frexp</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>frexp</refname>
  17         <refpurpose>split a floating point number</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>frexp</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24                 <paramdef>out genIType <parameter>exp</parameter></paramdef>
  25             </funcprototype>
  26             <funcprototype>
  27                 <funcdef>genDType <function>frexp</function></funcdef>
  28                 <paramdef>genDType <parameter>x</parameter></paramdef>
  29                 <paramdef>out genIType <parameter>exp</parameter></paramdef>
  30             </funcprototype>
  31         </funcsynopsis>
  32     </refsynopsisdiv>
  33     <refsect1 id="parameters"><title>Parameters</title>
  34         <variablelist>
  35         <varlistentry>
  36             <term><parameter>x</parameter></term>
  37             <listitem>
  38                 <para>
  39                     Specifies the value from which significand and exponent are to be extracted.
  40                 </para>
  41             </listitem>
  42         </varlistentry>
  43         <varlistentry>
  44             <term><parameter>out exp</parameter></term>
  45             <listitem>
  46                 <para>
  47                     Specifies the variable into which to place the exponent
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         </variablelist>
  52     </refsect1>
  53     <refsect1 id="description"><title>Description</title>
  54         <para>
  55             <function>frexp</function> extracts <parameter>x</parameter> into a floating-point significand
  56             in the range [0.5, 1.0) and in integral exponent of two, such that:
  57         </para>
  58         <para>
  59             <inlineequation><mml:math>
  60                 <mml:mi>x</mml:mi>
  61                 <mml:mo>=</mml:mo>
  62                 <mml:mi>significand</mml:mi>
  63                 <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
  64                 <mml:msup>
  65                 <mml:mn>2</mml:mn>
  66                 <mml:mi>exponent</mml:mi>
  67                 </mml:msup>
  68             </mml:math></inlineequation>
  69         </para>
  70         <para>
  71             The significand is returned by the function and the exponent is returned in the output
  72             parameter <parameter>exp</parameter>. For a floating-point value of zero, the
  73             significand and exponent are both zero. For a floating-point value that is an
  74             infinity or a floating-point NaN, the results are undefined.
  75         </para>
  76     </refsect1>
  77     <refsect1 id="versions"><title>Version Support</title>
  78         <informaltable frame="topbot">
  79             #VARTABLECOLS#
  80                 <thead>
  81                     #FUNCTABLEHEADER#
  82                     <row>
  83                         <entry>frexp (genType)</entry>#newin40#
  84                     </row>
  85                     <row>
  86                         <entry>frexp (genDType)</entry>#newin40#
  87                     </row>
  88                 </thead>
  89             </tgroup>
  90         </informaltable>
  91     </refsect1>
  92     <refsect1 id="seealso"><title>See Also</title>
  93         <para>
  94             <citerefentry><refentrytitle>ldexp</refentrytitle></citerefentry>
  95         </para>
  96     </refsect1>
  97     <refsect1 id="Copyright"><title>Copyright</title>
  98         <para>
  99             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 100             This material may be distributed subject to the terms and conditions set forth in
 101             the Open Publication License, v 1.0, 8 June 1999.
 102             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 103         </para>
 104     </refsect1>
 105 </refentry>