The lisp-stat Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The lisp-stat Reference Manual

This is the lisp-stat Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:54:40 2021 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Contributors Forks Stargazers Issues MS-PL License LinkedIn

About the Project

Lisp-Stat provides support for vectorized mathematical operations, and a comprehensive set of statistical methods that are implemented using the latest numerical algorithms. In addition, Common Lisp provides a dynamic programming environment (REPL), an excellent object-oriented facility (CLOS) and meta-object protocol (MOP).

Lisp-Stat is fully functional today, and most of the XLISP-STAT libraries can be ported with the aid of a compatibility package XLS-compat. This gives Lisp-Stat a leg up on ecosystem development.

Built With

Getting Started

To get a local copy up and running follow these steps:

Prerequisites

An ANSI Common Lisp implementation. Developed and tested with SBCL and CCL.

Installation

  1. Clone the repository
    cd ~/quicklisp/local-projects &&
    git clone https://github.com/Lisp-Stat/lisp-stat.git
    
  2. Reset the ASDF source-registry to find the new system (from the REPL)
    (asdf:clear-source-registry)
    
  3. Load the system
    (ql:quickload :lisp-stat)
    

Usage

Create a data frame from a file named "computers.csv" on the local disk:

(defparameter *df* (csv-to-data-frame
		      (uiop:read-file-string "computers.csv")))

For more examples, please refer to the Documentation.

Roadmap

See the open issues for a list of proposed features (and known issues).

Resources

This system is part of the Lisp-Stat project; that should be your first stop for information. Also see the community page for more information.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Please see CONTRIBUTING for details on the code of conduct, and the process for submitting pull requests.

License

Distributed under the MS-PL License. See LICENSE for more information.

Contact

Project Link: https://github.com/lisp-stat/lisp-stat


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 lisp-stat

Author

Steve Nunez <steve@symbolics.tech>

License

MS-PL

Description

A statistical computing environment for Common Lisp

Version

1.0

Dependencies
Source

lisp-stat.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 lisp-stat/base

Parent

lisp-stat (system)

Location

base/

Components

Previous: , Up: Modules   [Contents][Index]

3.2 lisp-stat/docs

Parent

lisp-stat (system)

Location

docs/

Component

doc-strings.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Next: , Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 lisp-stat.asd

Location

lisp-stat.asd

Systems

lisp-stat (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 lisp-stat/pkgdcls.lisp

Parent

lisp-stat (system)

Location

pkgdcls.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 lisp-stat/ls-init.lisp

Parent

lisp-stat (system)

Location

ls-init.lisp

Exported Definitions

*ls-version* (special variable)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 lisp-stat/base/utilities.lisp

Parent

base (module)

Location

base/utilities.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 lisp-stat/base/variables.lisp

Dependency

utilities.lisp (file)

Parent

base (module)

Location

base/variables.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

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

Parent

docs (module)

Location

docs/doc-strings.lisp


Previous: , Up: Files   [Contents][Index]

4.2 Static


Previous: , Up: Static files   [Contents][Index]

4.2.1 lisp-stat/license

Parent

lisp-stat (system)

Location

/home/quickref/quicklisp/dists/quicklisp/software/lisp-stat-20210411-git/license (not found)


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 lisp-stat

Base functions and variables for Lisp-Stat

Source

pkgdcls.lisp (file)

Nickname

ls

Use List
Used By List

ls-user

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

5.2 ls-user

User package for Lisp-Stat

Source

pkgdcls.lisp (file)

Use List

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *ls-version*
Package

lisp-stat

Source

ls-init.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: def NAME VALUE &optional DOCUMENTATION

Args: (var form)
VAR is not evaluated and must be a symbol. Assigns the value of FORM to VAR and adds VAR to the list *VARIABLES* of def’ed variables. Returns VAR. If VAR 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 (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Functions

Function: savevar VARS FILE &optional SUFFIX

Args: (vars-symbol-or-list file-name-root &optional suffix-string) NOTE: Ensure vars doesn’t contain CLOS objects that don’t have a save method. VARS is a symbol or a list of symbols. FILE-NAME-ROOT 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-NAME-ROOT.lisp in a form suitable for use with the load command.

Package

lisp-stat

Source

variables.lisp (file)

Function: undef V

Args: (v)
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.

Package

lisp-stat

Source

variables.lisp (file)

Function: variables ()

Args:()
Returns a list of the names of all def’ed variables.

Package

lisp-stat

Source

variables.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *ask-on-redefine*
Package

lisp-stat

Source

variables.lisp (file)

Special Variable: *release-name*
Package

lisp-stat

Source

ls-init.lisp (file)

Special Variable: *variables*
Package

lisp-stat

Source

variables.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: setup-ls-translations ()
Package

lisp-stat

Source

ls-init.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Generic functions

Generic Function: save DATA

Save the data.

Package

lisp-stat

Source

variables.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   S  
Index Entry  Section

F
File, Lisp, lisp-stat.asd: The lisp-stat․asd file
File, Lisp, lisp-stat/base/utilities.lisp: The lisp-stat/base/utilities․lisp file
File, Lisp, lisp-stat/base/variables.lisp: The lisp-stat/base/variables․lisp file
File, Lisp, lisp-stat/docs/doc-strings.lisp: The lisp-stat/docs/doc-strings․lisp file
File, Lisp, lisp-stat/ls-init.lisp: The lisp-stat/ls-init․lisp file
File, Lisp, lisp-stat/pkgdcls.lisp: The lisp-stat/pkgdcls․lisp file
File, static, lisp-stat/license: The lisp-stat/license file

L
Lisp File, lisp-stat.asd: The lisp-stat․asd file
Lisp File, lisp-stat/base/utilities.lisp: The lisp-stat/base/utilities․lisp file
Lisp File, lisp-stat/base/variables.lisp: The lisp-stat/base/variables․lisp file
Lisp File, lisp-stat/docs/doc-strings.lisp: The lisp-stat/docs/doc-strings․lisp file
Lisp File, lisp-stat/ls-init.lisp: The lisp-stat/ls-init․lisp file
Lisp File, lisp-stat/pkgdcls.lisp: The lisp-stat/pkgdcls․lisp file
lisp-stat.asd: The lisp-stat․asd file
lisp-stat/base: The lisp-stat/base module
lisp-stat/base/utilities.lisp: The lisp-stat/base/utilities․lisp file
lisp-stat/base/variables.lisp: The lisp-stat/base/variables․lisp file
lisp-stat/docs: The lisp-stat/docs module
lisp-stat/docs/doc-strings.lisp: The lisp-stat/docs/doc-strings․lisp file
lisp-stat/license: The lisp-stat/license file
lisp-stat/ls-init.lisp: The lisp-stat/ls-init․lisp file
lisp-stat/pkgdcls.lisp: The lisp-stat/pkgdcls․lisp file

M
Module, lisp-stat/base: The lisp-stat/base module
Module, lisp-stat/docs: The lisp-stat/docs module

S
Static File, lisp-stat/license: The lisp-stat/license file

Jump to:   F   L   M   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   D   F   G   M   S   U   V  
Index Entry  Section

D
def: Exported macros

F
Function, savevar: Exported functions
Function, setup-ls-translations: Internal functions
Function, undef: Exported functions
Function, variables: Exported functions

G
Generic Function, save: Internal generic functions

M
Macro, def: Exported macros

S
save: Internal generic functions
savevar: Exported functions
setup-ls-translations: Internal functions

U
undef: Exported functions

V
variables: Exported functions

Jump to:   D   F   G   M   S   U   V  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*ask-on-redefine*: Internal special variables
*ls-version*: Exported special variables
*release-name*: Internal special variables
*variables*: Internal special variables

S
Special Variable, *ask-on-redefine*: Internal special variables
Special Variable, *ls-version*: Exported special variables
Special Variable, *release-name*: Internal special variables
Special Variable, *variables*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   L   P   S  
Index Entry  Section

L
lisp-stat: The lisp-stat system
lisp-stat: The lisp-stat package
ls-user: The ls-user package

P
Package, lisp-stat: The lisp-stat package
Package, ls-user: The ls-user package

S
System, lisp-stat: The lisp-stat system

Jump to:   L   P   S