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

« back to all changes in this revision

Viewing changes to isinf.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:
 
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 relationalFunctionsInc1 SYSTEM "relationalFunctionsInc1.xml">
 
5
<!ENTITY relationalFunctionsInc2 SYSTEM "relationalFunctionsInc2.xml">
 
6
]>
 
7
<refentry>
 
8
    <refentryinfo>
 
9
        <keywordset>
 
10
            <keyword>isinf</keyword>
 
11
        </keywordset>
 
12
    </refentryinfo>
 
13
 
 
14
    <refmeta>                                    
 
15
        <refentrytitle>isinf</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="isinf">             
 
37
        <refname>isinf</refname>
 
38
 
 
39
        <refpurpose>
 
40
            Test for infinity value.
 
41
        </refpurpose>
 
42
    </refnamediv>
 
43
 
 
44
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
45
        <funcsynopsis>
 
46
            <funcprototype>
 
47
                <funcdef>
 
48
                    <link xlink:href="scalarDataTypes.html">int</link>
 
49
                    <function>                   
 
50
                        isinf
 
51
                    </function>
 
52
                </funcdef>
 
53
                <paramdef><link xlink:href="scalarDataTypes.html">float</link><parameter></parameter></paramdef>
 
54
            </funcprototype>
 
55
        </funcsynopsis>     
 
56
 
 
57
        <funcsynopsis>
 
58
            <funcprototype>
 
59
                <funcdef>
 
60
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
61
                    <function>                   
 
62
                        isinf
 
63
                    </function>
 
64
                </funcdef>
 
65
                <paramdef><link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link><parameter></parameter></paramdef>
 
66
            </funcprototype>
 
67
        </funcsynopsis>   
 
68
 
 
69
        <funcsynopsis>
 
70
            <funcprototype>
 
71
                <funcdef>
 
72
                    <link xlink:href="scalarDataTypes.html">int</link>
 
73
                    <function>                   
 
74
                        isinf
 
75
                    </function>
 
76
                </funcdef>
 
77
                <paramdef><link xlink:href="scalarDataTypes.html">double</link><parameter></parameter></paramdef>
 
78
            </funcprototype>
 
79
        </funcsynopsis>    
 
80
 
 
81
        <funcsynopsis>
 
82
            <funcprototype>
 
83
                <funcdef>
 
84
                    <link xlink:href="vectorDataTypes.html">long<replaceable>n</replaceable></link>
 
85
                    <function>                   
 
86
                        isinf
 
87
                    </function>
 
88
                </funcdef>
 
89
                <paramdef><link xlink:href="vectorDataTypes.html">double<replaceable>n</replaceable></link><parameter></parameter></paramdef>
 
90
            </funcprototype>
 
91
        </funcsynopsis> 
 
92
  
 
93
    </refsynopsisdiv>   
 
94
 
 
95
    
 
96
    
 
97
<!-- Optional Half prototypes -->
 
98
 <refsect2 xmlns:xlink="http://www.w3.org/1999/xlink" id="double">
 
99
        <title></title>
 
100
        <informaltable frame="none">
 
101
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
102
                <colspec colname="col1" colnum="1" />
 
103
                <tbody>
 
104
                    <row>
 
105
                        <entry>
 
106
<type><link xlink:href="scalarDataTypes.html">int</link></type> <function>isinf</function> (<type><link xlink:href="scalarDataTypes.html">half</link></type>)      // if half extension enabled 
 
107
 
 
108
<type><link xlink:href="vectorDataTypes.html">short<replaceable>n</replaceable></link></type> <function>isinf</function> (<type><link xlink:href="vectorDataTypes.html">half<replaceable>n</replaceable></link></type>)      // if half extension enabled 
 
109
</entry>
 
110
                    </row>
 
111
                </tbody>
 
112
            </tgroup>
 
113
        </informaltable>
 
114
    </refsect2> 
 
115
        
 
116
 
 
117
<!-- ================================ DESCRIPTION  -->
 
118
 
 
119
    <refsect1 id="description"><title>Description</title>
 
120
        <para>
 
121
        Test for infinity value (positive or negative).
 
122
        </para>
 
123
        <para>
 
124
        
 
125
        </para>
 
126
        
 
127
    </refsect1>
 
128
 
 
129
<!-- ================================ NOTES  -->
 
130
 
 
131
     <refsect1 id="notes"><title>Notes</title>
 
132
        &relationalFunctionsInc1;
 
133
        &relationalFunctionsInc2;
 
134
    </refsect1>
 
135
 
 
136
<!-- ================================ EXAMPLE  -->
 
137
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
138
<!--
 
139
    <refsect2 id="example1">
 
140
        <title>
 
141
            Example
 
142
        </title>
 
143
 
 
144
        <informaltable frame="none">
 
145
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
146
                <colspec colname="col1" colnum="1" />
 
147
                <tbody>
 
148
                    <row>
 
149
                        <entry>
 
150
                            Example goes here - it will be set in "code" type with white space preserved.
 
151
                        </entry>
 
152
                    </row>
 
153
                </tbody>
 
154
            </tgroup>
 
155
        </informaltable>
 
156
    </refsect2>
 
157
-->
 
158
 
 
159
 
 
160
<!-- ================================ SPECIFICATION  -->
 
161
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
162
-->
 
163
    <refsect1 id="specification"><title>Specification</title>
 
164
        <para>
 
165
            <imageobject>
 
166
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
167
            </imageobject>
 
168
                                                 
 
169
            <olink uri="relationalFunctions">OpenCL Specification</olink>
 
170
        </para>
 
171
    </refsect1>
 
172
 
 
173
 
 
174
<!-- ================================ ALSO SEE  -->
 
175
 
 
176
    <refsect1 id="seealso"><title>Also see</title>
 
177
        <para>
 
178
            <citerefentry href="relationalFunctions"><refentrytitle>Relational Functions</refentrytitle></citerefentry> 
 
179
        </para>
 
180
    </refsect1>
 
181
 
 
182
 
 
183
 
 
184
<!-- ============================== COPYRIGHT -->
 
185
<!-- Content included from copyright.inc.xsl -->
 
186
 
 
187
    <refsect3 id="Copyright"><title></title>
 
188
        <imageobject>
 
189
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
190
        </imageobject>
 
191
        <para />
 
192
    </refsect3>
 
193
 
 
194
</refentry>
 
195