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