HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
| 4 | <refentry id="radians">\r | |
| 5 | <refmeta>\r | |
| 6 | <refmetainfo>\r | |
| 7 | <copyright>\r | |
| 8 | <year>2011</year>\r | |
| 9 | <holder>Khronos Group</holder>\r | |
| 10 | </copyright>\r | |
| 11 | </refmetainfo>\r | |
| 12 | <refentrytitle>atan</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>atan</refname>\r | |
| 17 | <refpurpose>return the arc-tangent of the parameters</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>Declaration</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>genType <function>atan</function></funcdef>\r | |
| 23 | <paramdef>genType <parameter>y</parameter></paramdef>\r | |
| 24 | <paramdef>genType <parameter>x</parameter></paramdef>\r | |
| 25 | </funcprototype>\r | |
| 26 | </funcsynopsis>\r | |
| 27 | <funcsynopsis>\r | |
| 28 | <funcprototype>\r | |
| 29 | <funcdef>genType <function>atan</function></funcdef>\r | |
| 30 | <paramdef>genType <parameter>y_over_x</parameter></paramdef>\r | |
| 31 | </funcprototype>\r | |
| 32 | </funcsynopsis>\r | |
| 33 | </refsynopsisdiv>\r | |
| 34 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 35 | <variablelist>\r | |
| 36 | <varlistentry>\r | |
| 37 | <term><parameter>y</parameter></term>\r | |
| 38 | <listitem>\r | |
| 39 | <para>\r | |
| 40 | Specify the numerator of the fraction whose arctangent to return.\r | |
| 41 | </para>\r | |
| 42 | </listitem>\r | |
| 43 | </varlistentry>\r | |
| 44 | <varlistentry>\r | |
| 45 | <term><parameter>x</parameter></term>\r | |
| 46 | <listitem>\r | |
| 47 | <para>\r | |
| 48 | Specify the denominator of the fraction whose arctangent to return.\r | |
| 49 | </para>\r | |
| 50 | </listitem>\r | |
| 51 | </varlistentry>\r | |
| 52 | <varlistentry>\r | |
| 53 | <term><parameter>y_over_x</parameter></term>\r | |
| 54 | <listitem>\r | |
| 55 | <para>\r | |
| 56 | Specify the fraction whose arctangent to return.\r | |
| 57 | </para>\r | |
| 58 | </listitem>\r | |
| 59 | </varlistentry>\r | |
| 60 | </variablelist>\r | |
| 61 | </refsect1>\r | |
| 62 | <refsect1 id="description"><title>Description</title>\r | |
| 63 | <para>\r | |
| 64 | <function>atan</function> returns the angle whose trigonometric arctangent is\r | |
| 65 | <inlineequation><mml:math>\r | |
| 66 | <!-- eqn: b sub 0: -->\r | |
| 67 | <mml:mfrac>\r | |
| 68 | <mml:mrow>\r | |
| 69 | <mml:mi mathvariant="italic">y</mml:mi>\r | |
| 70 | </mml:mrow>\r | |
| 71 | <mml:mrow>\r | |
| 72 | <mml:mi mathvariant="italic">x</mml:mi>\r | |
| 73 | </mml:mrow>\r | |
| 74 | </mml:mfrac>\r | |
| 75 | </mml:math></inlineequation> or <inlineequation><mml:math><mml:mi mathvariant="italic">y_over_x</mml:mi></mml:math></inlineequation>,\r | |
| 76 | depending on which overload is invoked. In the first overload, the signs of <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation>\r | |
| 77 | and <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation> are used to determine the quadrant\r | |
| 78 | that the angle lies in. The values returned by <function>atan</function> in this case are in the range\r | |
| 79 | <inlineequation><mml:math>\r | |
| 80 | <mml:list order="numeric">\r | |
| 81 | <mml:csymbol><mml:mo>−</mml:mo><mml:pi/></mml:csymbol>\r | |
| 82 | <mml:pi/>\r | |
| 83 | </mml:list>\r | |
| 84 | </mml:math></inlineequation>. Results are undefined if <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation> is zero.\r | |
| 85 | </para>\r | |
| 86 | <para>\r | |
| 87 | For the second overload, <function>atan</function> returns the angle whose tangent is\r | |
| 88 | <inlineequation><mml:math><mml:mi mathvariant="italic">y_over_x</mml:mi></mml:math></inlineequation>. Values\r | |
| 89 | returned in this case are in the range\r | |
| 90 | <inlineequation><mml:math>\r | |
| 91 | <mml:list order="numeric">\r | |
| 92 | <mml:mrow>\r | |
| 93 | <mml:mo>−</mml:mo>\r | |
| 94 | <mml:mfrac>\r | |
| 95 | <mml:csymbol><mml:pi/></mml:csymbol>\r | |
| 96 | <mml:mn>2</mml:mn>\r | |
| 97 | </mml:mfrac>\r | |
| 98 | </mml:mrow>\r | |
| 99 | <mml:mfrac>\r | |
| 100 | <mml:pi/>\r | |
| 101 | <mml:mn>2</mml:mn>\r | |
| 102 | </mml:mfrac>\r | |
| 103 | </mml:list>\r | |
| 104 | </mml:math></inlineequation>.\r | |
| 105 | </para>\r | |
| 106 | </refsect1>\r | |
| 107 | <refsect1 id="versions"><title>Version Support</title>\r | |
| 108 | <informaltable frame="topbot">\r | |
| 109 | #VARTABLECOLS#\r | |
| 110 | <thead>\r | |
| 111 | #FUNCTABLEHEADER#\r | |
| 112 | <row>\r | |
| 113 | <entry>atan</entry>#newin11#\r | |
| 114 | </row>\r | |
| 115 | </thead>\r | |
| 116 | </tgroup>\r | |
| 117 | </informaltable>\r | |
| 118 | </refsect1>\r | |
| 119 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 120 | <para>\r | |
| 121 | <citerefentry><refentrytitle>sin</refentrytitle></citerefentry>,\r | |
| 122 | <citerefentry><refentrytitle>cos</refentrytitle></citerefentry>,\r | |
| 123 | <citerefentry><refentrytitle>tan</refentrytitle></citerefentry>\r | |
| 124 | </para>\r | |
| 125 | </refsect1>\r | |
| 126 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 127 | <para>\r | |
| 128 | Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r | |
| 129 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 130 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 131 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 132 | </para>\r | |
| 133 | </refsect1>\r | |
| 134 | </refentry>\r |