[lisplab-cvs] r48 - doc/manual

Jørn Inge Vestgården jivestgarden at common-lisp.net
Mon Jun 1 18:41:36 UTC 2009


Author: jivestgarden
Date: Mon Jun  1 14:41:36 2009
New Revision: 48

Log:
backup

Modified:
   doc/manual/lisplab.texi

Modified: doc/manual/lisplab.texi
==============================================================================
--- doc/manual/lisplab.texi	(original)
+++ doc/manual/lisplab.texi	Mon Jun  1 14:41:36 2009
@@ -41,6 +41,20 @@
 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.
+The name Lisplab is inspired by Matlab and Lisplab offers 
+much of the same kind of programming style as Matlab, with high level
+manipulation of matrices. Contrary to Matlab, Lisplab can do a 
+lot other than just matrix manipulation because Lisplab is 
+based on Common Lisp. Hence, you get all 
+the benefits of programming in a lexically scoped, dynamic, and fast
+general purpose programming language, not bound to the idiom 
+of @i{everything's a matrix}. 
+
+Note that Lisplab is not unique in building Matlab-like 
+syntax on top of Common Lisp. Lisplab contains much code from 
+Matlisp, but has also a lot of new code, refactored 
+code and rewritten code. Other libraries of similar nature 
+are FEMLLISP and NLISP.
 
 
 @node Dependencies 
@@ -77,7 +91,6 @@
 @end enumerate
 
 
-
 @node Installing
 @chapter Installing
 Lisplab is ASDF installable, but the installations is 
@@ -114,10 +127,32 @@
 
 @node Tutorial
 @chapter Tutorial
+The main package of Lisplab is @i{lisplab}, with nickname @i{ll}.
+The tutorial assues that you are in the  @i{lisplab} package or 
+use it.
+
+ at section Naming conventions
+The matrix classes and constructors follow the naming convention
+from BLAS where you give names based on element type and 
+matrix structure. 
+
+The most used types are @i{f - float}, @i{d - double}, 
+ at i{c - complex float}, @i{z - complex double float}, 
+while for matrix structure @i{ge - general},  @i{di - diagonal}, 
+and many more. So @i{matrix-dge} is a general matrix 
+with double float elements, while @i{matrix-zge} is a 
+general matrix with complex double float elements.
+
+ at xref{Structure}, for more about the naming conventions
+of matrix structure. There you also see the naming conventions for 
+files. 
+ at section Basic algebra
 
-
+ at section Matrix classes
 
 @section Matrix construction
+Lisplab offers a very many ways to create a matrix.
+
 
 @section Matrix manipulation
 
@@ -131,6 +166,8 @@
 
 @section Package structure
 
+ at section The four levels, 0 -- 3. 
+
 @section Class structure
 
 




More information about the lisplab-cvs mailing list