upstream-man-pages/manglsl/length.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="length">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>length</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>length</refname>
  17         <refpurpose>calculate the length of a vector</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>float <function>length</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24             </funcprototype>
  25             <funcprototype>
  26                 <funcdef>double <function>length</function></funcdef>
  27                 <paramdef>genDType <parameter>x</parameter></paramdef>
  28             </funcprototype>
  29         </funcsynopsis>
  30     </refsynopsisdiv>
  31     <refsect1 id="parameters"><title>Parameters</title>
  32         <variablelist>
  33         <varlistentry>
  34             <term><parameter>x</parameter></term>
  35             <listitem>
  36                 <para>
  37                     Specifies a vector of which to calculate the length.
  38                 </para>
  39             </listitem>
  40         </varlistentry>
  41         </variablelist>
  42     </refsect1>
  43     <refsect1 id="description"><title>Description</title>
  44         <para>
  45             <function>length</function> returns the length of the vector. i.e.,
  46             <inlineequation><mml:math>
  47                 <mml:apply>
  48                     <mml:root/>
  49                     <mml:csymbol>
  50                         <mml:msup>
  51                             <mml:mrow>
  52                                 <mml:mi>x</mml:mi><mml:mo stretchy='false'>[</mml:mo><mml:mn>0</mml:mn><mml:mo stretchy='false'>]</mml:mo>
  53                             </mml:mrow>
  54                             <mml:mn>2</mml:mn>
  55                         </mml:msup>
  56                         <mml:mo>+</mml:mo>
  57                         <mml:msup>
  58                             <mml:mrow>
  59                                 <mml:mi>x</mml:mi><mml:mo stretchy='false'>[</mml:mo><mml:mn>1</mml:mn><mml:mo stretchy='false'>]</mml:mo>
  60                             </mml:mrow>
  61                             <mml:mn>2</mml:mn>
  62                         </mml:msup>
  63                         <mml:mo>+</mml:mo>
  64                         <mml:mo lspace='0px' form='infix'>...</mml:mo>
  65                     </mml:csymbol>
  66                 </mml:apply>
  67             </mml:math></inlineequation>
  68         </para>
  69     </refsect1>
  70     <refsect1 id="versions"><title>Version Support</title>
  71         <informaltable frame="topbot">
  72             #VARTABLECOLS#
  73                 <thead>
  74                     #FUNCTABLEHEADER#
  75                     <row>
  76                         <entry>length (genType)</entry>#newin11#
  77                     </row>
  78                     <row>
  79                         <entry>length (genDType)</entry>#newin40#
  80                     </row>
  81                 </thead>
  82             </tgroup>
  83         </informaltable>
  84     </refsect1>
  85     <refsect1 id="seealso"><title>See Also</title>
  86         <para>
  87             <citerefentry><refentrytitle>distance</refentrytitle></citerefentry>,
  88             <citerefentry><refentrytitle>normalize</refentrytitle></citerefentry>
  89         </para>
  90     </refsect1>
  91     <refsect1 id="Copyright"><title>Copyright</title>
  92         <para>
  93             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  94             This material may be distributed subject to the terms and conditions set forth in
  95             the Open Publication License, v 1.0, 8 June 1999.
  96             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  97         </para>
  98     </refsect1>
  99 </refentry>