upstream-man-pages/manglsl/pow.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="pow">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>pow</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>pow</refname>
  17         <refpurpose>return the value of the first parameter raised to the power of the second</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>pow</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24                 <paramdef>genType <parameter>y</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>x</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specify the value to raise to the power <parameter>y</parameter>.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>y</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specify the power to which to raise <parameter>x</parameter>.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>pow</function> returns the value of <parameter>x</parameter> raised to the <parameter>y</parameter> power. i.e.,
  51             <inlineequation><mml:math><mml:msup><mml:mi>x</mml:mi><mml:mi>y</mml:mi></mml:msup></mml:math></inlineequation>.
  52             Results are undefined if <inlineequation><mml:math><mml:apply><mml:lt /><mml:mi>x</mml:mi><mml:mn>0</mml:mn></mml:apply></mml:math></inlineequation>
  53             or if <inlineequation><mml:math><mml:apply><mml:eq /><mml:mi>x</mml:mi><mml:mn>0</mml:mn></mml:apply></mml:math></inlineequation> and
  54             <inlineequation><mml:math><mml:apply><mml:eq /><mml:mi>y</mml:mi><mml:mn>0</mml:mn></mml:apply></mml:math></inlineequation>.
  55         </para>
  56     </refsect1>
  57     <refsect1 id="versions"><title>Version Support</title>
  58         <informaltable frame="topbot">
  59             #VARTABLECOLS#
  60                 <thead>
  61                     #FUNCTABLEHEADER#
  62                     <row>
  63                         <entry>pow</entry>#newin11#
  64                     </row>
  65                 </thead>
  66             </tgroup>
  67         </informaltable>
  68     </refsect1>
  69     <refsect1 id="seealso"><title>See Also</title>
  70         <para>
  71             <citerefentry><refentrytitle>sin</refentrytitle></citerefentry>,
  72             <citerefentry><refentrytitle>cos</refentrytitle></citerefentry>,
  73             <citerefentry><refentrytitle>sinh</refentrytitle></citerefentry>,
  74             <citerefentry><refentrytitle>cosh</refentrytitle></citerefentry>
  75         </para>
  76     </refsect1>
  77     <refsect1 id="Copyright"><title>Copyright</title>
  78         <para>
  79             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  80             This material may be distributed subject to the terms and conditions set forth in
  81             the Open Publication License, v 1.0, 8 June 1999.
  82             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  83         </para>
  84     </refsect1>
  85 </refentry>