summaryrefslogtreecommitdiff
path: root/opcodes/opi.xml
blob: 51fbf99b170e3abb72374fbb68a62b292551e20c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<refentry id="opi">
<indexterm id="IndexI"><primary>i</primary></indexterm>
  <refentryinfo><title>Signal Modifiers:Sample Level Operators</title></refentryinfo>
  <refmeta>
    <refentrytitle>i</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>i</refname>

    <refpurpose>
      Returns an init-type equivalent of a k-rate argument, or directly returns an i-rate argument.
          </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Returns an init-type equivalent of a k-rate argument, or directly returns an i-rate argument.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>i</command>(x) (control-rate or init-rate arg)</synopsis>

    <para>
      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.
      <note>
        <title>Note</title>
	<para>Using i() with a k-rate expression argument is not recommended, and can produce unexpected results.</para>
      </note>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="opa"><citetitle>a</citetitle></link>,
      <link linkend="opk"><citetitle>k</citetitle></link>,
      <link linkend="abs"><citetitle>abs</citetitle></link>,
      <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="sqrt"><citetitle>sqrt</citetitle></link>
    </para>
        <para> More information on this opcode: <ulink url="http://www.csounds.com/journal/issue10/CsoundRates.html"><citetitle>http://www.csounds.com/journal/issue10/CsoundRates.html</citetitle></ulink>  , written by Andrés Cabrera </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>i-rate arg version of function new since 5.14</para>
  </refsect1>

</refentry>