The cl-grnm Reference Manual

This is the cl-grnm Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:14:18 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-grnm

Grid Restrained Nelder-Mead, a multivariate rootfinder.

Author

Rigetti Computing and Mario S. Sommer

License

MIT (See LICENSE.txt)

Version

0.1.0

Source

cl-grnm.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-grnm/cl-grnm.asd

Source

cl-grnm.asd.

Parent Component

cl-grnm (system).

ASDF Systems

cl-grnm.

Packages

cl-grnm-asd.


3.1.2 cl-grnm/defpackage.lisp

Source

cl-grnm.asd.

Parent Component

cl-grnm (system).

Packages

cl-grnm.


3.1.3 cl-grnm/la.lisp

Dependency

defpackage.lisp (file).

Source

cl-grnm.asd.

Parent Component

cl-grnm (system).

Internals

3.1.4 cl-grnm/neldermead.lisp

Dependency

la.lisp (file).

Source

cl-grnm.asd.

Parent Component

cl-grnm (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-grnm-asd

Source

cl-grnm.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 cl-grnm

Source

defpackage.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: burmen-et-al-convergence-test (&key tol-x tol-f rel)
Package

cl-grnm.

Source

neldermead.lisp.

Function: grnm-optimize (objective-function initial-guess &key max-function-calls convergence-p verbose)
Package

cl-grnm.

Source

neldermead.lisp.

Function: initial-simplex (x0 &key displace)
Package

cl-grnm.

Source

neldermead.lisp.

Function: nm-optimize (objective-function initial-guess &key max-function-calls convergence-p verbose)
Package

cl-grnm.

Source

neldermead.lisp.

Function: pp-volume-test (cside)
Package

cl-grnm.

Source

neldermead.lisp.

Function: rosenbrock (v)
Package

cl-grnm.

Source

neldermead.lisp.

Function: standard-quadratic (v)
Package

cl-grnm.

Source

neldermead.lisp.


5.1.2 Standalone methods

Method: print-object ((s nm-simplex) stream)
Source

neldermead.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *biglambda*
Package

cl-grnm.

Source

neldermead.lisp.

Special Variable: *breakdown*
Package

cl-grnm.

Source

neldermead.lisp.

Special Variable: *psi*
Package

cl-grnm.

Source

neldermead.lisp.

Special Variable: *smalllambda*
Package

cl-grnm.

Source

neldermead.lisp.

Special Variable: *tau-a*
Package

cl-grnm.

Source

neldermead.lisp.

Special Variable: *tau-r*
Package

cl-grnm.

Source

neldermead.lisp.

Special Variable: *verbose-level*
Package

cl-grnm.

Source

neldermead.lisp.


5.2.2 Macros

Macro: with-matrix-dimensions (varforms &body body)
Package

cl-grnm.

Source

la.lisp.


5.2.3 Ordinary functions

Function: deep-shrink (f s g gamma_s convergence-p verbose)
Package

cl-grnm.

Source

neldermead.lisp.

Function: default-initial-simplex (x0)
Package

cl-grnm.

Source

neldermead.lisp.

Function: ip (v w &optional start)
Package

cl-grnm.

Source

la.lisp.

Function: make-matrix (m n)
Package

cl-grnm.

Source

la.lisp.

Function: make-vector (n &key initial-element)
Package

cl-grnm.

Source

la.lisp.

Function: nm-iteration (simplex f &key verbose gamma_reflect gamma_expand gamma_outer_contraction gamma_inner_contraction gamma_shrink)
Package

cl-grnm.

Source

neldermead.lisp.

Function: nm-iteration-burmen-et-al (simplex f grid &key verbose gamma_reflect gamma_expand gamma_outer_contraction gamma_inner_contraction)
Package

cl-grnm.

Source

neldermead.lisp.

Function: norm (v &optional start)
Package

cl-grnm.

Source

la.lisp.

Function: qr-factorization (mat &key with-q)
Package

cl-grnm.

Source

la.lisp.

Function: qrthing-closure (s n)
Package

cl-grnm.

Source

neldermead.lisp.

Function: regrid (g x1 dmin fkt)
Package

cl-grnm.

Source

neldermead.lisp.

Function: simplex-qr-thing (sidev)
Package

cl-grnm.

Source

neldermead.lisp.

Function: v*c (vector constant)
Package

cl-grnm.

Source

la.lisp.

Function: v+w*c (v w c)
Package

cl-grnm.

Source

la.lisp.


5.2.4 Generic functions

Generic Reader: best-before-reshape (object)
Package

cl-grnm.

Methods
Reader Method: best-before-reshape ((cached-simplex-data cached-simplex-data))

automatically generated reader method

Source

neldermead.lisp.

Target Slot

best-before-reshape.

Generic Writer: (setf best-before-reshape) (object)
Package

cl-grnm.

Methods
Writer Method: (setf best-before-reshape) ((cached-simplex-data cached-simplex-data))

automatically generated writer method

Source

neldermead.lisp.

Target Slot

best-before-reshape.

Generic Function: cached-slot (s slot computer)
Package

cl-grnm.

Methods
Method: cached-slot ((s nm-simplex) slot computer)
Source

neldermead.lisp.

Generic Reader: data (object)
Package

cl-grnm.

Methods
Reader Method: data ((nm-simplex nm-simplex))

automatically generated reader method

Source

neldermead.lisp.

Target Slot

data.

Generic Writer: (setf data) (object)
Package

cl-grnm.

Methods
Writer Method: (setf data) ((nm-simplex nm-simplex))

automatically generated writer method

Source

neldermead.lisp.

Target Slot

data.

Generic Reader: delta (object)
Package

cl-grnm.

Methods
Reader Method: delta ((grid grid))

automatically generated reader method

Source

neldermead.lisp.

Target Slot

delta.

Generic Writer: (setf delta) (object)
Package

cl-grnm.

Methods
Writer Method: (setf delta) ((grid grid))

automatically generated writer method

Source

neldermead.lisp.

Target Slot

delta.

Generic Function: dimension (s)
Package

cl-grnm.

Methods
Method: dimension ((s nm-simplex))
Source

neldermead.lisp.

Generic Reader: dmin (object)
Package

cl-grnm.

Methods
Reader Method: dmin ((cached-simplex-data cached-simplex-data))

automatically generated reader method

Source

neldermead.lisp.

Target Slot

dmin.

Generic Writer: (setf dmin) (object)
Package

cl-grnm.

Methods
Writer Method: (setf dmin) ((cached-simplex-data cached-simplex-data))

automatically generated writer method

Source

neldermead.lisp.

Target Slot

dmin.

Generic Reader: dv (object)
Package

cl-grnm.

Methods
Reader Method: dv ((cached-simplex-data cached-simplex-data))

automatically generated reader method

Source

neldermead.lisp.

Target Slot

dv.

Generic Writer: (setf dv) (object)
Package

cl-grnm.

Methods
Writer Method: (setf dv) ((cached-simplex-data cached-simplex-data))

automatically generated writer method

Source

neldermead.lisp.

Target Slot

dv.

Generic Function: fk (s k)
Package

cl-grnm.

Methods
Method: fk ((s nm-simplex) k)
Source

neldermead.lisp.

Generic Function: (setf fk) (s k)
Package

cl-grnm.

Methods
Method: (setf fk) ((s nm-simplex) k)
Source

neldermead.lisp.

Generic Reader: fx (object)
Package

cl-grnm.

Methods
Reader Method: fx ((nm-simplex nm-simplex))

automatically generated reader method

Source

neldermead.lisp.

Target Slot

fx.

Generic Writer: (setf fx) (object)
Package

cl-grnm.

Methods
Writer Method: (setf fx) ((nm-simplex nm-simplex))

automatically generated writer method

Source

neldermead.lisp.

Target Slot

fx.

Generic Reader: grid-z (object)
Package

cl-grnm.

Methods
Reader Method: grid-z ((grid grid))

automatically generated reader method

Source

neldermead.lisp.

Target Slot

z.

Generic Writer: (setf grid-z) (object)
Package

cl-grnm.

Methods
Writer Method: (setf grid-z) ((grid grid))

automatically generated writer method

Source

neldermead.lisp.

Target Slot

z.

Generic Function: improve (s x fx)
Package

cl-grnm.

Methods
Method: improve ((s nm-simplex) x fx)
Source

neldermead.lisp.

Generic Function: maybe-fill-simplex (s f)
Package

cl-grnm.

Methods
Method: maybe-fill-simplex ((s nm-simplex) f)
Source

neldermead.lisp.

Generic Function: maybe-reshape (s g ff &key force)
Package

cl-grnm.

Methods
Method: maybe-reshape ((s nm-simplex) (g grid) ff &key force)
Source

neldermead.lisp.

Generic Reader: pmap (object)
Package

cl-grnm.

Methods
Reader Method: pmap ((nm-simplex nm-simplex))

automatically generated reader method

Source

neldermead.lisp.

Target Slot

pmap.

Generic Writer: (setf pmap) (object)
Package

cl-grnm.

Methods
Writer Method: (setf pmap) ((nm-simplex nm-simplex))

automatically generated writer method

Source

neldermead.lisp.

Target Slot

pmap.

Generic Function: pseudopivot (s)
Package

cl-grnm.

Methods
Method: pseudopivot ((s nm-simplex))
Source

neldermead.lisp.

Generic Function: q-factor (s)
Package

cl-grnm.

Methods
Method: q-factor ((s nm-simplex))
Source

neldermead.lisp.

Generic Function: r-factor (s)
Package

cl-grnm.

Methods
Method: r-factor ((s nm-simplex))
Source

neldermead.lisp.

Generic Function: restrict (grid point)
Package

cl-grnm.

Methods
Method: restrict ((grid grid) point)
Source

neldermead.lisp.

Generic Function: side-vectors (s)
Package

cl-grnm.

Methods
Method: side-vectors ((s nm-simplex))
Source

neldermead.lisp.

Generic Function: sort-simplex (s)
Package

cl-grnm.

Methods
Method: sort-simplex ((s nm-simplex))
Source

neldermead.lisp.

Generic Reader: x (object)
Package

cl-grnm.

Methods
Reader Method: x ((nm-simplex nm-simplex))

automatically generated reader method

Source

neldermead.lisp.

Target Slot

x.

Generic Writer: (setf x) (object)
Package

cl-grnm.

Methods
Writer Method: (setf x) ((nm-simplex nm-simplex))

automatically generated writer method

Source

neldermead.lisp.

Target Slot

x.

Generic Function: xk (s k)
Package

cl-grnm.

Methods
Method: xk ((s nm-simplex) k)
Source

neldermead.lisp.

Generic Function: (setf xk) (s k)
Package

cl-grnm.

Methods
Method: (setf xk) ((s nm-simplex) k)
Source

neldermead.lisp.


5.2.5 Classes

Class: cached-simplex-data
Package

cl-grnm.

Source

neldermead.lisp.

Direct methods
Direct slots
Slot: pseudopivot
Slot: q-factor
Slot: side-vectors
Slot: r-factor
Slot: dv
Initargs

:dv

Readers

dv.

Writers

(setf dv).

Slot: dmin
Initargs

:dmin

Readers

dmin.

Writers

(setf dmin).

Slot: best-before-reshape
Initargs

:best-before-reshape

Readers

best-before-reshape.

Writers

(setf best-before-reshape).

Class: grid
Package

cl-grnm.

Source

neldermead.lisp.

Direct methods
Direct slots
Slot: z
Initargs

:z

Readers

grid-z.

Writers

(setf grid-z).

Slot: delta
Initargs

:delta

Readers

delta.

Writers

(setf delta).

Class: nm-simplex
Package

cl-grnm.

Source

neldermead.lisp.

Direct methods
Direct slots
Slot: x
Initargs

:x

Readers

x.

Writers

(setf x).

Slot: fx
Initargs

:fx

Readers

fx.

Writers

(setf fx).

Slot: pmap
Initargs

:pmap

Readers

pmap.

Writers

(setf pmap).

Slot: data
Readers

data.

Writers

(setf data).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   C   D   F   G   I   M   N   P   Q   R   S   V   W   X  
Index Entry  Section

(
(setf best-before-reshape): Private generic functions
(setf best-before-reshape): Private generic functions
(setf data): Private generic functions
(setf data): Private generic functions
(setf delta): Private generic functions
(setf delta): Private generic functions
(setf dmin): Private generic functions
(setf dmin): Private generic functions
(setf dv): Private generic functions
(setf dv): Private generic functions
(setf fk): Private generic functions
(setf fk): Private generic functions
(setf fx): Private generic functions
(setf fx): Private generic functions
(setf grid-z): Private generic functions
(setf grid-z): Private generic functions
(setf pmap): Private generic functions
(setf pmap): Private generic functions
(setf x): Private generic functions
(setf x): Private generic functions
(setf xk): Private generic functions
(setf xk): Private generic functions

B
best-before-reshape: Private generic functions
best-before-reshape: Private generic functions
burmen-et-al-convergence-test: Public ordinary functions

C
cached-slot: Private generic functions
cached-slot: Private generic functions

D
data: Private generic functions
data: Private generic functions
deep-shrink: Private ordinary functions
default-initial-simplex: Private ordinary functions
delta: Private generic functions
delta: Private generic functions
dimension: Private generic functions
dimension: Private generic functions
dmin: Private generic functions
dmin: Private generic functions
dv: Private generic functions
dv: Private generic functions

F
fk: Private generic functions
fk: Private generic functions
Function, burmen-et-al-convergence-test: Public ordinary functions
Function, deep-shrink: Private ordinary functions
Function, default-initial-simplex: Private ordinary functions
Function, grnm-optimize: Public ordinary functions
Function, initial-simplex: Public ordinary functions
Function, ip: Private ordinary functions
Function, make-matrix: Private ordinary functions
Function, make-vector: Private ordinary functions
Function, nm-iteration: Private ordinary functions
Function, nm-iteration-burmen-et-al: Private ordinary functions
Function, nm-optimize: Public ordinary functions
Function, norm: Private ordinary functions
Function, pp-volume-test: Public ordinary functions
Function, qr-factorization: Private ordinary functions
Function, qrthing-closure: Private ordinary functions
Function, regrid: Private ordinary functions
Function, rosenbrock: Public ordinary functions
Function, simplex-qr-thing: Private ordinary functions
Function, standard-quadratic: Public ordinary functions
Function, v*c: Private ordinary functions
Function, v+w*c: Private ordinary functions
fx: Private generic functions
fx: Private generic functions

G
Generic Function, (setf best-before-reshape): Private generic functions
Generic Function, (setf data): Private generic functions
Generic Function, (setf delta): Private generic functions
Generic Function, (setf dmin): Private generic functions
Generic Function, (setf dv): Private generic functions
Generic Function, (setf fk): Private generic functions
Generic Function, (setf fx): Private generic functions
Generic Function, (setf grid-z): Private generic functions
Generic Function, (setf pmap): Private generic functions
Generic Function, (setf x): Private generic functions
Generic Function, (setf xk): Private generic functions
Generic Function, best-before-reshape: Private generic functions
Generic Function, cached-slot: Private generic functions
Generic Function, data: Private generic functions
Generic Function, delta: Private generic functions
Generic Function, dimension: Private generic functions
Generic Function, dmin: Private generic functions
Generic Function, dv: Private generic functions
Generic Function, fk: Private generic functions
Generic Function, fx: Private generic functions
Generic Function, grid-z: Private generic functions
Generic Function, improve: Private generic functions
Generic Function, maybe-fill-simplex: Private generic functions
Generic Function, maybe-reshape: Private generic functions
Generic Function, pmap: Private generic functions
Generic Function, pseudopivot: Private generic functions
Generic Function, q-factor: Private generic functions
Generic Function, r-factor: Private generic functions
Generic Function, restrict: Private generic functions
Generic Function, side-vectors: Private generic functions
Generic Function, sort-simplex: Private generic functions
Generic Function, x: Private generic functions
Generic Function, xk: Private generic functions
grid-z: Private generic functions
grid-z: Private generic functions
grnm-optimize: Public ordinary functions

I
improve: Private generic functions
improve: Private generic functions
initial-simplex: Public ordinary functions
ip: Private ordinary functions

M
Macro, with-matrix-dimensions: Private macros
make-matrix: Private ordinary functions
make-vector: Private ordinary functions
maybe-fill-simplex: Private generic functions
maybe-fill-simplex: Private generic functions
maybe-reshape: Private generic functions
maybe-reshape: Private generic functions
Method, (setf best-before-reshape): Private generic functions
Method, (setf data): Private generic functions
Method, (setf delta): Private generic functions
Method, (setf dmin): Private generic functions
Method, (setf dv): Private generic functions
Method, (setf fk): Private generic functions
Method, (setf fx): Private generic functions
Method, (setf grid-z): Private generic functions
Method, (setf pmap): Private generic functions
Method, (setf x): Private generic functions
Method, (setf xk): Private generic functions
Method, best-before-reshape: Private generic functions
Method, cached-slot: Private generic functions
Method, data: Private generic functions
Method, delta: Private generic functions
Method, dimension: Private generic functions
Method, dmin: Private generic functions
Method, dv: Private generic functions
Method, fk: Private generic functions
Method, fx: Private generic functions
Method, grid-z: Private generic functions
Method, improve: Private generic functions
Method, maybe-fill-simplex: Private generic functions
Method, maybe-reshape: Private generic functions
Method, pmap: Private generic functions
Method, print-object: Public standalone methods
Method, pseudopivot: Private generic functions
Method, q-factor: Private generic functions
Method, r-factor: Private generic functions
Method, restrict: Private generic functions
Method, side-vectors: Private generic functions
Method, sort-simplex: Private generic functions
Method, x: Private generic functions
Method, xk: Private generic functions

N
nm-iteration: Private ordinary functions
nm-iteration-burmen-et-al: Private ordinary functions
nm-optimize: Public ordinary functions
norm: Private ordinary functions

P
pmap: Private generic functions
pmap: Private generic functions
pp-volume-test: Public ordinary functions
print-object: Public standalone methods
pseudopivot: Private generic functions
pseudopivot: Private generic functions

Q
q-factor: Private generic functions
q-factor: Private generic functions
qr-factorization: Private ordinary functions
qrthing-closure: Private ordinary functions

R
r-factor: Private generic functions
r-factor: Private generic functions
regrid: Private ordinary functions
restrict: Private generic functions
restrict: Private generic functions
rosenbrock: Public ordinary functions

S
side-vectors: Private generic functions
side-vectors: Private generic functions
simplex-qr-thing: Private ordinary functions
sort-simplex: Private generic functions
sort-simplex: Private generic functions
standard-quadratic: Public ordinary functions

V
v*c: Private ordinary functions
v+w*c: Private ordinary functions

W
with-matrix-dimensions: Private macros

X
x: Private generic functions
x: Private generic functions
xk: Private generic functions
xk: Private generic functions


A.3 Variables

Jump to:   *  
B   D   F   P   Q   R   S   X   Z  
Index Entry  Section

*
*biglambda*: Private special variables
*breakdown*: Private special variables
*psi*: Private special variables
*smalllambda*: Private special variables
*tau-a*: Private special variables
*tau-r*: Private special variables
*verbose-level*: Private special variables

B
best-before-reshape: Private classes

D
data: Private classes
delta: Private classes
dmin: Private classes
dv: Private classes

F
fx: Private classes

P
pmap: Private classes
pseudopivot: Private classes

Q
q-factor: Private classes

R
r-factor: Private classes

S
side-vectors: Private classes
Slot, best-before-reshape: Private classes
Slot, data: Private classes
Slot, delta: Private classes
Slot, dmin: Private classes
Slot, dv: Private classes
Slot, fx: Private classes
Slot, pmap: Private classes
Slot, pseudopivot: Private classes
Slot, q-factor: Private classes
Slot, r-factor: Private classes
Slot, side-vectors: Private classes
Slot, x: Private classes
Slot, z: Private classes
Special Variable, *biglambda*: Private special variables
Special Variable, *breakdown*: Private special variables
Special Variable, *psi*: Private special variables
Special Variable, *smalllambda*: Private special variables
Special Variable, *tau-a*: Private special variables
Special Variable, *tau-r*: Private special variables
Special Variable, *verbose-level*: Private special variables

X
x: Private classes

Z
z: Private classes