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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: Working with Matrices and Arrays in Mex-Files</title>
<meta name="description" content="GNU Octave: Working with Matrices and Arrays in Mex-Files">
<meta name="keywords" content="GNU Octave: Working with Matrices and Arrays in Mex-Files">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Mex_002dFiles.html#Mex_002dFiles" rel="up" title="Mex-Files">
<link href="Character-Strings-in-Mex_002dFiles.html#Character-Strings-in-Mex_002dFiles" rel="next" title="Character Strings in Mex-Files">
<link href="Getting-Started-with-Mex_002dFiles.html#Getting-Started-with-Mex_002dFiles" rel="prev" title="Getting Started with Mex-Files">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Working-with-Matrices-and-Arrays-in-Mex_002dFiles"></a>
<div class="header">
<p>
Next: <a href="Character-Strings-in-Mex_002dFiles.html#Character-Strings-in-Mex_002dFiles" accesskey="n" rel="next">Character Strings in Mex-Files</a>, Previous: <a href="Getting-Started-with-Mex_002dFiles.html#Getting-Started-with-Mex_002dFiles" accesskey="p" rel="prev">Getting Started with Mex-Files</a>, Up: <a href="Mex_002dFiles.html#Mex_002dFiles" accesskey="u" rel="up">Mex-Files</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Working-with-Matrices-and-Arrays-in-Mex_002dFiles-1"></a>
<h4 class="subsection">A.2.2 Working with Matrices and Arrays in Mex-Files</h4>
<p>The basic mex type of all variables is <code>mxArray</code>. Any object,
such as a matrix, cell array, or structure is stored in this basic
type. As such, <code>mxArray</code> serves basically the same purpose as the
octave_value class in oct-files in that it acts as a container for the
more specialized types.
</p>
<p>The <code>mxArray</code> structure contains at a minimum, the name of the
variable it represents, its dimensions, its type, and whether the variable is
real or complex. It can also contain a number of additional fields
depending on the type of the <code>mxArray</code>. There are a number of
functions to create <code>mxArray</code> structures, including
<code>mxCreateDoubleMatrix</code>, <code>mxCreateCellArray</code>, <code>mxCreateSparse</code>,
and the generic <code>mxCreateNumericArray</code>.
</p>
<p>The basic function to access the data contained in an array is
<code>mxGetPr</code>. As the mex interface assumes that real and imaginary
parts of a complex array are stored separately, there is an equivalent
function <code>mxGetPi</code> that gets the imaginary part. Both of these
functions are only for use with double precision matrices. The generic
functions <code>mxGetData</code> and <code>mxGetImagData</code> perform the same operation
on all matrix types. For example:
</p>
<div class="example">
<pre class="example">mxArray *m;
mwSize *dims;
UINT32_T *pr;
dims = (mwSize *) mxMalloc (2 * sizeof (mwSize));
dims[0] = 2; dims[1] = 2;
m = mxCreateNumericArray (2, dims, mxUINT32_CLASS, mxREAL);
pr = (UINT32_T *) mxGetData (m);
</pre></div>
<p>There are also the functions <code>mxSetPr</code>, etc., that perform the
inverse, and set the data of an array to use the block of memory pointed
to by the argument of <code>mxSetPr</code>.
</p>
<p>Note the type <code>mwSize</code> used above, and also <code>mwIndex</code>, are defined
as the native precision of the indexing in Octave on the platform on
which the mex-file is built. This allows both 32- and 64-bit platforms
to support mex-files. <code>mwSize</code> is used to define array dimensions
and the maximum number or elements, while <code>mwIndex</code> is used to define
indexing into arrays.
</p>
<p>An example that demonstrates how to work with arbitrary real or complex
double precision arrays is given by the file <samp>mypow2.c</samp> shown below.
</p>
<div class="example">
<pre class="verbatim">#include "mex.h"
void
mexFunction (int nlhs, mxArray* plhs[],
int nrhs, const mxArray* prhs[])
{
mwSize n;
mwIndex i;
double *vri, *vro;
if (nrhs != 1 || ! mxIsNumeric (prhs[0]))
mexErrMsgTxt ("ARG1 must be a matrix");
n = mxGetNumberOfElements (prhs[0]);
plhs[0] = mxCreateNumericArray (mxGetNumberOfDimensions (prhs[0]),
mxGetDimensions (prhs[0]),
mxGetClassID (prhs[0]),
mxIsComplex (prhs[0]));
vri = mxGetPr (prhs[0]);
vro = mxGetPr (plhs[0]);
if (mxIsComplex (prhs[0]))
{
double *vii, *vio;
vii = mxGetPi (prhs[0]);
vio = mxGetPi (plhs[0]);
for (i = 0; i < n; i++)
{
vro[i] = vri[i] * vri[i] - vii[i] * vii[i];
vio[i] = 2 * vri[i] * vii[i];
}
}
else
{
for (i = 0; i < n; i++)
vro[i] = vri[i] * vri[i];
}
}
</pre><pre class="example">
</pre></div>
<p>with an example of its use
</p>
<div class="example">
<pre class="example">b = randn (4,1) + 1i * randn (4,1);
all (b.^2 == mypow2 (b))
⇒ 1
</pre></div>
<p>The example above uses the functions <code>mxGetDimensions</code>,
<code>mxGetNumberOfElements</code>, and <code>mxGetNumberOfDimensions</code> to work
with the dimensions of multi-dimensional arrays. The functions
<code>mxGetM</code>, and <code>mxGetN</code> are also available to find the number
of rows and columns in a 2-D matrix.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Character-Strings-in-Mex_002dFiles.html#Character-Strings-in-Mex_002dFiles" accesskey="n" rel="next">Character Strings in Mex-Files</a>, Previous: <a href="Getting-Started-with-Mex_002dFiles.html#Getting-Started-with-Mex_002dFiles" accesskey="p" rel="prev">Getting Started with Mex-Files</a>, Up: <a href="Mex_002dFiles.html#Mex_002dFiles" accesskey="u" rel="up">Mex-Files</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
