HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 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="uaddCarry">\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>uaddCarry</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>uaddCarry</refname>\r | |
| 17 | <refpurpose>add unsigned integers and generate carry</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>Declaration</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>genUType <function>uaddCarry</function></funcdef>\r | |
| 23 | <paramdef>genUType <parameter>x</parameter></paramdef>\r | |
| 24 | <paramdef>genUType <parameter>y</parameter></paramdef>\r | |
| 25 | <paramdef>out genUType <parameter>carry</parameter></paramdef>\r | |
| 26 | </funcprototype>\r | |
| 27 | </funcsynopsis>\r | |
| 28 | </refsynopsisdiv>\r | |
| 29 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 30 | <variablelist>\r | |
| 31 | <varlistentry>\r | |
| 32 | <term><parameter>x</parameter></term>\r | |
| 33 | <listitem>\r | |
| 34 | <para>\r | |
| 35 | Specifies the first vector to be used in the summation operation.\r | |
| 36 | </para>\r | |
| 37 | </listitem>\r | |
| 38 | </varlistentry>\r | |
| 39 | <varlistentry>\r | |
| 40 | <term><parameter>y</parameter></term>\r | |
| 41 | <listitem>\r | |
| 42 | <para>\r | |
| 43 | Specifies the second vector to be used in the summation operation.\r | |
| 44 | </para>\r | |
| 45 | </listitem>\r | |
| 46 | </varlistentry>\r | |
| 47 | <varlistentry>\r | |
| 48 | <term><parameter>carry</parameter></term>\r | |
| 49 | <listitem>\r | |
| 50 | <para>\r | |
| 51 | Specifies the variable to receive the carry output of the sum.\r | |
| 52 | </para>\r | |
| 53 | </listitem>\r | |
| 54 | </varlistentry>\r | |
| 55 | </variablelist>\r | |
| 56 | </refsect1>\r | |
| 57 | <refsect1 id="description"><title>Description</title>\r | |
| 58 | <para>\r | |
| 59 | <function>uaddCarry</function> adds two 32-bit unsigned integer variables (scalars or vectors) and generates\r | |
| 60 | a 32-bit unsigned integer result, along with a carry output. The result is the sum of <parameter>x</parameter> and\r | |
| 61 | <parameter>y</parameter> modulo <inlineequation><mml:math><mml:msup><mml:mn>2</mml:mn><mml:mn>32</mml:mn></mml:msup></mml:math></inlineequation>.\r | |
| 62 | The value <parameter>carry</parameter> is set to 0 if the sum is less than\r | |
| 63 | <inlineequation><mml:math><mml:msup><mml:mn>2</mml:mn><mml:mn>32</mml:mn></mml:msup></mml:math></inlineequation>\r | |
| 64 | and to 1 otherwise.\r | |
| 65 | </para>\r | |
| 66 | </refsect1>\r | |
| 67 | <refsect1 id="versions"><title>Version Support</title>\r | |
| 68 | <informaltable frame="topbot">\r | |
| 69 | #VARTABLECOLS#\r | |
| 70 | <thead>\r | |
| 71 | #FUNCTABLEHEADER#\r | |
| 72 | <row>\r | |
| 73 | <entry>uaddCarry</entry>#newin40#\r | |
| 74 | </row>\r | |
| 75 | </thead>\r | |
| 76 | </tgroup>\r | |
| 77 | </informaltable>\r | |
| 78 | </refsect1>\r | |
| 79 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 80 | <para>\r | |
| 81 | <citerefentry><refentrytitle>usubBorrow</refentrytitle></citerefentry>\r | |
| 82 | </para>\r | |
| 83 | </refsect1>\r | |
| 84 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 85 | <para>\r | |
| 86 | Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r | |
| 87 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 88 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 89 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 90 | </para>\r | |
| 91 | </refsect1>\r | |
| 92 | </refentry>\r |