Author: jivestgarden
Date: Sat Aug 8 08:20:02 2009
New Revision: 72
Log:
freeze manual
Modified:
doc/manual/Makefile
doc/manual/lisplab.texi
Modified: doc/manual/Makefile
==============================================================================
--- doc/manual/Makefile (original)
+++ doc/manual/Makefile Sat Aug 8 08:20:02 2009
@@ -1,9 +1,28 @@
source=lisplab.texi
-all: html
+default: html
+
+all: html pdf
html: $(source)
makeinfo --html $(source)
pdf: $(source)
- texi2pdf $(source)
\ No newline at end of file
+ texi2pdf $(source)
+
+clean:
+ -rm lisplab.aux
+ -rm lisplab.cp
+ -rm lisplab.fn
+ -rm lisplab.pg
+ -rm lisplab.log
+ -rm lisplab.ky
+ -rm lisplab.tp
+ -rm lisplab.toc
+ -rm lisplab.vr
+
+distclean: clean
+ -rm lisplab.pdf
+ -rm -r lisplab
+ -rm lisplab.html
+ -rm *~
Modified: doc/manual/lisplab.texi
==============================================================================
--- doc/manual/lisplab.texi (original)
+++ doc/manual/lisplab.texi Sat Aug 8 08:20:02 2009
@@ -22,7 +22,6 @@
@node Top
@top Lisplab manual
-This is a short sample Texinfo file.
@end ifnottex
@menu
@@ -37,9 +36,11 @@
@node Introduction
@chapter Introduction
-Lisplab is a mathematics library in Common Lisp and offers
-an easy-to-use and rich programming framework with linear algebra,
-Fast Fourier Transform, Special functions, Runge-Kutta solver,
+Lisplab is a mathematics library in Common Lisp. It is
+placed under the Gnu general public license and offers
+an easy-to-use and rich programming framework for mathematics,
+including linear algebra,
+Fast Fourier Transform, special functions, Runge-Kutta solver,
infix notation, and general matrix utility functions.
The name Lisplab is inspired by Matlab and Lisplab offers
much of the same kind of programming style as Matlab, with high level
@@ -54,10 +55,10 @@
integers, rationals, and lists.
Note that Lisplab is not unique in building Matlab-like
-syntax on top of Common Lisp. Lisplab contains code from
-Matlisp, but has also a lot of new code, refactored
-code and rewritten code. Other Common Lisp matrix libraries
-are Matlisp, Femlisp and NLISP.
+syntax on top of Common Lisp. Other Common Lisp matrix libraries
+are Matlisp, Femlisp and NLISP. Lisplab itself was
+started as a branch of Matlisp, but has now moved
+far from the original code mass.
@node Getting started
@@ -139,7 +140,7 @@
with double float elements, while @i{matrix-zge} is a
general matrix with complex double float elements.
@item
-The generic functions of the basic algebra start with period:
+The generic functions of the basic algebra start with a dot:
@code{.+}, @code{.-}, @code{.*}, @code{./}, @code{.^}, @code{.sin}
@code{.cos}, @code{.tan}, @code{.besj}, @code{.realpart}, etc.
These functions work on numbers as the non-dotted Common Lisp functions
@@ -159,13 +160,14 @@
@section Status - past and future
The purpose of Lisplab
is to provide a complete mathematics programming environment,
-not just linear algebra. Currently it contains a fairly
-large matrix manipulation basis and linear algebra,
+not just linear algebra. Currently it contains much
+matrix manipulation and linear algebra stuff,
as well as fast Fourier transform and special functions.
It lacks special matrices, such as diagonal, tridiagonal,
and sparse matrices.
-Lisplab started as a refactoring of Matlisp, but
+Lisplab started as a refactoring of Matlisp (To make my simulations
+run on Windows for my professor), but
I ended up by reimplementing most of it, keeping
only the interfaces to Blas and Lapack. Currently,
Lisplab and Matlisp have more or less the same functionality.
@@ -179,8 +181,7 @@
The future I will mainly do minor changes and bug-fixes,
since it now covers my basic needs. I will only add new
-modules when needed.
-
+modules when I personally needed them.
However, there are many exiting extensions that can be made,
such as
@@ -195,8 +196,7 @@
image processing or cryptography.
@item Interface to new foreign libraries, e.g. GSL.
@end itemize
-
-Please contact if you want to contribute.
+So it this sounds interesting, please contact if you want to contribute.
@node Tutorial
@@ -213,7 +213,7 @@
use it.
- at section Basic algebra
+ at section The dotted algebra
Central in Lisplab is an algebra with the functions
@code{.+}, @code{.-}, @code{.*}, @code{./}, and @code{.^}.
These are generalization of
@@ -484,6 +484,8 @@
These are:
@code{.sin}, @code{.cos}, @code{.sin}, @code{.tan},
@code{.sinh}, @code{.cosh}, @code{.sinh}, @code{.tanh},
+ at code{.asin}, @code{.acos}, @code{.asin}, @code{.atan},
+ at code{.asinh}, @code{.acosh}, @code{.asinh}, @code{.atanh},
@code{.conj},
@code{.realpart}, @code{.imagpart}, @code{.exp}, @code{.abs}.
@@ -492,7 +494,7 @@
@code{.besj}, @code{.besy},
@code{.besi}, @code{.besk},
@code{.besh1}, @code{.besh2},
- at code{.ai}.
+ at code{.ai}, @code{.gamma}.
@section Infix notation
Infix input is with the macro @code{w/infix},
@@ -515,7 +517,7 @@
@section Package structure
So far, there is only one main package, called, you might guess it:
@i{lisplab}. Except from that there are only a few special packages
-for generated code and FFIs: slatec, blas, and FFTW.
+for generated code and FFIs: Slatec, Blas, and FFTW.
@section The four levels, 0 -- 3.
Lisplab has a layered structure with four levels, 0 -- 3,
@@ -562,7 +564,7 @@
(non matrix code).
@section Class structure
-
+TODO