[lisplab-cvs] r62 - in doc: html manual

Mon Jul 20 19:23:18 UTC 2009

Author: jivestgarden
Date: Mon Jul 20 15:23:09 2009
New Revision: 62

Log:
manual and html

Added:
   doc/html/
   doc/html/index.html
Modified:
   doc/manual/lisplab.texi

Added: doc/html/index.html
==============================================================================

--- (empty file)
+++ doc/html/index.html	Mon Jul 20 15:23:09 2009
@@ -0,0 +1,86 @@
+<?xml version="1.0"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <title>LISPLAB project</title>
+ <link rel="stylesheet" type="text/css" href="style.css"/>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+</head>
+
+<body>
+ <div class="header">
+  <h1>LISPLAB</h1>
+  <h2>Mathematics library for Common Lisp</h2>
+ </div>
+
+ <h3>Introduction</h3>
+ <p>
+ Lisplab is a mathematics library in common lisp
+ released under the GNU General Public License (GPL). 
+ Lisplab is based on code from <a href=http://matlisp.sourceforge.net>Matlisp</a>
+ to interface Blas/Lapack for computations, but has also a lots 
+ of code written natively in Common Lisp in addition. The main purpose 
+ of the library is to integration various sources
+ of mathematical software to a convenient platform for computations. 
+ The sources of software include
+ <ul>
+  <li>Interfaces to BLAS and LAPACK.
+  <li>Interface to FFTW.
+  <li>Numerical integration from QUADPACK and F2CL.
+  <li>Special functions from SLATEC and F2CL. 
+  <li>A lot of additional routines, for linear algebra, IO, fft, etc. 
+ </ul>
+ </p>
+ <p>
+ The part of Lisplab which is most mature is the matrix and linear algebra, 
+ and these should  provide a good basis for matrix based modelling. 
+ The interfaces to Blas/Matlisp are only to low degree finished.
+ However, new methods here should be quite easily added. 
+ </p>
+
+ <h3>Documentation</h3>
+ Module documentation with <a href="http://common-lisp.net/project/tinaa/">Tinaa</a>
+is <a href="tinaa/index.html">here</a>.
+
+ <h3>Mailing Lists</h3>
+ <ul>
+  <li>
+   <a
+    href="http://www.common-lisp.net/mailman/listinfo/lisplab-devel">
+    lisplab-devel</a><br/>for developers</li>
+  <li>
+   <a
+    href="http://www.common-lisp.net/mailman/listinfo/lisplab-cvs">
+    lisplab-cvs</a><br/>CVS log feed.</li>
+  <li>
+   <a
+    href="http://www.common-lisp.net/mailman/listinfo/lisplab-announce">
+    lisplab-announce</a><br/>for announcements.</li>
+
+ </ul>
+
+ <h3>Download</h3>
+ <p>
+ This project has no stable releases. For latest unstable 
+ code please checkout from Subversion.
+ </p>
+
+ <h3>Subversion</h3>
+ <p>
+ You can get the latest version of the source code from subversion 
+ <pre>
+   svn checkout svn://common-lisp.net/project/lisplab/svn lisplab
+ </pre>
+ or browse it
+ <a href="http://common-lisp.net/websvn/listing.php?repname=lisplab&path=%2F&sc=0">here</a>. 
+ </p>
+   
+ <div class="footer">
+  <a href="mailto:jivestgarden at gmail.com">Jørn Inge Vestgården</a>, 28. Feb. 2008.
+ </div>
+ <div class="check">
+  <a href="http://validator.w3.org/check/referer">Valid XHTML 1.0 Strict</a>
+ </div>
+</body>
+</html>

Modified: doc/manual/lisplab.texi
==============================================================================
--- doc/manual/lisplab.texi	(original)
+++ doc/manual/lisplab.texi	Mon Jul 20 15:23:09 2009
@@ -440,19 +440,74 @@
 Some of the linear algebra functions also work for 
 general element matrices 
 @example
-
+LL> (let ((a (mat 'matrix-ge (1 0) (0 -1)))
+	  (b (col 'matrix-ge  1/2 2/3)))
+      (m* a b))
+#<MATRIX-GE  2x1
+1/2 
+-2/3 
+ @{B5DCC79@}>
+LL> (minv (mat 'matrix-ge (1 2)(-2 1)))
+#<MATRIX-GE  2x2
+1/5 -2/5 
+2/5 1/5 
+ @{BF68821@}>
 @end example 
 
 
 @section Matrix IO
+Delimited files are read with @code{dlmread}. Delimited files 
+are written with @code{dlmwrite}. You can also write matrices
+as images with @code{pgmwrite} and @code{pswrite}, writing 
+portable graymap and postscript respectively. 
+
+Note that the IO functions are currently in a poor state. 
 
 @section Matrices without store
+The class @code{function-matrix} implements matrices with 
+functions and has no store. 
+
+The contents can for example be given directly by a rule, 
+using the macro funmat
+ at example
+LL> (funmat '(2 2) (i j) (if (= i j) 1 0))
+#<FUNCTION-MATRIX  2x2
+1 0 
+0 1 
+ @{AC0F489@}>
+ at end example 
+The funmat (and its generalization @code{fmat} that creates any matrix type) 
+it also useful to create grids.
+
+Function matrices are also used to view a part or restructured other matrix
+with @code{view-matrix}, @code{view-col}, or @code{view-row}.
 
 @section Ordinary functions
+These are: 
+ at code{.sin}, @code{.cos}, @code{.sin}, @code{.tan},
+ at code{.sinh}, @code{.cosh}, @code{.sinh}, @code{.tanh},
+ at code{.conj},
+ at code{.realpart}, @code{.imagpart}, @code{.exp},  @code{.abs}.
+
+TODO: add the inverse functions. 
 
 @section Special functions
+These are: 
+ at code{.besj}, @code{.besy},
+ at code{.besi}, @code{.besk},
+ at code{.besh1}, @code{.besh2},
+ at code{.ai}.
 
 @section Infix notation
+Infix input is with the macro @code{w/infix}. 
+ at example
+(w/infix 
+      (let ((x 3)) 
+	(1 .+ 2 .* x)))
+ at end example
+The @code{w/infix} messes as little as possible with the Lisp
+semantics, so that if you have a lot of formulas just wrap all 
+of it inside the macro.
 
 
 @node Structure


