The nail Reference Manual

This is the nail Reference Manual, version 0.1.8, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 22:36:20 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 nail

library providing convenient functions for working with linalg, statistics and probability.

Author

Walpurgisnatch

License

MIT

Version

0.1.8

Dependencies
  • cl-ppcre (system).
  • eazy-gnuplot (system).
  • cl-reexport (system).
Source

nail.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 nail/src

Source

nail.asd.

Parent Component

nail (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 nail/nail.asd

Source

nail.asd.

Parent Component

nail (system).

ASDF Systems

nail.


4.1.2 nail/src/utils.lisp

Source

nail.asd.

Parent Component

src (module).

Packages

nail.utils.

Public Interface

4.1.3 nail/src/plotting.lisp

Source

nail.asd.

Parent Component

src (module).

Packages

nail.plotting.


4.1.4 nail/src/linalg.lisp

Dependency

utils.lisp (file).

Source

nail.asd.

Parent Component

src (module).

Packages

nail.linalg.

Public Interface
Internals

4.1.5 nail/src/statistics.lisp

Dependency

linalg.lisp (file).

Source

nail.asd.

Parent Component

src (module).

Packages

nail.statistics.

Public Interface
Internals

de-mean (function).


4.1.6 nail/src/nail.lisp

Dependency

statistics.lisp (file).

Source

nail.asd.

Parent Component

src (module).

Packages

nail.


5 Packages

Packages are listed by definition order.


5.1 nail

Source

nail.lisp.

Use List

5.2 nail.statistics

Source

statistics.lisp.

Use List
Public Interface
Internals

de-mean (function).


5.3 nail.linalg

Source

linalg.lisp.

Use List
Used By List

nail.statistics.

Public Interface
Internals

5.4 nail.plotting

Source

plotting.lisp.

Use List
  • common-lisp.
  • eazy-gnuplot.

5.5 nail.utils

Source

utils.lisp.

Use List

common-lisp.

Used By List
Public Interface

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Macros

Macro: list-or-car (&body body)
Package

nail.utils.

Source

utils.lisp.

Macro: make-vector (dim &key orientation data generator)
Package

nail.linalg.

Source

linalg.lisp.

Macro: mapcar-2 (fun arg list)
Package

nail.utils.

Source

utils.lisp.


6.1.2 Ordinary functions

Function: copy-matrix (m)
Package

nail.linalg.

Source

linalg.lisp.

Function: correlation (x y)
Package

nail.statistics.

Source

statistics.lisp.

Function: covariance (x y)
Package

nail.statistics.

Source

statistics.lisp.

Function: distance (v w)
Package

nail.linalg.

Source

linalg.lisp.

Function: dot (&rest vectors)
Package

nail.linalg.

Source

linalg.lisp.

Function: elt-random (list)
Package

nail.utils.

Source

utils.lisp.

Function: elt-randoms (list n)
Package

nail.utils.

Source

utils.lisp.

Function: find-all (fun list)
Package

nail.utils.

Source

utils.lisp.

Function: find-max (list)
Package

nail.utils.

Source

utils.lisp.

Function: find-min (list)
Package

nail.utils.

Source

utils.lisp.

Function: flatten (list &optional acc)
Package

nail.utils.

Source

utils.lisp.

Function: m+ (&rest matrices)
Package

nail.linalg.

Source

linalg.lisp.

Function: m- (&rest matrices)
Package

nail.linalg.

Source

linalg.lisp.

Function: magnitude (v)
Package

nail.linalg.

Source

linalg.lisp.

Function: mappend (fn list)
Package

nail.utils.

Source

utils.lisp.

Function: matrix-at (m i j)
Package

nail.linalg.

Source

linalg.lisp.

Function: (setf matrix-at) (m i j)
Package

nail.linalg.

Source

linalg.lisp.

Function: matrix-col (m j)
Package

nail.linalg.

Source

linalg.lisp.

Function: matrix-print (m)
Package

nail.linalg.

Source

linalg.lisp.

Function: matrix-row (m i)
Package

nail.linalg.

Source

linalg.lisp.

Function: mean (list)
Package

nail.statistics.

Source

statistics.lisp.

Function: median (list)
Package

nail.statistics.

Source

statistics.lisp.

Function: mult (&rest operands)
Package

nail.linalg.

Source

linalg.lisp.

Function: normalized (v)
Package

nail.linalg.

Source

linalg.lisp.

Function: parse-float (string)
Package

nail.utils.

Source

utils.lisp.

Function: quantile (list p)
Package

nail.statistics.

Source

statistics.lisp.

Function: random-range (min max)
Package

nail.utils.

Source

utils.lisp.

Function: range (max &key min step)
Package

nail.utils.

Source

utils.lisp.

Function: range-random (n min max)
Package

nail.utils.

Source

utils.lisp.

Function: round-to (float decimals)
Package

nail.utils.

Source

utils.lisp.

Function: sort-closest-to (list element)
Package

nail.utils.

Source

utils.lisp.

Function: standard-deviation (list)
Package

nail.statistics.

Source

statistics.lisp.

Function: sum-of-squares (v)
Package

nail.linalg.

Source

linalg.lisp.

Function: transpose (&rest lists)
Package

nail.utils.

Source

utils.lisp.

Function: transposed (m)
Package

nail.linalg.

Source

linalg.lisp.

Function: variance (list)
Package

nail.statistics.

Source

statistics.lisp.

Function: vec-length (v)
Package

nail.linalg.

Source

linalg.lisp.

Function: vec-x (v)
Package

nail.linalg.

Source

linalg.lisp.

Function: vec-y (v)
Package

nail.linalg.

Source

linalg.lisp.

Function: vec-z (v)
Package

nail.linalg.

Source

linalg.lisp.


6.1.3 Generic functions

Generic Function: m* (op1 op2)
Package

nail.linalg.

Source

linalg.lisp.

Methods
Method: m* ((a single-float) (b single-float))
Method: m* ((s single-float) (m matrix))
Method: m* ((m matrix) (s single-float))
Method: m* ((a matrix) (b matrix))

6.1.4 Standalone methods

Method: initialize-instance :after ((m matrix) &key generator)
Source

linalg.lisp.


6.1.5 Classes

Class: matrix
Package

nail.linalg.

Source

linalg.lisp.

Direct methods
Direct slots
Slot: rows
Initform

(error "no :rows specified")

Initargs

:rows

Readers

matrix-rows.

Writers

This slot is read-only.

Slot: cols
Initform

(error "no :cols specified")

Initargs

:cols

Readers

matrix-cols.

Writers

This slot is read-only.

Slot: data
Initargs

:data

Readers

matrix-data.

Writers

(setf matrix-data).


6.2 Internals


6.2.1 Macros

Macro: assert-same-dimensions (a b)
Package

nail.linalg.

Source

linalg.lisp.

Macro: def-elementwise-op-fun (name op)
Package

nail.linalg.

Source

linalg.lisp.

Macro: do-matrix ((m i j &optional elt) &body body)
Package

nail.linalg.

Source

linalg.lisp.


6.2.2 Ordinary functions

Function: cross (a b)
Package

nail.linalg.

Source

linalg.lisp.

Function: de-mean (list)
Package

nail.statistics.

Source

statistics.lisp.

Function: is-threedimensional-vector? (v)
Package

nail.linalg.

Source

linalg.lisp.

Function: scalar-multiply (v s)
Package

nail.linalg.

Source

linalg.lisp.


6.2.3 Generic functions

Generic Reader: matrix-cols (object)
Package

nail.linalg.

Methods
Reader Method: matrix-cols ((matrix matrix))

automatically generated reader method

Source

linalg.lisp.

Target Slot

cols.

Generic Reader: matrix-data (object)
Package

nail.linalg.

Methods
Reader Method: matrix-data ((matrix matrix))

automatically generated reader method

Source

linalg.lisp.

Target Slot

data.

Generic Writer: (setf matrix-data) (object)
Package

nail.linalg.

Methods
Writer Method: (setf matrix-data) ((matrix matrix))

automatically generated writer method

Source

linalg.lisp.

Target Slot

data.

Generic Reader: matrix-rows (object)
Package

nail.linalg.

Methods
Reader Method: matrix-rows ((matrix matrix))

automatically generated reader method

Source

linalg.lisp.

Target Slot

rows.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   I   L   M   N   P   Q   R   S   T   V  
Index Entry  Section

(
(setf matrix-at): Public ordinary functions
(setf matrix-data): Private generic functions
(setf matrix-data): Private generic functions

A
assert-same-dimensions: Private macros

C
copy-matrix: Public ordinary functions
correlation: Public ordinary functions
covariance: Public ordinary functions
cross: Private ordinary functions

D
de-mean: Private ordinary functions
def-elementwise-op-fun: Private macros
distance: Public ordinary functions
do-matrix: Private macros
dot: Public ordinary functions

E
elt-random: Public ordinary functions
elt-randoms: Public ordinary functions

F
find-all: Public ordinary functions
find-max: Public ordinary functions
find-min: Public ordinary functions
flatten: Public ordinary functions
Function, (setf matrix-at): Public ordinary functions
Function, copy-matrix: Public ordinary functions
Function, correlation: Public ordinary functions
Function, covariance: Public ordinary functions
Function, cross: Private ordinary functions
Function, de-mean: Private ordinary functions
Function, distance: Public ordinary functions
Function, dot: Public ordinary functions
Function, elt-random: Public ordinary functions
Function, elt-randoms: Public ordinary functions
Function, find-all: Public ordinary functions
Function, find-max: Public ordinary functions
Function, find-min: Public ordinary functions
Function, flatten: Public ordinary functions
Function, is-threedimensional-vector?: Private ordinary functions
Function, m+: Public ordinary functions
Function, m-: Public ordinary functions
Function, magnitude: Public ordinary functions
Function, mappend: Public ordinary functions
Function, matrix-at: Public ordinary functions
Function, matrix-col: Public ordinary functions
Function, matrix-print: Public ordinary functions
Function, matrix-row: Public ordinary functions
Function, mean: Public ordinary functions
Function, median: Public ordinary functions
Function, mult: Public ordinary functions
Function, normalized: Public ordinary functions
Function, parse-float: Public ordinary functions
Function, quantile: Public ordinary functions
Function, random-range: Public ordinary functions
Function, range: Public ordinary functions
Function, range-random: Public ordinary functions
Function, round-to: Public ordinary functions
Function, scalar-multiply: Private ordinary functions
Function, sort-closest-to: Public ordinary functions
Function, standard-deviation: Public ordinary functions
Function, sum-of-squares: Public ordinary functions
Function, transpose: Public ordinary functions
Function, transposed: Public ordinary functions
Function, variance: Public ordinary functions
Function, vec-length: Public ordinary functions
Function, vec-x: Public ordinary functions
Function, vec-y: Public ordinary functions
Function, vec-z: Public ordinary functions

G
Generic Function, (setf matrix-data): Private generic functions
Generic Function, m*: Public generic functions
Generic Function, matrix-cols: Private generic functions
Generic Function, matrix-data: Private generic functions
Generic Function, matrix-rows: Private generic functions

I
initialize-instance: Public standalone methods
is-threedimensional-vector?: Private ordinary functions

L
list-or-car: Public macros

M
m*: Public generic functions
m*: Public generic functions
m*: Public generic functions
m*: Public generic functions
m*: Public generic functions
m+: Public ordinary functions
m-: Public ordinary functions
Macro, assert-same-dimensions: Private macros
Macro, def-elementwise-op-fun: Private macros
Macro, do-matrix: Private macros
Macro, list-or-car: Public macros
Macro, make-vector: Public macros
Macro, mapcar-2: Public macros
magnitude: Public ordinary functions
make-vector: Public macros
mapcar-2: Public macros
mappend: Public ordinary functions
matrix-at: Public ordinary functions
matrix-col: Public ordinary functions
matrix-cols: Private generic functions
matrix-cols: Private generic functions
matrix-data: Private generic functions
matrix-data: Private generic functions
matrix-print: Public ordinary functions
matrix-row: Public ordinary functions
matrix-rows: Private generic functions
matrix-rows: Private generic functions
mean: Public ordinary functions
median: Public ordinary functions
Method, (setf matrix-data): Private generic functions
Method, initialize-instance: Public standalone methods
Method, m*: Public generic functions
Method, m*: Public generic functions
Method, m*: Public generic functions
Method, m*: Public generic functions
Method, matrix-cols: Private generic functions
Method, matrix-data: Private generic functions
Method, matrix-rows: Private generic functions
mult: Public ordinary functions

N
normalized: Public ordinary functions

P
parse-float: Public ordinary functions

Q
quantile: Public ordinary functions

R
random-range: Public ordinary functions
range: Public ordinary functions
range-random: Public ordinary functions
round-to: Public ordinary functions

S
scalar-multiply: Private ordinary functions
sort-closest-to: Public ordinary functions
standard-deviation: Public ordinary functions
sum-of-squares: Public ordinary functions

T
transpose: Public ordinary functions
transposed: Public ordinary functions

V
variance: Public ordinary functions
vec-length: Public ordinary functions
vec-x: Public ordinary functions
vec-y: Public ordinary functions
vec-z: Public ordinary functions


A.3 Variables

Jump to:   C   D   R   S  
Index Entry  Section

C
cols: Public classes

D
data: Public classes

R
rows: Public classes

S
Slot, cols: Public classes
Slot, data: Public classes
Slot, rows: Public classes