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