File: Cell-Arrays-with-Mex_002dFiles.html

package info (click to toggle)
octave 6.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 124,192 kB
  • sloc: cpp: 322,665; ansic: 68,088; fortran: 20,980; objc: 8,121; sh: 7,719; yacc: 4,266; lex: 4,123; perl: 1,530; java: 1,366; awk: 1,257; makefile: 424; xml: 147
file content (108 lines) | stat: -rw-r--r-- 4,040 bytes parent folder | download
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Cell Arrays with Mex-Files (GNU Octave (version 6.2.0))</title>

<meta name="description" content="Cell Arrays with Mex-Files (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Cell Arrays with Mex-Files (GNU Octave (version 6.2.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<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="Mex_002dFiles.html" rel="up" title="Mex-Files">
<link href="Structures-with-Mex_002dFiles.html" rel="next" title="Structures with Mex-Files">
<link href="Character-Strings-in-Mex_002dFiles.html" rel="prev" title="Character Strings in Mex-Files">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<span id="Cell-Arrays-with-Mex_002dFiles"></span><div class="header">
<p>
Next: <a href="Structures-with-Mex_002dFiles.html" accesskey="n" rel="next">Structures with Mex-Files</a>, Previous: <a href="Character-Strings-in-Mex_002dFiles.html" accesskey="p" rel="prev">Character Strings in Mex-Files</a>, Up: <a href="Mex_002dFiles.html" accesskey="u" rel="up">Mex-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>
<span id="Cell-Arrays-with-Mex_002dFiles-1"></span><h4 class="subsection">A.2.4 Cell Arrays with Mex-Files</h4>

<p>One can perform exactly the same operations on Cell arrays in mex-files as in
oct-files.  An example that duplicates the function of the <samp>celldemo.cc</samp>
oct-file in a mex-file is given by <samp>mycell.c</samp> as shown below.
</p>
<div class="example">
<pre class="verbatim">#include &quot;mex.h&quot;

void
mexFunction (int nlhs, mxArray *plhs[],
             int nrhs, const mxArray *prhs[])
{
  mwSize n;
  mwIndex i;

  if (nrhs != 1 || ! mxIsCell (prhs[0]))
    mexErrMsgTxt (&quot;ARG1 must be a cell&quot;);

  n = mxGetNumberOfElements (prhs[0]);
  n = (n &gt; nlhs ? nlhs : n);

  for (i = 0; i &lt; n; i++)
    plhs[i] = mxDuplicateArray (mxGetCell (prhs[0], i));
}
</pre></div>

<p>The output is identical to the oct-file version as well.
</p>
<div class="example">
<pre class="example">[b1, b2, b3] = mycell ({1, [1, 2], &quot;test&quot;})
&rArr;
b1 =  1
b2 =

   1   2

b3 = test
</pre></div>

<p>Note in the example the use of the <code>mxDuplicateArray</code> function.  This is
needed as the <code>mxArray</code> pointer returned by <code>mxGetCell</code> might be
deallocated.  The inverse function to <code>mxGetCell</code>, used for setting Cell
values, is <code>mxSetCell</code> and is defined as
</p>
<div class="example">
<pre class="example">void mxSetCell (mxArray *ptr, int idx, mxArray *val);
</pre></div>

<p>Finally, to create a cell array or matrix, the appropriate functions are
</p>
<div class="example">
<pre class="example">mxArray *mxCreateCellArray (int ndims, const int *dims);
mxArray *mxCreateCellMatrix (int m, int n);
</pre></div>




</body>
</html>