README.md 1023 Bytes
Newer Older
Marco Antoniotti's avatar
Marco Antoniotti committed
1 2 3 4 5 6 7 8 9 10 11 12
Common Lisp Extension: Math
===========================
Copyright (c) 2018 Marco Antoniotti
See file COPYING for licensing information


DESCRIPTION
-----------

This library provides a layer of generic functions and some numerical
hooks that can be used to further "extend" Common Lisp mathematical
capabilities.
Marco Antoniotti's avatar
Marco Antoniotti committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

The symbols in the API are constants, mostly covering IEEE 754 names
and values, and generic functions of fixed arity.  These functions
usually come in two flavors: monadic and dyadic. They have names
following a simple scheme: monadic functions have a single dot
indicating the single argument, and dyadic ones have two, indicating
both arguments.

As an example:

* monadic minus: -.
* dyadic minus: .-.

All fixed arity generic functions also have an optional argument
possibly holding the resul.  This is ignored for simple arithmetic
results but is useful when writing, for example, matrix libraries that
must allocate the result, say, of a sum; one can pass the resulting
argument as the optional one.