|
5864
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 2006 Paul Kienzle |
|
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
|
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
|
|
20 02110-1301, USA. |
|
|
21 |
|
|
22 */ |
|
|
23 |
|
|
24 /* |
|
|
25 |
|
|
26 This code was originally distributed as part of Octave Forge under |
|
6064
|
27 the following terms: |
|
5864
|
28 |
|
|
29 Author: Paul Kienzle |
|
|
30 I grant this code to the public domain. |
|
|
31 2001-03-22 |
|
|
32 |
|
|
33 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
|
|
34 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
|
35 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
|
36 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
|
|
37 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
|
38 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
|
|
39 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
|
|
40 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
|
41 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
|
|
42 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
|
|
43 SUCH DAMAGE. |
|
|
44 |
|
|
45 */ |
|
|
46 |
|
|
47 /* mex.h is for use in C-programs only; do NOT include it in mex.cc */ |
|
|
48 |
|
|
49 #if ! defined (MEXPROTO_H) |
|
|
50 #define MEXPROTO_H |
|
|
51 |
|
|
52 #if defined (__cplusplus) |
|
5900
|
53 #include <cstdlib> |
|
5864
|
54 extern "C" { |
|
5900
|
55 #else |
|
|
56 #include <stdlib.h> |
|
5864
|
57 #endif |
|
|
58 |
|
6121
|
59 #include "oct-dlldefs.h" |
|
|
60 |
|
5900
|
61 #define MXARRAY_TYPEDEFS_ONLY |
|
|
62 #include "mxarray.h" |
|
|
63 #undef MXARRAY_TYPEDEFS_ONLY |
|
|
64 |
|
|
65 // Interface to the interpreter. |
|
6109
|
66 extern OCTINTERP_API const char *mexFunctionName (void); |
|
5864
|
67 |
|
6109
|
68 extern OCTINTERP_API int mexCallMATLAB (int nargout, mxArray *argout[], int nargin, |
|
5864
|
69 mxArray *argin[], const char *fname); |
|
|
70 |
|
6109
|
71 extern OCTINTERP_API void mexSetTrapFlag (int flag); |
|
|
72 extern OCTINTERP_API int mexEvalString (const char *s); |
|
|
73 extern OCTINTERP_API void mexErrMsgTxt (const char *s); |
|
6338
|
74 extern OCTINTERP_API void mexErrMsgIdAndTxt (const char *id, const char *s, ...); |
|
6109
|
75 extern OCTINTERP_API void mexWarnMsgTxt (const char *s); |
|
6338
|
76 extern OCTINTERP_API void mexWarnMsgIdAndTxt (const char *id, const char *s, ...); |
|
6109
|
77 extern OCTINTERP_API void mexPrintf (const char *fmt, ...); |
|
5864
|
78 |
|
6109
|
79 extern OCTINTERP_API mxArray *mexGetVariable (const char *space, const char *name); |
|
|
80 extern OCTINTERP_API const mxArray *mexGetVariablePtr (const char *space, const char *name); |
|
5864
|
81 |
|
6109
|
82 extern OCTINTERP_API int mexPutVariable (const char *space, const char *name, mxArray *ptr); |
|
5864
|
83 |
|
6109
|
84 extern OCTINTERP_API void mexMakeArrayPersistent (mxArray *ptr); |
|
|
85 extern OCTINTERP_API void mexMakeMemoryPersistent (void *ptr); |
|
5879
|
86 |
|
6109
|
87 extern OCTINTERP_API int mexAtExit (void (*f) (void)); |
|
|
88 extern OCTINTERP_API const mxArray *mexGet (double handle, const char *property); |
|
|
89 extern OCTINTERP_API int mexIsGlobal (const mxArray *ptr); |
|
|
90 extern OCTINTERP_API int mexIsLocked (void); |
|
|
91 extern OCTINTERP_API void mexLock (void); |
|
|
92 extern OCTINTERP_API int mexSet (double handle, const char *property, mxArray *val); |
|
|
93 extern OCTINTERP_API void mexUnlock (void); |
|
5900
|
94 |
|
|
95 // Floating point predicates. |
|
6109
|
96 extern OCTINTERP_API int mxIsFinite (double v); |
|
|
97 extern OCTINTERP_API int mxIsInf (double v); |
|
|
98 extern OCTINTERP_API int mxIsNaN (double v); |
|
5900
|
99 |
|
|
100 // Floating point values. |
|
6109
|
101 extern OCTINTERP_API double mxGetEps (void); |
|
|
102 extern OCTINTERP_API double mxGetInf (void); |
|
|
103 extern OCTINTERP_API double mxGetNaN (void); |
|
5900
|
104 |
|
|
105 // Memory management. |
|
6109
|
106 extern OCTINTERP_API void *mxCalloc (size_t n, size_t size); |
|
|
107 extern OCTINTERP_API void *mxMalloc (size_t n); |
|
|
108 extern OCTINTERP_API void *mxRealloc (void *ptr, size_t size); |
|
|
109 extern OCTINTERP_API void mxFree (void *ptr); |
|
5900
|
110 |
|
|
111 // Constructors. |
|
6109
|
112 extern OCTINTERP_API mxArray *mxCreateCellArray (int ndims, const int *dims); |
|
|
113 extern OCTINTERP_API mxArray *mxCreateCellMatrix (int m, int n); |
|
|
114 extern OCTINTERP_API mxArray *mxCreateCharArray (int ndims, const int *dims); |
|
|
115 extern OCTINTERP_API mxArray *mxCreateCharMatrixFromStrings (int m, const char **str); |
|
|
116 extern OCTINTERP_API mxArray *mxCreateDoubleMatrix (int nr, int nc, mxComplexity flag); |
|
|
117 extern OCTINTERP_API mxArray *mxCreateDoubleScalar (double val); |
|
|
118 extern OCTINTERP_API mxArray *mxCreateLogicalArray (int ndims, const int *dims); |
|
|
119 extern OCTINTERP_API mxArray *mxCreateLogicalMatrix (int m, int n); |
|
|
120 extern OCTINTERP_API mxArray *mxCreateLogicalScalar (int val); |
|
|
121 extern OCTINTERP_API mxArray *mxCreateNumericArray (int ndims, const int *dims, mxClassID class_id, mxComplexity flag); |
|
|
122 extern OCTINTERP_API mxArray *mxCreateNumericMatrix (int m, int n, mxClassID class_id, mxComplexity flag); |
|
|
123 extern OCTINTERP_API mxArray *mxCreateSparse (int m, int n, int nzmax, mxComplexity flag); |
|
|
124 extern OCTINTERP_API mxArray *mxCreateSparseLogicalMatrix (int m, int n, int nzmax); |
|
|
125 extern OCTINTERP_API mxArray *mxCreateString (const char *str); |
|
|
126 extern OCTINTERP_API mxArray *mxCreateStructArray (int ndims, int *dims, int num_keys, const char **keys); |
|
|
127 extern OCTINTERP_API mxArray *mxCreateStructMatrix (int rows, int cols, int num_keys, const char **keys); |
|
5900
|
128 |
|
|
129 // Copy constructor. |
|
6109
|
130 extern OCTINTERP_API mxArray *mxDuplicateArray (const mxArray *v); |
|
5900
|
131 |
|
|
132 // Destructor. |
|
6109
|
133 extern OCTINTERP_API void mxDestroyArray (mxArray *v); |
|
5900
|
134 |
|
|
135 // Type Predicates. |
|
6109
|
136 extern OCTINTERP_API int mxIsCell (const mxArray *ptr); |
|
|
137 extern OCTINTERP_API int mxIsChar (const mxArray *ptr); |
|
|
138 extern OCTINTERP_API int mxIsClass (const mxArray *ptr, const char *name); |
|
|
139 extern OCTINTERP_API int mxIsComplex (const mxArray *ptr); |
|
|
140 extern OCTINTERP_API int mxIsDouble (const mxArray *ptr); |
|
|
141 extern OCTINTERP_API int mxIsInt16 (const mxArray *ptr); |
|
|
142 extern OCTINTERP_API int mxIsInt32 (const mxArray *ptr); |
|
|
143 extern OCTINTERP_API int mxIsInt64 (const mxArray *ptr); |
|
|
144 extern OCTINTERP_API int mxIsInt8 (const mxArray *ptr); |
|
|
145 extern OCTINTERP_API int mxIsLogical (const mxArray *ptr); |
|
|
146 extern OCTINTERP_API int mxIsNumeric (const mxArray *ptr); |
|
|
147 extern OCTINTERP_API int mxIsSingle (const mxArray *ptr); |
|
|
148 extern OCTINTERP_API int mxIsSparse (const mxArray *ptr); |
|
|
149 extern OCTINTERP_API int mxIsStruct (const mxArray *ptr); |
|
|
150 extern OCTINTERP_API int mxIsUint16 (const mxArray *ptr); |
|
|
151 extern OCTINTERP_API int mxIsUint32 (const mxArray *ptr); |
|
|
152 extern OCTINTERP_API int mxIsUint64 (const mxArray *ptr); |
|
|
153 extern OCTINTERP_API int mxIsUint8 (const mxArray *ptr); |
|
5900
|
154 |
|
|
155 // Odd type+size predicate. |
|
6109
|
156 extern OCTINTERP_API int mxIsLogicalScalar (const mxArray *ptr); |
|
5900
|
157 |
|
|
158 // Odd type+size+value predicate. |
|
6109
|
159 extern OCTINTERP_API int mxIsLogicalScalarTrue (const mxArray *ptr); |
|
5900
|
160 |
|
|
161 // Size predicate. |
|
6109
|
162 extern OCTINTERP_API int mxIsEmpty (const mxArray *ptr); |
|
5900
|
163 |
|
|
164 // Just plain odd thing to ask of a value. |
|
6109
|
165 extern OCTINTERP_API int mxIsFromGlobalWS (const mxArray *ptr); |
|
5900
|
166 |
|
|
167 // Dimension extractors. |
|
6109
|
168 extern OCTINTERP_API int mxGetM (const mxArray *ptr); |
|
|
169 extern OCTINTERP_API int mxGetN (const mxArray *ptr); |
|
|
170 extern OCTINTERP_API int *mxGetDimensions (const mxArray *ptr); |
|
|
171 extern OCTINTERP_API int mxGetNumberOfDimensions (const mxArray *ptr); |
|
|
172 extern OCTINTERP_API int mxGetNumberOfElements (const mxArray *ptr); |
|
5900
|
173 |
|
|
174 // Dimension setters. |
|
6109
|
175 extern OCTINTERP_API void mxSetM (mxArray *ptr, int M); |
|
|
176 extern OCTINTERP_API void mxSetN (mxArray *ptr, int N); |
|
|
177 extern OCTINTERP_API void mxSetDimensions (mxArray *ptr, int *dims, int ndims); |
|
5900
|
178 |
|
|
179 // Data extractors. |
|
6109
|
180 extern OCTINTERP_API double *mxGetPi (const mxArray *ptr); |
|
|
181 extern OCTINTERP_API double *mxGetPr (const mxArray *ptr); |
|
|
182 extern OCTINTERP_API double mxGetScalar (const mxArray *ptr); |
|
|
183 extern OCTINTERP_API mxChar *mxGetChars (const mxArray *ptr); |
|
|
184 extern OCTINTERP_API mxLogical *mxGetLogicals (const mxArray *ptr); |
|
|
185 extern OCTINTERP_API void *mxGetData (const mxArray *ptr); |
|
|
186 extern OCTINTERP_API void *mxGetImagData (const mxArray *ptr); |
|
5900
|
187 |
|
|
188 // Data setters. |
|
6109
|
189 extern OCTINTERP_API void mxSetPr (mxArray *ptr, double *pr); |
|
|
190 extern OCTINTERP_API void mxSetPi (mxArray *ptr, double *pi); |
|
|
191 extern OCTINTERP_API void mxSetData (mxArray *ptr, void *data); |
|
|
192 extern OCTINTERP_API void mxSetImagData (mxArray *ptr, void *pi); |
|
5900
|
193 |
|
|
194 // Classes. |
|
6109
|
195 extern OCTINTERP_API mxClassID mxGetClassID (const mxArray *ptr); |
|
|
196 extern OCTINTERP_API const char *mxGetClassName (const mxArray *ptr); |
|
5900
|
197 |
|
6109
|
198 extern OCTINTERP_API void mxSetClassName (mxArray *ptr, const char *name); |
|
5900
|
199 |
|
|
200 // Cell support. |
|
6109
|
201 extern OCTINTERP_API mxArray *mxGetCell (const mxArray *ptr, int idx); |
|
5900
|
202 |
|
6109
|
203 extern OCTINTERP_API void mxSetCell (mxArray *ptr, int idx, mxArray *val); |
|
5900
|
204 |
|
|
205 // Sparse support. |
|
6109
|
206 extern OCTINTERP_API int *mxGetIr (const mxArray *ptr); |
|
|
207 extern OCTINTERP_API int *mxGetJc (const mxArray *ptr); |
|
|
208 extern OCTINTERP_API int mxGetNzmax (const mxArray *ptr); |
|
5900
|
209 |
|
6109
|
210 extern OCTINTERP_API void mxSetIr (mxArray *ptr, int *ir); |
|
|
211 extern OCTINTERP_API void mxSetJc (mxArray *ptr, int *jc); |
|
|
212 extern OCTINTERP_API void mxSetNzmax (mxArray *ptr, int nzmax); |
|
5900
|
213 |
|
|
214 // Structure support. |
|
6109
|
215 extern OCTINTERP_API int mxAddField (mxArray *ptr, const char *key); |
|
5900
|
216 |
|
6109
|
217 extern OCTINTERP_API void mxRemoveField (mxArray *ptr, int key_num); |
|
5900
|
218 |
|
6109
|
219 extern OCTINTERP_API mxArray *mxGetField (const mxArray *ptr, int index, const char *key); |
|
|
220 extern OCTINTERP_API mxArray *mxGetFieldByNumber (const mxArray *ptr, int index, int key_num); |
|
5900
|
221 |
|
6109
|
222 extern OCTINTERP_API void mxSetField (mxArray *ptr, int index, const char *key, mxArray *val); |
|
|
223 extern OCTINTERP_API void mxSetFieldByNumber (mxArray *ptr, int index, int key_num, mxArray *val); |
|
5900
|
224 |
|
6109
|
225 extern OCTINTERP_API int mxGetNumberOfFields (const mxArray *ptr); |
|
5900
|
226 |
|
6109
|
227 extern OCTINTERP_API const char *mxGetFieldNameByNumber (const mxArray *ptr, int key_num); |
|
|
228 extern OCTINTERP_API int mxGetFieldNumber (const mxArray *ptr, const char *key); |
|
5900
|
229 |
|
6109
|
230 extern OCTINTERP_API int mxGetString (const mxArray *ptr, char *buf, int buflen); |
|
|
231 extern OCTINTERP_API char *mxArrayToString (const mxArray *ptr); |
|
5900
|
232 |
|
|
233 // Miscellaneous. |
|
|
234 #ifdef NDEBUG |
|
|
235 #define mxAssert(expr, msg) \ |
|
|
236 do \ |
|
|
237 { \ |
|
|
238 if (! expr) \ |
|
|
239 { \ |
|
|
240 mexPrintf ("Assertion failed: %s, at line %d of file \"%s\".\n%s\n", \ |
|
|
241 #expr, __LINE__, __FILE__, msg); \ |
|
|
242 } \ |
|
|
243 } \ |
|
|
244 while (0) |
|
|
245 |
|
|
246 #define mxAssertS(expr, msg) \ |
|
|
247 do \ |
|
|
248 { \ |
|
|
249 if (! expr) \ |
|
|
250 { \ |
|
|
251 mexPrintf ("Assertion failed at line %d of file \"%s\".\n%s\n", \ |
|
|
252 __LINE__, __FILE__, msg); \ |
|
|
253 abort (); \ |
|
|
254 } \ |
|
|
255 } \ |
|
|
256 while (0) |
|
|
257 #else |
|
|
258 #define mxAssert(expr, msg) |
|
|
259 #define mxAssertS(expr, msg) |
|
5879
|
260 #endif |
|
|
261 |
|
6109
|
262 extern OCTINTERP_API int mxCalcSingleSubscript (const mxArray *ptr, int nsubs, int *subs); |
|
5900
|
263 |
|
6109
|
264 extern OCTINTERP_API int mxGetElementSize (const mxArray *ptr); |
|
5900
|
265 |
|
5864
|
266 #if defined (__cplusplus) |
|
|
267 } |
|
|
268 #endif |
|
|
269 |
|
|
270 #endif |
|
|
271 |
|
|
272 /* |
|
|
273 ;;; Local Variables: *** |
|
|
274 ;;; mode: C *** |
|
|
275 ;;; End: *** |
|
|
276 */ |
