upstream-man-pages/manglsl/outerProduct.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="outerProduct">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>outerProduct</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>outerProduct</refname>
  17         <refpurpose>calculate the outer product of a pair of vectors</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>mat2 <function>outerProduct</function></funcdef>
  23                 <paramdef>vec2 <parameter>c</parameter></paramdef>
  24                 <paramdef>vec2 <parameter>r</parameter></paramdef>
  25             </funcprototype>
  26             <funcprototype>
  27                 <funcdef>mat3 <function>outerProduct</function></funcdef>
  28                 <paramdef>vec3 <parameter>c</parameter></paramdef>
  29                 <paramdef>vec3 <parameter>r</parameter></paramdef>
  30             </funcprototype>
  31             <funcprototype>
  32                 <funcdef>mat4 <function>outerProduct</function></funcdef>
  33                 <paramdef>vec4 <parameter>c</parameter></paramdef>
  34                 <paramdef>vec4 <parameter>r</parameter></paramdef>
  35             </funcprototype>
  36             <funcprototype>
  37                 <funcdef>mat2x3 <function>outerProduct</function></funcdef>
  38                 <paramdef>vec3 <parameter>c</parameter></paramdef>
  39                 <paramdef>vec2 <parameter>r</parameter></paramdef>
  40             </funcprototype>
  41             <funcprototype>
  42                 <funcdef>mat3x2 <function>outerProduct</function></funcdef>
  43                 <paramdef>vec2 <parameter>c</parameter></paramdef>
  44                 <paramdef>vec3 <parameter>r</parameter></paramdef>
  45             </funcprototype>
  46             <funcprototype>
  47                 <funcdef>mat2x4 <function>outerProduct</function></funcdef>
  48                 <paramdef>vec4 <parameter>c</parameter></paramdef>
  49                 <paramdef>vec2 <parameter>r</parameter></paramdef>
  50             </funcprototype>
  51             <funcprototype>
  52                 <funcdef>mat4x2 <function>outerProduct</function></funcdef>
  53                 <paramdef>vec2 <parameter>c</parameter></paramdef>
  54                 <paramdef>vec4 <parameter>r</parameter></paramdef>
  55             </funcprototype>
  56             <funcprototype>
  57                 <funcdef>mat3x4 <function>outerProduct</function></funcdef>
  58                 <paramdef>vec4 <parameter>c</parameter></paramdef>
  59                 <paramdef>vec3 <parameter>r</parameter></paramdef>
  60             </funcprototype>
  61             <funcprototype>
  62                 <funcdef>mat4x3 <function>outerProduct</function></funcdef>
  63                 <paramdef>vec3 <parameter>c</parameter></paramdef>
  64                 <paramdef>vec4 <parameter>r</parameter></paramdef>
  65             </funcprototype>
  66             <funcprototype>
  67                 <funcdef>dmat2 <function>outerProduct</function></funcdef>
  68                 <paramdef>dvec2 <parameter>c</parameter></paramdef>
  69                 <paramdef>dvec2 <parameter>r</parameter></paramdef>
  70             </funcprototype>
  71             <funcprototype>
  72                 <funcdef>dmat3 <function>outerProduct</function></funcdef>
  73                 <paramdef>dvec3 <parameter>c</parameter></paramdef>
  74                 <paramdef>dvec3 <parameter>r</parameter></paramdef>
  75             </funcprototype>
  76             <funcprototype>
  77                 <funcdef>dmat4 <function>outerProduct</function></funcdef>
  78                 <paramdef>dvec4 <parameter>c</parameter></paramdef>
  79                 <paramdef>dvec4 <parameter>r</parameter></paramdef>
  80             </funcprototype>
  81             <funcprototype>
  82                 <funcdef>dmat2x3 <function>outerProduct</function></funcdef>
  83                 <paramdef>dvec3 <parameter>c</parameter></paramdef>
  84                 <paramdef>dvec2 <parameter>r</parameter></paramdef>
  85             </funcprototype>
  86             <funcprototype>
  87                 <funcdef>dmat3x2 <function>outerProduct</function></funcdef>
  88                 <paramdef>dvec2 <parameter>c</parameter></paramdef>
  89                 <paramdef>dvec3 <parameter>r</parameter></paramdef>
  90             </funcprototype>
  91             <funcprototype>
  92                 <funcdef>dmat2x4 <function>outerProduct</function></funcdef>
  93                 <paramdef>dvec4 <parameter>c</parameter></paramdef>
  94                 <paramdef>dvec2 <parameter>r</parameter></paramdef>
  95             </funcprototype>
  96             <funcprototype>
  97                 <funcdef>dmat4x2 <function>outerProduct</function></funcdef>
  98                 <paramdef>dvec2 <parameter>c</parameter></paramdef>
  99                 <paramdef>dvec4 <parameter>r</parameter></paramdef>
 100             </funcprototype>
 101             <funcprototype>
 102                 <funcdef>dmat3x4 <function>outerProduct</function></funcdef>
 103                 <paramdef>dvec4 <parameter>c</parameter></paramdef>
 104                 <paramdef>dvec3 <parameter>r</parameter></paramdef>
 105             </funcprototype>
 106             <funcprototype>
 107                 <funcdef>dmat4x3 <function>outerProduct</function></funcdef>
 108                 <paramdef>dvec3 <parameter>c</parameter></paramdef>
 109                 <paramdef>dvec4 <parameter>r</parameter></paramdef>
 110             </funcprototype>
 111         </funcsynopsis>
 112     </refsynopsisdiv>
 113     <refsect1 id="parameters"><title>Parameters</title>
 114         <variablelist>
 115         <varlistentry>
 116             <term><parameter>c</parameter></term>
 117             <listitem>
 118                 <para>
 119                     Specifies the parameter to be treated as a column vector.
 120                 </para>
 121             </listitem>
 122         </varlistentry>
 123         <varlistentry>
 124             <term><parameter>r</parameter></term>
 125             <listitem>
 126                 <para>
 127                     Specifies the parameter to be treated as a row vector.
 128                 </para>
 129             </listitem>
 130         </varlistentry>
 131         </variablelist>
 132     </refsect1>
 133     <refsect1 id="description"><title>Description</title>
 134         <para>
 135             <function>outerProduct</function> treats the first parameter <parameter>c</parameter> as a column
 136             vector (matrix with one column) and the second parameter <parameter>r</parameter> as a row vector
 137             (matrix with one row) and does a linear algebraic matrix multiply <parameter>c</parameter> * <parameter>r</parameter>,
 138             yielding a matrix whose number of rows is the number of components in <parameter>c</parameter> and
 139             whose number of columns is the number of components in <parameter>r</parameter>.
 140         </para>
 141     </refsect1>
 142     <refsect1 id="versions"><title>Version Support</title>
 143         <informaltable frame="topbot">
 144             #VARTABLECOLS#
 145                 <thead>
 146                     #FUNCTABLEHEADER#
 147                     <row>
 148                         <entry>outerProduct (float)</entry>#newin12#
 149                     </row>
 150                     <row>
 151                         <entry>outerProduct (double)</entry>#newin40#
 152                     </row>
 153                 </thead>
 154             </tgroup>
 155         </informaltable>
 156     </refsect1>
 157     <refsect1 id="seealso"><title>See Also</title>
 158         <para>
 159             <citerefentry><refentrytitle>dot</refentrytitle></citerefentry>
 160         </para>
 161     </refsect1>
 162     <refsect1 id="Copyright"><title>Copyright</title>
 163         <para>
 164             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 165             This material may be distributed subject to the terms and conditions set forth in
 166             the Open Publication License, v 1.0, 8 June 1999.
 167             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 168         </para>
 169     </refsect1>
 170 </refentry>