| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" |
| "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> |
| <refentry> |
| <refentryinfo> |
| <keywordset> |
| <keyword> |
| signbit |
| </keyword> |
| </keywordset> |
| </refentryinfo> |
| |
| <refmeta> |
| <refentrytitle>signbit</refentrytitle> |
| |
| <refmiscinfo> |
| <copyright> |
| <year>2007-2009</year> |
| <holder>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.</holder> |
| </copyright> |
| </refmiscinfo> |
| <manvolnum>2</manvolnum> |
| </refmeta> |
| |
| <!-- ================================ SYNOPSIS --> |
| |
| <refnamediv id="signbit"> |
| <refname>signbit</refname> |
| |
| <refpurpose> |
| Test for sign bit. |
| </refpurpose> |
| </refnamediv> |
| |
| <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title> |
| <funcsynopsis> |
| <funcprototype> |
| <funcdef> |
| <link xlink:href="scalarDataTypes.html">int</link> |
| |
| |
| <function> |
| signbit |
| </function> |
| </funcdef> |
| <paramdef>float<parameter></parameter></paramdef> |
| </funcprototype> |
| </funcsynopsis> |
| |
| <funcsynopsis> |
| <funcprototype> |
| <funcdef> |
| <link xlink:href="scalarDataTypes.html">int</link> |
| |
| <replaceable>n</replaceable> |
| <function> |
| signbit |
| </function> |
| </funcdef> |
| <paramdef>float<replaceable>n</replaceable><parameter></parameter></paramdef> |
| </funcprototype> |
| </funcsynopsis> |
| </refsynopsisdiv> |
| |
| <!-- Optional Double and Half prototypes --> |
| <refsect2 id="double"> |
| <title></title> |
| |
| <informaltable frame="none"> |
| <tgroup cols="1" align="left" colsep="0" rowsep="0"> |
| <colspec colname="col1" colnum="1" /> |
| <tbody> |
| <row> |
| <entry> |
| int <function>signbit</function> (<type>double</type>) // if double extension enabled |
| |
| <type>long<replaceable>n</replaceable></type> <function>signbit</function> (<type>double<replaceable>n</replaceable></type>) // if double extension enabled |
| </entry> |
| </row> |
| </tbody> |
| </tgroup> |
| </informaltable> |
| |
| <informaltable frame="none"> |
| <tgroup cols="1" align="left" colsep="0" rowsep="0"> |
| <colspec colname="col1" colnum="1" /> |
| <tbody> |
| <row> |
| <entry> |
| int <function>signbit</function> (<type>half</type>) // if half extension enabled |
| |
| <type>short<replaceable>n</replaceable></type> <function>signbit</function> (<type>half<replaceable>n</replaceable></type>) // if half extension enabled |
| </entry> |
| </row> |
| </tbody> |
| </tgroup> |
| </informaltable> |
| </refsect2> |
| |
| <!-- ================================ DESCRIPTION --> |
| |
| <refsect1 id="description"><title>Description</title> |
| <para> |
| The built-in function <function>signbit</function> tests for sign bit. The scalar version of the function returns a 1 if the sign bit in the float is set else returns 0. The vector version of the function returns the following for each component in float<varname>n</varname>: <varname>a</varname> -1 if the sign bit in the float is set else returns 0. |
| </para> |
| <para> |
| If extended with <citerefentry><refentrytitle>cl_khr_fp64</refentrytitle></citerefentry> or <citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry> to enable <type>double</type> or <type>half</type> respectively, then <function>signbit</function> returns -1 if the sign bit in the float is set; otherwise returns 0. |
| </para> |
| |
| </refsect1> |
| |
| <!-- ================================ NOTES --> |
| |
| <refsect1 id="notes"><title>Notes</title> |
| <para> |
| This function returns a 0 if the specified relation is <emphasis>false</emphasis> and a 1 if the specified relation is <emphasis>true</emphasis> for scalar argument types. It returns a 0 if the specified relation is <emphasis>false</emphasis> and a -1 (i.e. all |
| bits set) if the specified relation is <emphasis>true</emphasis> for vector argument types. |
| </para> |
| <para> |
| 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 <type>gentype</type> can be <type>char</type>, <type>char<replaceable>n</replaceable></type>, <type>uchar</type>, <type>uchar<replaceable>n</replaceable></type>, <type>short</type>, <type>short<replaceable>n</replaceable></type>, <type>ushort</type>, <type>ushort<replaceable>n</replaceable></type>, <type>int</type>, <type>intn</type>, <type>uint</type>, <type>uint<replaceable>n</replaceable></type>, <type>long</type>, <type>long<replaceable>n</replaceable></type>, <type>ulong</type>, <type>ulong<replaceable>n</replaceable></type>, <type>float</type>, and <type>float<replaceable>n</replaceable></type>. The argument type <type>igentype</type> refers to signed integer vector types i.e. <type>char</type>, <type>char<replaceable>n</replaceable></type>, <type>short</type>, <type>short<replaceable>n</replaceable></type>, <type>int</type>, <type>int<replaceable>n</replaceable></type>, <type>long</type>, and <type>long<replaceable>n</replaceable></type>. The argument type <type>ugentype</type> refers to unsigned integer vector types i.e. <type>uchar</type>, <type>uchar<replaceable>n</replaceable></type>, <type>ushort</type>, <type>ushort<replaceable>n</replaceable></type>, <type>uint</type>, <type>uint<replaceable>n</replaceable></type>, <type>ulong</type>, and <type>ulong<replaceable>n</replaceable></type>. |
| </para> |
| <para> |
| If extended with <citerefentry><refentrytitle>cl_khr_fp64</refentrytitle></citerefentry>, generic type name <type>gentype</type> may indicate <type>double</type> and <type>double{2|4|8|16}</type> as arguments and return values. If extended with <citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>, generic type name <type>gentype</type> may indicate <type>half</type> and <type>half{2|4|8|16}</type> as arguments and return values. |
| </para> |
| </refsect1> |
| |
| <!-- ================================ EXAMPLE --> |
| <!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE --> |
| <!-- |
| <refsect2 id="example1"> |
| <title> |
| Example |
| </title> |
| |
| <informaltable frame="none"> |
| <tgroup cols="1" align="left" colsep="0" rowsep="0"> |
| <colspec colname="col1" colnum="1" /> |
| <tbody> |
| <row> |
| <entry> |
| Example goes here - it will be set in "code" type with white space preserved. |
| </entry> |
| </row> |
| </tbody> |
| </tgroup> |
| </informaltable> |
| </refsect2> |
| --> |
| |
| |
| <!-- ================================ SPECIFICATION --> |
| <!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page |
| --> |
| <refsect1 id="specification"><title>Specification</title> |
| <para> |
| <imageobject> |
| <imagedata fileref="pdficon_small1.gif" format="gif" /> |
| </imageobject> |
| |
| <olink uri="relationalFunctions">OpenCL Specification</olink> |
| </para> |
| </refsect1> |
| |
| |
| <!-- ================================ ALSO SEE --> |
| |
| <refsect1 id="seealso"><title>Also see</title> |
| <para> |
| <citerefentry href="relationalFunctions"><refentrytitle>Relational Functions</refentrytitle></citerefentry> |
| </para> |
| </refsect1> |
| |
| |
| |
| <!-- ============================== COPYRIGHT --> |
| <!-- Content included from copyright.inc.xsl --> |
| |
| <refsect3 id="Copyright"><title></title> |
| <imageobject> |
| <imagedata fileref="KhronosLogo.jpg" format="jpg" /> |
| </imageobject> |
| <para /> |
| </refsect3> |
| |
| </refentry> |
| |