sdk/1.2/docs/man/divide.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">

<refentry>
    <refentryinfo>
        <keywordset>
            <keyword>half_divide, native_divide</keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>
        <refentrytitle>half_divide, native_divide</refentrytitle>

        <refmiscinfo>
            <copyright>
                <year>2007-2011</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="divide">
        <refname>half_divide, native_divide</refname>

        <refpurpose>
            Division functions.
        </refpurpose>
    </refnamediv>

    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>
                    gentype
                    <function>
                        half_divide
                    </function>
                </funcdef>
                <paramdef>gentype<parameter>x</parameter></paramdef>
                <paramdef>gentype<parameter>y</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>

        <funcsynopsis>
            <funcprototype>
                <funcdef>
                    gentype
                    <function>
                        native_divide
                    </function>
                </funcdef>
                <paramdef>gentype<parameter>x</parameter></paramdef>
                <paramdef>gentype<parameter>y</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>

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

    <refsect1 id="description"><title>Description</title>
        <para>
          <function>half_divide</function> computes <varname>x</varname> /
          <varname>y</varname>. This function is implemented with a minimum of 10-bits of
          accuracy i.e. an ULP value less than or equal to 8192 ulp.
        </para>

        <para>
          <function>native_cos</function> computes cosine over an implementation-defined range.
          The maximum error is implementation-defined.
        </para>

        <para>
          The vector versions of the math functions operate component-wise.  The description
          is percomponent.
        </para>

        <para>
          The built-in math functions are not affected by the prevailing rounding mode in the
          calling environment, and always return the same value as they would if called with
          the round to nearest even rounding mode.
        </para>

        <para>
          For any specific use of a function, the actual type has to be the same for all
          arguments and the return type, unless otherwise specified.
        </para>

        <para>
          The functions with the native_ prefix may map to one or more native device instructions
          and will typically have better performance compared to the corresponding functions
          (without the native__ prefix).  The accuracy (and in some cases the input range(s))
          of these functions is implementation-defined.
        </para>

        <para>
          <type>gentype</type> indicates that the functions can take <type>float</type>,
          <type>float2</type>, <type>float3</type>, <type>float4</type>, <type>float8</type>
          or <type>float16</type> as the type for the arguments.
        </para>
    </refsect1>

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

<!--
    <refsect1 id="notes"><title>Notes</title>
    </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>
        </para>
    </refsect1>

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

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

<!-- 17-Oct-2011 -->
</refentry>