The lisp-stat Reference Manual

This is the lisp-stat Reference Manual, version 1.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:02:55 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 lisp-stat

A statistical computing environment for Common Lisp

Long Name

Statistical Computing in Common Lisp

Author

Steve Nunez <>

Home Page

https://lisp-stat.dev/

Source Control

(GIT https://github.com/Lisp-Stat/lisp-stat.git)

Bug Tracker

https://github.com/Lisp-Stat/lisp-stat/issues

License

MS-PL

Long Description

The Lisp-Stat system is an umbrella for a few projects and provides a unified interface for working with statistics. The general rule is that Lisp-Stat may depend on other libraries, for example data-frame, but not the other way around. Lisp-Stat provides it’s own user package, LS-USER, which imports CL as well as the symbols we need from the other libraries. You should always do your work in the LS-USER package, and not in CL-USER.

Version

1.2.0

Dependencies
  • alexandria (system).
  • alexandria+ (system).
  • array-operations (system).
  • data-frame (system).
  • distributions (system).
  • dexador (system).
  • dfio (system).
  • num-utils (system).
  • select (system).
  • statistics (system).
  • org.tfeb.conduit-packages (system).
Source

lisp-stat.asd.

Child Components

3 Modules

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


3.1 lisp-stat/base

Source

lisp-stat.asd.

Parent Component

lisp-stat (system).

Child Component

variables.lisp (file).


3.2 lisp-stat/docs

Source

lisp-stat.asd.

Parent Component

lisp-stat (system).

Child Component

doc-strings.lisp (file).


4 Files

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


4.1 Lisp


4.1.1 lisp-stat/lisp-stat.asd

Source

lisp-stat.asd.

Parent Component

lisp-stat (system).

ASDF Systems

lisp-stat.


4.1.2 lisp-stat/pkgdcls.lisp

Source

lisp-stat.asd.

Parent Component

lisp-stat (system).

Packages

4.1.3 lisp-stat/base/variables.lisp

Source

lisp-stat.asd.

Parent Component

base (module).

Public Interface
Internals

4.1.4 lisp-stat/docs/doc-strings.lisp

Source

lisp-stat.asd.

Parent Component

docs (module).


4.1.5 lisp-stat/ls-init.lisp

Source

lisp-stat.asd.

Parent Component

lisp-stat (system).

Internals

setup-ls-translations (function).


4.2 Static


4.2.1 lisp-stat/license

Source

lisp-stat.asd.

Parent Component

lisp-stat (system).


5 Packages

Packages are listed by definition order.


5.1 lisp-stat

Source

pkgdcls.lisp.

Public Interface
Internals

5.2 ls-user

Source

pkgdcls.lisp.


6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: def (name value &optional documentation)

Define a data variable
VALUE is not evaluated and must be a symbol. Assigns the value of FORM to VALUE and adds VALUE to the list *VARIABLES* of def’ed variables. Returns VALUE. If VALUE is already bound and the global variable *ASK-ON-REDEFINE* is not nil then you are asked if you want to redefine the variable.

Package

lisp-stat.

Source

variables.lisp.


6.1.2 Ordinary functions

Function: savevar (vars file &optional suffix)

VARS is a symbol or a list of symbols. FILE is a string (or a symbol whose print name is used) not ending in SUFFIX (defaults to ".lisp"). The VARS and their current values are written to the file FILE.lisp in a form suitable for use with the load command. NOTE: Ensure VARS doesn’t contain CLOS objects that don’t have a SAVE-OBJ method. Example (savevar ’urban "urban")

Package

lisp-stat.

Source

variables.lisp.

Function: undef-var (v)

Remove V from the system
If V is the symbol of a defined variable the variable it is unbound and removed from the list of defined variables. If V is a list of variable names each is unbound and removed. Returns V. Example: (undef ’urban)

Package

lisp-stat.

Source

variables.lisp.

Function: variables ()

Returns a list of the names of all def’ed variables.

Package

lisp-stat.

Source

variables.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: *variables*
Package

lisp-stat.

Source

variables.lisp.


6.2.2 Ordinary functions

Function: setup-ls-translations ()
Package

lisp-stat.

Source

ls-init.lisp.


6.2.3 Generic functions

Generic Function: save-obj (data)

Save data object

Package

lisp-stat.

Source

variables.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*variables*: Private special variables

S
Special Variable, *variables*: Private special variables