Mercurial > hg > octave-nkf
annotate libinterp/corefcn/mexproto.h @ 20404:b0f7ee81d974 stable
doc: Remove extra spaces at start of docstring which show up in Info format.
* intro.txi: Use blank line between end of example and seealso.
* utils.cc: Remove stray comment from previous cset.
* annotation.m: Overhaul docstring.
* subspace.m: Re-indent academic reference.
* condest.m: Remove blank column of spaces in front of license.
* onenormest.m: Remove blank column of spaces in front of license.
* sinc.m: Remove extra single space at start of line.
* invhilb.m: Remove extra single space at start of line.
* gls.m: Remove extra single space at start of line.
* ols.m: Remove extra single space at start of line.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 14 May 2015 14:25:37 -0700 |
parents | 4197fc428c7d |
children |
rev | line source |
---|---|
5864 | 1 /* |
2 | |
19898
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17787
diff
changeset
|
3 Copyright (C) 2006-2015 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 | |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
58 /* 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
|
59 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
|
60 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
|
61 #if ! defined (OCTINTERP_API) |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
62 #if defined (_MSC_VER) |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
63 #define OCTINTERP_API __declspec(dllimport) |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
64 #else |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
65 /* All other compilers, at least for now. */ |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
66 #define OCTINTERP_API |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
67 #endif |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
68 #endif |
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
69 |
5900 | 70 #define MXARRAY_TYPEDEFS_ONLY |
71 #include "mxarray.h" | |
72 #undef MXARRAY_TYPEDEFS_ONLY | |
73 | |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
74 /* Interface to the interpreter. */ |
6109 | 75 extern OCTINTERP_API const char *mexFunctionName (void); |
5864 | 76 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
77 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
|
78 int nargin, mxArray *argin[], |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
79 const char *fname); |
5864 | 80 |
6109 | 81 extern OCTINTERP_API void mexSetTrapFlag (int flag); |
82 extern OCTINTERP_API int mexEvalString (const char *s); | |
83 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
|
84 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
|
85 ...); |
6109 | 86 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
|
87 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
|
88 ...); |
10127
f21fdff5c906
Change signature of mexPrintf.
David Grundberg <davidg@cs.umu.se>
parents:
10126
diff
changeset
|
89 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
|
90 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
91 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
|
92 const char *name); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
93 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
|
94 const char *name); |
5864 | 95 |
15352
9a8dbd6b6b20
* mysparse.c (mexFunction): Declare pbr and pbr2 as mxLogical*, not bool*.
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
96 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
|
97 const mxArray *ptr); |
5864 | 98 |
6109 | 99 extern OCTINTERP_API void mexMakeArrayPersistent (mxArray *ptr); |
100 extern OCTINTERP_API void mexMakeMemoryPersistent (void *ptr); | |
5879 | 101 |
6109 | 102 extern OCTINTERP_API int mexAtExit (void (*f) (void)); |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
103 extern OCTINTERP_API const mxArray *mexGet (double handle, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
104 const char *property); |
6109 | 105 extern OCTINTERP_API int mexIsGlobal (const mxArray *ptr); |
106 extern OCTINTERP_API int mexIsLocked (void); | |
107 extern OCTINTERP_API void mexLock (void); | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
108 extern OCTINTERP_API int mexSet (double handle, const char *property, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
109 mxArray *val); |
6109 | 110 extern OCTINTERP_API void mexUnlock (void); |
5900 | 111 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
112 /* Floating point predicates. */ |
6109 | 113 extern OCTINTERP_API int mxIsFinite (double v); |
114 extern OCTINTERP_API int mxIsInf (double v); | |
115 extern OCTINTERP_API int mxIsNaN (double v); | |
5900 | 116 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
117 /* Floating point values. */ |
6109 | 118 extern OCTINTERP_API double mxGetEps (void); |
119 extern OCTINTERP_API double mxGetInf (void); | |
120 extern OCTINTERP_API double mxGetNaN (void); | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
121 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
122 /* Memory management. */ |
6109 | 123 extern OCTINTERP_API void *mxCalloc (size_t n, size_t size); |
124 extern OCTINTERP_API void *mxMalloc (size_t n); | |
125 extern OCTINTERP_API void *mxRealloc (void *ptr, size_t size); | |
126 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
|
127 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
128 /* Constructors. */ |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
129 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
|
130 const mwSize *dims); |
6686 | 131 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
|
132 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
|
133 const mwSize *dims); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
134 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
|
135 const char **str); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
136 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
|
137 mxComplexity flag); |
6109 | 138 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
|
139 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
|
140 const mwSize *dims); |
6686 | 141 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
|
142 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
|
143 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
|
144 const mwSize *dims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
145 mxClassID class_id, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
146 mxComplexity flag); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
147 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
|
148 mxClassID class_id, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
149 mxComplexity flag); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
150 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
|
151 mxComplexity flag); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
152 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
|
153 mwSize nzmax); |
6109 | 154 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
|
155 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
|
156 const mwSize *dims, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
157 int num_keys, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
158 const char **keys); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
159 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
|
160 int num_keys, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
161 const char **keys); |
5900 | 162 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
163 /* Copy constructor. */ |
6109 | 164 extern OCTINTERP_API mxArray *mxDuplicateArray (const mxArray *v); |
5900 | 165 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
166 /* Destructor. */ |
6109 | 167 extern OCTINTERP_API void mxDestroyArray (mxArray *v); |
5900 | 168 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
169 /* Type Predicates. */ |
6109 | 170 extern OCTINTERP_API int mxIsCell (const mxArray *ptr); |
171 extern OCTINTERP_API int mxIsChar (const mxArray *ptr); | |
172 extern OCTINTERP_API int mxIsClass (const mxArray *ptr, const char *name); | |
173 extern OCTINTERP_API int mxIsComplex (const mxArray *ptr); | |
174 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
|
175 extern OCTINTERP_API int mxIsFunctionHandle (const mxArray *ptr); |
6109 | 176 extern OCTINTERP_API int mxIsInt16 (const mxArray *ptr); |
177 extern OCTINTERP_API int mxIsInt32 (const mxArray *ptr); | |
178 extern OCTINTERP_API int mxIsInt64 (const mxArray *ptr); | |
179 extern OCTINTERP_API int mxIsInt8 (const mxArray *ptr); | |
180 extern OCTINTERP_API int mxIsLogical (const mxArray *ptr); | |
181 extern OCTINTERP_API int mxIsNumeric (const mxArray *ptr); | |
182 extern OCTINTERP_API int mxIsSingle (const mxArray *ptr); | |
183 extern OCTINTERP_API int mxIsSparse (const mxArray *ptr); | |
184 extern OCTINTERP_API int mxIsStruct (const mxArray *ptr); | |
185 extern OCTINTERP_API int mxIsUint16 (const mxArray *ptr); | |
186 extern OCTINTERP_API int mxIsUint32 (const mxArray *ptr); | |
187 extern OCTINTERP_API int mxIsUint64 (const mxArray *ptr); | |
188 extern OCTINTERP_API int mxIsUint8 (const mxArray *ptr); | |
5900 | 189 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
190 /* Odd type+size predicate. */ |
6109 | 191 extern OCTINTERP_API int mxIsLogicalScalar (const mxArray *ptr); |
5900 | 192 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
193 /* Odd type+size+value predicate. */ |
6109 | 194 extern OCTINTERP_API int mxIsLogicalScalarTrue (const mxArray *ptr); |
5900 | 195 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
196 /* Size predicate. */ |
6109 | 197 extern OCTINTERP_API int mxIsEmpty (const mxArray *ptr); |
5900 | 198 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
199 /* Just plain odd thing to ask of a value. */ |
6109 | 200 extern OCTINTERP_API int mxIsFromGlobalWS (const mxArray *ptr); |
5900 | 201 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
202 /* Dimension extractors. */ |
6686 | 203 extern OCTINTERP_API size_t mxGetM (const mxArray *ptr); |
204 extern OCTINTERP_API size_t mxGetN (const mxArray *ptr); | |
205 extern OCTINTERP_API mwSize *mxGetDimensions (const mxArray *ptr); | |
206 extern OCTINTERP_API mwSize mxGetNumberOfDimensions (const mxArray *ptr); | |
207 extern OCTINTERP_API size_t mxGetNumberOfElements (const mxArray *ptr); | |
5900 | 208 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
209 /* Dimension setters. */ |
6686 | 210 extern OCTINTERP_API void mxSetM (mxArray *ptr, mwSize M); |
211 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
|
212 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
|
213 mwSize ndims); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
214 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
215 /* Data extractors. */ |
6109 | 216 extern OCTINTERP_API double *mxGetPi (const mxArray *ptr); |
217 extern OCTINTERP_API double *mxGetPr (const mxArray *ptr); | |
218 extern OCTINTERP_API double mxGetScalar (const mxArray *ptr); | |
219 extern OCTINTERP_API mxChar *mxGetChars (const mxArray *ptr); | |
220 extern OCTINTERP_API mxLogical *mxGetLogicals (const mxArray *ptr); | |
221 extern OCTINTERP_API void *mxGetData (const mxArray *ptr); | |
222 extern OCTINTERP_API void *mxGetImagData (const mxArray *ptr); | |
5900 | 223 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
224 /* Data setters. */ |
6109 | 225 extern OCTINTERP_API void mxSetPr (mxArray *ptr, double *pr); |
226 extern OCTINTERP_API void mxSetPi (mxArray *ptr, double *pi); | |
227 extern OCTINTERP_API void mxSetData (mxArray *ptr, void *data); | |
228 extern OCTINTERP_API void mxSetImagData (mxArray *ptr, void *pi); | |
5900 | 229 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
230 /* Classes. */ |
6109 | 231 extern OCTINTERP_API mxClassID mxGetClassID (const mxArray *ptr); |
232 extern OCTINTERP_API const char *mxGetClassName (const mxArray *ptr); | |
5900 | 233 |
6109 | 234 extern OCTINTERP_API void mxSetClassName (mxArray *ptr, const char *name); |
5900 | 235 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
236 /* Cell support. */ |
6686 | 237 extern OCTINTERP_API mxArray *mxGetCell (const mxArray *ptr, mwIndex idx); |
5900 | 238 |
6686 | 239 extern OCTINTERP_API void mxSetCell (mxArray *ptr, mwIndex idx, mxArray *val); |
5900 | 240 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
241 /* Sparse support. */ |
6686 | 242 extern OCTINTERP_API mwIndex *mxGetIr (const mxArray *ptr); |
243 extern OCTINTERP_API mwIndex *mxGetJc (const mxArray *ptr); | |
244 extern OCTINTERP_API mwSize mxGetNzmax (const mxArray *ptr); | |
5900 | 245 |
6686 | 246 extern OCTINTERP_API void mxSetIr (mxArray *ptr, mwIndex *ir); |
247 extern OCTINTERP_API void mxSetJc (mxArray *ptr, mwIndex *jc); | |
248 extern OCTINTERP_API void mxSetNzmax (mxArray *ptr, mwSize nzmax); | |
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 /* Structure support. */ |
6109 | 251 extern OCTINTERP_API int mxAddField (mxArray *ptr, const char *key); |
5900 | 252 |
6109 | 253 extern OCTINTERP_API void mxRemoveField (mxArray *ptr, int key_num); |
5900 | 254 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
255 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
|
256 const char *key); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
257 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
|
258 mwIndex index, int key_num); |
5900 | 259 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
260 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
|
261 const char *key, mxArray *val); |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
262 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
|
263 int key_num, mxArray *val); |
5900 | 264 |
6109 | 265 extern OCTINTERP_API int mxGetNumberOfFields (const mxArray *ptr); |
5900 | 266 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
267 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
|
268 int key_num); |
6109 | 269 extern OCTINTERP_API int mxGetFieldNumber (const mxArray *ptr, const char *key); |
5900 | 270 |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
271 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
|
272 mwSize buflen); |
6109 | 273 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
|
274 |
9651
7234534f47ba
mexproto.h: define OCTINTERP_API if it is not already defined
John W. Eaton <jwe@octave.org>
parents:
9650
diff
changeset
|
275 /* Miscellaneous. */ |
5900 | 276 #ifdef NDEBUG |
277 #define mxAssert(expr, msg) \ | |
278 do \ | |
279 { \ | |
280 if (! expr) \ | |
281 { \ | |
282 mexPrintf ("Assertion failed: %s, at line %d of file \"%s\".\n%s\n", \ | |
283 #expr, __LINE__, __FILE__, msg); \ | |
284 } \ | |
285 } \ | |
286 while (0) | |
287 | |
288 #define mxAssertS(expr, msg) \ | |
289 do \ | |
290 { \ | |
291 if (! expr) \ | |
292 { \ | |
293 mexPrintf ("Assertion failed at line %d of file \"%s\".\n%s\n", \ | |
294 __LINE__, __FILE__, msg); \ | |
295 abort (); \ | |
296 } \ | |
297 } \ | |
298 while (0) | |
299 #else | |
300 #define mxAssert(expr, msg) | |
301 #define mxAssertS(expr, msg) | |
5879 | 302 #endif |
303 | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
304 extern OCTINTERP_API mwIndex mxCalcSingleSubscript (const mxArray *ptr, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
305 mwSize nsubs, mwIndex *subs); |
5900 | 306 |
6686 | 307 extern OCTINTERP_API size_t mxGetElementSize (const mxArray *ptr); |
5900 | 308 |
5864 | 309 #if defined (__cplusplus) |
310 } | |
311 #endif | |
312 | |
313 #endif |