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

The fft Reference Manual

This is the fft Reference Manual, version 0.1.20110324, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:06:15 2024 GMT+0.

Next: Files, Previous: The fft Reference Manual, Up: The fft Reference Manual [Contents][Index]

1 Systems

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

fft

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

1.1 `fft`

Maintainer

Patrick Stein <pat@nklein.com>

Author

Patrick Stein <pat@nklein.com>

License

Public Domain

Version

0.1.20110324

Source

fft.asd.

Child Components

package.lisp (file).
utils.lisp (file).
fft.lisp (file).

Next: Packages, Previous: Systems, Up: The fft Reference Manual [Contents][Index]

2 Files

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

Lisp

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

Next: fft/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

2.1.1 `fft/fft.asd`

Source: fft.asd.
Parent Component: fft (system).
ASDF Systems: fft.

Next: fft/utils.lisp, Previous: fft/fft.asd, Up: Lisp [Contents][Index]

2.1.2 `fft/package.lisp`

Source: fft.asd.
Parent Component: fft (system).
Packages: fft.

Next: fft/fft.lisp, Previous: fft/package.lisp, Up: Lisp [Contents][Index]

2.1.3 `fft/utils.lisp`

Dependency

package.lisp (file).

Source

fft.asd.

Parent Component

fft (system).

Internals

*empty-array* (special variable).
copy-virtual-row (function).
length-type (type).
make-virtual-row (function).
next-row (function).
row-length (function).
(setf row-ref) (setf expander).
row-ref (function).
set-row-ref (function).
small-double-float (type).
virtual-row (function).
virtual-row (structure).
virtual-row-buffer (reader).
(setf virtual-row-buffer) (writer).
virtual-row-length (reader).
(setf virtual-row-length) (writer).
virtual-row-next (reader).
(setf virtual-row-next) (writer).
virtual-row-offset (reader).
(setf virtual-row-offset) (writer).
virtual-row-p (function).
virtual-row-span (reader).
(setf virtual-row-span) (writer).
vr-compile (macro).
vr-next-row (function).
vr-offset (function).
vr-span (function).

Previous: fft/utils.lisp, Up: Lisp [Contents][Index]

2.1.4 `fft/fft.lisp`

Dependencies

package.lisp (file).
utils.lisp (file).

Source

fft.asd.

Parent Component

fft (system).

Public Interface

fft (function).
ifft (function).

Internals

*fft-info* (special variable).
*ifft-info* (special variable).
array-to-row (function).
calculate-coefficients (function).
get-fft-buffers (function).
make-dst-buf (function).
multf (macro).
perform-fft (function).
row-to-array (function).
shift-samples (function).

Next: Definitions, Previous: Files, Up: The fft Reference Manual [Contents][Index]

3 Packages

Packages are listed by definition order.

fft

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

3.1 `fft`

Source

package.lisp.

Use List

common-lisp.

Public Interface

fft (function).
ifft (function).

Internals

*empty-array* (special variable).
*fft-info* (special variable).
*ifft-info* (special variable).
array-to-row (function).
calculate-coefficients (function).
copy-virtual-row (function).
get-fft-buffers (function).
length-type (type).
make-dst-buf (function).
make-virtual-row (function).
multf (macro).
next-row (function).
perform-fft (function).
row-length (function).
(setf row-ref) (setf expander).
row-ref (function).
row-to-array (function).
set-row-ref (function).
shift-samples (function).
small-double-float (type).
virtual-row (function).
virtual-row (structure).
virtual-row-buffer (reader).
(setf virtual-row-buffer) (writer).
virtual-row-length (reader).
(setf virtual-row-length) (writer).
virtual-row-next (reader).
(setf virtual-row-next) (writer).
virtual-row-offset (reader).
(setf virtual-row-offset) (writer).
virtual-row-p (function).
virtual-row-span (reader).
(setf virtual-row-span) (writer).
vr-compile (macro).
vr-next-row (function).
vr-offset (function).
vr-span (function).

Next: Indexes, Previous: Packages, Up: The fft Reference Manual [Contents][Index]

4 Definitions

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

Public Interface
Internals

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

4.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

4.1.1 Ordinary functions

Function: fft (src &optional dst) ¶

Package: fft.
Source: fft.lisp.

Function: ifft (src &optional dst) ¶

Package: fft.
Source: fft.lisp.

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

4.2 Internals

Special variables
Macros
Setf expanders
Ordinary functions
Structures
Types

Next: Macros, Previous: Internals, Up: Internals [Contents][Index]

4.2.1 Special variables

Special Variable: *empty-array* ¶

Package: fft.
Source: utils.lisp.

Special Variable: *fft-info* ¶

Package: fft.
Source: fft.lisp.

Special Variable: *ifft-info* ¶

Package: fft.
Source: fft.lisp.

Next: Setf expanders, Previous: Special variables, Up: Internals [Contents][Index]

4.2.2 Macros

Macro: multf (place &optional factor) ¶

Package: fft.
Source: fft.lisp.

Macro: vr-compile (form) ¶

Package: fft.
Source: utils.lisp.

Next: Ordinary functions, Previous: Macros, Up: Internals [Contents][Index]

4.2.3 Setf expanders

Setf Expander: (setf row-ref) (row index) ¶

Package: fft.
Source: utils.lisp.
Reader: row-ref (function).
Writer: set-row-ref (function).

Next: Structures, Previous: Setf expanders, Up: Internals [Contents][Index]

4.2.4 Ordinary functions

Function: array-to-row (array row &optional scale) ¶

Package: fft.
Source: fft.lisp.

Function: calculate-coefficients (coeffs inverse) ¶

Package: fft.
Source: fft.lisp.

Function: copy-virtual-row (instance) ¶

Package: fft.
Source: utils.lisp.

Function: get-fft-buffers (length inverse) ¶

Package: fft.
Source: fft.lisp.

Function: make-dst-buf (src dst) ¶

Package: fft.
Source: fft.lisp.

Function: make-virtual-row (&key length buffer offset span next) ¶

Package: fft.
Source: utils.lisp.

Function: next-row (row) ¶

Package: fft.
Source: utils.lisp.

Function: perform-fft (row &optional inverse) ¶

Package: fft.
Source: fft.lisp.

Function: row-length (row) ¶

Package: fft.
Source: utils.lisp.

Function: row-ref (row index) ¶

Package: fft.
Source: utils.lisp.
Setf expander for this function: (setf row-ref).

Function: row-to-array (row array) ¶

Package: fft.
Source: fft.lisp.

Function: set-row-ref (row index value) ¶

Package: fft.
Source: utils.lisp.
Setf expanders to this function: (setf row-ref).

Function: shift-samples (row) ¶

Package: fft.
Source: fft.lisp.

Function: virtual-row (buffer &optional dimension pre post) ¶

Package: fft.
Source: utils.lisp.

Reader: virtual-row-buffer (instance) ¶

Writer: (setf virtual-row-buffer) (instance) ¶

Package: fft.
Source: utils.lisp.
Target Slot: buffer.

Reader: virtual-row-length (instance) ¶

Writer: (setf virtual-row-length) (instance) ¶

Package: fft.
Source: utils.lisp.
Target Slot: length.

Reader: virtual-row-next (instance) ¶

Writer: (setf virtual-row-next) (instance) ¶

Package: fft.
Source: utils.lisp.
Target Slot: next.

Reader: virtual-row-offset (instance) ¶

Writer: (setf virtual-row-offset) (instance) ¶

Package: fft.
Source: utils.lisp.
Target Slot: offset.

Function: virtual-row-p (object) ¶

Package: fft.
Source: utils.lisp.

Reader: virtual-row-span (instance) ¶

Writer: (setf virtual-row-span) (instance) ¶

Package: fft.
Source: utils.lisp.
Target Slot: span.

Function: vr-next-row (buffer pre post) ¶

Package: fft.
Source: utils.lisp.

Function: vr-offset (buffer pre post &optional index) ¶

Package: fft.
Source: utils.lisp.

Function: vr-span (buffer pre post) ¶

Package: fft.
Source: utils.lisp.

Next: Types, Previous: Ordinary functions, Up: Internals [Contents][Index]

4.2.5 Structures

Structure: virtual-row ¶

Package

fft.

Source

utils.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: length ¶

Package: common-lisp.
Type: fft::length-type
Initform: 0
Readers: virtual-row-length.
Writers: (setf virtual-row-length).

Slot: buffer ¶

Type: (simple-array (complex double-float) *)
Initform: fft::*empty-array*
Readers: virtual-row-buffer.
Writers: (setf virtual-row-buffer).

Slot: offset ¶

Type: fft::length-type
Initform: 0
Readers: virtual-row-offset.
Writers: (setf virtual-row-offset).

Slot: span ¶

Type: fft::length-type
Initform: 0
Readers: virtual-row-span.
Writers: (setf virtual-row-span).

Slot: next ¶

Readers: virtual-row-next.
Writers: (setf virtual-row-next).

Previous: Structures, Up: Internals [Contents][Index]

4.2.6 Types

Type: length-type () ¶

Package: fft.
Source: utils.lisp.

Type: small-double-float () ¶

Package: fft.
Source: utils.lisp.

Previous: Definitions, Up: The fft Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	( A C F G I M N P R S V

	Index Entry	Section

(
	`(setf row-ref)`:	Private setf expanders
	`(setf virtual-row-buffer)`:	Private ordinary functions
	`(setf virtual-row-length)`:	Private ordinary functions
	`(setf virtual-row-next)`:	Private ordinary functions
	`(setf virtual-row-offset)`:	Private ordinary functions
	`(setf virtual-row-span)`:	Private ordinary functions

A
	`array-to-row`:	Private ordinary functions

C
	`calculate-coefficients`:	Private ordinary functions
	`copy-virtual-row`:	Private ordinary functions

F
	`fft`:	Public ordinary functions
	`Function, (setf virtual-row-buffer)`:	Private ordinary functions
	`Function, (setf virtual-row-length)`:	Private ordinary functions
	`Function, (setf virtual-row-next)`:	Private ordinary functions
	`Function, (setf virtual-row-offset)`:	Private ordinary functions
	`Function, (setf virtual-row-span)`:	Private ordinary functions
	`Function, array-to-row`:	Private ordinary functions
	`Function, calculate-coefficients`:	Private ordinary functions
	`Function, copy-virtual-row`:	Private ordinary functions
	`Function, fft`:	Public ordinary functions
	`Function, get-fft-buffers`:	Private ordinary functions
	`Function, ifft`:	Public ordinary functions
	`Function, make-dst-buf`:	Private ordinary functions
	`Function, make-virtual-row`:	Private ordinary functions
	`Function, next-row`:	Private ordinary functions
	`Function, perform-fft`:	Private ordinary functions
	`Function, row-length`:	Private ordinary functions
	`Function, row-ref`:	Private ordinary functions
	`Function, row-to-array`:	Private ordinary functions
	`Function, set-row-ref`:	Private ordinary functions
	`Function, shift-samples`:	Private ordinary functions
	`Function, virtual-row`:	Private ordinary functions
	`Function, virtual-row-buffer`:	Private ordinary functions
	`Function, virtual-row-length`:	Private ordinary functions
	`Function, virtual-row-next`:	Private ordinary functions
	`Function, virtual-row-offset`:	Private ordinary functions
	`Function, virtual-row-p`:	Private ordinary functions
	`Function, virtual-row-span`:	Private ordinary functions
	`Function, vr-next-row`:	Private ordinary functions
	`Function, vr-offset`:	Private ordinary functions
	`Function, vr-span`:	Private ordinary functions

G
	`get-fft-buffers`:	Private ordinary functions

I
	`ifft`:	Public ordinary functions

M
	`Macro, multf`:	Private macros
	`Macro, vr-compile`:	Private macros
	`make-dst-buf`:	Private ordinary functions
	`make-virtual-row`:	Private ordinary functions
	`multf`:	Private macros

N
	`next-row`:	Private ordinary functions

P
	`perform-fft`:	Private ordinary functions

R
	`row-length`:	Private ordinary functions
	`row-ref`:	Private ordinary functions
	`row-to-array`:	Private ordinary functions

S
	`set-row-ref`:	Private ordinary functions
	`Setf Expander, (setf row-ref)`:	Private setf expanders
	`shift-samples`:	Private ordinary functions

V
	`virtual-row`:	Private ordinary functions
	`virtual-row-buffer`:	Private ordinary functions
	`virtual-row-length`:	Private ordinary functions
	`virtual-row-next`:	Private ordinary functions
	`virtual-row-offset`:	Private ordinary functions
	`virtual-row-p`:	Private ordinary functions
	`virtual-row-span`:	Private ordinary functions
	`vr-compile`:	Private macros
	`vr-next-row`:	Private ordinary functions
	`vr-offset`:	Private ordinary functions
	`vr-span`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* B L N O S

	Index Entry	Section

*
	`empty-array`:	Private special variables
	`fft-info`:	Private special variables
	`ifft-info`:	Private special variables

B
	`buffer`:	Private structures

L
	`length`:	Private structures

N
	`next`:	Private structures

O
	`offset`:	Private structures

S
	`Slot, buffer`:	Private structures
	`Slot, length`:	Private structures
	`Slot, next`:	Private structures
	`Slot, offset`:	Private structures
	`Slot, span`:	Private structures
	`span`:	Private structures
	`Special Variable, empty-array`:	Private special variables
	`Special Variable, fft-info`:	Private special variables
	`Special Variable, ifft-info`:	Private special variables

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

A.4 Data types

Jump to:	F L P S T U V

	Index Entry	Section

F
	`fft`:	The fft system
	`fft`:	The fft package
	`fft.asd`:	The fft/fft․asd file
	`fft.lisp`:	The fft/fft․lisp file
	`File, fft.asd`:	The fft/fft․asd file
	`File, fft.lisp`:	The fft/fft․lisp file
	`File, package.lisp`:	The fft/package․lisp file
	`File, utils.lisp`:	The fft/utils․lisp file

L
	`length-type`:	Private types

P
	`Package, fft`:	The fft package
	`package.lisp`:	The fft/package․lisp file

S
	`small-double-float`:	Private types
	`Structure, virtual-row`:	Private structures
	`System, fft`:	The fft system

T
	`Type, length-type`:	Private types
	`Type, small-double-float`:	Private types

U
	`utils.lisp`:	The fft/utils․lisp file

V
	`virtual-row`:	Private structures

The fft Reference Manual

Table of Contents

1 Systems

1.1 fft

2 Files

2.1 Lisp

2.1.1 fft/fft.asd

2.1.2 fft/package.lisp

2.1.3 fft/utils.lisp

2.1.4 fft/fft.lisp

3 Packages

3.1 fft

4 Definitions

4.1 Public Interface

4.1.1 Ordinary functions

4.2 Internals

4.2.1 Special variables

4.2.2 Macros

4.2.3 Setf expanders

4.2.4 Ordinary functions

4.2.5 Structures

4.2.6 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `fft`

2.1.1 `fft/fft.asd`

2.1.2 `fft/package.lisp`

2.1.3 `fft/utils.lisp`

2.1.4 `fft/fft.lisp`

3.1 `fft`