[gmpy-commits] CVS: gmpy/doc gmpydoc.txt,1.3,1.4 index.html,1.3,1.4

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/gmpy/gmpy/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv18786

Modified Files:
	gmpydoc.txt index.html 
Log Message:
Minor changes for 1.0.

Index: gmpydoc.txt
===================================================================
RCS file: /cvsroot/gmpy/gmpy/doc/gmpydoc.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** gmpydoc.txt	5 Mar 2002 11:05:11 -0000	1.3
--- gmpydoc.txt	8 Aug 2003 09:15:57 -0000	1.4
***************
*** 36,39 ****
--- 36,41 ----
  Minor editing for version 0.9c (2002/03/05).

+ Minor editing for version 1.0 (2003/08/08).
+ 

  *Acknowledgments*
***************
*** 55,68 ****
  *Installation and testing*

! Pre-requisites: Python 2.2, GMP 4.0.1 (see later for Win32).
  GMP 3.1.1 is still supported for the moment (but will
  be phased out soon) -- testing and bugfixes only for
  bugs reproducible in GMP 4 (no more workarounds for
  GMP 3 - only bugs).  Not yet any GMP 4 only functionality.
! No known use of Python 2.2-only functionality yet, but
  no support/bugfixes planned for older Python releases.

  To build gmpy from sources, unpack the sources zipfile
! (gmpy-sources-09.zip, for example, for release 0.9)
  into a new, dedicated directory; cd to that directory
  (from any shell on Unix/Linux, from a 'Dos box' aka
--- 57,70 ----
  *Installation and testing*

! Pre-requisites: Python 2.3, GMP 4.0.1 (see later for Win32).
  GMP 3.1.1 is still supported for the moment (but will
  be phased out soon) -- testing and bugfixes only for
  bugs reproducible in GMP 4 (no more workarounds for
  GMP 3 - only bugs).  Not yet any GMP 4 only functionality.
! No known use of Python 2.3-only functionality yet, but
  no support/bugfixes planned for older Python releases.

  To build gmpy from sources, unpack the sources zipfile
! (gmpy-sources-10.zip, for example, for release 1.0)
  into a new, dedicated directory; cd to that directory
  (from any shell on Unix/Linux, from a 'Dos box' aka
***************
*** 78,82 ****
  be used (the linker will give two warnings, but they are
  innocuous ones -- please ignore them).  GMP 3.1.1 for MSVC++
! 6 is found at: ftp://ftp.whiterose.net/pub/lundman.

  GMP 4 for Windows has not been checked out yet.  Take care
--- 80,85 ----
  be used (the linker will give two warnings, but they are
  innocuous ones -- please ignore them).  GMP 3.1.1 for MSVC++
! 6 is found at: ftp://ftp.whiterose.net/pub/lundman -- but
! you don't need to download that to build and use gmpy.

  GMP 4 for Windows has not been checked out yet.  Take care
***************
*** 89,100 ****

  Distutils are not yet supported for the pre-built gmpy.pyd
! for windows, that comes in the gmpy-win32-binary-08.zip
! file -- just move the gmpy.pyd it contains to c:\Python22
! (or wherever you have your Python 2.2 installation).

  The sources zipfile also contains this file (gmpydoc.txt),
  an example C source file for a separate module that uses
  the C-API of gmpy to interoperate with it (the .pyd for
! that example module, for Win32, is also in -binary-08.zip),
  a copy of the index.html for the gmpy sourceforge site,
  and python scripts that exemplify, show the performance
--- 92,103 ----

  Distutils are not yet supported for the pre-built gmpy.pyd
! for windows, that comes in the gmpy-win32-binary-10.zip
! file -- just move the gmpy.pyd it contains to c:\Python23
! (or wherever you have your Python 2.3 installation).

  The sources zipfile also contains this file (gmpydoc.txt),
  an example C source file for a separate module that uses
  the C-API of gmpy to interoperate with it (the .pyd for
! that example module, for Win32, is also in -binary-10.zip),
  a copy of the index.html for the gmpy sourceforge site,
  and python scripts that exemplify, show the performance
***************
*** 103,126 ****

  To test the installation, ensure Tim Peter's doctest.py
! is in a directory in the PYTHONPATH (a copy is enclosed
! in the gmpy sources zipfile), and, in the directory
  where you unpacked the sources, run at the command prompt:

!         python gmpy_test_09.py

  Expected output is something like (details may differ!):
  """
! Unit tests for gmpy 0.9 pre-alpha
!     on Python 2.2 (#1, Dec 23 2001, 20:09:01)
! [GCC 2.96 20000731 (Mandrake Linux 8.1 2.96-0.62mdk)]
! Testing gmpy 0.9.0c (GMP 4.0.1), default caching (20, 20, -2..11)
! gmpy_test_09_cvr 262 tests, 0 failures
! gmpy_test_09_rnd  26 tests, 0 failures
! gmpy_test_09_mpf 140 tests, 0 failures
! gmpy_test_09_mpq 242 tests, 0 failures
! gmpy_test_09_mpz 310 tests, 0 failures
  25 items passed all tests:
!     [ 25 lines snipped ]
! 980 tests in 25 items.
  980 passed and 0 failed.
  Test passed.
--- 106,132 ----

  To test the installation, ensure Tim Peter's doctest.py
! is in a directory in the PYTHONPATH (it's in the standard
! library since 2.1, so, no problem:-), and, in the directory
  where you unpacked the sources, run at the command prompt:

!         python gmpy_test.py

  Expected output is something like (details may differ!):
  """
! Unit tests for gmpy 1,0 alpha
!     on Python 2.3+ (#1, Aug  5 2003, 17:15:06)
! [GCC 3.2.2 (Mandrake Linux 9.1 3.2.2-3mdk)]
! Testing gmpy 1.0 (GMP 4.0.1), default caching (20, 20, -2..11)
! gmpy_test_cvr 262 tests, 0 failures
! gmpy_test_rnd  26 tests, 0 failures
! gmpy_test_mpf 140 tests, 0 failures
! gmpy_test_mpq 242 tests, 0 failures
! gmpy_test_mpz 310 tests, 0 failures
! 5 items had no tests:
!     gmpy_test_cvr._test
!     [[ snip snip ]]
  25 items passed all tests:
!     [[ snip snip ]]
! 980 tests in 30 items.
  980 passed and 0 failed.
  Test passed.
***************
*** 130,135 ****
  that each of the various modules listed at the start can
  also be run independently, if so desired:
!         python gmpy_test_09_mpq.py
!         python gmpy_test_09_mpz.py
  and so on, expecting output analogous to the above example.  
  The key issue is the 'Test passed' line at the end of each run!
--- 136,141 ----
  that each of the various modules listed at the start can
  also be run independently, if so desired:
!         python gmpy_test_mpq.py
!         python gmpy_test_mpz.py
  and so on, expecting output analogous to the above example.  
  The key issue is the 'Test passed' line at the end of each run!
***************
*** 137,141 ****
  *PLEASE* report any failures to gmpy's maintainers, with
  any details you can supply on your machine, on your OS, and
! on your installation of GMP 4, gmpy 0.9, Python 2.2, and any
  other relevant issue (your C/C++ compiler & libraries, &c).
  *THANKS* in advance -- bug reporting and feedback is your
--- 143,147 ----
  *PLEASE* report any failures to gmpy's maintainers, with
  any details you can supply on your machine, on your OS, and
! on your installation of GMP 4, gmpy 1.0, Python 2.3, and any
  other relevant issue (your C/C++ compiler & libraries, &c).
  *THANKS* in advance -- bug reporting and feedback is your

Index: index.html
===================================================================
RCS file: /cvsroot/gmpy/gmpy/doc/index.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** index.html	5 Mar 2002 11:05:11 -0000	1.3
--- index.html	8 Aug 2003 09:15:57 -0000	1.4
***************
*** 14,19 ****
  <BODY>
  <FONT SIZE=-1>
! Last updated on: 2002, Mar 5;
! for GMPY release: 0.9.0c pre-alpha
  <A href="http://sourceforge.net">
  <IMG src="http://sourceforge.net/sflogo.php?group_id=13335&type=1"
--- 14,19 ----
  <BODY>
  <FONT SIZE=-1>
! Last updated on: 2003, Aug 8;
! for GMPY release: 1.0 alpha
  <A href="http://sourceforge.net">
  <IMG src="http://sourceforge.net/sflogo.php?group_id=13335&type=1"
***************
*** 48,52 ****
  exposure of MPZ, MPF (floating-point), and MPQ (rational)
  functionality of current GMP (release 4.0), that will fully
! support current Python (release 2.2) and its handy 'distutils'
  (and also support a "C API" allowing some level of interoperation
  with other C-written extension modules for Python).
--- 48,52 ----
  exposure of MPZ, MPF (floating-point), and MPQ (rational)
  functionality of current GMP (release 4.0), that will fully
! support current Python (release 2.3) and its handy 'distutils'
  (and also support a "C API" allowing some level of interoperation
  with other C-written extension modules for Python).
***************
*** 66,75 ****
  the same module, or as a further, separate add-on module).
  Rooting for MPFR to be merged with GMP so we can avoid some
! awkwardness (hopefully by GMP 4.1 later in Spring 2002...!).

  <H2>Mutability... but <u>not</u> for now</H2>
  Early tests have shown that supporting Python 2's "in-place
  operation" functionality (by making MPZ, MPF and MPQ Python objects
! <b>mutable</b>) could offer a substantial performance boost.
  <p>
  Despite this, widespread feeling among Python cognoscenti appears
--- 66,75 ----
  the same module, or as a further, separate add-on module).
  Rooting for MPFR to be merged with GMP so we can avoid some
! awkwardness (but seeing no movement on this front so far).

  <H2>Mutability... but <u>not</u> for now</H2>
  Early tests have shown that supporting Python 2's "in-place
  operation" functionality (by making MPZ, MPF and MPQ Python objects
! <b>mutable</b>) would offer a substantial performance boost.
  <p>
  Despite this, widespread feeling among Python cognoscenti appears
***************
*** 90,101 ****

  <H1>Project Status and near-future plans</H1>
! The gmpy module's early, pre-alpha releases (latest current release
! as of 2002/03/05: 0.9.0c) are available for download in both
! source and Windows-binary form.  They expose all of the mpz, mpq
  and mpf functionality that was already available in GMP 3.1, and 
  most of the random-number generation functionality (there are no
  current plans to extend gmpy to expose other such functionality,
! although the currently experimental way that it is architected is
! subject to likely future changes).
  <p>
  On most platforms, you will need to separately procure and install
--- 90,101 ----

  <H1>Project Status and near-future plans</H1>
! The gmpy module's alpha release (latest current release
! as of 2002/08/08: 1.0) is available for download in both
! source and Windows-binary form.  It exposes all of the mpz, mpq
  and mpf functionality that was already available in GMP 3.1, and 
  most of the random-number generation functionality (there are no
  current plans to extend gmpy to expose other such functionality,
! although the currently experimental way in which it is architected
! is subject to possible future changes).
  <p>
  On most platforms, you will need to separately procure and install
***************
*** 164,168 ****
  use, and also in the context of PySymbolic, a tad too many design
  decisions have been delayed/postponed by introducing module-level
! flags, letting us 'have it both ways' in the current pre-alpha 
  gmpy; this has produced a somewhat unwieldy mix of module-level
  flag-setting and call-back functions.  This whole area's architecture
--- 164,168 ----
  use, and also in the context of PySymbolic, a tad too many design
  decisions have been delayed/postponed by introducing module-level
! flags, letting us 'have it both ways' in the current alpha 
  gmpy; this has produced a somewhat unwieldy mix of module-level
  flag-setting and call-back functions.  This whole area's architecture
***************
*** 170,190 ****

  <H2>Near-future plans</h2>
! The first alpha release, 1.0, is not deemed to
! be very far at this time.  It will only differ
! in degree, not in kind, from the current pre-alphas.
! <p>
! Main changes foreseen will include: re-architecting
! the module-level setting functions; more elegantly
! formatted documentation; more timing-measurement
! scripts and usage-examples.  Some of the currently
! experimental 'callbacks' will also be removed,
! having been proven unnecessary.  All relevant GMP 4
! functionality will be exposed.
  <p>
! The current plans forecast all of this will be completed
! on, or before, May 1, 2002 (give or take about 10 days).
! But our predictions have proved optimistic in the past,
! so, don't hold your breath (pitching in and helping it
! happen, on the other hand, _might_ be advisable:-).
  <p>
  <A HREF="http://sourceforge.net/projects/gmpy/">Project
--- 170,183 ----

  <H2>Near-future plans</h2>
! Future releases may have changes including: re-architecting the
! module-level setting functions; more elegantly formatted documentation;
! more timing-measurement scripts and usage-examples.  Some of the
! currently experimental 'callbacks' will also be removed, having been
! proven unnecessary.  All relevant GMP 4 functionality will be exposed.
  <p>
! No predictions on timing, though.  gmpy 1.0 meets all current needs
! of the main author, so his motivation to work more on it is low:-).
! So, don't hold your breath (pitching in and helping it happen, on the
! other hand, _might_ be advisable:-).
  <p>
  <A HREF="http://sourceforge.net/projects/gmpy/">Project