upstream-doc/manglsl/matrixCompMult.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="matrixCompMult">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>matrixCompMult</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>matrixCompMult</refname>
  17         <refpurpose>perform a component-wise multiplication of two matrices</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>mat <function>matrixCompMult</function></funcdef>
  23                 <paramdef>mat <parameter>x</parameter></paramdef>
  24                 <paramdef>mat <parameter>y</parameter></paramdef>
  25             </funcprototype>
  26             <funcprototype>
  27                 <funcdef>dmat <function>matrixCompMult</function></funcdef>
  28                 <paramdef>dmat <parameter>x</parameter></paramdef>
  29                 <paramdef>dmat <parameter>y</parameter></paramdef>
  30             </funcprototype>
  31         </funcsynopsis>
  32     </refsynopsisdiv>
  33     <refsect1 id="parameters"><title>Parameters</title>
  34         <variablelist>
  35         <varlistentry>
  36             <term><parameter>x</parameter></term>
  37             <listitem>
  38                 <para>
  39                     Specifies the first matrix multiplicand.
  40                 </para>
  41             </listitem>
  42         </varlistentry>
  43         <varlistentry>
  44             <term><parameter>y</parameter></term>
  45             <listitem>
  46                 <para>
  47                     Specifies the second matrix multiplicand.
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         </variablelist>
  52     </refsect1>
  53     <refsect1 id="description"><title>Description</title>
  54         <para>
  55             <function>matrixCompMult</function> performs a component-wise multiplication of two
  56             matrices, yielding a result matrix where each component, <code>result[i][j]</code> is
  57             computed as the scalar product of <code><parameter>x</parameter>[i][j]</code> and
  58             <code><parameter>y</parameter>[i][j]</code>.
  59         </para>
  60     </refsect1>
  61     <refsect1 id="versions"><title>Version Support</title>
  62         <informaltable frame="topbot">
  63             #VARTABLECOLS#
  64                 <thead>
  65                     #FUNCTABLEHEADER#
  66                     <row>
  67                         <entry>matrixCompMult (genType)</entry>#newin11#
  68                     </row>
  69                     <row>
  70                         <entry>matrixCompMult (genDType)</entry>#newin40#
  71                     </row>
  72                 </thead>
  73             </tgroup>
  74         </informaltable>
  75     </refsect1>
  76     <refsect1 id="seealso"><title>See Also</title>
  77         <para>
  78             <citerefentry><refentrytitle>dot</refentrytitle></citerefentry>,
  79             <citerefentry><refentrytitle>reflect</refentrytitle></citerefentry>
  80         </para>
  81     </refsect1>
  82     <refsect1 id="Copyright"><title>Copyright</title>
  83         <para>
  84             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  85             This material may be distributed subject to the terms and conditions set forth in
  86             the Open Publication License, v 1.0, 8 June 1999.
  87             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  88         </para>
  89     </refsect1>
  90 </refentry>