blob: 6ab9ac9e3306a993c34683dbad456111baba0c89 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<style xmlns="" type="text/css">
/* This style sets a margin around the entire page */
html, body {
margin: 10px;
}
p {
font: normal 16px verdana, sans-serif;
margin: 0;
padding-bottom:12px;
}
h1 {
font: bold 25px verdana, sans-serif;
margin-top: 0;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h2 {
font: bold 19px verdana, sans-serif;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h3 {
font: bold 19px verdana, sans-serif !important;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
li {
font: normal 16px verdana, sans-serif;
margin-top: 0;
margin-bottom: 18px;
padding-top: 0;
padding-bottom: 0;
}
.pdparam {
font: italic 16px verdana, sans-serif;
}
.term {
font: italic 16px verdana, sans-serif;
font-weight: normal;
}
.type {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
a:link, a:visited {
color: blue;
text-decoration: none;
font: normal 16px;
}
a:hover {
background-color: #FFFF99;
font: normal 16px;
}
div.funcsynopsis {
text-align: left;
background-color: #e6e6e6;
font: normal 16px verdana, sans-serif;
padding-top: 10px;
padding-bottom: 10px;
}
div.funcsynopsis table {
border-collapse: separate;
font: normal 16px verdana, sans-serif;
}
div.funcsynopsis td {
background-color: #e6e6e6;
border: 0 solid #000;
padding: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 {
font-family: verdana, sans-serif;
font-size: 16px;
}
code.constant {
font: normal 16px courier new, monospace !important;
}
span.errorname {
font: normal 16px verdana, sans-serif !important;
}
code.function {
font: bold 16px verdana, sans-serif !important;
}
b.fsfunc {
font: bold 16px verdana, sans-serif !important;
}
code.varname {
font: italic 16px verdana, sans-serif;
}
code.replaceable {
font: italic 16px courier new, monospace;
}
code.funcdef {
font: normal 16px verdana, sans-serif !important;
}
.citerefentry {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
code.fsfunc {
font: normal 16px verdana, sans-serif !important;
}
/* PARAMETER: This style controls spacing between the terms in Parameter section */
dt {
margin-top: 15px;
}
/* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
div.refsect1 table {
width: 100%;
margin-top: 10px;
background-color: #FFF;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 th {
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: bold 16px verdana, sans-serif;
}
div.refsect1 td {
background-color: #FFF;
padding: 5px;
vertical-align: text-top;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 p{
font: normal 16px verdana, sans-serif;
margin-top: 8px;
margin-bottom: 8px;
padding-top: 0;
padding-bottom: 0;
}
/* EXAMPLE: These styles apply only to the Example section */
div.refsect2 {
font: normal 16px courier new, monospace !important;
}
div.refsect2 table {
margin-top: 0;
background-color: #e6e6e6;
width: 100%;
border: 0 solid #000;
padding: 2px;
font: normal 16px courier new, monospace !important;
}
div.refsect2 td {
background-color: #e6e6e6;
font: normal 16px courier new, monospace !important;
white-space:pre;
}
/* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
div.refsect3 {
font: normal 11px verdana, sans-serif;
margin-top: 50px;
margin-bottom: 20px;
padding-top: 0;
padding-bottom: 0;
}
</style>
<title>Relational Built-In Functions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="Relational Built-In Functions" />
</head>
<body>
<div class="refentry">
<a id="idm1"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<h1>Relational Built-In Functions</h1>
<p>Click an item in the table below for details about that function.</p>
</div>
<div class="refsect1">
<a id="springboard"></a>
<h2></h2>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
</colgroup>
<tbody>
<tr>
<td align="left">
<a class="citerefentry" href="isequal.html">
<span class="citerefentry">
<span class="refentrytitle">isequal</span>
</span>
</a>
</td>
<td align="left">
<p>Compare of <code class="varname">x</code> == <code class="varname">y</code>.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isnotequal.html">
<span class="citerefentry">
<span class="refentrytitle">isnotequal</span>
</span>
</a>
</td>
<td align="left">
<p>Compare of <code class="varname">x</code> != <code class="varname">y</code>.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isgreater.html">
<span class="citerefentry">
<span class="refentrytitle">isgreater</span>
</span>
</a>
</td>
<td align="left">
<p>Compare of <code class="varname">x</code> &gt; <code class="varname">y</code>.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isgreaterequal.html">
<span class="citerefentry">
<span class="refentrytitle">isgreaterequal</span>
</span>
</a>
</td>
<td align="left">
<p>Compare of <code class="varname">x</code> &gt;= <code class="varname">y</code>.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isless.html">
<span class="citerefentry">
<span class="refentrytitle">isless</span>
</span>
</a>
</td>
<td align="left">
<p>Compare of <code class="varname">x</code> &lt; <code class="varname">y</code>.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="islessequal.html">
<span class="citerefentry">
<span class="refentrytitle">islessequal</span>
</span>
</a>
</td>
<td align="left">
<p>Compare of <code class="varname">x</code> &lt;= <code class="varname">y</code>.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="islessgreater.html">
<span class="citerefentry">
<span class="refentrytitle">islessgreater</span>
</span>
</a>
</td>
<td align="left">
<p>Compare of (<code class="varname">x</code> &lt; <code class="varname">y</code>) || (<code class="varname">x</code> &gt; <code class="varname">y</code>).</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isfinite.html">
<span class="citerefentry">
<span class="refentrytitle">isfinite</span>
</span>
</a>
</td>
<td align="left">
<p>Test for finite value.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isinf.html">
<span class="citerefentry">
<span class="refentrytitle">isinf</span>
</span>
</a>
</td>
<td align="left">
<p>Test for +ve or -ve infinity.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isnan.html">
<span class="citerefentry">
<span class="refentrytitle">isnan</span>
</span>
</a>
</td>
<td align="left">
<p>Test for a NaN.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isnormal.html">
<span class="citerefentry">
<span class="refentrytitle">isnormal</span>
</span>
</a>
</td>
<td align="left">
<p>Test for a normal value.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isordered.html">
<span class="citerefentry">
<span class="refentrytitle">isordered</span>
</span>
</a>
</td>
<td align="left">
<p>Test if arguments are ordered.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="isunordered.html">
<span class="citerefentry">
<span class="refentrytitle">isunordered</span>
</span>
</a>
</td>
<td align="left">
<p>Test if arguments are unordered.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="signbit.html">
<span class="citerefentry">
<span class="refentrytitle">signbit</span>
</span>
</a>
</td>
<td align="left">
<p>Test for sign bit.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="any.html">
<span class="citerefentry">
<span class="refentrytitle">any</span>
</span>
</a>
</td>
<td align="left">
<p>1 if MSB in any component of <code class="varname">x</code> is set; else 0.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="any.html">
<span class="citerefentry">
<span class="refentrytitle">all</span>
</span>
</a>
</td>
<td align="left">
<p>1 if MSB in all components of <code class="varname">x</code> is set; else 0.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="bitselect.html">
<span class="citerefentry">
<span class="refentrytitle">bitselect</span>
</span>
</a>
</td>
<td align="left">
<p>Each bit of result is corresponding bit of <code class="varname">a</code> if corresponding bit of <code class="varname">c</code> is 0.</p>
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="select.html">
<span class="citerefentry">
<span class="refentrytitle">select</span>
</span>
</a>
</td>
<td align="left">
<p>For each component of a vector type, result[<code class="varname">i</code>] = if MSB of <code class="varname">c</code>[<code class="varname">i</code>] is set ? <code class="varname">b</code>[<code class="varname">i</code>] : <code class="varname">a</code>[<code class="varname">i</code>] For scalar type, result = <code class="varname">c</code> ? <code class="varname">b</code> : <code class="varname">a</code>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1">
<a id="description"></a>
<h2>Description</h2>
<p>
The relational and equality operators (&lt;, &lt;=, &gt;, &gt;=, !=, ==) can be used with scalar and vector
built-in types and produce a scalar or vector signed integer result respectively.
</p>
<p>
The built-in relational functions can be used with built-in scalar or vector types as
arguments and return a scalar vector integer result.
The argment type <span class="type">gentype</span> can be <span class="type">char</span>, <span class="type">char<em class="replaceable"><code>n</code></em></span>, <span class="type">uchar</span>, <span class="type">uchar<em class="replaceable"><code>n</code></em></span>, <span class="type">short</span>,
<span class="type">short<em class="replaceable"><code>n</code></em></span>, <span class="type">ushort</span>, <span class="type">ushort<em class="replaceable"><code>n</code></em></span>, <span class="type">int</span>, <span class="type">int<em class="replaceable"><code>n</code></em></span>, <span class="type">uint</span>, <span class="type">uint<em class="replaceable"><code>n</code></em></span>, <span class="type">long</span>, <span class="type">long<em class="replaceable"><code>n</code></em></span>, <span class="type">ulong</span>, <span class="type">ulong<em class="replaceable"><code>n</code></em></span>, <span class="type">float</span>, and <span class="type">float<em class="replaceable"><code>n</code></em></span>.
The argument type <span class="type">igentype</span> refers to signed integer vector types i.e. <span class="type">char</span>, <span class="type">char<em class="replaceable"><code>n</code></em></span>, <span class="type">short</span>, <span class="type">short<em class="replaceable"><code>n</code></em></span>, <span class="type">int</span>, <span class="type">int<em class="replaceable"><code>n</code></em></span>, <span class="type">long</span>, and <span class="type">long<em class="replaceable"><code>n</code></em></span>.
The argument type <span class="type">ugentype</span> refers to unsigned integer vector types i.e. <span class="type">uchar</span>, <span class="type">uchar<em class="replaceable"><code>n</code></em></span>, <span class="type">ushort</span>, <span class="type">ushort<em class="replaceable"><code>n</code></em></span>, <span class="type">uint</span>, <span class="type">uint<em class="replaceable"><code>n</code></em></span>, <span class="type">ulong</span>, and <span class="type">ulong<em class="replaceable"><code>n</code></em></span>.
</p>
<p>
The built-in relational functions are extended with <a class="citerefentry" href="cl_khr_fp64.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp64</span></span></a> to include appropriate versions of functions that take <span class="type">double</span>, and <span class="type">double{2|4|8|16}</span> as arguments and return values. They are also extended with with <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a> to include appropriate versions of functions that take <span class="type">half</span>, and <span class="type">half{2|4|8|16}</span> as arguments and return values.
</p>
</div>
<div class="refsect1">
<a id="specification"></a>
<h2>Specification</h2>
<p>
<img src="pdficon_small1.gif" />
<a href="http://www.khronos.org/registry/cl/specs/opencl-1.0.pdf#page=184" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2009 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</div>
</div>
</body>
</html>