[Numpy-svn] r3115 - trunk/numpy

numpy-svn at scipy.org numpy-svn at scipy.org
Mon Sep 4 20:43:29 CDT 2006


Author: charris
Date: 2006-09-04 20:43:27 -0500 (Mon, 04 Sep 2006)
New Revision: 3115

Modified:
   trunk/numpy/add_newdocs.py
Log:
Add more docs to function fromfile()

Modified: trunk/numpy/add_newdocs.py
===================================================================
--- trunk/numpy/add_newdocs.py	2006-09-05 00:54:09 UTC (rev 3114)
+++ trunk/numpy/add_newdocs.py	2006-09-05 01:43:27 UTC (rev 3115)
@@ -147,19 +147,33 @@
     """)
 
 add_newdoc('numpy.core.multiarray','fromfile',
-    """fromfile(file=, dtype=float, count=-1, sep='')
+    """fromfile(file=, dtype=float, count=-1, sep='') -> array.
 
-    Return an array of the given data type from a (text or binary) file.
-    The file argument can be an open file or a string with the name of a
-    file to read from.  If count==-1, then the entire file is read,
-    otherwise count is the number of items of the given type read in.  If
-    sep is '' then read a binary file, otherwise it gives the separator
-    between elements in a text file.
+    Required arguments:
+        file -- open file object or string containing file name.
 
-    WARNING: This function should be used sparingly, as it is not a
-    platform-independent method of persistence.  But it can be useful to
-    read in simply-formatted or binary data quickly.
+    Keyword arguments:
+        dtype -- type and order of the returned array (default float)
+        count -- number of items to input (default all)
+        sep -- separater between items if file is a text file (default "")
 
+    Return an array of the given data type from a text or binary file. The
+    'file' argument can be an open file or a string with the name of a file to
+    read from.  If 'count' == -1 the entire file is read, otherwise count is the
+    number of items of the given type to read in.  If 'sep' is "" it means to
+    read binary data from the file using the specified dtype, otherwise it gives
+    the separator between elements in a text file. The 'dtype' value is also
+    used to determine the size and order of the items in binary files.
+
+
+    Data written using the tofile() method can be conveniently recovered using
+    this function.
+
+    WARNING: This function should be used sparingly as the binary files are not
+    platform independent. In particular, they contain no endianess or datatype
+    information. Nevertheless it can be useful for reading in simply formatted
+    or binary data quickly.
+
     """)
 
 add_newdoc('numpy.core.multiarray','frombuffer',
@@ -1038,7 +1052,7 @@
     """a.tofile(fid, sep="", format="%s") -> None. Write the data to a file.
 
     Required arguments:
-        file -- an open file object or a filename
+        file -- an open file object or a string containing a filename
 
     Keyword arguments:
         sep -- separator for text output. Write binary if empty (default "")
@@ -1048,13 +1062,16 @@
     endianess and precision is lost, so this method is not a good choice for
     files intended to archive data or transport data between machines with
     different endianess. Some of these problems can be overcome by outputting
-    text files at the expense of speed and file size.
+    the data as text files at the expense of speed and file size.
 
     If 'sep' is empty this method is equivalent to file.write(a.tostring()). If
     'sep' is not empty each data item is converted to the nearest Python type
     and formatted using "format"%item. The resulting strings are written to the
     file separated by the contents of 'sep'.
 
+    The data produced by this method can be recovered by using the function
+    fromfile().
+
     """))
 
 



More information about the Numpy-svn mailing list