<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title>lenarray</title> <link rel="stylesheet" type="text/css" href="csound.css" /> <link rel="stylesheet" type="text/css" href="syntax-highlighting.css" /> <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /> <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" /> <link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" /> <link rel="prev" href="ksmps.html" title="ksmps" /> <link rel="next" href="lfo.html" title="lfo" /> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">lenarray</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="ksmps.html">Prev</a> </td> <th width="60%" align="center">Orchestra Opcodes and Operators</th> <td width="20%" align="right"> <a accesskey="n" href="lfo.html">Next</a></td> </tr> </table> <hr /> </div> <div class="refentry"> <a id="lenarray"></a> <div class="titlepage"></div> <a id="IndexLenarray" class="indexterm"></a> <div class="refnamediv"> <h2> <span class="refentrytitle">lenarray</span> </h2> <p>lenarray — Evaluates the size or shape length of an array. </p> </div> <div class="refsect1"> <a id="idm281472921241960"></a> <h2>Description</h2> <p> Evaluates the size or number of dimensions of an array. </p> </div> <div class="refsect1"> <a id="idm281472921160888"></a> <h2>Syntax</h2> <pre class="synopsis">ir <span class="command"><strong>lenarray</strong></span> karray[, iwhich]</pre> <pre class="synopsis">kr <span class="command"><strong>lenarray</strong></span> karray[, iwhich]</pre> </div> <div class="refsect1"> <a id="idm281472921157368"></a> <h2>Initialisation</h2> <p> <span class="emphasis"><em>karray</em></span> -- The array that is being questioned. It can be of any dimension. </p> <p> <span class="emphasis"><em>iwhich</em></span> -- selects which dimension to evaluate the size. If zero or negative it selects the number of dimensions. It defaults to 1, as used in a vector. </p> </div> <div class="refsect1"> <a id="idm281472921154792"></a> <h2>Performance</h2> <p> <span class="emphasis"><em>kr</em></span> -- length of vector. </p> <p> <span class="emphasis"><em>karray</em></span> -- array to query. </p> <p> If the dimension requested is larger than the actual array, or the array is not initialised the value -1 is returned. </p> </div> <div class="refsect1"> <a id="idm281472921151800"></a> <h2>Examples</h2> <p> Here is an example of the lenarray opcode. It uses the file <a class="ulink" href="examples/lenarray.csd" target="_top"><em class="citetitle">lenarray.csd</em></a>. </p> <div class="example"> <a id="idm281472921149944"></a> <p class="title"> <strong>Example 453. Example of the lenarray opcode.</strong> </p> <div class="example-contents"> <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p> <div class="refsect1"> <a id="idm281472748510152"></a> <pre class="programlisting"> <span class="nt"><CsoundSynthesizer></span> <span class="nt"><CsOptions></span> -n -m128 <span class="c1">;no sound output, reduced messages</span> <span class="nt"></CsOptions></span> <span class="nt"><CsInstruments></span> <span class="c1">;example by joachim heintz</span> <span class="vg">sr</span> <span class="o">=</span> <span class="mi">44100</span> <span class="vg">ksmps</span> <span class="o">=</span> <span class="mi">32</span> <span class="vg">nchnls</span> <span class="o">=</span> <span class="mi">1</span> <span class="vg">0dbfs</span> <span class="o">=</span> <span class="mi">1</span> <span class="kd">instr</span> <span class="nf">1</span> <span class="c1">;simple example</span> k<span class="n">Arr</span><span class="p">[]</span> <span class="nb">fillarray</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span> <span class="c1">;fill array manually</span> <span class="nb">printks</span> <span class="s">"Length of kArr = </span><span class="si">%d</span><span class="se">\n\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="nb">lenarray</span><span class="p">(</span>k<span class="n">Arr</span><span class="p">)</span> <span class="c1">;print out its length</span> <span class="nb">turnoff</span> <span class="c1">;only do this in the first k-cycle</span> <span class="kd">endin</span> <span class="kd">instr</span> <span class="nf">2</span> <span class="c1">;random array length</span> i<span class="n">NumEls</span> <span class="nb">random</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">11</span> <span class="c1">;create random number between 1 and 10</span> k<span class="n">Arr</span><span class="p">[]</span> <span class="nb">init</span> <span class="nb">int</span><span class="p">(</span>i<span class="n">NumEls</span><span class="p">)</span> <span class="c1">;create array of this length</span> <span class="nb">printks</span> <span class="s">"Random length of kArr = </span><span class="si">%d</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="nb">lenarray</span><span class="p">(</span>k<span class="n">Arr</span><span class="p">)</span> <span class="c1">;print out</span> <span class="nb">turnoff</span> <span class="kd">endin</span> <span class="kd">instr</span> <span class="nf">3</span> <span class="c1">;fill random array length with random elements</span> i<span class="n">NumEls</span> <span class="nb">random</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">11</span> <span class="c1">;create random number between 1 and 10</span> k<span class="n">Arr</span><span class="p">[]</span> <span class="nb">init</span> <span class="nb">int</span><span class="p">(</span>i<span class="n">NumEls</span><span class="p">)</span> <span class="c1">;create array of this length</span> <span class="nb">printks</span> <span class="s">"Random length of kArr = </span><span class="si">%d</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="nb">lenarray</span><span class="p">(</span>k<span class="n">Arr</span><span class="p">)</span> <span class="c1">;print out</span> <span class="c1">;fill</span> k<span class="n">Indx</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1">;initialize index</span> <span class="k">until</span> k<span class="n">Indx</span> <span class="o">==</span> <span class="nb">lenarray</span><span class="p">(</span>k<span class="n">Arr</span><span class="p">)</span> <span class="k">do</span> k<span class="n">Arr</span><span class="p">[</span>k<span class="n">Indx</span><span class="p">]</span> <span class="nb">rnd31</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">0</span> <span class="c1">;set element to random value -10...10</span> k<span class="n">Indx</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c1">;increase index</span> <span class="k">od</span> <span class="c1">;print</span> k<span class="n">Indx</span> <span class="o">=</span> <span class="mi">0</span> <span class="c1">;initialize index</span> <span class="k">until</span> k<span class="n">Indx</span> <span class="o">==</span> <span class="nb">lenarray</span><span class="p">(</span>k<span class="n">Arr</span><span class="p">)</span> <span class="k">do</span> <span class="nb">printf</span><span class="p">(</span><span class="s">"kArr[</span><span class="si">%d</span><span class="s">] = %f</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> k<span class="n">Indx</span><span class="o">+</span><span class="mi">1</span><span class="p">,</span> k<span class="n">Indx</span><span class="p">,</span> k<span class="n">Arr</span><span class="p">[</span>k<span class="n">Indx</span><span class="p">])</span> k<span class="n">Indx</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c1">;increase index</span> <span class="k">od</span> <span class="nb">turnoff</span> <span class="kd">endin</span> <span class="nt"></CsInstruments></span> <span class="nt"><CsScore></span> <span class="nb">i</span> <span class="mi">1</span> <span class="mi">0</span> <span class="mf">.1</span> <span class="nb">i</span> <span class="mi">2</span> <span class="mi">0</span> <span class="mf">.1</span> <span class="nb">i</span> <span class="mi">2</span> <span class="mi">0</span> <span class="mf">.1</span> <span class="nb">i</span> <span class="mi">3</span> <span class="mi">0</span> <span class="mf">.1</span> <span class="nt"></CsScore></span> <span class="nt"></CsoundSynthesizer></span> </pre> </div> </div> </div> <p><br class="example-break" /> </p> </div> <div class="refsect1"> <a id="idm281472921145656"></a> <h2>See Also</h2> <p> <a class="link" href="vectorial.html" title="Vectorial Opcodes"><em class="citetitle"></em>Vectorial opcodes</a> </p> </div> <div class="refsect1"> <a id="idm281472921143608"></a> <h2>Credits</h2> <p> </p> <table border="0" summary="Simple list" class="simplelist"> <tr> <td>Author: John ffitch</td> </tr> <tr> <td>Codemist Ltd</td> </tr> <tr> <td>2013</td> </tr> </table> <p> </p> <p>New in version 6.00</p> <p>Extended to multi-dimensions in 6.04</p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="ksmps.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="OpcodesTop.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="lfo.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">ksmps </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> lfo</td> </tr> </table> </div> </body> </html>