upstream-man-pages/manglsl/findLSB.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 <refentry id="findLSB">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>findLSB</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>findLSB</refname>
  17         <refpurpose>find the index of the least significant bit set to 1 in an integer</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genIType <function>findLSB</function></funcdef>
  23                 <paramdef>genIType <parameter>value</parameter></paramdef>
  24             </funcprototype>            <funcprototype>
  25                 <funcdef>genIType <function>findLSB</function></funcdef>
  26                 <paramdef>genUType <parameter>value</parameter></paramdef>
  27             </funcprototype>
  28         </funcsynopsis>
  29     </refsynopsisdiv>
  30     <refsect1 id="parameters"><title>Parameters</title>
  31         <variablelist>
  32         <varlistentry>
  33             <term><parameter>value</parameter></term>
  34             <listitem>
  35                 <para>
  36                     Specifies the value whose bits to scan.
  37                 </para>
  38             </listitem>
  39         </varlistentry>
  40         </variablelist>
  41     </refsect1>
  42     <refsect1 id="description"><title>Description</title>
  43         <para>
  44             <function>findLSB</function> returns the bit number of the least significant bit that is set to 1 in the binary
  45             representation of <parameter>value</parameter>. If <parameter>value</parameter> is zero, -1 will be returned.
  46         </para>
  47     </refsect1>
  48     <refsect1 id="versions"><title>Version Support</title>
  49         <informaltable frame="topbot">
  50             #VARTABLECOLS#
  51                 <thead>
  52                     #FUNCTABLEHEADER#
  53                     <row>
  54                         <entry>findLSB</entry>#newin40#
  55                     </row>
  56                 </thead>
  57             </tgroup>
  58         </informaltable>
  59     </refsect1>
  60     <refsect1 id="seealso"><title>See Also</title>
  61         <para>
  62             <citerefentry><refentrytitle>findMSB</refentrytitle></citerefentry>
  63         </para>
  64     </refsect1>
  65     <refsect1 id="Copyright"><title>Copyright</title>
  66         <para>
  67             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  68             This material may be distributed subject to the terms and conditions set forth in
  69             the Open Publication License, v 1.0, 8 June 1999.
  70             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  71         </para>
  72     </refsect1>
  73 </refentry>