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