code : string
A string of valid C++ code. It should not specify a return
statement. Instead it should assign results that need to be
returned to Python in the return_val.
arg_names : [str], optional
A list of Python variable names that should be transferred from
Python into the C/C++ code. It defaults to an empty string.
local_dict : dict, optional
If specified, it is a dictionary of values that should be used as
the local scope for the C/C++ code. If local_dict is not
specified the local dictionary of the calling function is used.
global_dict : dict, optional
If specified, it is a dictionary of values that should be used as
the global scope for the C/C++ code. If global_dict is not
specified, the global dictionary of the calling function is used.
force : {0, 1}, optional
If 1, the C++ code is compiled every time inline is called. This
is really only useful for debugging, and probably only useful if
your editing support_code a lot.
compiler : str, optional
The name of compiler to use when compiling. On windows, it
understands ‘msvc’ and ‘gcc’ as well as all the compiler names
understood by distutils. On Unix, it’ll only understand the
values understood by distutils. (I should add ‘gcc’ though to
this).
On windows, the compiler defaults to the Microsoft C++ compiler.
If this isn’t available, it looks for mingw32 (the gcc compiler).
On Unix, it’ll probably use the same compiler that was used when
compiling Python. Cygwin’s behavior should be similar.
verbose : {0,1,2}, optional
Speficies how much much information is printed during the compile
phase of inlining code. 0 is silent (except on windows with msvc
where it still prints some garbage). 1 informs you when compiling
starts, finishes, and how long it took. 2 prints out the command
lines for the compilation process and can be useful if your having
problems getting code to work. Its handy for finding the name of
the .cpp file if you need to examine it. verbose has no affect if
the compilation isn’t necessary.
support_code : str, optional
A string of valid C++ code declaring extra code that might be
needed by your compiled function. This could be declarations of
functions, classes, or structures.
headers : [str], optional
A list of strings specifying header files to use when compiling
the code. The list might look like ["<vector>","'my_header'"].
Note that the header strings need to be in a form than can be
pasted at the end of a #include statement in the C++ code.
customize : base_info.custom_info, optional
An alternative way to specify support_code, headers, etc. needed
by the function. See scipy.weave.base_info for more
details. (not sure this’ll be used much).
type_converters : [type converters], optional
These guys are what convert Python data types to C/C++ data types.
If you’d like to use a different set of type conversions than the
default, specify them here. Look in the type conversions section
of the main documentation for examples.
auto_downcast : {1,0}, optional
This only affects functions that have numpy arrays as input
variables. Setting this to 1 will cause all floating point values
to be cast as float instead of double if all the Numeric arrays
are of type float. If even one of the arrays has type double or
double complex, all variables maintain there standard
types.
newarr_converter : int, optional
Unused.
|