[Maxima-commits] CVS: maxima/share/contrib/numericalio encode-decode-float.lisp, 1.4, 1.5

[Robert D. <rob...@us...>]

Update of /cvsroot/maxima/maxima/share/contrib/numericalio
In directory sc8-pr-cvs16.sourceforge.net:/tmp/cvs-serv12089/share/contrib/numericalio

Modified Files:
	encode-decode-float.lisp 
Log Message:
Additional comments about Lisp functions.

Index: encode-decode-float.lisp
===================================================================
RCS file: /cvsroot/maxima/maxima/share/contrib/numericalio/encode-decode-float.lisp,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- encode-decode-float.lisp	4 Feb 2008 02:16:24 -0000	1.4
+++ encode-decode-float.lisp	23 Mar 2008 22:36:09 -0000	1.5
@@ -1,10 +1,24 @@
-;;  Copyright 2007 by Robert Dodier
+;; encode-decode-float.lisp
+;; Copyright 2007 by Robert Dodier
 
-;;  This program is free software; you can redistribute it and/or
-;;  modify it under the terms of the GNU General Public License, version 2.
+;; This program is free software; you can redistribute it and/or
+;; modify it under the terms of the GNU General Public License, version 2.
 
-;;  This program has NO WARRANTY, not even the implied warranty of
-;;  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+;; This program has NO WARRANTY, not even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+;; These functions encode integers into 64 bit IEEE 754 floats
+;; and decode 64 bit floats into 64 bit integers.
+;; These functions cannot handle any other size of float.
+;; 
+;; Encode float-64 to integer:  SMASH-FLOAT-64-INTO-INTEGER
+;; Decode integer to float-64:  CONSTRUCT-FLOAT-64-FROM-INTEGER
+;;
+;; Write float-64 to output stream:  WRITE-FLOAT-64
+;; Read float-64 from input stream:  READ-FLOAT-64
+;; Read an unsigned integer (of any size) from input stream: READ-UNSIGNED-INTEGER
+;; Write an unsigned integer (of any size) to output stream: WRITE-UNSIGNED-INTEGER
+;; Set assumed external byte order for input and output:  DEFINE-EXTERNAL-BYTE-ORDER
 
 (in-package :maxima)