upstream-man-pages/manglsl/inverse.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="inverse">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>inverse</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>inverse</refname>
  17         <refpurpose>calculate the inverse of a matrix</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>mat2 <function>inverse</function></funcdef>
  23                 <paramdef>mat2 <parameter>m</parameter></paramdef>
  24             </funcprototype>
  25             <funcprototype>
  26                 <funcdef>mat3 <function>inverse</function></funcdef>
  27                 <paramdef>mat3 <parameter>m</parameter></paramdef>
  28             </funcprototype>
  29             <funcprototype>
  30                 <funcdef>mat4 <function>inverse</function></funcdef>
  31                 <paramdef>mat4 <parameter>m</parameter></paramdef>
  32             </funcprototype>
  33             <funcprototype>
  34                 <funcdef>dmat2 <function>inverse</function></funcdef>
  35                 <paramdef>dmat2 <parameter>m</parameter></paramdef>
  36             </funcprototype>
  37             <funcprototype>
  38                 <funcdef>dmat3 <function>inverse</function></funcdef>
  39                 <paramdef>dmat3 <parameter>m</parameter></paramdef>
  40             </funcprototype>
  41             <funcprototype>
  42                 <funcdef>dmat4 <function>inverse</function></funcdef>
  43                 <paramdef>dmat4 <parameter>m</parameter></paramdef>
  44             </funcprototype>
  45         </funcsynopsis>
  46     </refsynopsisdiv>
  47     <refsect1 id="parameters"><title>Parameters</title>
  48         <variablelist>
  49         <varlistentry>
  50             <term><parameter>m</parameter></term>
  51             <listitem>
  52                 <para>
  53                     Specifies the matrix of which to take the inverse.
  54                 </para>
  55             </listitem>
  56         </varlistentry>
  57         </variablelist>
  58     </refsect1>
  59     <refsect1 id="description"><title>Description</title>
  60         <para>
  61             <function>inverse</function> returns the inverse of the matrix <parameter>m</parameter>. The values in the
  62             returned matrix are undefined if <parameter>m</parameter> is singular or poorly-conditioned (nearly singular).
  63         </para>
  64     </refsect1>
  65     <refsect1 id="versions"><title>Version Support</title>
  66         <informaltable frame="topbot">
  67             #VARTABLECOLS#
  68                 <thead>
  69                     #FUNCTABLEHEADER#
  70                     <row>
  71                         <entry>inverse (float)</entry>#newin14#
  72                     </row>
  73                     <row>
  74                         <entry>inverse (double)</entry>#newin40#
  75                     </row>
  76                 </thead>
  77             </tgroup>
  78         </informaltable>
  79     </refsect1>
  80     <refsect1 id="seealso"><title>See Also</title>
  81         <para>
  82             <citerefentry><refentrytitle>transpose</refentrytitle></citerefentry>,
  83             <citerefentry><refentrytitle>determinant</refentrytitle></citerefentry>
  84         </para>
  85     </refsect1>
  86     <refsect1 id="Copyright"><title>Copyright</title>
  87         <para>
  88             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  89             This material may be distributed subject to the terms and conditions set forth in
  90             the Open Publication License, v 1.0, 8 June 1999.
  91             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  92         </para>
  93     </refsect1>
  94 </refentry>