Mercurial > octave
annotate libinterp/corefcn/mexproto.h @ 22462:6cb7813e5b2f
Add new mxIsScalar function for MEX API.
* NEWS: Announce new function.
* mex.cc (mxArray_octave_value::is_scalar): New function.
* mex.cc (mxArray_matlab::is_scalar): New function.
* mex.cc (mxIsScalar): New API function which calls internal is_scalar.
* mexproto.h (mxIsScalar): Add new function prototype. Organize list of
prototypes to be clearer.
* mxarray.in.h (mxArray_base::is_scalar): Declare virtual function.
* mxarray.in.h (mxArray::is_scalar): Declare function which calls the is_scalar
member function based on the object type (octave_value or matlab).
author | Rik <rik@octave.org> |
---|---|
date | Sat, 10 Sep 2016 07:40:52 -0700 |
parents | 6af82fc041a4 |
children | 1d2960b5efe6 |
rev | line source |
---|---|
5864 | 1 /* |
2 | |
22323
bac0d6f07a3e
maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents:
22197
diff
changeset
|
3 Copyright (C) 2006-2016 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 | |
21241
bae38398f5f1
use consistent style for all liboctave and libinterp include guards
John W. Eaton <jwe@octave.org>
parents:
21200
diff
changeset
|
48 #if ! defined (octave_mexproto_h) |
bae38398f5f1
use consistent style for all liboctave and libinterp include guards
John W. Eaton <jwe@octave.org>
parents:
21200
diff
changeset
|
49 #define octave_mexproto_h 1 |
5864 | 50 |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21241
diff
changeset
|
51 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21241
diff
changeset
|
52 |
5864 | 53 #if defined (__cplusplus) |
21200
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
54 # include <cstdlib> |
5864 | 55 extern "C" { |
5900 | 56 #else |
21200
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
57 # include <stdlib.h> |
5864 | 58 #endif |
59 | |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
60 /* The definition of OCTINTERP_API is normally provided by Octave's |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
61 config.h file. This is provided for the case of mex.h included by |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
62 user programs that don't use Octave's config.h. */ |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
63 #if ! defined (OCTINTERP_API) |
21200
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
64 # if defined (_MSC_VER) |
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
65 # define OCTINTERP_API __declspec(dllimport) |
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
66 # else |
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
67 /* All other compilers, at least for now. */ |
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
68 # define OCTINTERP_API |
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
69 # endif |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
70 #endif |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
71 |
5900 | 72 #define MXARRAY_TYPEDEFS_ONLY |
73 #include "mxarray.h" | |
74 #undef MXARRAY_TYPEDEFS_ONLY | |
75 | |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
76 /* Interface to the interpreter. */ |
6109 | 77 extern OCTINTERP_API const char *mexFunctionName (void); |
5864 | 78 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
79 extern OCTINTERP_API int mexCallMATLAB (int nargout, mxArray *argout[], |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
80 int nargin, mxArray *argin[], |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
81 const char *fname); |
22451
ad5439817753
Add mexCallMATLABWithTrap to MEX API (bug #48949).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
82 extern OCTINTERP_API mxArray * mexCallMATLABWithTrap (int nargout, |
ad5439817753
Add mexCallMATLABWithTrap to MEX API (bug #48949).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
83 mxArray *argout[], |
ad5439817753
Add mexCallMATLABWithTrap to MEX API (bug #48949).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
84 int nargin, |
ad5439817753
Add mexCallMATLABWithTrap to MEX API (bug #48949).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
85 mxArray *argin[], |
ad5439817753
Add mexCallMATLABWithTrap to MEX API (bug #48949).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
86 const char *fname); |
ad5439817753
Add mexCallMATLABWithTrap to MEX API (bug #48949).
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
87 |
6109 | 88 extern OCTINTERP_API int mexEvalString (const char *s); |
22454
8445f67a8123
Add function mexEvalStringWithTrap to MEX API.
Rik <rik@octave.org>
parents:
22451
diff
changeset
|
89 extern OCTINTERP_API mxArray * mexEvalStringWithTrap (const char *s); |
22462
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
90 |
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
91 extern OCTINTERP_API void mexSetTrapFlag (int flag); |
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
92 |
6109 | 93 extern OCTINTERP_API void mexErrMsgTxt (const char *s); |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
94 extern OCTINTERP_API void mexErrMsgIdAndTxt (const char *id, const char *s, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
95 ...); |
6109 | 96 extern OCTINTERP_API void mexWarnMsgTxt (const char *s); |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
97 extern OCTINTERP_API void mexWarnMsgIdAndTxt (const char *id, const char *s, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
98 ...); |
10127
f21fdff5c906
Change signature of mexPrintf.
David Grundberg <davidg@cs.umu.se>
parents:
10126
diff
changeset
|
99 extern OCTINTERP_API int mexPrintf (const char *fmt, ...); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
100 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
101 extern OCTINTERP_API mxArray *mexGetVariable (const char *space, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
102 const char *name); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
103 extern OCTINTERP_API const mxArray *mexGetVariablePtr (const char *space, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
104 const char *name); |
5864 | 105 |
15352
9a8dbd6b6b20
* mysparse.c (mexFunction): Declare pbr and pbr2 as mxLogical*, not bool*.
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
106 extern OCTINTERP_API int mexPutVariable (const char *space, const char *name, |
9a8dbd6b6b20
* mysparse.c (mexFunction): Declare pbr and pbr2 as mxLogical*, not bool*.
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
107 const mxArray *ptr); |
5864 | 108 |
22462
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
109 extern OCTINTERP_API const mxArray *mexGet (double handle, |
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
110 const char *property); |
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
111 extern OCTINTERP_API int mexSet (double handle, const char *property, |
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
112 mxArray *val); |
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
113 |
6109 | 114 extern OCTINTERP_API void mexMakeArrayPersistent (mxArray *ptr); |
115 extern OCTINTERP_API void mexMakeMemoryPersistent (void *ptr); | |
5879 | 116 |
22462
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
117 extern OCTINTERP_API void mexLock (void); |
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
118 extern OCTINTERP_API void mexUnlock (void); |
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
119 |
6109 | 120 extern OCTINTERP_API int mexIsGlobal (const mxArray *ptr); |
121 extern OCTINTERP_API int mexIsLocked (void); | |
22462
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
122 |
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
123 extern OCTINTERP_API int mexAtExit (void (*f) (void)); |
5900 | 124 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
125 /* Floating point predicates. */ |
6109 | 126 extern OCTINTERP_API int mxIsFinite (double v); |
127 extern OCTINTERP_API int mxIsInf (double v); | |
128 extern OCTINTERP_API int mxIsNaN (double v); | |
5900 | 129 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
130 /* Floating point values. */ |
6109 | 131 extern OCTINTERP_API double mxGetEps (void); |
132 extern OCTINTERP_API double mxGetInf (void); | |
133 extern OCTINTERP_API double mxGetNaN (void); | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
134 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
135 /* Memory management. */ |
6109 | 136 extern OCTINTERP_API void *mxCalloc (size_t n, size_t size); |
137 extern OCTINTERP_API void *mxMalloc (size_t n); | |
138 extern OCTINTERP_API void *mxRealloc (void *ptr, size_t size); | |
139 extern OCTINTERP_API void mxFree (void *ptr); | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
140 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
141 /* Constructors. */ |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
142 extern OCTINTERP_API mxArray *mxCreateCellArray (mwSize ndims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
143 const mwSize *dims); |
6686 | 144 extern OCTINTERP_API mxArray *mxCreateCellMatrix (mwSize m, mwSize n); |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
145 extern OCTINTERP_API mxArray *mxCreateCharArray (mwSize ndims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
146 const mwSize *dims); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
147 extern OCTINTERP_API mxArray *mxCreateCharMatrixFromStrings (mwSize m, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
148 const char **str); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
149 extern OCTINTERP_API mxArray *mxCreateDoubleMatrix (mwSize nr, mwSize nc, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
150 mxComplexity flag); |
6109 | 151 extern OCTINTERP_API mxArray *mxCreateDoubleScalar (double val); |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
152 extern OCTINTERP_API mxArray *mxCreateLogicalArray (mwSize ndims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
153 const mwSize *dims); |
6686 | 154 extern OCTINTERP_API mxArray *mxCreateLogicalMatrix (mwSize m, mwSize n); |
7879
a017ca5a2f75
mexproto.h: fix mxCreateLogicalScalar decl
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
155 extern OCTINTERP_API mxArray *mxCreateLogicalScalar (mxLogical val); |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
156 extern OCTINTERP_API mxArray *mxCreateNumericArray (mwSize ndims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
157 const mwSize *dims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
158 mxClassID class_id, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
159 mxComplexity flag); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
160 extern OCTINTERP_API mxArray *mxCreateNumericMatrix (mwSize m, mwSize n, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
161 mxClassID class_id, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
162 mxComplexity flag); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
163 extern OCTINTERP_API mxArray *mxCreateSparse (mwSize m, mwSize n, mwSize nzmax, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
164 mxComplexity flag); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
165 extern OCTINTERP_API mxArray *mxCreateSparseLogicalMatrix (mwSize m, mwSize n, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
166 mwSize nzmax); |
6109 | 167 extern OCTINTERP_API mxArray *mxCreateString (const char *str); |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
168 extern OCTINTERP_API mxArray *mxCreateStructArray (mwSize ndims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
169 const mwSize *dims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
170 int num_keys, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
171 const char **keys); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
172 extern OCTINTERP_API mxArray *mxCreateStructMatrix (mwSize rows, mwSize cols, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
173 int num_keys, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
174 const char **keys); |
5900 | 175 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
176 /* Copy constructor. */ |
6109 | 177 extern OCTINTERP_API mxArray *mxDuplicateArray (const mxArray *v); |
5900 | 178 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
179 /* Destructor. */ |
6109 | 180 extern OCTINTERP_API void mxDestroyArray (mxArray *v); |
5900 | 181 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
182 /* Type Predicates. */ |
6109 | 183 extern OCTINTERP_API int mxIsCell (const mxArray *ptr); |
184 extern OCTINTERP_API int mxIsChar (const mxArray *ptr); | |
185 extern OCTINTERP_API int mxIsClass (const mxArray *ptr, const char *name); | |
186 extern OCTINTERP_API int mxIsComplex (const mxArray *ptr); | |
187 extern OCTINTERP_API int mxIsDouble (const mxArray *ptr); | |
11100
cdf940db26a0
provide mxIsFunctionHandle MEX interface function
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
188 extern OCTINTERP_API int mxIsFunctionHandle (const mxArray *ptr); |
6109 | 189 extern OCTINTERP_API int mxIsInt16 (const mxArray *ptr); |
190 extern OCTINTERP_API int mxIsInt32 (const mxArray *ptr); | |
191 extern OCTINTERP_API int mxIsInt64 (const mxArray *ptr); | |
192 extern OCTINTERP_API int mxIsInt8 (const mxArray *ptr); | |
193 extern OCTINTERP_API int mxIsLogical (const mxArray *ptr); | |
194 extern OCTINTERP_API int mxIsNumeric (const mxArray *ptr); | |
195 extern OCTINTERP_API int mxIsSingle (const mxArray *ptr); | |
196 extern OCTINTERP_API int mxIsSparse (const mxArray *ptr); | |
197 extern OCTINTERP_API int mxIsStruct (const mxArray *ptr); | |
198 extern OCTINTERP_API int mxIsUint16 (const mxArray *ptr); | |
199 extern OCTINTERP_API int mxIsUint32 (const mxArray *ptr); | |
200 extern OCTINTERP_API int mxIsUint64 (const mxArray *ptr); | |
201 extern OCTINTERP_API int mxIsUint8 (const mxArray *ptr); | |
5900 | 202 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
203 /* Odd type+size predicate. */ |
6109 | 204 extern OCTINTERP_API int mxIsLogicalScalar (const mxArray *ptr); |
5900 | 205 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
206 /* Odd type+size+value predicate. */ |
6109 | 207 extern OCTINTERP_API int mxIsLogicalScalarTrue (const mxArray *ptr); |
5900 | 208 |
22462
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
209 /* Size predicates. */ |
6109 | 210 extern OCTINTERP_API int mxIsEmpty (const mxArray *ptr); |
22462
6cb7813e5b2f
Add new mxIsScalar function for MEX API.
Rik <rik@octave.org>
parents:
22459
diff
changeset
|
211 extern OCTINTERP_API bool mxIsScalar (const mxArray *ptr); |
5900 | 212 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
213 /* Just plain odd thing to ask of a value. */ |
6109 | 214 extern OCTINTERP_API int mxIsFromGlobalWS (const mxArray *ptr); |
5900 | 215 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
216 /* Dimension extractors. */ |
6686 | 217 extern OCTINTERP_API size_t mxGetM (const mxArray *ptr); |
218 extern OCTINTERP_API size_t mxGetN (const mxArray *ptr); | |
219 extern OCTINTERP_API mwSize *mxGetDimensions (const mxArray *ptr); | |
220 extern OCTINTERP_API mwSize mxGetNumberOfDimensions (const mxArray *ptr); | |
221 extern OCTINTERP_API size_t mxGetNumberOfElements (const mxArray *ptr); | |
5900 | 222 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
223 /* Dimension setters. */ |
6686 | 224 extern OCTINTERP_API void mxSetM (mxArray *ptr, mwSize M); |
225 extern OCTINTERP_API void mxSetN (mxArray *ptr, mwSize N); | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
226 extern OCTINTERP_API void mxSetDimensions (mxArray *ptr, const mwSize *dims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
227 mwSize ndims); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
228 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
229 /* Data extractors. */ |
6109 | 230 extern OCTINTERP_API double *mxGetPi (const mxArray *ptr); |
231 extern OCTINTERP_API double *mxGetPr (const mxArray *ptr); | |
232 extern OCTINTERP_API double mxGetScalar (const mxArray *ptr); | |
233 extern OCTINTERP_API mxChar *mxGetChars (const mxArray *ptr); | |
234 extern OCTINTERP_API mxLogical *mxGetLogicals (const mxArray *ptr); | |
235 extern OCTINTERP_API void *mxGetData (const mxArray *ptr); | |
236 extern OCTINTERP_API void *mxGetImagData (const mxArray *ptr); | |
5900 | 237 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
238 /* Data setters. */ |
6109 | 239 extern OCTINTERP_API void mxSetPr (mxArray *ptr, double *pr); |
240 extern OCTINTERP_API void mxSetPi (mxArray *ptr, double *pi); | |
241 extern OCTINTERP_API void mxSetData (mxArray *ptr, void *data); | |
242 extern OCTINTERP_API void mxSetImagData (mxArray *ptr, void *pi); | |
5900 | 243 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
244 /* Classes. */ |
6109 | 245 extern OCTINTERP_API mxClassID mxGetClassID (const mxArray *ptr); |
246 extern OCTINTERP_API const char *mxGetClassName (const mxArray *ptr); | |
5900 | 247 |
6109 | 248 extern OCTINTERP_API void mxSetClassName (mxArray *ptr, const char *name); |
5900 | 249 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
250 /* Cell support. */ |
6686 | 251 extern OCTINTERP_API mxArray *mxGetCell (const mxArray *ptr, mwIndex idx); |
5900 | 252 |
6686 | 253 extern OCTINTERP_API void mxSetCell (mxArray *ptr, mwIndex idx, mxArray *val); |
5900 | 254 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
255 /* Sparse support. */ |
6686 | 256 extern OCTINTERP_API mwIndex *mxGetIr (const mxArray *ptr); |
257 extern OCTINTERP_API mwIndex *mxGetJc (const mxArray *ptr); | |
258 extern OCTINTERP_API mwSize mxGetNzmax (const mxArray *ptr); | |
5900 | 259 |
6686 | 260 extern OCTINTERP_API void mxSetIr (mxArray *ptr, mwIndex *ir); |
261 extern OCTINTERP_API void mxSetJc (mxArray *ptr, mwIndex *jc); | |
262 extern OCTINTERP_API void mxSetNzmax (mxArray *ptr, mwSize nzmax); | |
5900 | 263 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
264 /* Structure support. */ |
6109 | 265 extern OCTINTERP_API int mxAddField (mxArray *ptr, const char *key); |
5900 | 266 |
6109 | 267 extern OCTINTERP_API void mxRemoveField (mxArray *ptr, int key_num); |
5900 | 268 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
269 extern OCTINTERP_API mxArray *mxGetField (const mxArray *ptr, mwIndex index, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
270 const char *key); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
271 extern OCTINTERP_API mxArray *mxGetFieldByNumber (const mxArray *ptr, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
272 mwIndex index, int key_num); |
5900 | 273 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
274 extern OCTINTERP_API void mxSetField (mxArray *ptr, mwIndex index, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
275 const char *key, mxArray *val); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
276 extern OCTINTERP_API void mxSetFieldByNumber (mxArray *ptr, mwIndex index, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
277 int key_num, mxArray *val); |
5900 | 278 |
6109 | 279 extern OCTINTERP_API int mxGetNumberOfFields (const mxArray *ptr); |
5900 | 280 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
281 extern OCTINTERP_API const char *mxGetFieldNameByNumber (const mxArray *ptr, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
282 int key_num); |
6109 | 283 extern OCTINTERP_API int mxGetFieldNumber (const mxArray *ptr, const char *key); |
5900 | 284 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
285 extern OCTINTERP_API int mxGetString (const mxArray *ptr, char *buf, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
286 mwSize buflen); |
6109 | 287 extern OCTINTERP_API char *mxArrayToString (const mxArray *ptr); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
288 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
289 /* Miscellaneous. */ |
22459
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
290 extern OCTINTERP_API mwIndex |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
291 mxCalcSingleSubscript (const mxArray *ptr, mwSize nsubs, mwIndex *subs); |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
292 |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
293 extern OCTINTERP_API size_t mxGetElementSize (const mxArray *ptr); |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
294 |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
295 #if defined (MEX_DEBUG) |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
296 |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
297 # define mxAssert(expr, msg) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
298 do \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
299 { \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
300 if (! expr) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
301 { \ |
22459
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
302 if (msg != NULL && msg[0] != '\0') \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
303 mexErrMsgIdAndTxt ("Octave:MEX", \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
304 "Assertion failed: %s, at line %d of file \"%s\".\n%s\n", \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
305 #expr, __LINE__, __FILE__, msg); \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
306 else \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
307 mexErrMsgIdAndTxt ("Octave:MEX", \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
308 "Assertion failed: %s, at line %d of file \"%s\".\n", \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
309 #expr, __LINE__, __FILE__); \ |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
310 } \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
311 } \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
312 while (0) |
5900 | 313 |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
314 # define mxAssertS(expr, msg) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
315 do \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
316 { \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
317 if (! expr) \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
318 { \ |
22459
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
319 if (msg != NULL && msg[0] != '\0') \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
320 mexErrMsgIdAndTxt ("Octave:MEX", \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
321 "Assertion failed at line %d of file \"%s\".\n%s\n", \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
322 __LINE__, __FILE__, msg); \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
323 else \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
324 mexErrMsgIdAndTxt ("Octave:MEX", \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
325 "Assertion failed at line %d of file \"%s\".\n", \ |
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
326 __LINE__, __FILE__); \ |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
327 } \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
328 } \ |
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
329 while (0) |
22459
6af82fc041a4
Implement Matlab-compatible MEX functions mxAssert and mxAssertS.
Rik <rik@octave.org>
parents:
22454
diff
changeset
|
330 |
5900 | 331 #else |
21200
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
332 # define mxAssert(expr, msg) |
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
333 # define mxAssertS(expr, msg) |
5879 | 334 #endif |
335 | |
5864 | 336 #if defined (__cplusplus) |
337 } | |
338 #endif | |
339 | |
340 #endif | |
22407
34ce5be04942
maint: Style check C++ code in libinterp/.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
341 |