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