1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="frexp">
<info>
<copyright>
<year>2011-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>frexp</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>frexp</refname>
<refpurpose>split a floating point number</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Declaration</title>
<funcsynopsis>
<funcprototype>
<funcdef>genType <function>frexp</function></funcdef>
<paramdef>genType <parameter>x</parameter></paramdef>
<paramdef>out genIType <parameter>exp</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>genDType <function>frexp</function></funcdef>
<paramdef>genDType <parameter>x</parameter></paramdef>
<paramdef>out genIType <parameter>exp</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<para>
Specifies the value from which significand and exponent are to be extracted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>out exp</parameter></term>
<listitem>
<para>
Specifies the variable into which to place the exponent
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para>
<function>frexp</function> extracts <parameter>x</parameter> into a floating-point significand
in the range [0.5, 1.0) and in integral exponent of two, such that:
</para>
<para>
<inlineequation><mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mi>x</mml:mi>
<mml:mo>=</mml:mo>
<mml:mi>significand</mml:mi>
<mml:mo lspace="2px" rspace="2px">⋅</mml:mo>
<mml:msup>
<mml:mn>2</mml:mn>
<mml:mi>exponent</mml:mi>
</mml:msup>
</mml:math></inlineequation>
</para>
<para>
The significand is returned by the function and the exponent is returned in the output
parameter <parameter>exp</parameter>. For a floating-point value of zero, the
significand and exponent are both zero. For a floating-point value that is an
infinity or a floating-point NaN, the results are undefined.
</para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="funchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry>frexp (genType)</entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='40']/*)"/>
</row>
<row>
<entry>frexp (genDType)</entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='40']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>ldexp</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 2011-2014 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>
|