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