rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / length.xml

diff --git a/upstream-doc/manglsl/length.xml b/upstream-doc/manglsl/length.xml
new file mode 100644 (file)
index 0000000..3ca5a88
--- /dev/null
+++ b/upstream-doc/manglsl/length.xml
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
+<refentry id="length">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2011</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>length</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>length</refname>\r
+        <refpurpose>calculate the length of a vector</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>Declaration</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>float <function>length</function></funcdef>\r
+                <paramdef>genType <parameter>x</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>double <function>length</function></funcdef>\r
+                <paramdef>genDType <parameter>x</parameter></paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <refsect1 id="parameters"><title>Parameters</title>\r
+        <variablelist>\r
+        <varlistentry>\r
+            <term><parameter>x</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies a vector of which to calculate the length.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>length</function> returns the length of the vector. i.e.,\r
+            <inlineequation><mml:math>\r
+                <mml:apply>\r
+                    <mml:root/>\r
+                    <mml:csymbol>\r
+                        <mml:msup>\r
+                            <mml:mrow>\r
+                                <mml:mi>x</mml:mi><mml:mo stretchy='false'>[</mml:mo><mml:mn>0</mml:mn><mml:mo stretchy='false'>]</mml:mo>\r
+                            </mml:mrow>\r
+                            <mml:mn>2</mml:mn>\r
+                        </mml:msup>\r
+                        <mml:mo>+</mml:mo>\r
+                        <mml:msup>\r
+                            <mml:mrow>\r
+                                <mml:mi>x</mml:mi><mml:mo stretchy='false'>[</mml:mo><mml:mn>1</mml:mn><mml:mo stretchy='false'>]</mml:mo>\r
+                            </mml:mrow>\r
+                            <mml:mn>2</mml:mn>\r
+                        </mml:msup>\r
+                        <mml:mo>+</mml:mo>\r
+                        <mml:mo lspace='0px' form='infix'>...</mml:mo>\r
+                    </mml:csymbol>\r
+                </mml:apply>\r
+            </mml:math></inlineequation>\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="versions"><title>Version Support</title>\r
+        <informaltable frame="topbot">\r
+            #VARTABLECOLS#\r
+                <thead>\r
+                    #FUNCTABLEHEADER#\r
+                    <row>\r
+                        <entry>length (genType)</entry>#newin11#\r
+                    </row>\r
+                    <row>\r
+                        <entry>length (genDType)</entry>#newin40#\r
+                    </row>\r
+                </thead>\r
+            </tgroup>\r
+        </informaltable>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>distance</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>normalize</refentrytitle></citerefentry>\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="Copyright"><title>Copyright</title>\r
+        <para>\r
+            Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
+            This material may be distributed subject to the terms and conditions set forth in \r
+            the Open Publication License, v 1.0, 8 June 1999.\r
+            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
+        </para>\r
+    </refsect1>\r
+</refentry>\r