abs.xml

<refentry id="abs">
<indexterm id="IndexAbs"><primary>abs</primary></indexterm>
  <refentryinfo><title>Mathematical Operations:Mathematical Functions</title></refentryinfo>
  <refmeta>
    <refentrytitle>abs</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>abs</refname>

    <refpurpose>
      Returns an absolute value.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Returns the absolute value of <emphasis>x</emphasis>.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>abs</command>(x) (no rate
    restriction)</synopsis>
       <synopsis><command>abs</command>(k/i[]) (k- or i-arrays )</synopsis>

    <para>
      where the argument within the parentheses may be an expression. Value converters perform arithmetic translation from units of one kind to units of another. The result can then be a term in a further expression.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the abs opcode. It uses the file <ulink url="examples/abs.csd"><citetitle>abs.csd</citetitle></ulink>.

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

        

        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/abs.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>

      Its output should include lines like:
      <screen>
instr 1:  iabs = 0.000
instr 1:  iabs = 0.150
instr 1:  iabs = 13.000
      </screen>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="exp"><citetitle>exp</citetitle></link>,
      <link linkend="frac"><citetitle>frac</citetitle></link>,
      <link linkend="int"><citetitle>int</citetitle></link>,
      <link linkend="log"><citetitle>log</citetitle></link>,
      <link linkend="log10"><citetitle>log10</citetitle></link>,
      <link linkend="opi"><citetitle>i</citetitle></link>,
      <link linkend="sqrt"><citetitle>sqrt</citetitle></link>
    </para>
  </refsect1>
</refentry>