Commit 2ea2bd70 authored by Liam M. Healy's avatar Liam M. Healy
Browse files

Update documentation for multiple systems

parent 579cf96b
......@@ -3,7 +3,10 @@ Antik: a Common Lisp library for computational mathematics, science, and enginee
Antik defines library functions for common mathematical operations used in science and engineering including arrays and physical (dimensioned) quantities. It is expressly designed to facilitate the interchange of data with foreign (that is, non-lisp) libraries. For example, GSLL, the GNU Scientific Library for Lisp, uses Antik.
There are several systems that comprise Antik and included in this repository:
1) antik-base, common definitions
2) grid, generalized arrays
3) foreign-array, grids whose content is in foreign memory
1) grid, generalized arrays
2) foreign-array, grids whose content is in foreign memory
3) input-output, getting data into and out of CL calculation sets
4) physical-dimension, quantities with physical properties (e.g., mass, length) and relationships
5) mathematics, various definitions for applied mathematics
In addition, there are other systems used internally.
No preview for this file type
......@@ -27,7 +27,7 @@
@include macros.texinfo
@copying
Copyright @copyright{} 2009, 2010, 2011 Liam M. Healy
Copyright @copyright{} 2009, 2010, 2011, 2013 Liam M. Healy
@end copying
@titlepage
......@@ -49,7 +49,7 @@ Copyright @copyright{} 2009, 2010, 2011 Liam M. Healy
* Numerical Output Format::
* Mathematical Utility::
* Three Dimensional Space::
* Higher::
* Mathematics::
* Internals::
* Download and installation::
* Copying this software::
......@@ -83,6 +83,16 @@ There is a package defined for users to use Antik, @code{antik-user}. All the a
@include include/fun-antik-make-user-package.texinfo
There are several (ASDF) systems that comprise Antik, and, those systems can be selectively loaded depending on the definitions needed. The systems of direct interest to most users are
@itemize
@item grid
@item foreign-array
@item input-output
@item physical-dimension
@item mathematics
@end itemize
There are various extensions/additions offered through the @code{asdf-system-connections} mechanism. In particular, if the system @code{lisp-unit} is loaded, then there are a number of regression tests available.
@node Mathematics, Organization of Computation, Introduction, Top
@chapter Mathematics
......@@ -183,6 +193,8 @@ Typically scientific and engineering computation starts with input values and co
This section will describe the definitions for organizing computations. At present very little is written; only @dfn{parameters} definitions exist, and these are likely to change.
Load the system @code{input-output} for these definitions.
@node Parameters, , Introduction to organization, Organization of Computation
@section Parameters
@cindex Parameters
......@@ -278,6 +290,8 @@ Current value is "xyz".
@node Introduction to grids, Creating a grid, Grids, Grids
@section Introduction to grids
Load the system @code{grid} for these definitions.
@menu
* The grid concept::
* Types of grids::
......@@ -338,6 +352,8 @@ There are some tests defined for these modules; to run the tests, make
sure that @command{asdf-system-connections} system is loaded before
anything else, and @command{lisp-unit} is loaded, then
@example
(in-package :antik)
(lisp-unit:run-tests)
(in-package :grid)
(lisp-unit:run-tests)
@end example
......@@ -427,7 +443,7 @@ or with @code{make-array}.
@cindex Vector, foreign
The @command{foreign-array} class
uses @url{http://common-lisp.net/project/cffi/,@command{CFFI}} to allow the use
of C arrays as grids.
of C arrays as grids. Load the system @code{foreign-array} to enable use of foreign arrays.
Classes of vectors and matrices are named by appending the element
type as hypenated words to "vector" or "matrix". The following table
......@@ -1146,6 +1162,8 @@ execution time when running this function:
The symbols defined for physical quantities are in the @code{antik}
@url{http://www.lispworks.com/documentation/HyperSpec/Body/11_aa.htm,package}.
Load the system @code{physical-dimension} for these definitions. If you wish to have the degree symbol, load the external system @code{cl-unicode}. If you need correct UT1, load the external system @code{drakma}. If you don't know what this is, you don't need it.
@node Physical dimension, Physical constants, Introduction to physical quantities, Physical Quantities
@section Physical dimension
......@@ -1470,11 +1488,12 @@ The function @code{nf} is provided to format numbers according to specific crite
@node Mathematical Utility, Three Dimensional Space, Numerical Output Format, Top
@chapter Mathematical Utility
This module has definitions for mathematical utilities.
This system has definitions for mathematical utilities.
@include include/fun-antik-angle-law-of-cosines.texinfo
@include include/fun-antik-prime-factors.texinfo
Load the system @code{mathematics} for these definitions.
@node Three Dimensional Space, Higher, Mathematical Utility, Top
@node Three Dimensional Space, Mathematics, Mathematical Utility, Top
@chapter Three Dimensional Space
This module has definitions related to Cartesian 3-space and rotations.
......@@ -1515,18 +1534,20 @@ This module has definitions related to Cartesian 3-space and rotations.
@include include/fun-antik-tait-bryan-angles.texinfo
@include include/fun-antik-tait-bryan-rotation.texinfo
@node Higher, Internals, Three Dimensional Space, Top
@chapter Higher
@node Mathematics, Internals, Three Dimensional Space, Top
@chapter Mathematics
@cindex GSLL
@cindex Higher mathematics using external libraries
These functions provide a more straightforward interface to foreign libraries like @url{http://common-lisp.net/project/gsll/,GSLL}. For example, GSLL supplies several functions to invert a matrix, but the function defined here @code{invert-matrix} uses LU decomposition with all the necessary preparation.
Load the systems @code{mathematics} and @code{GSLL} for these definitions.
@menu
* Linear Algebra::
* Optimization::
@end menu
@node Linear Algebra, Optimization, Higher, Higher
@node Linear Algebra, Optimization, Mathematics, Mathematics
@section Linear Algebra
@cindex Linear Algebra
@cindex GSLL
......@@ -1535,7 +1556,7 @@ These functions require that @url{http://common-lisp.net/project/gsll/,GSLL} be
@include include/fun-antik-determinant.texinfo
@include include/fun-antik-invert-matrix.texinfo
@node Optimization, , Linear Algebra, Higher
@node Optimization, , Linear Algebra, Mathematics
@section Optimization
@cindex Mathematical optimization
@cindex Optimization, mathematical
......@@ -1545,7 +1566,7 @@ These functions require that GSLL be loaded.
@include include/fun-antik-minimize-1d.texinfo
@include include/fun-antik-root-1d.texinfo
@node Internals, Download and installation, Higher, Top
@node Internals, Download and installation, Mathematics, Top
@chapter Internals
@cindex Internals of Antik
This chapter describes some of the designs used internally, for the benefit of those who wish to port libraries to use some of the definitions in Antik, or those who are merely curious. If you wish to simply use Antik, you can skip this chapter.
......
......@@ -9,7 +9,7 @@
<link rel="prev" href="Properties.html#Properties" title="Properties">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Making-physical-dimension-quantities.html#Making-physical-dimension-quantities" title="Making physical dimension quantities">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -9,7 +9,7 @@
<link rel="prev" href="Foreign-Library-Kit.html#Foreign-Library-Kit" title="Foreign Library Kit">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Efficiency.html#Efficiency" title="Efficiency">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Polar.html#Polar" title="Polar">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Functions-and-Macros.html#Functions-and-Macros" title="Functions and Macros">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Mapping.html#Mapping" title="Mapping">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Constants-and-Variables.html#Constants-and-Variables" title="Constants and Variables">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -9,7 +9,7 @@
<link rel="prev" href="Generic-Functions.html#Generic-Functions" title="Generic Functions">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -9,7 +9,7 @@
<link rel="prev" href="Condition.html#Condition" title="Condition">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -9,7 +9,7 @@
<link rel="next" href="Index.html#Index" title="Index">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Iterate.html#Iterate" title="Iterate">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Operations.html#Operations" title="Operations">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Time-arithmetic-and-time-intervals.html#Time-arithmetic-and-time-intervals" title="Time arithmetic and time intervals">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -10,7 +10,7 @@
<link rel="next" href="Systems-of-units.html#Systems-of-units" title="Systems of units">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -9,7 +9,7 @@
<link rel="next" href="Copying-this-software.html#Copying-this-software" title="Copying this software">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
......@@ -9,7 +9,7 @@
<link rel="prev" href="Capabilities-and-Internals.html#Capabilities-and-Internals" title="Capabilities and Internals">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2009, 2010, 2011 Liam M. Healy-->
Copyright (C) 2009, 2010, 2011, 2013 Liam M. Healy-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment