[lisplab-cvs] r47 - doc/manual

[Jørn Inge Vestgården]

Author: jivestgarden
Date: Mon Jun  1 13:46:57 2009
New Revision: 47

Log:
Manaual. Unfinished but started

Added:
   doc/manual/
   doc/manual/lisplab.texi

Added: doc/manual/lisplab.texi
==============================================================================
--- (empty file)
+++ doc/manual/lisplab.texi	Mon Jun  1 13:46:57 2009
@@ -0,0 +1,147 @@
+\input texinfo   @c -*-texinfo-*-
+ at setfilename lisplab.info
+ at settitle Lisplab manual
+
+ at copying
+GPL 
+
+Copyright @copyright{} 2009 Jorn Inge Vestgaarden
+ at end copying
+
+ at titlepage
+ at title Lisplab manual
+     
+ at page
+ at vskip 0pt plus 1filll
+ at insertcopying
+ at end titlepage
+     
+ at contents
+
+ at ifnottex
+ at node Top
+ at top Lisplab manual
+     
+This is a short sample Texinfo file.
+ at end ifnottex
+     
+ at menu
+* Introduction::
+* Dependencies::
+* Installing::
+* Tutorial::
+* Structure::
+* Index::
+ at end menu
+
+ at c The body
+
+ at node Introduction
+ at chapter Introduction
+Lisplab is a mathematics library in Common Lisp. Common Lisp 
+is a general purpose programming. The purpose 
+of Lisplab is to specialize Common Lisp towards mathematics.
+
+
+ at node Dependencies 
+ at chapter Dependencies 
+Lisplab has been developed with SBCL, SLIME and ASDF on Linux,
+and there are yet unnecessary bindings to these platforms.
+ at enumerate
+ at item 
+Some of the optimized lisp code uses the SBCL macro 
+ at code{truly-the}. This must be dealt with. 
+
+ at item
+The FFTW FFI is only for SBCL.
+
+ at item
+The Matlisp FFI should be portable to other lisps and 
+Windows, but it has not been tested.
+
+ at end enumerate
+
+In order to enjoy the full power of Lisplab you 
+must install some foreign libraries. These are
+ at enumerate
+ at item 
+BLAS -- Basic Linear Algebra Subprograms. Preferably the Atlas build
+
+ at item 
+LAPACK -- Matrix library. Preferably the Atlas build
+
+
+ at item 
+FFTW -- The fastest Fast Fourier Transform available. 
+
+ at end enumerate
+
+
+
+ at node Installing
+ at chapter Installing
+Lisplab is ASDF installable, but the installations is 
+more complicated than most Common Lisp libraries because of 
+the external dependencies. Lisplab has of the following 
+ASDF systems
+ at enumerate
+ at item @emph{Lisplab} --
+the full Lisplab installation. 
+
+ at item @emph{Lisplab-base} -- 
+the part of Lisplab without external dependencies. It should run 
+on all platforms.
+
+ at item @emph{Lisplab-matlisp} --
+FFIs to BLAS and LAPACK. These are modified version from Matlisp.
+
+ at item @emph{Lisplab-fftw} --
+FFI to FFTW for Fast Fourier Transform.
+
+ at item Slatec -- 
+special functions, generated from Fortran by f2cl.
+Originally made for Maxima.
+
+ at item Quadpack -- 
+integration routines, generated from Fortran by f2cl.
+ at end enumerate
+
+The simplest way to install Lisplab is to load @code{start.lisp}.
+If you have problems loading, first look at @code{start.lisp} 
+and see if you can hack it.
+The foreign libraries are also loaded by ASDF and it takes 
+the file pathnames from the file @code{libs.lisp}.
+
+ at node Tutorial
+ at chapter Tutorial
+
+
+
+ at section Matrix construction
+
+ at section Matrix manipulation
+
+ at section Ordinary functions
+
+ at section Special functions
+
+
+ at node Structure
+ at chapter Structure
+
+ at section Package structure
+
+ at section Class structure
+
+
+
+
+ at c End stuff
+
+ at node Index
+ at unnumbered Index
+     
+ at printindex cp
+
+
+ at bye