Owlpack  -  version .9
----------------------


This package contains UNOFFICIAL Java versions of the LINPACK decomposition 
routines including Cholesky, QR, singular value, and LU along with all 
necessary sub-functions and associated functions.  It has been written in
differing levels of abstraction where NMatrix is the most abstract and 
FMatrix, DMatrix, and CMatrix (when finished) are more specialized.  NMatrix
returns the same values as the other three classes when used correctly.


WARNING!!
---------


1.)  This is version .9.  There are known bugs in some programs that will be 
corrected, and intended extensions will soon be added.
 	
BUGS:  The NMatrix class is not complete for LComplex numbers.  The singular
value decomposition, the Cholesky decomposition, and the QR decomposition 
do not work correctly when using LComplex.  Changes will be made to the files
NFull and NPoFull.  All LU decompositions work correctly, and NMatrix works 
correctly for all LFloat and LDouble numbers.  Correcting the flawed 
decompositions may require changing all LNumbers.  If any additional errors
are found please email them to Jeff Piper (jpiper@rice.edu).

EXTENSION:  The CDMatrix and CFMatrix classes will be added so that the 
collection is complete.  These classes are going to be simmilar to the 
DMatrix and FMatrix classes, but dealing with complex numbers.  

2.)  The commentary preceding some functions is not necessarily correct.
Changes in the internal representation of some Objects have removed or added
the necessity of some arguments.  Most of the commentary is a modified 
variation of that for linpack written in the original fortran code.  

3.)  If a method is not supported by a certain class, such as inverse() for
banded matrices, a new UnsupportedMethodException is thrown.

4.)  The directories oldstuff in DMatrix and FMatrix contain the _Util and 
_Matrix files that contain rolled loops.


DISCLAIMER OF WARRANTIES
------------------------


THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. 
THE AUTHOR/TRANSLATOR DOES NOT WARRANT, GUARANTEE OR MAKE ANY 
REPRESENTATIONS REGARDING THE SOFTWARE OR DOCUMENTATION IN TERMS 
OF THEIR CORRECTNESS, RELIABILITY, CURRENTNESS, OR OTHERWISE.
THE ENTIRE RISK AS TO THE RESULTS AND PERFORMANCE OF THE SOFTWARE 
IS ASSUMED BY YOU. IN NO CASE WILL ANY PARTY INVOLVED WITH THE
CREATION OR DISTRIBUTION OF THE SOFTWARE BE LIABLE FOR ANY DAMAGE 
THAT MAY RESULT FROM THE USE OF THIS SOFTWARE.


Documentation
-------------


The documentation for these functions is not complete, but calling most 
functions is simple because they take no arguments.  The calling sequence for
the more complex functions, such as the cholesky routines, can be found in 
the commentary preceding the functions.  


Installation
------------


In order to install and run OwlPack, first download the file OwlPack.tar.gz
from the directory /net/www1/users/zoran/public_html/OwlPack/ .  The 
recommended format is to create a OwlPack/ directory in your home directory
then create a src/ and build/ directory inside of it.  Inside the src/ 
directory and at the UNIX prompt type:

	gunzip OwlPack.tar.gz

This unzips the compressed file to a tar file which needs to be decompressed.
To decompress it type:

	tar -xf OwlPack.tar

The directory heirarchy is now created and the source is ready to be compiled.


Compilation
-----------


From your src/ directory the one-line command:

	javac -depend -d /home/jpiper/MyJavaLinpack/build edu/rice/linpack/
		util/Trig.java

will compile the file Trig.java.  This format will compile any file in your
directory.
To run the compiled files, the command

	java -classpath /usr/java/lib/classes.zip:/home/jpiper/MyJavaLinpack/
		build Tests.TNFull

will run the pre-compiled test TNFull.java located in the directory 
/home/OwlPack/src/Tests/TNFull.java.  


Support
-------


If you have any comments or questions about this software, or suggestions
for improvement, please contact me:

Jeff Piper
jpiper@rice.edu
713-630-8613


Last modified 9/2/98.
