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=
"usubBorrow">
9 <holder>Khronos Group
</holder>
12 <refentrytitle>usubBorrow
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>usubBorrow
</refname>
17 <refpurpose>subtract unsigned integers and generate borrow
</refpurpose>
19 <refsynopsisdiv><title>Declaration
</title>
22 <funcdef>genUType
<function>usubBorrow
</function></funcdef>
23 <paramdef>genUType
<parameter>x
</parameter></paramdef>
24 <paramdef>genUType
<parameter>y
</parameter></paramdef>
25 <paramdef>out genUType
<parameter>borrow
</parameter></paramdef>
29 <refsect1 id=
"parameters"><title>Parameters
</title>
32 <term><parameter>x
</parameter></term>
35 Specifies the first vector to be used in the subtraction operation.
40 <term><parameter>y
</parameter></term>
43 Specifies the second vector to be used in the subtraction operation.
48 <term><parameter>borrow
</parameter></term>
51 Specifies the variable to receive the borrow output of the difference.
57 <refsect1 id=
"description"><title>Description
</title>
59 <function>usubBorrow
</function> subtracts two
32-bit unsigned integer variables (scalars or vectors) and generates
60 a
32-bit unsigned integer result, along with a borrow output. The result is the difference of
<parameter>x
</parameter> and
61 <parameter>y
</parameter> if non-negative, or
<inlineequation><mml:math><mml:msup><mml:mn>2</mml:mn><mml:mn>32</mml:mn></mml:msup></mml:math></inlineequation>
62 plus that difference otherwise.
63 The value
<parameter>borrow
</parameter> is set to
0 if
<parameter>x
</parameter> ≥ <parameter>y
</parameter> and to
1 otherwise.
66 <refsect1 id=
"versions"><title>Version Support
</title>
67 <informaltable frame=
"topbot">
72 <entry>usubBorrow
</entry>#newin40#
78 <refsect1 id=
"seealso"><title>See Also
</title>
80 <citerefentry><refentrytitle>uaddCarry
</refentrytitle></citerefentry>
83 <refsect1 id=
"Copyright"><title>Copyright
</title>
85 Copyright
<trademark class=
"copyright"></trademark> 2011 Khronos Group.
86 This material may be distributed subject to the terms and conditions set forth in
87 the Open Publication License, v
1.0,
8 June
1999.
88 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.