rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / frexp.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
<refentry id="frexp">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>frexp</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>frexp</refname>\r
        <refpurpose>split a floating point number</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genType <function>frexp</function></funcdef>\r
                <paramdef>genType <parameter>x</parameter></paramdef>\r
                <paramdef>out genIType <parameter>exp</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>genDType <function>frexp</function></funcdef>\r
                <paramdef>genDType <parameter>x</parameter></paramdef>\r
                <paramdef>out genIType <parameter>exp</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>x</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the value from which significand and exponent are to be extracted.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>out exp</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the variable into which to place the exponent\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>frexp</function> extracts <parameter>x</parameter> into a floating-point significand\r
            in the range [0.5, 1.0) and in integral exponent of two, such that:\r
        </para>\r
        <para>\r
            <inlineequation><mml:math>\r
                <mml:mi>x</mml:mi>\r
                <mml:mo>=</mml:mo>\r
                <mml:mi>significand</mml:mi>\r
                <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>\r
                <mml:msup>\r
                <mml:mn>2</mml:mn>\r
                <mml:mi>exponent</mml:mi>\r
                </mml:msup>\r
            </mml:math></inlineequation>\r
        </para>\r
        <para>\r
            The significand is returned by the function and the exponent is returned in the output\r
            parameter <parameter>exp</parameter>. For a floating-point value of zero, the\r
            significand and exponent are both zero. For a floating-point value that is an\r
            infinity or a floating-point NaN, the results are undefined.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="versions"><title>Version Support</title>\r
        <informaltable frame="topbot">\r
            #VARTABLECOLS#\r
                <thead>\r
                    #FUNCTABLEHEADER#\r
                    <row>\r
                        <entry>frexp (genType)</entry>#newin40#\r
                    </row>\r
                    <row>\r
                        <entry>frexp (genDType)</entry>#newin40#\r
                    </row>\r
                </thead>\r
            </tgroup>\r
        </informaltable>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>ldexp</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
            This material may be distributed subject to the terms and conditions set forth in \r
            the Open Publication License, v 1.0, 8 June 1999.\r
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
        </para>\r
    </refsect1>\r
</refentry>\r