diff options
author | Charles Harris <charlesr.harris@gmail.com> | 2013-08-18 11:16:06 -0600 |
---|---|---|
committer | Charles Harris <charlesr.harris@gmail.com> | 2013-08-18 11:20:45 -0600 |
commit | 8ddb0ce0acafe75d78df528b4d2540dfbf4b364d (patch) | |
tree | 156b23f48f14c7c1df699874007c521b5482d1a4 /numpy/f2py/docs | |
parent | 13b0b272f764c14bc4ac34f5b19fd030d9c611a4 (diff) | |
download | numpy-8ddb0ce0acafe75d78df528b4d2540dfbf4b364d.tar.gz |
STY: Giant whitespace cleanup.
Now is as good a time as any with open PR's at a low.
Diffstat (limited to 'numpy/f2py/docs')
-rw-r--r-- | numpy/f2py/docs/FAQ.txt | 10 | ||||
-rw-r--r-- | numpy/f2py/docs/HISTORY.txt | 85 | ||||
-rw-r--r-- | numpy/f2py/docs/OLDNEWS.txt | 2 | ||||
-rw-r--r-- | numpy/f2py/docs/README.txt | 26 | ||||
-rw-r--r-- | numpy/f2py/docs/TESTING.txt | 2 | ||||
-rw-r--r-- | numpy/f2py/docs/THANKS.txt | 2 | ||||
-rw-r--r-- | numpy/f2py/docs/usersguide/index.txt | 66 |
7 files changed, 96 insertions, 97 deletions
diff --git a/numpy/f2py/docs/FAQ.txt b/numpy/f2py/docs/FAQ.txt index 416560e92..4b50933cf 100644 --- a/numpy/f2py/docs/FAQ.txt +++ b/numpy/f2py/docs/FAQ.txt @@ -238,7 +238,7 @@ constructs in future. But note that the task in non-trivial and may require the next edition of F2PY for which I don't have resources to work with at the moment. -Jeffrey Hagelberg from LLNL has made progress on adding +Jeffrey Hagelberg from LLNL has made progress on adding support for derived types to f2py. He writes: At this point, I have a version of f2py that supports derived types @@ -543,7 +543,7 @@ __ http://www.met.ed.ac.uk/~cory/PyARTS/ + `Python interface to PSPLINE`__, a collection of Spline and Hermite interpolation tools for 1D, 2D, and 3D datasets on - rectilinear grids. + rectilinear grids. __ http://pypspline.sourceforge.net @@ -572,11 +572,11 @@ Here are some comments people have posted to f2py mailing list and c.l.py: + Fernando Perez: Anyway, many many thanks for this amazing tool. - I haven't used pyfort, but I can definitely vouch for the amazing quality of - f2py. And since f2py is actively used by numpy, it won't go unmaintained. + I haven't used pyfort, but I can definitely vouch for the amazing quality of + f2py. And since f2py is actively used by numpy, it won't go unmaintained. It's quite impressive, and very easy to use. -+ Kevin Mueller: First off, thanks to those responsible for F2PY; ++ Kevin Mueller: First off, thanks to those responsible for F2PY; its been an integral tool of my research for years now. + David Linke: Best regards and thanks for the great tool! diff --git a/numpy/f2py/docs/HISTORY.txt b/numpy/f2py/docs/HISTORY.txt index 077189ee2..4326e4852 100644 --- a/numpy/f2py/docs/HISTORY.txt +++ b/numpy/f2py/docs/HISTORY.txt @@ -38,7 +38,7 @@ Release 2.46.243 - Fixed missing need kw error. - Fixed getting callback non-existing extra arguments. - - External callback functions and extra_args can be set via + - External callback functions and extra_args can be set via ext.module namespace. - Avoid crash when external callback function is not set. @@ -46,7 +46,7 @@ Release 2.46.243 - Enabled ``intent(out)`` for ``intent(aux)`` non-complex scalars. - Fixed splitting lines in F90 fixed form mode. - - Fixed FORTRANAME typo, relevant when wrapping scalar functions with + - Fixed FORTRANAME typo, relevant when wrapping scalar functions with ``--no-wrap-functions``. - Improved failure handling for callback functions. - Fixed bug in writting F90 wrapper functions when a line length @@ -65,8 +65,8 @@ Release 2.46.243 * crackfortran.py - - Introduced parent_block key. Get ``use`` statements recursively - from parent blocks. + - Introduced parent_block key. Get ``use`` statements recursively + from parent blocks. - Apply parameter values to kindselectors. - Fixed bug evaluating ``selected_int_kind`` function. - Ignore Name and Syntax errors when evaluating scalars. @@ -135,7 +135,7 @@ Release 2.45.241_1926 functional at the moment. - Introduced ``intent(aux)`` attribute. Useful to save a value of a parameter to auxiliary C variable. Note that ``intent(aux)`` - implies ``intent(c)``. + implies ``intent(c)``. - Added ``usercode`` section. When ``usercode`` is used in ``python module`` block twise then the contents of the second multi-line block is inserted after the definition of external routines. @@ -173,7 +173,7 @@ Release 2.43.239_1831 * fortranobject.c - Patch to make PyArray_CanCastSafely safe on 64-bit machines. - Fixes incorrect results when passing ``array('l')`` to + Fixes incorrect results when passing ``array('l')`` to ``real*8 intent(in,out,overwrite)`` arguments. * rules.py @@ -278,14 +278,14 @@ Release 2.43.239_1806 - Added support for multiple statements in one line (separated with semicolon). - Impl. get_useparameters function for using parameter values from other f90 modules. - - Applied Bertholds patch to fix bug in evaluating expressions + - Applied Bertholds patch to fix bug in evaluating expressions like ``1.d0/dvar``. - Fixed bug in reading string parameters. - Evaluating parameters in charselector. Code cleanup. - Using F90 module parameters to resolve kindselectors. - Made the evaluation of module data init-expression more robust. - Support for ``entry`` statement. - - Fixed ``determineexprtype`` that in the case of parameters + - Fixed ``determineexprtype`` that in the case of parameters returned non-dictionary objects. - Use ``-*- fix -*-`` to specify that a file is in fixed format. @@ -316,7 +316,7 @@ Release 2.39.235_1693 - Handle ``XDY`` parameter constants. - - Introduced formatpattern to workaround a corner case where reserved + - Introduced formatpattern to workaround a corner case where reserved keywords are used in format statement. Other than that, format pattern has no use. @@ -371,7 +371,7 @@ Release 2.39.235_1644 - Fixed bug in Fortran 90 comments of fixed format. - Warn when .pyf signatures contain undefined symbols. - Better detection of source code formats. Using ``-*- fortran -*-`` - or ``-*- f90 -*-`` in the first line of a Fortran source file is + or ``-*- f90 -*-`` in the first line of a Fortran source file is recommended to help f2py detect the format, fixed or free, respectively, correctly. @@ -409,7 +409,7 @@ Release 2.39.235_1644 * setup.py - - Installing f2py.py instead of f2py.bat under NT. + - Installing f2py.py instead of f2py.bat under NT. - Introduced ``--with-numpy_distutils`` that is useful when making f2py tar-ball with numpy_distutils included. @@ -451,7 +451,7 @@ Release 2.37.233-1545 - Fixed segfaults (that were introduced with recent memory leak fixes) when using allocatable arrays. - - Introduced F2PY_REPORT_ON_ARRAY_COPY CPP macro int-variable. If defined + - Introduced F2PY_REPORT_ON_ARRAY_COPY CPP macro int-variable. If defined then a message is printed to stderr whenever a copy of an array is made and arrays size is larger than F2PY_REPORT_ON_ARRAY_COPY. @@ -547,7 +547,7 @@ Public Release 2.32.225-1419 * docs/usersguide/ - Complete revision of F2PY Users Guide + Complete revision of F2PY Users Guide * tests/run_all.py @@ -598,8 +598,8 @@ Public Release 2.32.225-1419 - Introduced multiline block. Currently usable only for ``callstatement`` statement. - Improved array length calculation in getarrlen(..). - - "From sky" program group is created only if ``groupcounter<1``. - See TODO.txt. + - "From sky" program group is created only if ``groupcounter<1``. + See TODO.txt. - Added support for ``dimension(n:*)``, ``dimension(*:n)``. They are treated as ``dimesnion(*)`` by f2py. - Fixed parameter substitution (this fixes TODO item by Patrick @@ -640,7 +640,7 @@ Public Release 2.32.225-1419 * src/fortranobject.c - - Multi-dimensional common block members and allocatable arrays + - Multi-dimensional common block members and allocatable arrays are returned as Fortran-contiguous arrays. - Fixed NULL return to Python without exception. - Fixed memory leak in getattr(<fortranobj>,'__doc__'). @@ -667,7 +667,7 @@ Public Release 2.32.225-1419 - Introduced dummy routine feature. - F77 and F90 wrapper subroutines (if any) as saved to different files, <modulename>-f2pywrappers.f and <modulename>-f2pywrappers2.f90, - respectively. Therefore, wrapping F90 requires numpy_distutils >= + respectively. Therefore, wrapping F90 requires numpy_distutils >= 0.2.0_alpha_2.229. - Fixed compiler warnings about meaningless ``const void (*f2py_func)(..)``. - Improved error messages for ``*_from_pyobj``. @@ -690,9 +690,9 @@ Public Release 2.32.225-1419 - (float|long_double)_from_pyobj now use double_from_pyobj. - complex_(float|long_double)_from_pyobj now use complex_double_from_pyobj. - Rewrote ``*_from_pyobj`` to be more robust. This fixes segfaults if - getting * from a string. Note that int_from_pyobj differs - from PyNumber_Int in that it accepts also complex arguments - (takes the real part) and sequences (takes the 1st element). + getting * from a string. Note that int_from_pyobj differs + from PyNumber_Int in that it accepts also complex arguments + (takes the real part) and sequences (takes the 1st element). - Removed unnecessary void* casts in NUMFROMARROBJ. - Fixed casts in ``*_from_pyobj`` functions. - Replaced CNUMFROMARROBJ with NUMFROMARROBJ. @@ -704,7 +704,7 @@ Public Release 2.32.225-1419 - Introduced isdummyroutine(). - Fixed islong_* functions. - Fixed isintent_in for intent(c) arguments (bug report: Pierre Schnizer). - - Introduced F2PYError and throw_error. Using throw_error, f2py + - Introduced F2PYError and throw_error. Using throw_error, f2py rejects illegal .pyf file constructs that otherwise would cause compilation failures or python crashes. - Fixed islong_long(logical*8)->True. @@ -715,7 +715,7 @@ Public Release 2.32.225-1419 * Speed up for ``*_from_pyobj`` functions if obj is a sequence. -* Fixed SegFault (reported by M.Braun) due to invalid ``Py_DECREF`` +* Fixed SegFault (reported by M.Braun) due to invalid ``Py_DECREF`` in ``GETSCALARFROMPYTUPLE``. Older Releases @@ -737,7 +737,7 @@ Older Releases *** Fixed the order of build_flib options when using --fcompiler=... *** Recognize .f95 and .F95 files as Fortran sources with free format. *** Cleaned up the output of 'f2py -h': removed obsolete items, - added build_flib options section. + added build_flib options section. *** Added --help-compiler option: it lists available Fortran compilers as detected by numpy_distutils/command/build_flib.py. This option is available only with -c option. @@ -748,7 +748,7 @@ Older Releases :: - *** Fixed copying of non-contigious 1-dimensional arrays bug. + *** Fixed copying of non-contigious 1-dimensional arrays bug. (Thanks to Travis O.). @@ -760,7 +760,7 @@ Older Releases *** Fixed ignoring type declarations. *** Turned F2PY_REPORT_ATEXIT off by default. *** Made MAX,MIN macros available by default so that they can be - always used in signature files. + always used in signature files. *** Disabled F2PY_REPORT_ATEXIT for FreeBSD. @@ -791,7 +791,7 @@ Older Releases *** Updated f2py for the latest numpy_distutils. *** A nasty bug with multi-dimensional Fortran arrays is fixed - (intent(out) arrays had wrong shapes). (Thanks to Eric for + (intent(out) arrays had wrong shapes). (Thanks to Eric for pointing out this bug). *** F2PY_REPORT_ATEXIT is disabled by default for __WIN32__. @@ -809,9 +809,9 @@ Older Releases *** Introduced 'callprotoargument' statement so that proper prototypes can be declared. This is crucial when wrapping C functions as it will fix segmentation faults when these wrappers use non-pointer - arguments (thanks to R. Clint Whaley for explaining this to me). + arguments (thanks to R. Clint Whaley for explaining this to me). Note that in f2py generated wrapper, the prototypes have - the following forms: + the following forms: extern #rtype# #fortranname#(#callprotoargument#); or extern #rtype# F_FUNC(#fortranname#,#FORTRANNAME#)(#callprotoargument#); @@ -831,7 +831,7 @@ Older Releases intent(overwrite) will make default overwrite_<name>=1. *** Introduced intent(in|inout,out,out=<name>) attribute that renames arguments name when returned. This renaming has effect only in - documentation strings. + documentation strings. *** Introduced 'callstatement' statement to pyf file syntax. With this one can specify explicitly how wrapped function should be called from the f2py generated module. WARNING: this is a dangerous feature @@ -841,7 +841,7 @@ Older Releases be used only inside a subroutine or function block (it should be enough though) and must be only in one continuous line. The syntax of the statement is: callstatement <C-expression>; - + :Release: 2.11.174 :Date: 18 January 2002 @@ -852,23 +852,23 @@ Older Releases *** Introduced extra keyword argument copy_<varname> for intent(copy) variables. It defaults to 1 and forces to make a copy for intent(in) variables when passing on to wrapped functions (in case - they undesirably change the variable in-situ). + they undesirably change the variable in-situ). *** Introduced has_column_major_storage member function for all f2py generated extension modules. It is equivalent to Python call 'transpose(obj).iscontiguous()' but very efficient. *** Introduced -DF2PY_REPORT_ATEXIT. If this is used when compiling, a report is printed to stderr as python exits. The report includes - the following timings: - 1) time spent in all wrapped function calls; + the following timings: + 1) time spent in all wrapped function calls; 2) time spent in f2py generated interface around the wrapped functions. This gives a hint whether one should worry about storing data in proper order (C or Fortran). 3) time spent in Python functions called by wrapped functions through call-back interface. 4) time spent in f2py generated call-back interface. - For now, -DF2PY_REPORT_ATEXIT is enabled by default. Use + For now, -DF2PY_REPORT_ATEXIT is enabled by default. Use -DF2PY_REPORT_ATEXIT_DISABLE to disable it (I am not sure if - Windows has needed tools, let me know). + Windows has needed tools, let me know). Also, I appreciate if you could send me the output of 'F2PY performance report' (with CPU and platform information) so that I could optimize f2py generated interfaces for future releases. @@ -885,15 +885,15 @@ Older Releases may be useful for cases where the wrapped function changes the argument in situ and this may not be desired side effect. Otherwise, it is safe to not use intent(copy) for the sake - of a better performance. - intent(cache,hide|optional) - just creates a junk of memory. + of a better performance. + intent(cache,hide|optional) - just creates a junk of memory. It does not care about proper storage order. Can be also intent(in) but then the corresponding argument must be a contiguous array with a proper elsize. *** intent(c) can be used also for subroutine names so that -DNO_APPEND_FORTRAN can be avoided for C functions. - *** IMPORTANT BREAKING GOOD ... NEWS!!!: + *** IMPORTANT BREAKING GOOD ... NEWS!!!: From now on you don't have to worry about the proper storage order in multi-dimensional arrays that was earlier a real headache when @@ -929,14 +929,14 @@ Older Releases changed. *** Introduced test-site/test_f2py2e.py script that runs all tests. - *** Fixed global variables initialization problem in crackfortran + *** Fixed global variables initialization problem in crackfortran when run_main is called several times. *** Added 'import Numeric' to C/API init<module> function. *** Fixed f2py.bat in setup.py. *** Switched over to numpy_distutils and dropped fortran_support. *** On Windows create f2py.bat file. *** Introduced -c option: read fortran or pyf files, construct extension - modules, build, and save them to current directory. + modules, build, and save them to current directory. In one word: do-it-all-in-one-call. *** Introduced pyf_extensions(sources,f2py_opts) function. It simplifies the extension building process considerably. Only for internal use. @@ -983,7 +983,7 @@ Older Releases and caused core dump with a non-gcc compiler (Thanks to Pierre Schnizer for reporting this bug). *** Fixed "warning: variable `..' might be clobbered by `longjmp' or `vfork'": - - Reorganized the structure of wrapper functions to get rid of + - Reorganized the structure of wrapper functions to get rid of `goto capi_fail' statements that caused the above warning. @@ -1038,7 +1038,6 @@ Older Releases feature. setup_<modulename>.py uses fortran_support module (from SciPy), but for your convenience it is included also with f2py as an additional package. Note that it has not as many compilers supported as with - using Makefile-<modulename>, but new compilers should be added to + using Makefile-<modulename>, but new compilers should be added to fortran_support module, not to f2py2e package. *** Fixed some compiler warnings about else statements. - diff --git a/numpy/f2py/docs/OLDNEWS.txt b/numpy/f2py/docs/OLDNEWS.txt index 401d2dcee..23d332e35 100644 --- a/numpy/f2py/docs/OLDNEWS.txt +++ b/numpy/f2py/docs/OLDNEWS.txt @@ -60,4 +60,4 @@ .. _HISTORY.txt: HISTORY.html .. _Numarray: http://www.stsci.edu/resources/software_hardware/numarray -.. _TESTING.txt: TESTING.html
\ No newline at end of file +.. _TESTING.txt: TESTING.html diff --git a/numpy/f2py/docs/README.txt b/numpy/f2py/docs/README.txt index cec8a6ec0..f232f1d5d 100644 --- a/numpy/f2py/docs/README.txt +++ b/numpy/f2py/docs/README.txt @@ -21,10 +21,10 @@ __ FAQ.html .. topic:: NEWS!!! January 5, 2006 - + WARNING -- these notes are out of date! The package structure for NumPy and SciPy has changed considerably. Much of this information is now incorrect. - + January 30, 2005 Latest F2PY release (version 2.45.241_1926). @@ -47,7 +47,7 @@ __ FAQ.html __ http://cens.ioc.ee/cgi-bin/cvsweb/python/f2py2e/docs/HISTORY.txt.diff?r1=1.137&r2=1.131&f=h September 25, 2004 - Latest F2PY release (version 2.43.239_1806). + Latest F2PY release (version 2.43.239_1806). Support for ``ENTRY`` statement. New attributes: ``intent(inplace)``, ``intent(callback)``. Supports Numarray 1.1. Introduced ``-*- fix -*-`` header content. Improved ``PARAMETER`` support. @@ -150,7 +150,7 @@ Here follows a more detailed list of F2PY features: <dim> | <start>:<end> | * | : + Attributes and statements:: - + intent([ in | inout | out | hide | in,out | inout,out | c | copy | cache | callback | inplace | aux ]) dimension(<dimspec>) @@ -249,7 +249,7 @@ Unpack the source file, change to directrory ``F2PY-?-???/`` and run The F2PY installation installs a Python package ``f2py2e`` to your Python ``site-packages`` directory and a script ``f2py`` to your -Python executable path. +Python executable path. See also Installation__ section in `F2PY FAQ`_. @@ -287,7 +287,7 @@ __ hello.f 2) Run :: - + f2py -c -m hello hello.f This will build an extension module ``hello.so`` (or ``hello.sl``, @@ -299,12 +299,12 @@ __ hello.f >>> import hello >>> print hello.__doc__ >>> print hello.foo.__doc__ - >>> hello.foo(4) + >>> hello.foo(4) Hello from Fortran! a= 4 - >>> + >>> -If the above works, then you can try out more thorough +If the above works, then you can try out more thorough `F2PY unit tests`__ and read the `F2PY Users Guide and Reference Manual`_. __ FAQ.html#q-how-to-test-if-f2py-is-working-correctly @@ -354,7 +354,7 @@ __ http://cens.ioc.ee/cgi-bin/cvsweb/python/f2py2e/docs/HISTORY.txt?rev=HEAD&con A mailing list f2py-users@cens.ioc.ee is open for F2PY releated discussion/questions/etc. -* `Subscribe..`__ +* `Subscribe..`__ * `Archives..`__ __ http://cens.ioc.ee/mailman/listinfo/f2py-users @@ -412,9 +412,9 @@ __ http://jrfonseca.dyndns.org/debian/ * `American National Standard Programming Language FORTRAN ANSI(R) X3.9-1978`__ * `J3`_ -- The US Fortran standards committee. * SWIG_ -- A software development tool that connects programs written - in C and C++ with a variety of high-level programming languages. + in C and C++ with a variety of high-level programming languages. * `Mathtools.net`_ -- A technical computing portal for all scientific - and engineering needs. + and engineering needs. .. __: http://www.fortran.com/fortran/F77_std/rjcnf.html @@ -445,7 +445,7 @@ __ http://jrfonseca.dyndns.org/debian/ .. _distutils: http://www.python.org/sigs/distutils-sig/ .. _Numerical Python: http://www.numpy.org/ .. _Pyfort: http://pyfortran.sourceforge.net/ -.. _Scientific Python: +.. _Scientific Python: http://starship.python.net/crew/hinsen/scientific.html .. _The Fortran Company: http://www.fortran.com/fortran/ .. _J3: http://www.j3-fortran.org/ diff --git a/numpy/f2py/docs/TESTING.txt b/numpy/f2py/docs/TESTING.txt index d90521175..a6df92c48 100644 --- a/numpy/f2py/docs/TESTING.txt +++ b/numpy/f2py/docs/TESTING.txt @@ -35,7 +35,7 @@ Tests about the failure. * Test intent(in), intent(out) scalar arguments, - scalars returned by F77 functions + scalars returned by F77 functions and F90 module functions:: tests/f77/return_integer.py diff --git a/numpy/f2py/docs/THANKS.txt b/numpy/f2py/docs/THANKS.txt index 0a3f0b9d6..636540687 100644 --- a/numpy/f2py/docs/THANKS.txt +++ b/numpy/f2py/docs/THANKS.txt @@ -4,7 +4,7 @@ ================= F2PY__ is an open source Python package and command line tool developed and -maintained by Pearu Peterson (me__). +maintained by Pearu Peterson (me__). .. __: http://cens.ioc.ee/projects/f2py2e/ .. __: http://cens.ioc.ee/~pearu/ diff --git a/numpy/f2py/docs/usersguide/index.txt b/numpy/f2py/docs/usersguide/index.txt index 5a8d12c68..7b26cac54 100644 --- a/numpy/f2py/docs/usersguide/index.txt +++ b/numpy/f2py/docs/usersguide/index.txt @@ -4,7 +4,7 @@ F2PY Users Guide and Reference Manual ////////////////////////////////////////////////////////////////////// -:Author: Pearu Peterson +:Author: Pearu Peterson :Contact: pearu@cens.ioc.ee :Web site: http://cens.ioc.ee/projects/f2py2e/ :Date: $Date: 2005/04/02 10:03:26 $ @@ -97,7 +97,7 @@ Python the Fortran subroutine ``FIB`` is accessible via ``fib1.fib``:: a : input rank-1 array('d') with bounds (n) Optional arguments: n := len(a) input int - + >>> a=Numeric.zeros(8,'d') >>> fib1.fib(a) >>> print a @@ -125,7 +125,7 @@ Python the Fortran subroutine ``FIB`` is accessible via ``fib1.fib``:: Traceback (most recent call last): File "<stdin>", line 1, in ? fib.error: (len(a)>=n) failed for 1st keyword n - >>> + >>> This demonstrates one of the useful features in F2PY, that it, F2PY implements basic compatibility checks between related @@ -236,8 +236,8 @@ In Python:: n : input int Return objects: a : rank-1 array('d') with bounds (n) - - >>> print fib2.fib(8) + + >>> print fib2.fib(8) [ 0. 1. 1. 2. 3. 5. 8. 13.] .. topic:: Comments @@ -292,8 +292,8 @@ previous case:: n : input int Return objects: a : rank-1 array('d') with bounds (n) - - >>> print fib3.fib(8) + + >>> print fib3.fib(8) [ 0. 1. 1. 2. 3. 5. 8. 13.] @@ -405,17 +405,17 @@ Type declarations :: - <typespec> := byte | character [<charselector>] + <typespec> := byte | character [<charselector>] | complex [<kindselector>] | real [<kindselector>] - | double complex | double precision + | double complex | double precision | integer [<kindselector>] | logical [<kindselector>] - <charselector> := * <charlen> + <charselector> := * <charlen> | ( [len=] <len> [ , [kind=] <kind>] ) | ( kind= <kind> [ , len= <len> ] ) <kindselector> := * <intlen> | ( [kind=] <kind> ) - <entitydecl> := <name> [ [ * <charlen> ] [ ( <arrayspec> ) ] + <entitydecl> := <name> [ [ * <charlen> ] [ ( <arrayspec> ) ] | [ ( <arrayspec> ) ] * <charlen> ] | [ / <init_expr> / | = <init_expr> ] \ [ , <entitydecl> ] @@ -425,7 +425,7 @@ Type declarations + ``<attrspec>`` is a comma separated list of attributes_; + ``<arrayspec>`` is a comma separated list of dimension bounds; - + + ``<init_expr>`` is a `C expression`__. + ``<intlen>`` may be negative integer for ``integer`` type @@ -463,7 +463,7 @@ Use statements: <rename_list> := <local_name> => <use_name> [ , <rename_list> ] Currently F2PY uses ``use`` statement only for linking call-back - modules and ``external`` arguments (call-back functions), see + modules and ``external`` arguments (call-back functions), see `Call-back arguments`_. Common block statements: @@ -570,10 +570,10 @@ __ external_ corresponding prototype:: extern <return type> FUNC_F(<routine name>,<ROUTINE NAME>)(<callprotoargument>); - + + ``fortranname [<acctual Fortran/C routine name>]`` You can use arbitrary ``<routine name>`` for a given Fortran/C - function. Then you have to specify + function. Then you have to specify ``<acctual Fortran/C routine name>`` with this statement. If ``fortranname`` statement is used without @@ -605,7 +605,7 @@ __ external_ module methods ``PyMethodDef``-array. It must be a comma-separated list of C arrays (see `Extending and Embedding`__ Python documentation for details). - ``pymethoddef`` statement can be used only inside + ``pymethoddef`` statement can be used only inside ``python module`` block. __ http://www.python.org/doc/current/ext/ext.html @@ -626,7 +626,7 @@ The following attributes are used by F2PY: For an optional array argument, all its dimensions must be bounded. -``required`` +``required`` The corresponding argument is considered as a required one. This is default. You need to specify ``required`` only if there is a need to disable automatic ``optional`` setting when ``<init_expr>`` is used. @@ -691,7 +691,7 @@ The following attributes are used by F2PY: argument like in the following example:: integer intent(hide),depend(a) :: n = len(a) - real intent(in),dimension(n) :: a + real intent(in),dimension(n) :: a + ``c`` The argument is treated as a C scalar or C array argument. In @@ -809,7 +809,7 @@ The following attributes are used by F2PY: ``external`` The corresponding argument is a function provided by user. The - signature of this so-called call-back function can be defined + signature of this so-called call-back function can be defined - in ``__user__`` module block, - or by demonstrative (or real, if the signature file is a real Fortran @@ -964,12 +964,12 @@ All wrappers (to Fortran/C routines or to common blocks or to Fortran 90 module data) generated by F2PY are exposed to Python as ``fortran`` type objects. Routine wrappers are callable ``fortran`` type objects while wrappers to Fortran data have attributes referring to data -objects. +objects. All ``fortran`` type object have attribute ``_cpointer`` that contains CObject referring to the C pointer of the corresponding Fortran/C function or variable in C level. Such CObjects can be used as an -callback argument of F2PY generated functions to bypass Python C/API +callback argument of F2PY generated functions to bypass Python C/API layer of calling Python functions from Fortran or C when the computational part of such functions is implemented in C or Fortran and wrapped with F2PY (or any other tool capable of providing CObject @@ -1047,7 +1047,7 @@ expects an array version of a string in order to *in situ* changes to be effective. .. topic:: Example - + Consider the following `Fortran 77 code`__: .. include:: string.f @@ -1439,7 +1439,7 @@ distinguished by the usage of ``-c`` and ``-h`` switches: "filename.ext" <filename.ext> - + The include statement is inserted just before the wrapper functions. This feature enables using arbitrary C functions (defined in ``<includefile>``) in F2PY generated wrappers. @@ -1457,7 +1457,7 @@ distinguished by the usage of ``-c`` and ``-h`` switches: ``--include-paths <path1>:<path2>:..`` Search include files from given directories. - ``--help-link [<list of resources names>]`` + ``--help-link [<list of resources names>]`` List system resources found by ``numpy_distutils/system_info.py``. For example, try ``f2py --help-link lapack_opt``. @@ -1490,9 +1490,9 @@ distinguished by the usage of ``-c`` and ``-h`` switches: ``--fcompiler=<Vendor>`` Specify Fortran compiler type by vendor. ``--f77exec=<path>`` - Specify the path to F77 compiler + Specify the path to F77 compiler ``--fcompiler-exec=<path>`` [depreciated] - Specify the path to F77 compiler + Specify the path to F77 compiler ``--f90exec=<path>`` Specify the path to F90 compiler ``--f90compiler-exec=<path>`` [depreciated] @@ -1553,7 +1553,7 @@ distinguished by the usage of ``-c`` and ``-h`` switches: Other options: ``-m <modulename>`` - Name of an extension module. Default is ``untitled``. Don't use this option + Name of an extension module. Default is ``untitled``. Don't use this option if a signature file (*.pyf) is used. ``--[no-]lower`` Do [not] lower the cases in ``<fortran files>``. By default, @@ -1602,7 +1602,7 @@ The following functions are provided by the ``f2py2e`` module: ``compile(source, modulename='untitled', extra_args='', verbose=1, source_fn=None)`` - Build extension module from Fortran 77 source string ``source``. + Build extension module from Fortran 77 source string ``source``. Return 0 if successful. Note that this function actually calls ``f2py -c ..`` from shell to ensure safety of the current Python process. @@ -1618,7 +1618,7 @@ Using ``numpy_distutils`` ``numpy_distutils`` is part of the SciPy_ project and aims to extend standard Python ``distutils`` to deal with Fortran sources and F2PY signature files, e.g. compile Fortran sources, call F2PY to construct -extension modules, etc. +extension modules, etc. .. topic:: Example @@ -1664,7 +1664,7 @@ extension modules, etc. ``config_fc`` to change Fortran compiler options - as well as ``build_ext`` and ``build_clib`` commands are enhanced + as well as ``build_ext`` and ``build_clib`` commands are enhanced to support Fortran sources. Run @@ -1679,7 +1679,7 @@ extension modules, etc. can choose different Fortran compilers by using ``build_ext`` command option ``--fcompiler=<Vendor>``. Here ``<Vendor>`` can be one of the following names:: - + absoft sun mips intel intelv intele intelev nag compaq compaqv gnu vast pg hpux See ``numpy_distutils/fcompiler.py`` for up-to-date list of @@ -1712,7 +1712,7 @@ extension modules, etc. command option ``--fcompiler=<Vendor>`` or by defining environment variable ``FC_VENDOR=<Vendor>``. Here ``<Vendor>`` can be one of the following names:: - + Absoft Sun SGI Intel Itanium NAG Compaq Digital Gnu VAST PG See ``numpy_distutils/command/build_flib.py`` for up-to-date list of @@ -1740,7 +1740,7 @@ wraps the C library function ``system()``:: In Python: .. include:: spam_session.dat - :literal: + :literal: Modifying the dictionary of a F2PY generated module =================================================== |