upstream-man-pages/manglsl/ldexp.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="ldexp">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>ldexp</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>ldexp</refname>
  17         <refpurpose>assemble a floating point number from a value and exponent</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>ldexp</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24                 <paramdef>genIType <parameter>exp</parameter></paramdef>
  25             </funcprototype>
  26             <funcprototype>
  27                 <funcdef>genDType <function>ldexp</function></funcdef>
  28                 <paramdef>genDType <parameter>x</parameter></paramdef>
  29                 <paramdef>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 to be used as a source of significand.
  40                 </para>
  41             </listitem>
  42         </varlistentry>
  43         <varlistentry>
  44             <term><parameter>out exp</parameter></term>
  45             <listitem>
  46                 <para>
  47                     Specifies the value to be used as a source of exponent.
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         </variablelist>
  52     </refsect1>
  53     <refsect1 id="description"><title>Description</title>
  54         <para>
  55             <function>ldexp</function> builds a floating point number from <parameter>x</parameter> and
  56             the corresponding integral exponent of two in <parameter>exp</parameter>, returning:
  57         </para>
  58         <para>
  59             <inlineequation><mml:math>
  60                 <mml:mi>significand</mml:mi>
  61                 <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
  62                 <mml:msup>
  63                     <mml:mn>2</mml:mn>
  64                     <mml:mi>exponent</mml:mi>
  65                 </mml:msup>
  66             </mml:math></inlineequation>
  67         </para>
  68         <para>
  69             If this product is too large to be represented in the floating point type, the result
  70             is undefined.
  71         </para>
  72     </refsect1>
  73     <refsect1 id="versions"><title>Version Support</title>
  74         <informaltable frame="topbot">
  75             #VARTABLECOLS#
  76                 <thead>
  77                     #FUNCTABLEHEADER#
  78                     <row>
  79                         <entry>ldexp (genType)</entry>#newin40#
  80                     </row>
  81                     <row>
  82                         <entry>ldexp (genDType)</entry>#newin40#
  83                     </row>
  84                 </thead>
  85             </tgroup>
  86         </informaltable>
  87     </refsect1>
  88     <refsect1 id="seealso"><title>See Also</title>
  89         <para>
  90             <citerefentry><refentrytitle>frexp</refentrytitle></citerefentry>
  91         </para>
  92     </refsect1>
  93     <refsect1 id="Copyright"><title>Copyright</title>
  94         <para>
  95             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  96             This material may be distributed subject to the terms and conditions set forth in
  97             the Open Publication License, v 1.0, 8 June 1999.
  98             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  99         </para>
 100     </refsect1>
 101 </refentry>