← Back to branch summary

~ubuntu-branches/ubuntu/trusty/khronos-opencl-man/trusty

« back to all changes in this revision

Viewing changes to sqrt.xml

  • Committer: Package Import Robot
  • Author(s): Mathieu Malaterre
  • Date: 2013-05-21 18:06:15 UTC
  • Revision ID: package-import@ubuntu.com-20130521180615-6e0s2n3pai95ip2f
Tags: upstream-1.0~svn21772
Import upstream version 1.0~svn21772

Show diffs side-by-side

added added

removed removed

Lines of Context:
sqrt.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
<!ENTITY mathFunctionsInc SYSTEM "mathFunctionsInc.xml">
 
5
]>
 
6
 
 
7
<refentry>
 
8
    <refentryinfo>
 
9
        <keywordset>
 
10
            <keyword>sqrt, rsqrt, half_sqrt, native_sqrt, half_sqrt, native_sqrt</keyword>
 
11
        </keywordset>
 
12
    </refentryinfo>
 
13
 
 
14
    <refmeta>
 
15
        <refentrytitle>sqrt, rsqrt, half_sqrt, native_sqrt, half_sqrt, native_sqrt</refentrytitle>
 
16
 
 
17
        <refmiscinfo>
 
18
            <copyright>
 
19
                <year>2007-2011</year>
 
20
                <holder>The Khronos Group Inc.
 
21
 Permission is hereby granted, free of charge, to any person obtaining a
 
22
copy of this software and/or associated documentation files (the
 
23
"Materials"), to deal in the Materials without restriction, including
 
24
without limitation the rights to use, copy, modify, merge, publish,
 
25
distribute, sublicense, and/or sell copies of the Materials, and to
 
26
permit persons to whom the Materials are furnished to do so, subject to
 
27
the condition that this copyright notice and permission notice shall be included
 
28
in all copies or substantial portions of the Materials.</holder>
 
29
            </copyright>
 
30
        </refmiscinfo>
 
31
        <manvolnum>3</manvolnum>
 
32
    </refmeta>
 
33
 
 
34
<!-- ================================ SYNOPSIS -->
 
35
 
 
36
    <refnamediv id="sqrt">
 
37
        <refname>sqrt, rsqrt, half_sqrt, native_sqrt, half_sqrt, native_sqrt</refname>
 
38
 
 
39
        <refpurpose>
 
40
            Square root functions.
 
41
        </refpurpose>
 
42
    </refnamediv>
 
43
 
 
44
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
45
        <funcsynopsis>
 
46
            <funcprototype>
 
47
                <funcdef>
 
48
                    gentype
 
49
                    <function>
 
50
                        sqrt
 
51
                    </function>
 
52
                </funcdef>
 
53
                <paramdef>gentype<parameter></parameter></paramdef>
 
54
            </funcprototype>
 
55
        </funcsynopsis>
 
56
 
 
57
        <funcsynopsis>
 
58
            <funcprototype>
 
59
                <funcdef>
 
60
                    gentype
 
61
                    <function>
 
62
                        half_sqrt
 
63
                    </function>
 
64
                </funcdef>
 
65
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
66
            </funcprototype>
 
67
        </funcsynopsis>
 
68
 
 
69
        <funcsynopsis>
 
70
            <funcprototype>
 
71
                <funcdef>
 
72
                    gentype
 
73
                    <function>
 
74
                        native_sqrt
 
75
                    </function>
 
76
                </funcdef>
 
77
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
78
            </funcprototype>
 
79
        </funcsynopsis>
 
80
 
 
81
        <funcsynopsis>
 
82
            <funcprototype>
 
83
                <funcdef>
 
84
                    gentype
 
85
                    <function>
 
86
                        rsqrt
 
87
                    </function>
 
88
                </funcdef>
 
89
                <paramdef>gentype<parameter></parameter></paramdef>
 
90
            </funcprototype>
 
91
        </funcsynopsis>
 
92
 
 
93
        <funcsynopsis>
 
94
            <funcprototype>
 
95
                <funcdef>
 
96
                    gentype
 
97
                    <function>
 
98
                        half_rsqrt
 
99
                    </function>
 
100
                </funcdef>
 
101
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
102
            </funcprototype>
 
103
        </funcsynopsis>
 
104
 
 
105
        <funcsynopsis>
 
106
            <funcprototype>
 
107
                <funcdef>
 
108
                    gentype
 
109
                    <function>
 
110
                        native_rsqrt
 
111
                    </function>
 
112
                </funcdef>
 
113
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
114
            </funcprototype>
 
115
        </funcsynopsis>
 
116
    </refsynopsisdiv>
 
117
 
 
118
<!-- ================================ DESCRIPTION  -->
 
119
 
 
120
    <refsect1 id="description"><title>Description</title>
 
121
        <para>
 
122
          <function>sqrt</function> computes square root.
 
123
        </para>
 
124
 
 
125
        <para>
 
126
          <function>half_sqrt</function> computes square root.
 
127
        </para>
 
128
 
 
129
        <para>
 
130
          <function>native_sqrt</function> computes square root over an implementation-defined
 
131
          range. The maximum error is implementation-defined.
 
132
        </para>
 
133
 
 
134
        <para>
 
135
          <function>rsqrt</function> computes inverse square root.
 
136
        </para>
 
137
 
 
138
        <para>
 
139
          <function>half_rsqrt</function> computes inverse square root.
 
140
        </para>
 
141
 
 
142
        <para>
 
143
          <function>native_rsqrt</function> computes inverse square root over an
 
144
          implementation-defined range. The maximum error is implementation-defined.
 
145
        </para>
 
146
    </refsect1>
 
147
 
 
148
<!-- ================================ NOTES  -->
 
149
 
 
150
    <refsect1 id="notes"><title>Notes</title>
 
151
 
 
152
        &mathFunctionsInc;
 
153
 
 
154
        <para>
 
155
          Functions with the <constant>half_</constant> prefix are implemented with a minimum
 
156
          of 10-bits of accuracy i.e. an ULP value less than or equal to 8192 ulp.
 
157
        </para>
 
158
 
 
159
        <para>
 
160
          Functions with the <constant>native_</constant> prefix may map to one or more
 
161
          native device instructions and will typically have better performance compared to the
 
162
          corresponding functions (without the <constant>native__</constant> prefix). The accuracy
 
163
          (and in some cases the input range(s)) of these functions is implementation-defined.
 
164
        </para>
 
165
    </refsect1>
 
166
 
 
167
<!-- ================================ EXAMPLE  -->
 
168
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
169
<!--
 
170
    <refsect2 id="example1">
 
171
        <title>
 
172
            Example
 
173
        </title>
 
174
 
 
175
        <informaltable frame="none">
 
176
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
177
                <colspec colname="col1" colnum="1" />
 
178
                <tbody>
 
179
                    <row>
 
180
                        <entry>
 
181
                            Example goes here - it will be set in "code" type with white space preserved.
 
182
                        </entry>
 
183
                    </row>
 
184
                </tbody>
 
185
            </tgroup>
 
186
        </informaltable>
 
187
    </refsect2>
 
188
-->
 
189
 
 
190
<!-- ================================ SPECIFICATION  -->
 
191
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
192
-->
 
193
    <refsect1 id="specification"><title>Specification</title>
 
194
        <para>
 
195
            <imageobject>
 
196
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
197
            </imageobject>
 
198
 
 
199
            <olink uri="mathFunctions">OpenCL Specification</olink>
 
200
        </para>
 
201
    </refsect1>
 
202
 
 
203
<!-- ================================ ALSO SEE  -->
 
204
 
 
205
    <refsect1 id="seealso"><title>Also see</title>
 
206
        <para>
 
207
            <citerefentry href="mathFunctions"><refentrytitle>Math Functions</refentrytitle></citerefentry>
 
208
        </para>
 
209
    </refsect1>
 
210
 
 
211
<!-- ============================== COPYRIGHT -->
 
212
<!-- Content included from copyright.inc.xsl -->
 
213
 
 
214
    <refsect3 id="Copyright"><title></title>
 
215
        <imageobject>
 
216
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
217
        </imageobject>
 
218
        <para />
 
219
    </refsect3>
 
220
 
 
221
<!-- 13-Oct-2011 -->
 
222
</refentry>
 
223