<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="tanh">
  <refmeta>
    <refentrytitle>tanh</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>tanh</refname>

    <refpurpose>
      Performs a hyperbolic tangent function.
      <indexterm id="IndexTanh"><primary>tanh</primary></indexterm>
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Returns the hyperbolic tangent of <emphasis>x</emphasis> (<emphasis>x</emphasis> in radians).
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>tanh</command>(x) (no rate restriction)</synopsis>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the tanh opcode. It uses the files <ulink url="examples/tanh.orc"><citetitle>tanh.orc</citetitle></ulink> and <ulink url="examples/tanh.sco"><citetitle>tanh.sco</citetitle></ulink>.

      <example>
        <title>Example of the tanh opcode.</title>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/tanh.orc" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/tanh.sco" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>
      </example>

      Its output should include a line like this:
      <screen>
instr 1:  i1 = 0.762
      </screen>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="cos"><citetitle>cos</citetitle></link>,
      <link linkend="cosh"><citetitle>cosh</citetitle></link>,
      <link linkend="cosinv"><citetitle>cosinv</citetitle></link>,
      <link linkend="sin"><citetitle>sin</citetitle></link>,
      <link linkend="sinh"><citetitle>sinh</citetitle></link>,
      <link linkend="sininv"><citetitle>sininv</citetitle></link>,
      <link linkend="tan"><citetitle>tan</citetitle></link>,
      <link linkend="taninv"><citetitle>taninv</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Example written by &namekevin;.</para>
  </refsect1>
</refentry>
