File: Cell-Arrays-in-Oct_002dFiles.html

package info (click to toggle)
octave 10.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 659; xml: 192
file content (91 lines) | stat: -rw-r--r-- 3,531 bytes parent folder | download | duplicates (2)
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Cell Arrays in Oct-Files (GNU Octave (version 10.3.0))</title>

<meta name="description" content="Cell Arrays in Oct-Files (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Cell Arrays in Oct-Files (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Oct_002dFiles.html" rel="up" title="Oct-Files">
<link href="Structures-in-Oct_002dFiles.html" rel="next" title="Structures in Oct-Files">
<link href="Character-Strings-in-Oct_002dFiles.html" rel="prev" title="Character Strings in Oct-Files">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="subsection-level-extent" id="Cell-Arrays-in-Oct_002dFiles">
<div class="nav-panel">
<p>
Next: <a href="Structures-in-Oct_002dFiles.html" accesskey="n" rel="next">Structures in Oct-Files</a>, Previous: <a href="Character-Strings-in-Oct_002dFiles.html" accesskey="p" rel="prev">Character Strings in Oct-Files</a>, Up: <a href="Oct_002dFiles.html" accesskey="u" rel="up">Oct-Files</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="Cell-Arrays-in-Oct_002dFiles-1"><span>A.1.4 Cell Arrays in Oct-Files<a class="copiable-link" href="#Cell-Arrays-in-Oct_002dFiles-1"> &para;</a></span></h4>

<p>Octave&rsquo;s cell type is also available from within oct-files.  A cell array is
just an <code class="code">Array</code> of <code class="code">octave_value</code>s, and thus each element of the cell
array can be treated like any other <code class="code">octave_value</code>.  A simple example is
</p>
<div class="example">
<pre class="verbatim">#include &lt;octave/oct.h&gt;
#include &lt;octave/Cell.h&gt;

DEFUN_DLD (celldemo, args, , &quot;Cell Demo&quot;)
{
  if (args.length () != 1)
    print_usage ();

  Cell c = args(0).cell_value ();

  octave_value_list retval;
  retval.resize (c.numel ());    // faster code by pre-declaring size

  for (octave_idx_type i = 0; i &lt; c.numel (); i++)
    {
      retval(i) = c(i);          // using operator syntax
      //retval(i) = c.elem (i);  // using method syntax
    }

  return retval;
}
</pre></div>

<p>Note that cell arrays are used less often in standard oct-files and so the
<samp class="file">Cell.h</samp> header file must be explicitly included.  The rest of the example
extracts the <code class="code">octave_value</code>s one by one from the cell array and returns
them as individual output arguments.  For example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">[b1, b2, b3] = celldemo ({1, [1, 2], &quot;test&quot;})
&rArr;
b1 =  1
b2 =

   1   2

b3 = test
</pre></div></div>

</div>



</body>
</html>