← Back to branch summary

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

« back to all changes in this revision

Viewing changes to isunordered.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:
isunordered.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 relationalFunctionsInc1 SYSTEM "relationalFunctionsInc1.xml">
 
5
<!ENTITY relationalFunctionsInc2 SYSTEM "relationalFunctionsInc2.xml">
 
6
]>
 
7
 
 
8
<refentry>
 
9
    <refentryinfo>
 
10
        <keywordset>
 
11
            <keyword>isunordered</keyword>
 
12
        </keywordset>
 
13
    </refentryinfo>
 
14
 
 
15
    <refmeta>
 
16
        <refentrytitle>isunordered</refentrytitle>
 
17
 
 
18
        <refmiscinfo>
 
19
            <copyright>
 
20
                <year>2007-2011</year>
 
21
                <holder>The Khronos Group Inc.
 
22
 Permission is hereby granted, free of charge, to any person obtaining a
 
23
copy of this software and/or associated documentation files (the
 
24
"Materials"), to deal in the Materials without restriction, including
 
25
without limitation the rights to use, copy, modify, merge, publish,
 
26
distribute, sublicense, and/or sell copies of the Materials, and to
 
27
permit persons to whom the Materials are furnished to do so, subject to
 
28
the condition that this copyright notice and permission notice shall be included
 
29
in all copies or substantial portions of the Materials.</holder>
 
30
            </copyright>
 
31
        </refmiscinfo>
 
32
        <manvolnum>3</manvolnum>
 
33
    </refmeta>
 
34
 
 
35
<!-- ================================ SYNOPSIS -->
 
36
 
 
37
    <refnamediv id="isunordered">
 
38
        <refname>isunordered</refname>
 
39
 
 
40
        <refpurpose>
 
41
            Test if arguments are unordered.
 
42
        </refpurpose>
 
43
    </refnamediv>
 
44
 
 
45
    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
 
46
        <funcsynopsis>
 
47
            <funcprototype>
 
48
                <funcdef>
 
49
                    <link xlink:href="scalarDataTypes.html">int</link>
 
50
                    <function>
 
51
                        isunordered
 
52
                    </function>
 
53
                </funcdef>
 
54
                <paramdef><link xlink:href="scalarDataTypes.html">float</link><parameter>x</parameter></paramdef>
 
55
                <paramdef><link xlink:href="scalarDataTypes.html">float</link><parameter>y</parameter></paramdef>
 
56
            </funcprototype>
 
57
        </funcsynopsis>
 
58
 
 
59
        <funcsynopsis>
 
60
            <funcprototype>
 
61
                <funcdef>
 
62
                    <link xlink:href="vectorDataTypes.html">int<replaceable>n</replaceable></link>
 
63
                    <function>
 
64
                        isunordered
 
65
                    </function>
 
66
                </funcdef>
 
67
                <paramdef><link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link><parameter>x</parameter></paramdef>
 
68
                <paramdef><link xlink:href="vectorDataTypes.html">float<replaceable>n</replaceable></link><parameter>y</parameter></paramdef>
 
69
            </funcprototype>
 
70
        </funcsynopsis>
 
71
 
 
72
        <funcsynopsis>
 
73
            <funcprototype>
 
74
                <funcdef>
 
75
                    <link xlink:href="scalarDataTypes.html">int</link>
 
76
                    <function>
 
77
                        isunordered
 
78
                    </function>
 
79
                </funcdef>
 
80
                <paramdef><link xlink:href="scalarDataTypes.html">double</link><parameter>x</parameter></paramdef>
 
81
                <paramdef><link xlink:href="scalarDataTypes.html">double</link><parameter>y</parameter></paramdef>
 
82
            </funcprototype>
 
83
        </funcsynopsis>
 
84
 
 
85
        <funcsynopsis>
 
86
            <funcprototype>
 
87
                <funcdef>
 
88
                    <link xlink:href="vectorDataTypes.html">long<replaceable>n</replaceable></link>
 
89
                    <function>
 
90
                        isunordered
 
91
                    </function>
 
92
                </funcdef>
 
93
                <paramdef><link xlink:href="vectorDataTypes.html">double<replaceable>n</replaceable></link><parameter>x</parameter></paramdef>
 
94
                <paramdef><link xlink:href="vectorDataTypes.html">double<replaceable>n</replaceable></link><parameter>y</parameter></paramdef>
 
95
            </funcprototype>
 
96
        </funcsynopsis>
 
97
    </refsynopsisdiv>
 
98
 
 
99
<!-- Optional Half prototypes -->
 
100
 
 
101
 <refsect2  xmlns:xlink="http://www.w3.org/1999/xlink" id="double">
 
102
        <title></title>
 
103
 
 
104
        <informaltable frame="none">
 
105
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
106
                <colspec colname="col1" colnum="1" />
 
107
                <tbody>
 
108
 
 
109
                    <row>
 
110
                        <entry>
 
111
<type><link xlink:href="scalarDataTypes.html">int</link></type> <function>isunordered</function>
 
112
     (<type><link xlink:href="scalarDataTypes.html">half</link></type> <varname>x</varname>,
 
113
       <type><link xlink:href="scalarDataTypes.html">half</link></type> <varname>y</varname>)   // if half extension enabled
 
114
                        </entry>
 
115
                    </row>
 
116
 
 
117
                    <row>
 
118
                        <entry>
 
119
<type><link xlink:href="vectorDataTypes.html">short<replaceable>n</replaceable></link></type> <function>isunordered</function>
 
120
     (<type><link xlink:href="vectorDataTypes.html">half<replaceable>n</replaceable></link></type> <varname>x</varname>,
 
121
       <type><link xlink:href="vectorDataTypes.html">half<replaceable>n</replaceable></link></type> <varname>y</varname>)   // if half extension enabled
 
122
                        </entry>
 
123
                    </row>
 
124
 
 
125
                </tbody>
 
126
            </tgroup>
 
127
        </informaltable>
 
128
    </refsect2>
 
129
 
 
130
<!-- ================================ DESCRIPTION  -->
 
131
 
 
132
    <refsect1 id="description"><title>Description</title>
 
133
        <para>
 
134
          Test if arguments are unordered. <function>isunordered</function>() takes arguments
 
135
          <varname>x</varname> and <varname>y</varname>, returning non-zero if <varname>x</varname>
 
136
          or  <varname>y</varname> is NaN, and zero otherwise.
 
137
        </para>
 
138
    </refsect1>
 
139
 
 
140
<!-- ================================ NOTES  -->
 
141
 
 
142
    <refsect1 id="notes"><title>Notes</title>
 
143
 
 
144
        &relationalFunctionsInc1;
 
145
 
 
146
        &relationalFunctionsInc2;
 
147
 
 
148
    </refsect1>
 
149
 
 
150
<!-- ================================ EXAMPLE  -->
 
151
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
 
152
<!--
 
153
    <refsect2 id="example1">
 
154
        <title>
 
155
            Example
 
156
        </title>
 
157
 
 
158
        <informaltable frame="none">
 
159
            <tgroup cols="1" align="left" colsep="0" rowsep="0">
 
160
                <colspec colname="col1" colnum="1" />
 
161
                <tbody>
 
162
                    <row>
 
163
                        <entry>
 
164
                            Example goes here - it will be set in "code" type with white space preserved.
 
165
                        </entry>
 
166
                    </row>
 
167
                </tbody>
 
168
            </tgroup>
 
169
        </informaltable>
 
170
    </refsect2>
 
171
-->
 
172
 
 
173
<!-- ================================ SPECIFICATION  -->
 
174
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
 
175
-->
 
176
    <refsect1 id="specification"><title>Specification</title>
 
177
        <para>
 
178
            <imageobject>
 
179
                <imagedata fileref="pdficon_small1.gif" format="gif" />
 
180
            </imageobject>
 
181
 
 
182
            <olink uri="relationalFunctions">OpenCL Specification</olink>
 
183
        </para>
 
184
    </refsect1>
 
185
 
 
186
<!-- ================================ ALSO SEE  -->
 
187
 
 
188
    <refsect1 id="seealso"><title>Also see</title>
 
189
        <para>
 
190
            <citerefentry href="relationalFunctions"><refentrytitle>Relational Functions</refentrytitle></citerefentry>
 
191
        </para>
 
192
    </refsect1>
 
193
 
 
194
<!-- ============================== COPYRIGHT -->
 
195
<!-- Content included from copyright.inc.xsl -->
 
196
 
 
197
    <refsect3 id="Copyright"><title></title>
 
198
        <imageobject>
 
199
                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
 
200
        </imageobject>
 
201
        <para />
 
202
    </refsect3>
 
203
 
 
204
<!-- 16-Oct-2011 -->
 
205
</refentry>
 
206