File: mwrap.1

package info (click to toggle)
mwrap 1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,548 kB
  • sloc: cpp: 3,315; python: 1,850; ansic: 856; makefile: 258; lex: 233; sh: 145
file content (87 lines) | stat: -rw-r--r-- 2,600 bytes parent folder | download
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
.TH MWRAP 1 2012 "mwrap" "MWRAP manpage"
.SH NAME
mwrap - Octave/MATLAB mex generator
.SH SYNOPSIS
.SY mwrap
.OP \-mex \fIoutputmex\fP
.OP \-m \fIoutput.m\fP
.OP \-c \fIoutputmex.c\fP
.OP \-mb
.OP \-list
.OP \-catch
.OP \-i8
.OP \-c99complex
.OP \-cppcomplex
.OP \-gpu
\fIinfile1\fP \fIinfile2\fP ...
.br
.SH DESCRIPTION
.LP
\fBmwrap\fP is an interface generation system in the spirit of SWIG or
matwrap.  From a set of augmented Octave/MATLAB script files, \fBmwrap\fP
will generate a MEX gateway to desired C/C++ function calls and \.m function
files to access that gateway.  The details of converting to and from
Octave's or MATLAB's data structures, and of allocating and freeing
temporary storage, are hidden from the user.
.SH OPTIONS
.TP
.B \-mex
specifies the name of the MEX function that the generated functions will
call.  This name will generally be the same as the prefix for the C/C++
output file name.
.
.TP
.B \-m
specifies the name of the Octave/MATLAB script to be generated.
.
.TP
.B \-c
specifies the name of the C MEX file to be generated.  The MEX file may
contain stubs corresponding to several different generated files.
.
.TP
.B \-mb
redirect Octave/MATLAB function output to files named in the input.  In this
mode, the processor will change Octave/MATLAB function output files whenever
it encounters a line beginning with @.  If @ occurs alone on a line, the
output will be turned off; if the line begins with @function, the line will
be treated as the first line of a function, and the m-file name will be
deduced from the function name; and otherwise, the characters after @ (up to
the next set of white space) will be treated as a filename, and \fBmwrap\fP
will try to write to that file.
.
.TP
.B \-list
print to the standard output the names of all files that would be generated
from redirect output by the \-mb flag.
.
.TP
.B \-catch
surround library calls in try/catch blocks in order to intercept C++
exceptions.
.
.TP
.B \-i8
convert \fBint\fP, \fBlong\fP, \fBuint\fP, \fBulong\fP types to
\fBint64_t\fP, \fBuint64_t\fP. This provides
a convenient way to interface with \fB-fdefault-integer-8\fP and 
\fB-i8\fP flags used by Fortran compilers.
.
.TP
.B \-c99complex
use the C99 complex floating point types as the default \fBdcomplex\fP and
\fBfcomplex\fP types.
.
.TP
.B \-cppcomplex
use the C++ complex floating point types as the default \fBdcomplex\fP and
\fBfcomplex\fP types.
.
.TP
.B \-gpu
add support code for MATLAB gpuArray.

.SH AUTHORS
.LP
\fBmwrap\fP is written by David Bindel and Zydrunas Gimbutas. This
manual page was written by Nicolas Bourdaud.