| 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="equal">\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>equal</refentrytitle>\r |
| 13 | <manvolnum>3G</manvolnum>\r |
| 14 | </refmeta>\r |
| 15 | <refnamediv>\r |
| 16 | <refname>equal</refname>\r |
| 17 | <refpurpose>perform a component-wise equal-to comparison of two vectors</refpurpose>\r |
| 18 | </refnamediv>\r |
| 19 | <refsynopsisdiv><title>Declaration</title>\r |
| 20 | <funcsynopsis>\r |
| 21 | <funcprototype>\r |
| 22 | <funcdef>bvec <function>equal</function></funcdef>\r |
| 23 | <paramdef>vec <parameter>x</parameter></paramdef>\r |
| 24 | <paramdef>vec <parameter>y</parameter></paramdef>\r |
| 25 | </funcprototype>\r |
| 26 | <funcprototype>\r |
| 27 | <funcdef>bvec <function>equal</function></funcdef>\r |
| 28 | <paramdef>ivec <parameter>x</parameter></paramdef>\r |
| 29 | <paramdef>ivec <parameter>y</parameter></paramdef>\r |
| 30 | </funcprototype>\r |
| 31 | <funcprototype>\r |
| 32 | <funcdef>bvec <function>equal</function></funcdef>\r |
| 33 | <paramdef>uvec <parameter>x</parameter></paramdef>\r |
| 34 | <paramdef>uvec <parameter>y</parameter></paramdef>\r |
| 35 | </funcprototype>\r |
| 36 | </funcsynopsis>\r |
| 37 | </refsynopsisdiv>\r |
| 38 | <refsect1 id="parameters"><title>Parameters</title>\r |
| 39 | <variablelist>\r |
| 40 | <varlistentry>\r |
| 41 | <term><parameter>x</parameter></term>\r |
| 42 | <listitem>\r |
| 43 | <para>\r |
| 44 | Specifies the first vector to be used in the comparison operation.\r |
| 45 | </para>\r |
| 46 | </listitem>\r |
| 47 | </varlistentry>\r |
| 48 | <varlistentry>\r |
| 49 | <term><parameter>x</parameter></term>\r |
| 50 | <listitem>\r |
| 51 | <para>\r |
| 52 | Specifies the second vector to be used in the comparison operation.\r |
| 53 | </para>\r |
| 54 | </listitem>\r |
| 55 | </varlistentry>\r |
| 56 | </variablelist>\r |
| 57 | </refsect1>\r |
| 58 | <refsect1 id="description"><title>Description</title>\r |
| 59 | <para>\r |
| 60 | <function>equal</function> returns a boolean vector in which each element <emphasis>i</emphasis> is computed\r |
| 61 | as <parameter>x</parameter>[<emphasis>i</emphasis>] == <parameter>y</parameter>[<emphasis>i</emphasis>].\r |
| 62 | </para>\r |
| 63 | </refsect1>\r |
| 64 | <refsect1 id="versions"><title>Version Support</title>\r |
| 65 | <informaltable frame="topbot">\r |
| 66 | #VARTABLECOLS#\r |
| 67 | <thead>\r |
| 68 | #FUNCTABLEHEADER#\r |
| 69 | <row>\r |
| 70 | <entry>equal</entry>#newin11#\r |
| 71 | </row>\r |
| 72 | </thead>\r |
| 73 | </tgroup>\r |
| 74 | </informaltable>\r |
| 75 | </refsect1>\r |
| 76 | <refsect1 id="seealso"><title>See Also</title>\r |
| 77 | <para>\r |
| 78 | <citerefentry><refentrytitle>lessThan</refentrytitle></citerefentry>,\r |
| 79 | <citerefentry><refentrytitle>lessThanEqual</refentrytitle></citerefentry>,\r |
| 80 | <citerefentry><refentrytitle>greaterThan</refentrytitle></citerefentry>,\r |
| 81 | <citerefentry><refentrytitle>greaterThanEqual</refentrytitle></citerefentry>,\r |
| 82 | <citerefentry><refentrytitle>notEqual</refentrytitle></citerefentry>,\r |
| 83 | <citerefentry><refentrytitle>any</refentrytitle></citerefentry>,\r |
| 84 | <citerefentry><refentrytitle>all</refentrytitle></citerefentry>,\r |
| 85 | <citerefentry><refentrytitle>not</refentrytitle></citerefentry>\r |
| 86 | </para>\r |
| 87 | </refsect1>\r |
| 88 | <refsect1 id="Copyright"><title>Copyright</title>\r |
| 89 | <para>\r |
| 90 | Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r |
| 91 | This material may be distributed subject to the terms and conditions set forth in \r |
| 92 | the Open Publication License, v 1.0, 8 June 1999.\r |
| 93 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r |
| 94 | </para>\r |
| 95 | </refsect1>\r |
| 96 | </refentry>\r |