upstream-doc/manglsl/acos.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="radians">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>acos</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>acos</refname>
  17         <refpurpose>return the arccosine of the parameter</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>acos</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>x</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specify the value whose arccosine to return.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>atan</function> returns the angle whose trigonometric cosine is
  42             <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>.
  43             The range of values returned by <function>acos</function> is
  44             <inlineequation><mml:math>
  45                 <mml:list order="numeric">
  46                     <mml:mn>0</mml:mn>
  47                     <mml:pi/>
  48                 </mml:list>
  49             </mml:math></inlineequation>.
  50             The result is undefined if
  51             <inlineequation><mml:math><mml:apply><mml:gt /><mml:apply><mml:abs /><mml:mi mathvariant="italic">x</mml:mi></mml:apply><mml:mn>1</mml:mn></mml:apply></mml:math></inlineequation>.
  52         </para>
  53     </refsect1>
  54     <refsect1 id="versions"><title>Version Support</title>
  55         <informaltable frame="topbot">
  56             #VARTABLECOLS#
  57                 <thead>
  58                     #FUNCTABLEHEADER#
  59                     <row>
  60                         <entry>acos</entry>#newin11#
  61                     </row>
  62                 </thead>
  63             </tgroup>
  64         </informaltable>
  65     </refsect1>
  66     <refsect1 id="seealso"><title>See Also</title>
  67         <para>
  68             <citerefentry><refentrytitle>sin</refentrytitle></citerefentry>,
  69             <citerefentry><refentrytitle>cos</refentrytitle></citerefentry>,
  70             <citerefentry><refentrytitle>asin</refentrytitle></citerefentry>,
  71             <citerefentry><refentrytitle>tan</refentrytitle></citerefentry>
  72         </para>
  73     </refsect1>
  74     <refsect1 id="Copyright"><title>Copyright</title>
  75         <para>
  76             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  77             This material may be distributed subject to the terms and conditions set forth in
  78             the Open Publication License, v 1.0, 8 June 1999.
  79             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  80         </para>
  81     </refsect1>
  82 </refentry>