← Back to branch summary

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

« back to all changes in this revision

Viewing changes to sin.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:
sin.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>sin, sincos, sinh, sinpi</keyword>
 
11
        </keywordset>
 
12
    </refentryinfo>
 
13
 
 
14
    <refmeta>
 
15
        <refentrytitle>sin, sincos, sinh, sinpi</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="sin">
 
37
        <refname>sin, sincos, sinh, sinpi, half_sin, native_sin</refname>
 
38
 
 
39
        <refpurpose>
 
40
            Sine 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
                        sin
 
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
                        sincos
 
63
                    </function>
 
64
                </funcdef>
 
65
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
66
                <paramdef><link xlink:href="global.html">__global</link>  gentype<parameter>*cosval</parameter></paramdef>
 
67
            </funcprototype>
 
68
        </funcsynopsis>
 
69
 
 
70
        <funcsynopsis>
 
71
            <funcprototype>
 
72
                <funcdef>
 
73
                    gentype
 
74
                    <function>
 
75
                        sincos
 
76
                    </function>
 
77
                </funcdef>
 
78
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
79
                <paramdef><link xlink:href="local.html">__local</link> gentype<parameter>*cosval</parameter></paramdef>
 
80
            </funcprototype>
 
81
        </funcsynopsis>
 
82
 
 
83
        <funcsynopsis>
 
84
            <funcprototype>
 
85
                <funcdef>
 
86
                    gentype
 
87
                    <function>
 
88
                        sincos
 
89
                    </function>
 
90
                </funcdef>
 
91
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
92
                <paramdef><link xlink:href="private.html">__private</link>  gentype<parameter>*cosval</parameter></paramdef>
 
93
            </funcprototype>
 
94
        </funcsynopsis>
 
95
 
 
96
        <funcsynopsis>
 
97
            <funcprototype>
 
98
                <funcdef>
 
99
                    gentype
 
100
                    <function>
 
101
                        sinh
 
102
                    </function>
 
103
                </funcdef>
 
104
                <paramdef>gentype<parameter></parameter></paramdef>
 
105
            </funcprototype>
 
106
        </funcsynopsis>
 
107
 
 
108
        <funcsynopsis>
 
109
            <funcprototype>
 
110
                <funcdef>
 
111
                    gentype
 
112
                    <function>
 
113
                        sinpi
 
114
                    </function>
 
115
                </funcdef>
 
116
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
117
            </funcprototype>
 
118
        </funcsynopsis>
 
119
 
 
120
        <funcsynopsis>
 
121
            <funcprototype>
 
122
                <funcdef>
 
123
                    gentype
 
124
                    <function>
 
125
                        half_sin
 
126
                    </function>
 
127
                </funcdef>
 
128
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
129
            </funcprototype>
 
130
        </funcsynopsis>
 
131
 
 
132
        <funcsynopsis>
 
133
            <funcprototype>
 
134
                <funcdef>
 
135
                    gentype
 
136
                    <function>
 
137
                        native_sin
 
138
                    </function>
 
139
                </funcdef>
 
140
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
141
            </funcprototype>
 
142
        </funcsynopsis>
 
143
    </refsynopsisdiv>
 
144
 
 
145
<!-- ================================ DESCRIPTION  -->
 
146
 
 
147
    <refsect1 id="description"><title>Description</title>
 
148
        <para>
 
149
            <function>sin</function> computes the sine.
 
150
        </para>
 
151
 
 
152
        <para>
 
153
          <function>sincos</function> computes sine and cosine of <varname>x</varname>. The
 
154
          computed sine is the return value and computed cosine is returned in
 
155
          <varname>cosval</varname>.
 
156
        </para>
 
157
 
 
158
        <para>
 
159
          <function>sinh</function> computes the hyperbolic sine.
 
160
        </para>
 
161
 
 
162
        <para>
 
163
          <function>sinpi</function> computes <function>sin</function> (<varname>pi * x</varname>).
 
164
        </para>
 
165
 
 
166
        <para>
 
167
          <function>half_sin</function> computes sine. <varname>x</varname> must be in the
 
168
          range -2<superscript>16</superscript>... +2<superscript>16</superscript>.
 
169
        </para>
 
170
 
 
171
        <para>
 
172
          <function>native_sin</function> computes sine over an implementation-defined range. The
 
173
          maximum error is implementation-defined.
 
174
        </para>
 
175
    </refsect1>
 
176
 
 
177
<!-- ================================ NOTES  -->
 
178
 
 
179
    <refsect1 id="notes"><title>Notes</title>
 
180
 
 
181
        &mathFunctionsInc;
 
182
 
 
183
        <para>
 
184
          Functions with the <constant>half_</constant> prefix are implemented with a minimum
 
185
          of 10-bits of accuracy i.e. an ULP value &le; 8192 ulp.
 
186
        </para>
 
187
 
 
188
        <para>
 
189
          Functions with the <constant>native__</constant> prefix may map to one or more
 
190
          native device instructions and will typically have better performance compared to the
 
191
          corresponding functions (without the <constant>native__</constant> prefix). The accuracy
 
192
          (and in some cases the input range(s)) of these functions is implementation-defined.
 
193
        </para>
 
194
    </refsect1>
 
195
 
 
196
<!-- ================================ EXAMPLE  -->
 
197
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
198
<!--
 
199
    <refsect2 id="example1">
 
200
        <title>
 
201
            Example
 
202
        </title>
 
203
 
 
204
        <informaltable frame="none">
 
205
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
206
                <colspec colname="col1" colnum="1" />
 
207
                <tbody>
 
208
                    <row>
 
209
                        <entry>
 
210
                            Example goes here - it will be set in "code" type with white space preserved.
 
211
                        </entry>
 
212
                    </row>
 
213
                </tbody>
 
214
            </tgroup>
 
215
        </informaltable>
 
216
    </refsect2>
 
217
-->
 
218
 
 
219
<!-- ================================ SPECIFICATION  -->
 
220
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
221
-->
 
222
    <refsect1 id="specification"><title>Specification</title>
 
223
        <para>
 
224
            <imageobject>
 
225
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
226
            </imageobject>
 
227
 
 
228
            <olink uri="mathFunctions">OpenCL Specification</olink>
 
229
        </para>
 
230
    </refsect1>
 
231
 
 
232
<!-- ================================ ALSO SEE  -->
 
233
 
 
234
    <refsect1 id="seealso"><title>Also see</title>
 
235
        <para>
 
236
            <citerefentry href="mathFunctions"><refentrytitle>Math Functions</refentrytitle></citerefentry>
 
237
        </para>
 
238
    </refsect1>
 
239
 
 
240
<!-- ============================== COPYRIGHT -->
 
241
<!-- Content included from copyright.inc.xsl -->
 
242
 
 
243
    <refsect3 id="Copyright"><title></title>
 
244
        <imageobject>
 
245
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
246
        </imageobject>
 
247
        <para />
 
248
    </refsect3>
 
249
 
 
250
<!-- 13-Oct-2011 -->
 
251
</refentry>
 
252