blob: cccf914d6d2a70e74a0711048315b861a9637b5f [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>islessequal</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content=" &#10; islessequal&#10; " />
</head>
<body>
<div class="refentry">
<a id="idm1"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<a xmlns="http://www.w3.org/1999/xhtml" id="islessequal"></a>
<h1>islessequal</h1>
<p>
Compare of <code xmlns="http://www.w3.org/1999/xhtml" class="varname">x</code> &lt;= <code xmlns="http://www.w3.org/1999/xhtml" class="varname">y</code>.
</p>
</div>
<div class="refsynopsisdiv">
<h2></h2>
<div class="funcsynopsis">
<table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
<tr valign="bottom">
<td>
<code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
<a class="link" href="scalarDataTypes.html" target="_top">int</a>
<strong class="fsfunc">
islessequal
</strong>
(</code>
<td>float <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">x</var>, </td>
</td>
</tr>
<tr valign="top">
<td> </td>
<td>float <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">y</var><code>)</code></td>
</tr>
</table>
</div>
<div class="funcsynopsis">
<table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
<tr valign="bottom">
<td>
<code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
<a class="link" href="scalarDataTypes.html" target="_top">int</a>
<em class="replaceable">n</em>
<strong class="fsfunc">
islessequal
</strong>
(</code>
<td>float<em xmlns="http://www.w3.org/1999/xhtml" class="replaceable">n</em> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">x</var>, </td>
</td>
</tr>
<tr valign="top">
<td> </td>
<td>float<em xmlns="http://www.w3.org/1999/xhtml" class="replaceable">n</em> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">y</var><code>)</code></td>
</tr>
</table>
</div>
</div>
<div class="refsect2">
<a id="double"></a>
<h3></h3>
<div class="informaltable">
<table class="informaltable" border="0">
<colgroup>
<col align="left" class="col1" />
</colgroup>
<tbody>
<tr>
<td align="left">
int <code class="function">islessequal</code> (<span class="type">double</span> <code class="varname">x</code>,
<span class="type">double</span> <code class="varname">y</code>) // if double extension enabled
<span class="type">long<em class="replaceable"><code>n</code></em></span> <code class="function">islessequal</code> (<span class="type">double<em class="replaceable"><code>n</code></em></span> <code class="varname">x</code>,
<span class="type">double<em class="replaceable"><code>n</code></em></span> <code class="varname">y</code>) // if double extension enabled
</td>
</tr>
</tbody>
</table>
</div>
<div class="informaltable">
<table class="informaltable" border="0">
<colgroup>
<col align="left" class="col1" />
</colgroup>
<tbody>
<tr>
<td align="left">
int <code class="function">islessequal</code> (<span class="type">half</span> <code class="varname">x</code>,
<span class="type">half</span> <code class="varname">y</code>) // if half extension enabled
<span class="type">short<em class="replaceable"><code>n</code></em></span> <code class="function">islessequal</code> (<span class="type">half<em class="replaceable"><code>n</code></em></span> <code class="varname">x</code>,
<span class="type">half<em class="replaceable"><code>n</code></em></span> <code class="varname">y</code>) // if half extension enabled
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1">
<a id="description"></a>
<h2>Description</h2>
<p>
Returns the component-wise compare of <code class="varname">x</code> &lt;= <code class="varname">y</code>.
</p>
<p>
</p>
</div>
<div class="refsect1">
<a id="notes"></a>
<h2>Notes</h2>
<p>
This function returns a 0 if the specified relation is <span class="emphasis"><em>false</em></span> and a 1 if the specified relation is <span class="emphasis"><em>true</em></span> for scalar argument types. It returns a 0 if the specified relation is <span class="emphasis"><em>false</em></span> and a -1 (i.e. all
bits set) if the specified relation is <span class="emphasis"><em>true</em></span> for vector argument types. This function always return 0 if either argument is not a number (NaN).
</p>
<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>
This function can be used with built-in scalar or vector types as arguments and return a scalar vector integer result. The argument type igentype 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>.
</p>
<p>
If extended with <a class="citerefentry" href="cl_khr_fp64.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp64</span></span></a>, generic type name <span class="type">gentype</span> may indicate <span class="type">double</span> and <span class="type">double{2|4|8|16}</span> as arguments and return values. If extended with <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a>, generic type name <span class="type">gentype</span> may indicate <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 class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<a class="citerefentry" href="relationalFunctions.html"><span class="citerefentry"><span class="refentrytitle">Relational Functions</span></span></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>