The cl-iterative Reference Manual

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

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-iterative

Generic iterative algorithm with multiple controls

Author

Alexey Cherkaev (mobius-eng)

License

LGPLv3

Version

0.1.0

Dependencies
  • alexandria (system).
  • optima (system).
Source

cl-iterative.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-iterative/cl-iterative.asd

Source

cl-iterative.asd.

Parent Component

cl-iterative (system).

ASDF Systems

cl-iterative.


3.1.2 cl-iterative/package.lisp

Source

cl-iterative.asd.

Parent Component

cl-iterative (system).

Packages

3.1.3 cl-iterative/iterator.lisp

Dependency

package.lisp (file).

Source

cl-iterative.asd.

Parent Component

cl-iterative (system).

Public Interface
Internals

3.1.4 cl-iterative/cl-iterative.lisp

Dependency

iterator.lisp (file).

Source

cl-iterative.asd.

Parent Component

cl-iterative (system).

Public Interface
Internals

3.1.5 cl-iterative/iteratorex.lisp

Dependency

cl-iterative.lisp (file).

Source

cl-iterative.asd.

Parent Component

cl-iterative (system).

Public Interface

3.1.6 cl-iterative/cl-iterative-ex.lisp

Dependency

iteratorex.lisp (file).

Source

cl-iterative.asd.

Parent Component

cl-iterative (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 cl-iterative-ex

Upgrades controls from CL-ITERATIVE to work with ITERATOREX

Source

package.lisp.

Use List
Public Interface

4.2 cl-iterative

Control of computation flow and iterative algorithm

Source

package.lisp.

Use List
  • common-lisp.
  • optima.
Used By List
Public Interface
Internals

4.3 iteratorex

Extension of ITERATOR to annotate it with INFO

Source

package.lisp.

Use List
Public Interface

4.4 iterator

Computation flow

Source

package.lisp.

Use List
  • common-lisp.
  • optima.
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 Macros

Macro: define-simple-constructor (class (&rest args))

Make simple constuctor with boa arguments for CLASS

Package

cl-iterative.

Source

cl-iterative.lisp.


5.1.2 Ordinary functions

Function: ->continue (iterator &optional update-value-function)

Change status of the ITERATOR to :CONTINUE

Package

iterator.

Source

iterator.lisp.

Function: ->failed (iterator &optional update-value-function)

Change status of the ITERATOR to :FAILED

Package

iterator.

Source

iterator.lisp.

Function: ->finished (iterator &optional update-value-function)

Change status of the ITERATOR to :FINISHED

Package

iterator.

Source

iterator.lisp.

Function: add-info (&optional init-info)

Constructs ADD-INFO control

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Function: alter-value (function)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: bind (iterator &rest functions)

Propogates ITERATOR’s value through FUNCTIONS iff its status is :CONTINUE. Each function must accept iterator’s value and return a new iterator.

Package

iterator.

Source

iterator.lisp.

Function: change-status (iterator new-status &optional update-value-function)

Destructively change iterator’s status

Package

iterator.

Source

iterator.lisp.

Function: combine-controls (&rest controls)

Combine controls forming a generic control. Controls are applied in order they appear

Package

cl-iterative.

Source

cl-iterative.lisp.

Function: continue (val)

Make contine iterator

Package

iterator.

Source

iterator.lisp.

Function: continue-p (iterator)

Is ITERATOR :CONTINUE?

Package

iterator.

Source

iterator.lisp.

Function: control (init apply)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: converged-number (&optional tolerance)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: converged-number-with-id (&optional id tolerance)

Constructs CONVERGED-NUMBER-WITH-ID control

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Function: converged-value (close-p copy &optional final)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: converged-value-with-id (close-p copy &optional id final)

Constructs CONVERGED-VALUE-WITH-ID control

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Function: failed (val)

Make failed iterator

Package

iterator.

Source

iterator.lisp.

Function: failed-p (iterator)

Is ITERATOR :FAILED?

Package

iterator.

Source

iterator.lisp.

Function: failed-value (predicate &optional final)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: failed-value-with-id (predicate &optional id final)

Constructs FAILED-VALUE-WITH-ID control

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Function: finished (val)

Make finished iterator

Package

iterator.

Source

iterator.lisp.

Function: finished-p (iterator)

Is ITERATOR :FINISHED?

Package

iterator.

Source

iterator.lisp.

Function: finished-value (predicate &optional final)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: finished-value-with-id (predicate &optional id final)

Constructs FINIED-VALUE-WITH-ID control

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Function: fixed-point (function init-value &key pre-treat controls post-treat)

Fixed point method solving x=f(x) starting from x0.
CONTROL is an object implementing control protocol: INIT-CONTROL and APPLY-CONTROL.
FUNCTION might change INIT-VALUE destuctively
Returns (VALUES SOLUTION SOLVED-P INDICATOR), where
SOLUTION is the final result,
SOLVED-P is the indicator if the solution was reached successfully, INDICATOR is an extra indicator of what could have gone wrong.

Package

cl-iterative.

Source

cl-iterative.lisp.

Function: fmap (iterator &rest functions)

Update iterators value iff it is :CONTINUE

Package

iterator.

Source

iterator.lisp.

Function: iterate (y0 iter-computation &optional pre-treat post-treat)

Iteratively apply CONTROL to iterator Y0 until it finishes

Package

cl-iterative.

Source

cl-iterative.lisp.

Function: iterator (status value)

Constructs ITERATOR with given STATUS and VALUE

Package

iterator.

Source

iterator.lisp.

Function: limit-iterations (max &optional final)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: limit-iterations-with-id (max &optional id final)

Constructs LIMIT-ITERATIONS-WITH-ID control

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Function: log-computation (log-function)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: replace-value (iterator new-value)

Destrcutively change ITERATOR’s value

Package

iterator.

Source

iterator.lisp.

Function: update-value (iterator update-function &rest args)

Destructively update ITERATOR’s value

Package

iterator.

Source

iterator.lisp.

Function: upgrade (iterator &optional info)
Package

iteratorex.

Source

iteratorex.lisp.


5.1.3 Generic functions

Generic Function: apply-control (control value)

Apply CONTROL to a VALUE. CONTROL must return ITERATOR

Package

cl-iterative.

Source

cl-iterative.lisp.

Methods
Method: apply-control :after ((control control-with-id) (value iteratorex))
Source

cl-iterative-ex.lisp.

Method: apply-control ((control add-info) (val iteratorex))
Source

cl-iterative-ex.lisp.

Method: apply-control ((control add-info) (val iterator))
Source

cl-iterative-ex.lisp.

Method: apply-control ((control control) value)
Method: apply-control ((control alter-value) value)
Method: apply-control ((control converged-number) value)
Method: apply-control ((control converged-value) value)
Method: apply-control ((control log-computation) value)
Method: apply-control ((control limit-iterations) value)
Method: apply-control ((control change-status) value)
Method: apply-control (control value)
Generic Reader: control-apply-function (object)
Generic Writer: (setf control-apply-function) (object)
Package

cl-iterative.

Methods
Reader Method: control-apply-function ((control control))
Writer Method: (setf control-apply-function) ((control control))

A generic control apply function

Source

cl-iterative.lisp.

Target Slot

control-apply-function.

Generic Function: control-id (object)
Package

cl-iterative-ex.

Methods
Method: control-id (obj)
Source

cl-iterative-ex.lisp.

Reader Method: control-id ((control-with-id control-with-id))

automatically generated reader method

Source

cl-iterative-ex.lisp.

Target Slot

id.

Generic Reader: control-init-function (object)
Generic Writer: (setf control-init-function) (object)
Package

cl-iterative.

Methods
Reader Method: control-init-function ((control control))
Writer Method: (setf control-init-function) ((control control))

A generic control init function

Source

cl-iterative.lisp.

Target Slot

control-init-function.

Generic Function: fixed-point-result-indicator (iterator)

Returns the indicator of the cause of the final result

Package

cl-iterative.

Source

cl-iterative.lisp.

Methods
Method: fixed-point-result-indicator ((iterator iteratorex))
Source

cl-iterative-ex.lisp.

Method: fixed-point-result-indicator ((iterator iterator))
Generic Function: info (object)
Package

iteratorex.

Methods
Method: info ((obj iterator))
Source

iteratorex.lisp.

Reader Method: info ((iteratorex iteratorex))

automatically generated reader method

Source

iteratorex.lisp.

Target Slot

info.

Generic Writer: (setf info) (object)
Package

iteratorex.

Methods
Writer Method: (setf info) ((iteratorex iteratorex))

automatically generated writer method

Source

iteratorex.lisp.

Target Slot

info.

Generic Function: init-control (control init-value)

Initialize CONTROL using INIT-VALUE. Useful for stateful controls

Package

cl-iterative.

Source

cl-iterative.lisp.

Methods
Method: init-control ((control control) init-value)
Method: init-control ((control converged-number) init-value)
Method: init-control ((control converged-value) init-value)
Method: init-control ((control log-computation) init-value)
Method: init-control ((control limit-iterations) init-value)
Method: init-control (control init-value)
Generic Reader: init-info (object)
Package

cl-iterative-ex.

Methods
Reader Method: init-info ((add-info add-info))

automatically generated reader method

Source

cl-iterative-ex.lisp.

Target Slot

init-info.

Generic Function: push-info-p (object)
Package

cl-iterative-ex.

Methods
Method: push-info-p (obj)
Source

cl-iterative-ex.lisp.

Reader Method: push-info-p ((control-with-id control-with-id))

automatically generated reader method

Source

cl-iterative-ex.lisp.

Target Slot

push-info-p.

Generic Reader: status (object)
Generic Writer: (setf status) (object)
Package

iterator.

Methods
Reader Method: status ((iterator iterator))
Writer Method: (setf status) ((iterator iterator))

Iterator status: :continue :finished or :failed

Source

iterator.lisp.

Target Slot

status.

Generic Reader: value (object)
Generic Writer: (setf value) (object)
Package

iterator.

Methods
Reader Method: value ((iterator iterator))
Writer Method: (setf value) ((iterator iterator))

Iterator value

Source

iterator.lisp.

Target Slot

value.


5.1.4 Standalone methods

Method: change-class :after ((instance iterator) (new-class-name (eql iteratorex:iteratorex)) &rest initargs)
Source

iteratorex.lisp.

Method: print-object ((obj iteratorex) out)
Source

iteratorex.lisp.

Method: print-object ((obj iterator) out)
Source

iterator.lisp.


5.1.5 Classes

Class: add-info

Control that adds info to an iterator

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Direct methods
Direct slots
Slot: init-info
Initargs

:init-info

Readers

init-info.

Writers

This slot is read-only.

Class: alter-value

Control that alters the value if, for example, it is outside of some boundaries. The behaviour is control by FUNCTION.

Package

cl-iterative.

Source

cl-iterative.lisp.

Direct methods
Direct slots
Slot: alter-value-function

Function that alters the value. Must return ITERATOR

Initargs

:function

Readers

alter-value-function.

Writers

This slot is read-only.

Class: control

A generic control class. It is used to combine other controls.

Package

cl-iterative.

Source

cl-iterative.lisp.

Direct methods
Direct slots
Slot: control-init-function

A generic control init function

Initargs

:init

Readers

control-init-function.

Writers

(setf control-init-function).

Slot: control-apply-function

A generic control apply function

Initargs

:apply

Readers

control-apply-function.

Writers

(setf control-apply-function).

Class: control-with-id

Control mixin that adds ID to other controls

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

control-id.

Writers

This slot is read-only.

Slot: push-info-p
Initargs

:push-info-p

Readers

push-info-p.

Writers

This slot is read-only.

Class: converged-number

Control that will finish the computation if the number sequence converges. This is a simplified (for numbers) version of CONVERGED-VALUE

Package

cl-iterative.

Source

cl-iterative.lisp.

Direct subclasses

converged-number-with-id.

Direct methods
Direct slots
Slot: converged-number-tolerance

Absolute tolerance within which two numbers are considered to be the same

Initargs

:tolerance

Readers

converged-number-tolerance.

Writers

This slot is read-only.

Slot: converged-number-last

Internal storage of the previous item in the sequence

Readers

converged-number-last.

Writers

(setf converged-number-last).

Class: converged-number-with-id

Extension of CONVERGED-NUMBER with ID info

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Direct superclasses
Class: converged-value

Controls if the sequence of values is converged (Cauchy criteria) Since the value might change destructively, it requires COPY function to store the copy of the previous value in the sequence

Package

cl-iterative.

Source

cl-iterative.lisp.

Direct subclasses

converged-value-with-id.

Direct methods
Direct slots
Slot: converged-value-close-p

Predicate that checks if two values are close enough for the sequence to be considered convergent

Initargs

:close-p

Readers

converged-value-close-p.

Writers

This slot is read-only.

Slot: converged-value-copy

Reliably copy the value: the value itself might be
detroyed during the computation, this function must be able to copy it to reliably compare previus and current value in the sequence

Initargs

:copy

Readers

converged-value-copy.

Writers

This slot is read-only.

Slot: converged-value-final

Final function to apply to value once converged

Initargs

:final

Readers

converged-value-final.

Writers

This slot is read-only.

Slot: converged-value-last

Internal: stores the previous value (copied) of the sequence

Readers

converged-value-last.

Writers

(setf converged-value-last).

Class: converged-value-with-id

Extension of CONVERGED-VALUE with ID info

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Direct superclasses
Class: failed-value

Change computation to failed if predicate returns T

Package

cl-iterative.

Source

cl-iterative.lisp.

Direct superclasses

change-status.

Direct subclasses

failed-value-with-id.

Direct slots
Slot: change-status-target
Initform

(function iterator:->failed)

Class: failed-value-with-id

Extension of FAILED-VALUE with ID info

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Direct superclasses
Class: finished-value

Change computation to finish if predicate returns T

Package

cl-iterative.

Source

cl-iterative.lisp.

Direct superclasses

change-status.

Direct subclasses

finished-value-with-id.

Direct slots
Slot: change-status-target
Initform

(function iterator:->finished)

Class: finished-value-with-id

Extension of FINISHED-VALUE with ID info

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Direct superclasses
Class: iterator

Computation flow status

Package

iterator.

Source

iterator.lisp.

Direct subclasses

iteratorex.

Direct methods
Direct slots
Slot: status

Iterator status: :continue :finished or :failed

Initargs

:status

Readers

status.

Writers

(setf status).

Slot: value

Iterator value

Initargs

:value

Readers

value.

Writers

(setf value).

Class: iteratorex
Package

iteratorex.

Source

iteratorex.lisp.

Direct superclasses

iterator.

Direct methods
Direct slots
Slot: info
Readers

info.

Writers

(setf info).

Class: limit-iterations

Control that fails computation if it exceeds max number of evaluations

Package

cl-iterative.

Source

cl-iterative.lisp.

Direct subclasses

limit-iterations-with-id.

Direct methods
Direct slots
Slot: limit-iterations-max

Max number of evaluations permitted

Initargs

:max

Readers

limit-iterations-max.

Writers

This slot is read-only.

Slot: limit-iterations-final

Final function to apply to value once failed

Initargs

:final

Readers

limit-iterations-final.

Writers

This slot is read-only.

Slot: limit-iterations-performed

Internal storage of the number of evaluations already performed

Initform

0

Readers

limit-iterations-performed.

Writers

(setf limit-iterations-performed).

Class: limit-iterations-with-id

Extension of LIMIT-ITERATIONS with ID info

Package

cl-iterative-ex.

Source

cl-iterative-ex.lisp.

Direct superclasses
Class: log-computation

Control that logs the progress of computation

Package

cl-iterative.

Source

cl-iterative.lisp.

Direct methods
Direct slots
Slot: log-function

Function to log the computation process.
Accepts two arguments: (TAG VALUE)
TAG is either :INIT or :APPLY indicating at which point it was called VALUE is ITERATOR’s value passed.

Initargs

:log-function

Readers

log-function.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Ordinary functions

Function: iterator-p (obj)

Returns T if a given OBJ is ITERATOR

Package

iterator.

Source

iterator.lisp.

Function: reduce-list (function init-state list)

Reduce (fold left) LIST with FUNCTION starting from INIT-STATE. Supports shortcircuiting if FUNCTION returns REDUCED value

Package

cl-iterative.

Source

cl-iterative.lisp.

Function: reduced (x)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: reduced-p (x)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: reduced-value (x)
Package

cl-iterative.

Source

cl-iterative.lisp.

Function: status-p (obj status)

If OBJ is ITERATOR checks its STATUS

Package

iterator.

Source

iterator.lisp.


5.2.2 Generic functions

Generic Reader: alter-value-function (object)
Package

cl-iterative.

Methods
Reader Method: alter-value-function ((alter-value alter-value))

Function that alters the value. Must return ITERATOR

Source

cl-iterative.lisp.

Target Slot

alter-value-function.

Generic Reader: change-status-final (object)
Package

cl-iterative.

Methods
Reader Method: change-status-final ((change-status change-status))

Final transformation to apply to value once predicate is T

Source

cl-iterative.lisp.

Target Slot

change-status-final.

Generic Reader: change-status-pred (object)
Package

cl-iterative.

Methods
Reader Method: change-status-pred ((change-status change-status))

Predicate on the value of ITERATOR

Source

cl-iterative.lisp.

Target Slot

change-status-pred.

Generic Reader: change-status-target (object)
Package

cl-iterative.

Methods
Reader Method: change-status-target ((change-status change-status))

Function of iterator changing the status

Source

cl-iterative.lisp.

Target Slot

change-status-target.

Generic Reader: converged-number-last (object)
Generic Writer: (setf converged-number-last) (object)
Package

cl-iterative.

Methods
Reader Method: converged-number-last ((converged-number converged-number))
Writer Method: (setf converged-number-last) ((converged-number converged-number))

Internal storage of the previous item in the sequence

Source

cl-iterative.lisp.

Target Slot

converged-number-last.

Generic Reader: converged-number-tolerance (object)
Package

cl-iterative.

Methods
Reader Method: converged-number-tolerance ((converged-number converged-number))

Absolute tolerance within which two numbers are considered to be the same

Source

cl-iterative.lisp.

Target Slot

converged-number-tolerance.

Generic Reader: converged-value-close-p (object)
Package

cl-iterative.

Methods
Reader Method: converged-value-close-p ((converged-value converged-value))

Predicate that checks if two values are close enough for the sequence to be considered convergent

Source

cl-iterative.lisp.

Target Slot

converged-value-close-p.

Generic Reader: converged-value-copy (object)
Package

cl-iterative.

Methods
Reader Method: converged-value-copy ((converged-value converged-value))

Reliably copy the value: the value itself might be
detroyed during the computation, this function must be able to copy it to reliably compare previus and current value in the sequence

Source

cl-iterative.lisp.

Target Slot

converged-value-copy.

Generic Reader: converged-value-final (object)
Package

cl-iterative.

Methods
Reader Method: converged-value-final ((converged-value converged-value))

Final function to apply to value once converged

Source

cl-iterative.lisp.

Target Slot

converged-value-final.

Generic Reader: converged-value-last (object)
Generic Writer: (setf converged-value-last) (object)
Package

cl-iterative.

Methods
Reader Method: converged-value-last ((converged-value converged-value))
Writer Method: (setf converged-value-last) ((converged-value converged-value))

Internal: stores the previous value (copied) of the sequence

Source

cl-iterative.lisp.

Target Slot

converged-value-last.

Generic Reader: limit-iterations-final (object)
Package

cl-iterative.

Methods
Reader Method: limit-iterations-final ((limit-iterations limit-iterations))

Final function to apply to value once failed

Source

cl-iterative.lisp.

Target Slot

limit-iterations-final.

Generic Reader: limit-iterations-max (object)
Package

cl-iterative.

Methods
Reader Method: limit-iterations-max ((limit-iterations limit-iterations))

Max number of evaluations permitted

Source

cl-iterative.lisp.

Target Slot

limit-iterations-max.

Generic Reader: limit-iterations-performed (object)
Generic Writer: (setf limit-iterations-performed) (object)
Package

cl-iterative.

Methods
Reader Method: limit-iterations-performed ((limit-iterations limit-iterations))
Writer Method: (setf limit-iterations-performed) ((limit-iterations limit-iterations))

Internal storage of the number of evaluations already performed

Source

cl-iterative.lisp.

Target Slot

limit-iterations-performed.

Generic Reader: log-function (object)
Package

cl-iterative.

Methods
Reader Method: log-function ((log-computation log-computation))

Function to log the computation process.
Accepts two arguments: (TAG VALUE)
TAG is either :INIT or :APPLY indicating at which point it was called VALUE is ITERATOR’s value passed.

Source

cl-iterative.lisp.

Target Slot

log-function.


5.2.3 Classes

Class: change-status

Base class for control changing status based on predicate on value

Package

cl-iterative.

Source

cl-iterative.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: change-status-pred

Predicate on the value of ITERATOR

Initargs

:predicate

Readers

change-status-pred.

Writers

This slot is read-only.

Slot: change-status-final

Final transformation to apply to value once predicate is T

Initform

(function identity)

Initargs

:final

Readers

change-status-final.

Writers

This slot is read-only.

Slot: change-status-target

Function of iterator changing the status

Readers

change-status-target.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (   -  
A   B   C   D   F   G   I   L   M   P   R   S   U   V  
Index Entry  Section

(
(setf control-apply-function): Public generic functions
(setf control-apply-function): Public generic functions
(setf control-init-function): Public generic functions
(setf control-init-function): Public generic functions
(setf converged-number-last): Private generic functions
(setf converged-number-last): Private generic functions
(setf converged-value-last): Private generic functions
(setf converged-value-last): Private generic functions
(setf info): Public generic functions
(setf info): Public generic functions
(setf limit-iterations-performed): Private generic functions
(setf limit-iterations-performed): Private generic functions
(setf status): Public generic functions
(setf status): Public generic functions
(setf value): Public generic functions
(setf value): Public generic functions

-
->continue: Public ordinary functions
->failed: Public ordinary functions
->finished: Public ordinary functions

A
add-info: Public ordinary functions
alter-value: Public ordinary functions
alter-value-function: Private generic functions
alter-value-function: Private generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions
apply-control: Public generic functions

B
bind: Public ordinary functions

C
change-class: Public standalone methods
change-status: Public ordinary functions
change-status-final: Private generic functions
change-status-final: Private generic functions
change-status-pred: Private generic functions
change-status-pred: Private generic functions
change-status-target: Private generic functions
change-status-target: Private generic functions
combine-controls: Public ordinary functions
continue: Public ordinary functions
continue-p: Public ordinary functions
control: Public ordinary functions
control-apply-function: Public generic functions
control-apply-function: Public generic functions
control-id: Public generic functions
control-id: Public generic functions
control-id: Public generic functions
control-init-function: Public generic functions
control-init-function: Public generic functions
converged-number: Public ordinary functions
converged-number-last: Private generic functions
converged-number-last: Private generic functions
converged-number-tolerance: Private generic functions
converged-number-tolerance: Private generic functions
converged-number-with-id: Public ordinary functions
converged-value: Public ordinary functions
converged-value-close-p: Private generic functions
converged-value-close-p: Private generic functions
converged-value-copy: Private generic functions
converged-value-copy: Private generic functions
converged-value-final: Private generic functions
converged-value-final: Private generic functions
converged-value-last: Private generic functions
converged-value-last: Private generic functions
converged-value-with-id: Public ordinary functions

D
define-simple-constructor: Public macros

F
failed: Public ordinary functions
failed-p: Public ordinary functions
failed-value: Public ordinary functions
failed-value-with-id: Public ordinary functions
finished: Public ordinary functions
finished-p: Public ordinary functions
finished-value: Public ordinary functions
finished-value-with-id: Public ordinary functions
fixed-point: Public ordinary functions
fixed-point-result-indicator: Public generic functions
fixed-point-result-indicator: Public generic functions
fixed-point-result-indicator: Public generic functions
fmap: Public ordinary functions
Function, ->continue: Public ordinary functions
Function, ->failed: Public ordinary functions
Function, ->finished: Public ordinary functions
Function, add-info: Public ordinary functions
Function, alter-value: Public ordinary functions
Function, bind: Public ordinary functions
Function, change-status: Public ordinary functions
Function, combine-controls: Public ordinary functions
Function, continue: Public ordinary functions
Function, continue-p: Public ordinary functions
Function, control: Public ordinary functions
Function, converged-number: Public ordinary functions
Function, converged-number-with-id: Public ordinary functions
Function, converged-value: Public ordinary functions
Function, converged-value-with-id: Public ordinary functions
Function, failed: Public ordinary functions
Function, failed-p: Public ordinary functions
Function, failed-value: Public ordinary functions
Function, failed-value-with-id: Public ordinary functions
Function, finished: Public ordinary functions
Function, finished-p: Public ordinary functions
Function, finished-value: Public ordinary functions
Function, finished-value-with-id: Public ordinary functions
Function, fixed-point: Public ordinary functions
Function, fmap: Public ordinary functions
Function, iterate: Public ordinary functions
Function, iterator: Public ordinary functions
Function, iterator-p: Private ordinary functions
Function, limit-iterations: Public ordinary functions
Function, limit-iterations-with-id: Public ordinary functions
Function, log-computation: Public ordinary functions
Function, reduce-list: Private ordinary functions
Function, reduced: Private ordinary functions
Function, reduced-p: Private ordinary functions
Function, reduced-value: Private ordinary functions
Function, replace-value: Public ordinary functions
Function, status-p: Private ordinary functions
Function, update-value: Public ordinary functions
Function, upgrade: Public ordinary functions

G
Generic Function, (setf control-apply-function): Public generic functions
Generic Function, (setf control-init-function): Public generic functions
Generic Function, (setf converged-number-last): Private generic functions
Generic Function, (setf converged-value-last): Private generic functions
Generic Function, (setf info): Public generic functions
Generic Function, (setf limit-iterations-performed): Private generic functions
Generic Function, (setf status): Public generic functions
Generic Function, (setf value): Public generic functions
Generic Function, alter-value-function: Private generic functions
Generic Function, apply-control: Public generic functions
Generic Function, change-status-final: Private generic functions
Generic Function, change-status-pred: Private generic functions
Generic Function, change-status-target: Private generic functions
Generic Function, control-apply-function: Public generic functions
Generic Function, control-id: Public generic functions
Generic Function, control-init-function: Public generic functions
Generic Function, converged-number-last: Private generic functions
Generic Function, converged-number-tolerance: Private generic functions
Generic Function, converged-value-close-p: Private generic functions
Generic Function, converged-value-copy: Private generic functions
Generic Function, converged-value-final: Private generic functions
Generic Function, converged-value-last: Private generic functions
Generic Function, fixed-point-result-indicator: Public generic functions
Generic Function, info: Public generic functions
Generic Function, init-control: Public generic functions
Generic Function, init-info: Public generic functions
Generic Function, limit-iterations-final: Private generic functions
Generic Function, limit-iterations-max: Private generic functions
Generic Function, limit-iterations-performed: Private generic functions
Generic Function, log-function: Private generic functions
Generic Function, push-info-p: Public generic functions
Generic Function, status: Public generic functions
Generic Function, value: Public generic functions

I
info: Public generic functions
info: Public generic functions
info: Public generic functions
init-control: Public generic functions
init-control: Public generic functions
init-control: Public generic functions
init-control: Public generic functions
init-control: Public generic functions
init-control: Public generic functions
init-control: Public generic functions
init-info: Public generic functions
init-info: Public generic functions
iterate: Public ordinary functions
iterator: Public ordinary functions
iterator-p: Private ordinary functions

L
limit-iterations: Public ordinary functions
limit-iterations-final: Private generic functions
limit-iterations-final: Private generic functions
limit-iterations-max: Private generic functions
limit-iterations-max: Private generic functions
limit-iterations-performed: Private generic functions
limit-iterations-performed: Private generic functions
limit-iterations-with-id: Public ordinary functions
log-computation: Public ordinary functions
log-function: Private generic functions
log-function: Private generic functions

M
Macro, define-simple-constructor: Public macros
Method, (setf control-apply-function): Public generic functions
Method, (setf control-init-function): Public generic functions
Method, (setf converged-number-last): Private generic functions
Method, (setf converged-value-last): Private generic functions
Method, (setf info): Public generic functions
Method, (setf limit-iterations-performed): Private generic functions
Method, (setf status): Public generic functions
Method, (setf value): Public generic functions
Method, alter-value-function: Private generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, apply-control: Public generic functions
Method, change-class: Public standalone methods
Method, change-status-final: Private generic functions
Method, change-status-pred: Private generic functions
Method, change-status-target: Private generic functions
Method, control-apply-function: Public generic functions
Method, control-id: Public generic functions
Method, control-id: Public generic functions
Method, control-init-function: Public generic functions
Method, converged-number-last: Private generic functions
Method, converged-number-tolerance: Private generic functions
Method, converged-value-close-p: Private generic functions
Method, converged-value-copy: Private generic functions
Method, converged-value-final: Private generic functions
Method, converged-value-last: Private generic functions
Method, fixed-point-result-indicator: Public generic functions
Method, fixed-point-result-indicator: Public generic functions
Method, info: Public generic functions
Method, info: Public generic functions
Method, init-control: Public generic functions
Method, init-control: Public generic functions
Method, init-control: Public generic functions
Method, init-control: Public generic functions
Method, init-control: Public generic functions
Method, init-control: Public generic functions
Method, init-info: Public generic functions
Method, limit-iterations-final: Private generic functions
Method, limit-iterations-max: Private generic functions
Method, limit-iterations-performed: Private generic functions
Method, log-function: Private generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, push-info-p: Public generic functions
Method, push-info-p: Public generic functions
Method, status: Public generic functions
Method, value: Public generic functions

P
print-object: Public standalone methods
print-object: Public standalone methods
push-info-p: Public generic functions
push-info-p: Public generic functions
push-info-p: Public generic functions

R
reduce-list: Private ordinary functions
reduced: Private ordinary functions
reduced-p: Private ordinary functions
reduced-value: Private ordinary functions
replace-value: Public ordinary functions

S
status: Public generic functions
status: Public generic functions
status-p: Private ordinary functions

U
update-value: Public ordinary functions
upgrade: Public ordinary functions

V
value: Public generic functions
value: Public generic functions


A.3 Variables

Jump to:   A   C   I   L   P   S   V  
Index Entry  Section

A
alter-value-function: Public classes

C
change-status-final: Private classes
change-status-pred: Private classes
change-status-target: Public classes
change-status-target: Public classes
change-status-target: Private classes
control-apply-function: Public classes
control-init-function: Public classes
converged-number-last: Public classes
converged-number-tolerance: Public classes
converged-value-close-p: Public classes
converged-value-copy: Public classes
converged-value-final: Public classes
converged-value-last: Public classes

I
id: Public classes
info: Public classes
init-info: Public classes

L
limit-iterations-final: Public classes
limit-iterations-max: Public classes
limit-iterations-performed: Public classes
log-function: Public classes

P
push-info-p: Public classes

S
Slot, alter-value-function: Public classes
Slot, change-status-final: Private classes
Slot, change-status-pred: Private classes
Slot, change-status-target: Public classes
Slot, change-status-target: Public classes
Slot, change-status-target: Private classes
Slot, control-apply-function: Public classes
Slot, control-init-function: Public classes
Slot, converged-number-last: Public classes
Slot, converged-number-tolerance: Public classes
Slot, converged-value-close-p: Public classes
Slot, converged-value-copy: Public classes
Slot, converged-value-final: Public classes
Slot, converged-value-last: Public classes
Slot, id: Public classes
Slot, info: Public classes
Slot, init-info: Public classes
Slot, limit-iterations-final: Public classes
Slot, limit-iterations-max: Public classes
Slot, limit-iterations-performed: Public classes
Slot, log-function: Public classes
Slot, push-info-p: Public classes
Slot, status: Public classes
Slot, value: Public classes
status: Public classes

V
value: Public classes


A.4 Data types

Jump to:   A   C   F   I   L   P   S  
Index Entry  Section

A
add-info: Public classes
alter-value: Public classes

C
change-status: Private classes
cl-iterative: The cl-iterative system
cl-iterative: The cl-iterative package
cl-iterative-ex: The cl-iterative-ex package
cl-iterative-ex.lisp: The cl-iterative/cl-iterative-ex․lisp file
cl-iterative.asd: The cl-iterative/cl-iterative․asd file
cl-iterative.lisp: The cl-iterative/cl-iterative․lisp file
Class, add-info: Public classes
Class, alter-value: Public classes
Class, change-status: Private classes
Class, control: Public classes
Class, control-with-id: Public classes
Class, converged-number: Public classes
Class, converged-number-with-id: Public classes
Class, converged-value: Public classes
Class, converged-value-with-id: Public classes
Class, failed-value: Public classes
Class, failed-value-with-id: Public classes
Class, finished-value: Public classes
Class, finished-value-with-id: Public classes
Class, iterator: Public classes
Class, iteratorex: Public classes
Class, limit-iterations: Public classes
Class, limit-iterations-with-id: Public classes
Class, log-computation: Public classes
control: Public classes
control-with-id: Public classes
converged-number: Public classes
converged-number-with-id: Public classes
converged-value: Public classes
converged-value-with-id: Public classes

F
failed-value: Public classes
failed-value-with-id: Public classes
File, cl-iterative-ex.lisp: The cl-iterative/cl-iterative-ex․lisp file
File, cl-iterative.asd: The cl-iterative/cl-iterative․asd file
File, cl-iterative.lisp: The cl-iterative/cl-iterative․lisp file
File, iterator.lisp: The cl-iterative/iterator․lisp file
File, iteratorex.lisp: The cl-iterative/iteratorex․lisp file
File, package.lisp: The cl-iterative/package․lisp file
finished-value: Public classes
finished-value-with-id: Public classes

I
iterator: The iterator package
iterator: Public classes
iterator.lisp: The cl-iterative/iterator․lisp file
iteratorex: The iteratorex package
iteratorex: Public classes
iteratorex.lisp: The cl-iterative/iteratorex․lisp file

L
limit-iterations: Public classes
limit-iterations-with-id: Public classes
log-computation: Public classes

P
Package, cl-iterative: The cl-iterative package
Package, cl-iterative-ex: The cl-iterative-ex package
Package, iterator: The iterator package
Package, iteratorex: The iteratorex package
package.lisp: The cl-iterative/package․lisp file

S
System, cl-iterative: The cl-iterative system