sdk/1.1/docs/man/fma.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd" [
<!ENTITY mathFunctionsInc SYSTEM "mathFunctionsInc.xml">
]>
<refentry>
    <refentryinfo>
        <keywordset>
            <keyword>fma</keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>                                    
        <refentrytitle>fma</refentrytitle>

        <refmiscinfo>
            <copyright>
                <year>2007-2010</year>
                <holder>The Khronos Group Inc. 
 Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.</holder>
            </copyright>
        </refmiscinfo>
        <manvolnum>3</manvolnum>
    </refmeta>

<!-- ================================ SYNOPSIS -->

    <refnamediv id="fma">             
        <refname>fma</refname>

        <refpurpose>
            Multiply and add, then round.
        </refpurpose>
    </refnamediv>

    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>
                    gentype
                    <function>                   
                        fma
                    </function>
                </funcdef>
                <paramdef>gentype<parameter>a</parameter></paramdef>    
                <paramdef>gentype<parameter>b</parameter></paramdef>    
                <paramdef>gentype<parameter>c</parameter></paramdef>    
            </funcprototype>
        </funcsynopsis>     
    </refsynopsisdiv>   
    

<!-- ================================ DESCRIPTION  -->

    <refsect1 id="description"><title>Description</title>
        <para>Returns the correctly rounded floating-point
representation of the sum of <varname>c</varname> with the infinitely
precise product of <varname>a</varname> and <varname>b</varname>. Rounding of
intermediate products shall not occur. Edge case
behavior is per the IEEE 754-2008 standard.</para>
    </refsect1>

<!-- ================================ NOTES  -->

    <refsect1 id="notes"><title>Notes</title>
        &mathFunctionsInc;
        <para>
        The <citerefentry href="FP_CONTRACT"><refentrytitle>FP_FAST_FMA_HALF</refentrytitle></citerefentry> macro indicates whether the <function>fma</function>() family of functions are fast
compared with direct code for half precision floating-point. If defined, the
<citerefentry href="FP_CONTRACT"><refentrytitle>FP_FAST_FMA_HALF</refentrytitle></citerefentry> macro shall indicate that the <function>fma</function>() function generally executes about as
fast as, or faster than, a multiply and an add of half operands
        </para>
    </refsect1>

<!-- ================================ EXAMPLE  -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
<!--
    <refsect2 id="example1">
        <title>
            Example
        </title>

        <informaltable frame="none">
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
                <colspec colname="col1" colnum="1" />
                <tbody>
                    <row>
                        <entry>
                            Example goes here - it will be set in "code" type with white space preserved.
                        </entry>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect2>
-->


<!-- ================================ SPECIFICATION  -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
    <refsect1 id="specification"><title>Specification</title>
        <para>
            <imageobject>
                <imagedata fileref="pdficon_small1.gif" format="gif" />
            </imageobject>
                                                 
            <olink uri="mathFunctions">OpenCL Specification</olink>
        </para>
    </refsect1>


<!-- ================================ ALSO SEE  -->

    <refsect1 id="seealso"><title>Also see</title>
        <para>
            <citerefentry href="mathFunctions"><refentrytitle>Math Functions</refentrytitle></citerefentry>,  
            <citerefentry href="FP_CONTRACT"><refentrytitle>Floating-Point Macros and Pragma</refentrytitle></citerefentry>,  
        </para>
    </refsect1>



<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->

    <refsect3 id="Copyright"><title></title>
        <imageobject>
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
        </imageobject>
        <para />
    </refsect3>

</refentry>