upstream-man-pages/manglsl/asin.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>asin</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>asin</refname>
  17         <refpurpose>return the arcsine of the parameter</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>asin</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 arcsine 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 sine is
  42             <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>.
  43             The range of values returned by <function>asin</function> is
  44             <inlineequation><mml:math>
  45                 <mml:list order="numeric">
  46                     <mml:mrow>
  47                         <mml:mo>&minus;</mml:mo>
  48                         <mml:mfrac>
  49                             <mml:csymbol><mml:pi/></mml:csymbol>
  50                             <mml:mn>2</mml:mn>
  51                         </mml:mfrac>
  52                     </mml:mrow>
  53                     <mml:mfrac>
  54                         <mml:pi/>
  55                         <mml:mn>2</mml:mn>
  56                     </mml:mfrac>
  57                 </mml:list>
  58             </mml:math></inlineequation>.
  59             The result is undefined if
  60             <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>.
  61         </para>
  62     </refsect1>
  63     <refsect1 id="versions"><title>Version Support</title>
  64         <informaltable frame="topbot">
  65             #VARTABLECOLS#
  66                 <thead>
  67                     #FUNCTABLEHEADER#
  68                     <row>
  69                         <entry>asin</entry>#newin11#
  70                     </row>
  71                 </thead>
  72             </tgroup>
  73         </informaltable>
  74     </refsect1>
  75     <refsect1 id="seealso"><title>See Also</title>
  76         <para>
  77             <citerefentry><refentrytitle>sin</refentrytitle></citerefentry>,
  78             <citerefentry><refentrytitle>cos</refentrytitle></citerefentry>,
  79             <citerefentry><refentrytitle>acos</refentrytitle></citerefentry>,
  80             <citerefentry><refentrytitle>tan</refentrytitle></citerefentry>
  81         </para>
  82     </refsect1>
  83     <refsect1 id="Copyright"><title>Copyright</title>
  84         <para>
  85             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  86             This material may be distributed subject to the terms and conditions set forth in
  87             the Open Publication License, v 1.0, 8 June 1999.
  88             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  89         </para>
  90     </refsect1>
  91 </refentry>