Commit 9f6f3dc2 authored by Liam M. Healy's avatar Liam M. Healy
Browse files

Sphinx documentation started

parent 004db63d
# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
# the i18n builder cannot share the environment and doctrees with the others
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
rm -rf $(BUILDDIR)/*
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
@echo "Build finished; now you can process the pickle files."
@echo "Build finished; now you can process the JSON files."
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Antik.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Antik.qhc"
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Antik"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Antik"
@echo "# devhelp"
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
@echo "Build finished. The text files are in $(BUILDDIR)/text."
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
@echo "The overview file is in $(BUILDDIR)/changes."
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: fc32d1fe8b49f8e52feb1a8f9b05aa34
tags: 645f666f9bcd5a90fca523b33c5a78b7
Elementary Mathematical Functions
Generic mathematical functions are provided so that they may be called on something other than numbers, such as grids. When called with CL numbers, they call the equivalent CL function.
.. cl:package:: antik
.. cl:function:: abs
.. cl:function:: acos
.. cl:function:: asin
.. cl:function:: atan
.. cl:function:: cosh
.. cl:function:: cos
.. cl:function:: exp
.. cl:function:: expt
.. cl:function:: floor
.. cl:function:: round
.. cl:function:: signum
.. cl:function:: sinh
.. cl:function:: sin
.. cl:function:: sqrt
.. cl:function:: tanh
.. cl:function:: tan
.. cl:function:: =
.. cl:function:: >=
.. cl:function:: >
.. cl:function:: <=
.. cl:function:: <
.. cl:function:: minusp
.. cl:function:: plusp
.. cl:function:: zerop
.. cl:function:: +
.. cl:function:: -
.. cl:function:: *
.. cl:function:: /
Introduction to Antik
Antik provides a foundation for scientific and engineering computation in Common Lisp. It is designed not only to facilitate numerical computations, but to permit the use of numerical computation libraries and the interchange of data and procedures, whether foreign (non-Lisp) or Lisp libraries. Notably, GSLL_ provides an interface to the GNU Scientific Library (GSL_) and is based on Antik.
Antik is designed and developed to provide a common foundation and interoperability between scientific, engineering and mathematical libraries, whether in Lisp or not. Interoperability means that objects created can easily be passed to one or more libraries, and libraries can be mixed and combined to solve a problem. It also means that names of like functions will be the same, differening only in the package. For example, if systems ``foo`` and ``bar`` both provide an LU decomposition, that function will be ``foo:lu-decomposition`` in one and ``bar:lu-decomposition`` in the other. Should a user wish to compare or switch libraries in such a function call, it is a simple matter of changing the package. If a whole library should be switched, the names can be used without a package prefix and the use-package form changed. This makes it easy to compare results, and select and mix the best libraries for a calculation.
.. _GSLL:
.. _GSL:
Systems and Packages
There are several ASDF systems_ that can be loaded,
- ``antik``
- ``science-data``
- ``physical-dimension``
- ``foreign-array``
- ``antik-base``
Except for ``antik``, each of these also loads the one listed after it; ``antik`` loads ``physical-dimension``. It also loads GSLL_. Most users should load these systems using Quicklisp_.
There are two Common Lisp packages_ defined by Antik, ``antik`` and ``grid``. Some functions defined by Antik are generalizations of functions befined by Common Lisp, so the name is chosen the same, but in one of the two new packages. Shadowing_ is used to make sure that reference to the symbol will use the Antik definition and not the CL definition.
There is one additional package defined for the user's convience, ``antik-user``, which uses_ and properly shadows all symbols but has no definitions initially. The function ``antik:make-user-package`` will make a new package with these features.
.. cl:package:: antik
.. cl:function:: make-user-package
.. _GSLL:
.. _quicklisp:
.. _systems:
.. _packages:
.. _shadowing:,shadow
.. _uses:,use
.. Antik documentation master file, created by
sphinx-quickstart on Sat Jan 3 15:51:23 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Antik's documentation!
.. toctree::
:maxdepth: 2
Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
These definitions are provided as a utility mainly for the Antik itself, but are available for users as well.
.. cl:package:: antik
.. cl:function:: all-same
.. cl:function:: stream-to-string
* basic.css
* ~~~~~~~~~
* Sphinx stylesheet -- basic theme.
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
div.related h3 {
display: none;
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
div.related li {
display: inline;
div.related li.right {
float: right;
margin-right: 5px;
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
div.sphinxsidebar ul {
list-style: none;
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
div.sphinxsidebar form {
margin-top: 10px;
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
div.sphinxsidebar #searchbox input[type="submit"] {
width: 30px;
img {
border: 0;
max-width: 100%;
/* -- search page ----------------------------------------------------------- */ {
margin: 10px 0 0 20px;
padding: 0;
} li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
} li a {
font-weight: bold;
} li div.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
ul.keywordmatches li.goodmatch a {
font-weight: bold;
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
table.contentstable p.biglink {
line-height: 150%;
a.biglink {
font-size: 1.3em;
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
table.indextable td {
text-align: left;
vertical-align: top;
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
table.indextable tr.pcap {
height: 10px;
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
/* -- general body styles --------------------------------------------------- */
a.headerlink {
visibility: hidden;
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink {
visibility: visible;
div.body p.caption {
text-align: inherit;
div.body td {
text-align: left;
.field-list ul {
padding-left: 1em;
.first {
margin-top: 0 !important;
p.rubric {
margin-top: 30px;
font-weight: bold;
img.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
img.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
.align-left {
text-align: left;
.align-center {
text-align: center;
.align-right {
text-align: right;
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px 7px 0 7px;
background-color: #ffe;
width: 40%;
float: right;
p.sidebar-title {
font-weight: bold;
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px 7px 0 7px;
margin: 10px 0 10px 0;
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
div.admonition dt {
font-weight: bold;
div.admonition dl {
margin-bottom: 0;
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
div.body p.centered {
text-align: center;
margin-top: 25px;
/* -- tables ---------------------------------------------------------------- */
table.docutils {
border: 0;
border-collapse: collapse;