← Back to branch summary

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

« back to all changes in this revision

Viewing changes to lgamma.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:
lgamma.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
<refentry>
 
7
    <refentryinfo>
 
8
        <keywordset>
 
9
            <keyword>lgamma, lgamma_r</keyword>
 
10
        </keywordset>
 
11
    </refentryinfo>
 
12
 
 
13
    <refmeta>
 
14
        <refentrytitle>lgamma, lgamma_r</refentrytitle>
 
15
 
 
16
        <refmiscinfo>
 
17
            <copyright>
 
18
                <year>2007-2011</year>
 
19
                <holder>The Khronos Group Inc.
 
20
 Permission is hereby granted, free of charge, to any person obtaining a
 
21
copy of this software and/or associated documentation files (the
 
22
"Materials"), to deal in the Materials without restriction, including
 
23
without limitation the rights to use, copy, modify, merge, publish,
 
24
distribute, sublicense, and/or sell copies of the Materials, and to
 
25
permit persons to whom the Materials are furnished to do so, subject to
 
26
the condition that this copyright notice and permission notice shall be included
 
27
in all copies or substantial portions of the Materials.</holder>
 
28
            </copyright>
 
29
        </refmiscinfo>
 
30
        <manvolnum>3</manvolnum>
 
31
    </refmeta>
 
32
 
 
33
<!-- ================================ SYNOPSIS -->
 
34
 
 
35
    <refnamediv id="lgamma">
 
36
        <refname>lgamma, lgamma_r</refname>
 
37
 
 
38
        <refpurpose>
 
39
            Log gamma functions.
 
40
        </refpurpose>
 
41
    </refnamediv>
 
42
 
 
43
<!-- floatn VARIATIONS===============================  -->
 
44
 
 
45
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
46
        <funcsynopsis>
 
47
            <funcprototype>
 
48
                <funcdef>
 
49
                    gentype
 
50
                    <function>
 
51
                        lgamma
 
52
                    </function>
 
53
                </funcdef>
 
54
                <paramdef>gentype<parameter>x</parameter></paramdef>
 
55
            </funcprototype>
 
56
        </funcsynopsis>
 
57
 
 
58
        <funcsynopsis>
 
59
            <funcprototype>
 
60
                <funcdef>
 
61
                    <link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link>
 
62
                    <function>
 
63
                        lgamma_r
 
64
                    </function>
 
65
                </funcdef>
 
66
                <paramdef>
 
67
                    <link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link>
 
68
                    <parameter>x</parameter></paramdef>
 
69
                <paramdef><link xlink:href="global.html">__global</link>
 
70
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
71
                    <parameter>*signp</parameter>
 
72
                </paramdef>
 
73
            </funcprototype>
 
74
        </funcsynopsis>
 
75
 
 
76
        <funcsynopsis>
 
77
            <funcprototype>
 
78
                <funcdef>
 
79
                    <link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link>
 
80
                    <function>
 
81
                        lgamma_r
 
82
                    </function>
 
83
                </funcdef>
 
84
                <paramdef>
 
85
                    <link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link>
 
86
                    <parameter>x</parameter></paramdef>
 
87
                <paramdef><link xlink:href="local.html">__local</link>
 
88
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
89
                    <parameter>*signp</parameter>
 
90
                </paramdef>
 
91
            </funcprototype>
 
92
        </funcsynopsis>
 
93
 
 
94
        <funcsynopsis>
 
95
            <funcprototype>
 
96
                <funcdef>
 
97
                    <link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link>
 
98
                    <function>
 
99
                        lgamma_r
 
100
                    </function>
 
101
                </funcdef>
 
102
                <paramdef>
 
103
                    <link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link>
 
104
                    <parameter>x</parameter></paramdef>
 
105
                <paramdef><link xlink:href="private.html">__private</link>
 
106
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
107
                    <parameter>*signp</parameter>
 
108
                </paramdef>
 
109
            </funcprototype>
 
110
        </funcsynopsis>
 
111
 
 
112
<!-- float VARIATIONS===============================  -->
 
113
 
 
114
        <funcsynopsis>
 
115
            <funcprototype>
 
116
                <funcdef>
 
117
                    <link xlink:href="vectorDataTypes.html">float</link>
 
118
                    <function>
 
119
                        lgamma_r
 
120
                    </function>
 
121
                </funcdef>
 
122
                <paramdef>
 
123
                    <link xlink:href="vectorDataTypes.html">float</link>
 
124
                    <parameter>x</parameter></paramdef>
 
125
                <paramdef><link xlink:href="global.html">__global</link>
 
126
                    <link xlink:href="vectorDataTypes.html">int</link>
 
127
                    <parameter>*signp</parameter>
 
128
                </paramdef>
 
129
            </funcprototype>
 
130
        </funcsynopsis>
 
131
 
 
132
        <funcsynopsis>
 
133
            <funcprototype>
 
134
                <funcdef>
 
135
                    <link xlink:href="vectorDataTypes.html">float</link>
 
136
                    <function>
 
137
                        lgamma_r
 
138
                    </function>
 
139
                </funcdef>
 
140
                <paramdef>
 
141
                    <link xlink:href="vectorDataTypes.html">float</link>
 
142
                    <parameter>x</parameter></paramdef>
 
143
                <paramdef><link xlink:href="local.html">__local</link>
 
144
                    <link xlink:href="vectorDataTypes.html">int</link>
 
145
                    <parameter>*signp</parameter>
 
146
                </paramdef>
 
147
            </funcprototype>
 
148
        </funcsynopsis>
 
149
 
 
150
        <funcsynopsis>
 
151
            <funcprototype>
 
152
                <funcdef>
 
153
                    <link xlink:href="vectorDataTypes.html">float</link>
 
154
                    <function>
 
155
                        lgamma_r
 
156
                    </function>
 
157
                </funcdef>
 
158
                <paramdef>
 
159
                    <link xlink:href="vectorDataTypes.html">float</link>
 
160
                    <parameter>x</parameter></paramdef>
 
161
                <paramdef><link xlink:href="private.html">__private</link>
 
162
                    <link xlink:href="vectorDataTypes.html">int</link>
 
163
                    <parameter>*signp</parameter>
 
164
                </paramdef>
 
165
            </funcprototype>
 
166
        </funcsynopsis>
 
167
 
 
168
<!-- doublen VARIATIONS===============================  -->
 
169
 
 
170
        <funcsynopsis>
 
171
            <funcprototype>
 
172
                <funcdef>
 
173
                    <link xlink:href="vectorDataTypes.html">double<replaceable>n</replaceable></link>
 
174
                    <function>
 
175
                        lgamma_r
 
176
                    </function>
 
177
                </funcdef>
 
178
                <paramdef>
 
179
                    <link xlink:href="vectorDataTypes.html">double<replaceable>n</replaceable></link>
 
180
                    <parameter>x</parameter></paramdef>
 
181
                <paramdef><link xlink:href="global.html">__global</link>
 
182
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
183
                    <parameter>*signp</parameter>
 
184
                </paramdef>
 
185
            </funcprototype>
 
186
        </funcsynopsis>
 
187
 
 
188
        <funcsynopsis>
 
189
            <funcprototype>
 
190
                <funcdef>
 
191
                    <link xlink:href="vectorDataTypes.html">double<replaceable>n</replaceable></link>
 
192
                    <function>
 
193
                        lgamma_r
 
194
                    </function>
 
195
                </funcdef>
 
196
                <paramdef>
 
197
                    <link xlink:href="vectorDataTypes.html">double<replaceable>n</replaceable></link>
 
198
                    <parameter>x</parameter></paramdef>
 
199
                <paramdef><link xlink:href="local.html">__local</link>
 
200
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
201
                    <parameter>*signp</parameter>
 
202
                </paramdef>
 
203
            </funcprototype>
 
204
        </funcsynopsis>
 
205
 
 
206
        <funcsynopsis>
 
207
            <funcprototype>
 
208
                <funcdef>
 
209
                    <link xlink:href="vectorDataTypes.html">double<replaceable>n</replaceable></link>
 
210
                    <function>
 
211
                        lgamma_r
 
212
                    </function>
 
213
                </funcdef>
 
214
                <paramdef>
 
215
                    <link xlink:href="vectorDataTypes.html">double<replaceable>n</replaceable></link>
 
216
                    <parameter>x</parameter></paramdef>
 
217
                <paramdef><link xlink:href="private.html">__private</link>
 
218
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
219
                    <parameter>*signp</parameter>
 
220
                </paramdef>
 
221
            </funcprototype>
 
222
        </funcsynopsis>
 
223
 
 
224
<!-- double VARIATIONS===============================  -->
 
225
 
 
226
        <funcsynopsis>
 
227
            <funcprototype>
 
228
                <funcdef>
 
229
                    <link xlink:href="vectorDataTypes.html">double</link>
 
230
                    <function>
 
231
                        lgamma_r
 
232
                    </function>
 
233
                </funcdef>
 
234
                <paramdef>
 
235
                    <link xlink:href="vectorDataTypes.html">double</link>
 
236
                    <parameter>x</parameter></paramdef>
 
237
                <paramdef><link xlink:href="global.html">__global</link>
 
238
                    <link xlink:href="vectorDataTypes.html">int</link>
 
239
                    <parameter>*signp</parameter>
 
240
                </paramdef>
 
241
            </funcprototype>
 
242
        </funcsynopsis>
 
243
 
 
244
        <funcsynopsis>
 
245
            <funcprototype>
 
246
                <funcdef>
 
247
                    <link xlink:href="vectorDataTypes.html">double</link>
 
248
                    <function>
 
249
                        lgamma_r
 
250
                    </function>
 
251
                </funcdef>
 
252
                <paramdef>
 
253
                    <link xlink:href="vectorDataTypes.html">double</link>
 
254
                    <parameter>x</parameter></paramdef>
 
255
                <paramdef><link xlink:href="local.html">__local</link>
 
256
                    <link xlink:href="vectorDataTypes.html">int</link>
 
257
                    <parameter>*signp</parameter>
 
258
                </paramdef>
 
259
            </funcprototype>
 
260
        </funcsynopsis>
 
261
 
 
262
        <funcsynopsis>
 
263
            <funcprototype>
 
264
                <funcdef>
 
265
                    <link xlink:href="vectorDataTypes.html">double</link>
 
266
                    <function>
 
267
                        lgamma_r
 
268
                    </function>
 
269
                </funcdef>
 
270
                <paramdef>
 
271
                    <link xlink:href="vectorDataTypes.html">double</link>
 
272
                    <parameter>x</parameter></paramdef>
 
273
                <paramdef><link xlink:href="private.html">__private</link>
 
274
                    <link xlink:href="vectorDataTypes.html">int</link>
 
275
                    <parameter>*signp</parameter>
 
276
                </paramdef>
 
277
            </funcprototype>
 
278
        </funcsynopsis>
 
279
 
 
280
<!-- halfn VARIATIONS===============================  -->
 
281
 
 
282
        <funcsynopsis>
 
283
            <funcprototype>
 
284
                <funcdef>
 
285
                    <link xlink:href="vectorDataTypes.html">half<replaceable>n</replaceable></link>
 
286
                    <function>
 
287
                        lgamma_r
 
288
                    </function>
 
289
                </funcdef>
 
290
                <paramdef>
 
291
                    <link xlink:href="vectorDataTypes.html">half<replaceable>n</replaceable></link>
 
292
                    <parameter>x</parameter></paramdef>
 
293
                <paramdef><link xlink:href="global.html">__global</link>
 
294
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
295
                    <parameter>*signp</parameter>
 
296
                </paramdef>
 
297
            </funcprototype>
 
298
        </funcsynopsis>
 
299
 
 
300
        <funcsynopsis>
 
301
            <funcprototype>
 
302
                <funcdef>
 
303
                    <link xlink:href="vectorDataTypes.html">half<replaceable>n</replaceable></link>
 
304
                    <function>
 
305
                        lgamma_r
 
306
                    </function>
 
307
                </funcdef>
 
308
                <paramdef>
 
309
                    <link xlink:href="vectorDataTypes.html">half<replaceable>n</replaceable></link>
 
310
                    <parameter>x</parameter></paramdef>
 
311
                <paramdef><link xlink:href="local.html">__local</link>
 
312
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
313
                    <parameter>*signp</parameter>
 
314
                </paramdef>
 
315
            </funcprototype>
 
316
        </funcsynopsis>
 
317
 
 
318
        <funcsynopsis>
 
319
            <funcprototype>
 
320
                <funcdef>
 
321
                    <link xlink:href="vectorDataTypes.html">half<replaceable>n</replaceable></link>
 
322
                    <function>
 
323
                        lgamma_r
 
324
                    </function>
 
325
                </funcdef>
 
326
                <paramdef>
 
327
                    <link xlink:href="vectorDataTypes.html">half<replaceable>n</replaceable></link>
 
328
                    <parameter>x</parameter></paramdef>
 
329
                <paramdef><link xlink:href="private.html">__private</link>
 
330
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
331
                    <parameter>*signp</parameter>
 
332
                </paramdef>
 
333
            </funcprototype>
 
334
        </funcsynopsis>
 
335
 
 
336
<!-- half VARIATIONS===============================  -->
 
337
 
 
338
        <funcsynopsis>
 
339
            <funcprototype>
 
340
                <funcdef>
 
341
                    <link xlink:href="vectorDataTypes.html">half</link>
 
342
                    <function>
 
343
                        lgamma_r
 
344
                    </function>
 
345
                </funcdef>
 
346
                <paramdef>
 
347
                    <link xlink:href="vectorDataTypes.html">half</link>
 
348
                    <parameter>x</parameter></paramdef>
 
349
                <paramdef><link xlink:href="global.html">__global</link>
 
350
                    <link xlink:href="vectorDataTypes.html">int</link>
 
351
                    <parameter>*signp</parameter>
 
352
                </paramdef>
 
353
            </funcprototype>
 
354
        </funcsynopsis>
 
355
 
 
356
        <funcsynopsis>
 
357
            <funcprototype>
 
358
                <funcdef>
 
359
                    <link xlink:href="vectorDataTypes.html">half</link>
 
360
                    <function>
 
361
                        lgamma_r
 
362
                    </function>
 
363
                </funcdef>
 
364
                <paramdef>
 
365
                    <link xlink:href="vectorDataTypes.html">half</link>
 
366
                    <parameter>x</parameter></paramdef>
 
367
                <paramdef><link xlink:href="local.html">__local</link>
 
368
                    <link xlink:href="vectorDataTypes.html">int</link>
 
369
                    <parameter>*signp</parameter>
 
370
                </paramdef>
 
371
            </funcprototype>
 
372
        </funcsynopsis>
 
373
 
 
374
        <funcsynopsis>
 
375
            <funcprototype>
 
376
                <funcdef>
 
377
                    <link xlink:href="vectorDataTypes.html">half</link>
 
378
                    <function>
 
379
                        lgamma_r
 
380
                    </function>
 
381
                </funcdef>
 
382
                <paramdef>
 
383
                    <link xlink:href="vectorDataTypes.html">half</link>
 
384
                    <parameter>x</parameter></paramdef>
 
385
                <paramdef><link xlink:href="private.html">__private</link>
 
386
                    <link xlink:href="vectorDataTypes.html">int</link>
 
387
                    <parameter>*signp</parameter>
 
388
                </paramdef>
 
389
            </funcprototype>
 
390
        </funcsynopsis>
 
391
    </refsynopsisdiv>
 
392
 
 
393
<!-- ================================ DESCRIPTION  -->
 
394
 
 
395
    <refsect1 id="description"><title>Description</title>
 
396
        <para>
 
397
          Returns the natural logarithm of the absolute value of the gamma function. The sign
 
398
          of the gamma function is returned in the <varname>signp</varname> argument of the
 
399
          <function>lgamma_r</function>.
 
400
        </para>
 
401
 
 
402
        <para>
 
403
          An application that wants to use <type>half</type>
 
404
          and <type>half<replaceable>n</replaceable></type> types
 
405
          will need to include the <code>#pragma OPENCL EXTENSION
 
406
          <citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>
 
407
          : enable</code> directive. If extended with
 
408
          <citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>,
 
409
          generic type name <type>gentype</type> also includes <type>half</type> and
 
410
          <type>half{2|3|4|8|16}</type>.
 
411
        </para>
 
412
    </refsect1>
 
413
 
 
414
<!-- ================================ NOTES  -->
 
415
 
 
416
    <refsect1 id="notes"><title>Notes</title>
 
417
 
 
418
        &mathFunctionsInc;
 
419
 
 
420
    </refsect1>
 
421
 
 
422
<!-- ================================ EXAMPLE  -->
 
423
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
424
<!--
 
425
    <refsect2 id="example1">
 
426
        <title>
 
427
            Example
 
428
        </title>
 
429
 
 
430
        <informaltable frame="none">
 
431
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
432
                <colspec colname="col1" colnum="1" />
 
433
                <tbody>
 
434
                    <row>
 
435
                        <entry>
 
436
                            Example goes here - it will be set in "code" type with white space preserved.
 
437
                        </entry>
 
438
                    </row>
 
439
                </tbody>
 
440
            </tgroup>
 
441
        </informaltable>
 
442
    </refsect2>
 
443
-->
 
444
 
 
445
<!-- ================================ SPECIFICATION  -->
 
446
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
447
-->
 
448
    <refsect1 id="specification"><title>Specification</title>
 
449
        <para>
 
450
            <imageobject>
 
451
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
452
            </imageobject>
 
453
 
 
454
            <olink uri="mathFunctions">OpenCL Specification</olink>
 
455
        </para>
 
456
    </refsect1>
 
457
 
 
458
<!-- ================================ ALSO SEE  -->
 
459
 
 
460
    <refsect1 id="seealso"><title>Also see</title>
 
461
        <para>
 
462
            <citerefentry href="mathFunctions"><refentrytitle>Math Functions</refentrytitle></citerefentry>
 
463
        </para>
 
464
    </refsect1>
 
465
 
 
466
<!-- ============================== COPYRIGHT -->
 
467
<!-- Content included from copyright.inc.xsl -->
 
468
 
 
469
    <refsect3 id="Copyright"><title></title>
 
470
        <imageobject>
 
471
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
472
        </imageobject>
 
473
        <para />
 
474
    </refsect3>
 
475
 
 
476
<!-- 16-Oct-2011 -->
 
477
</refentry>
 
478