The fft Reference Manual
Table of Contents
The fft Reference Manual
This is the fft Reference Manual, version 0.1.20110324,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 13:27:56 2020 GMT+0.
1 Systems
The main system appears first, followed by any subsystem dependency.
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 (file)
- Components
-
2 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
2.1 Lisp
2.1.1 fft.asd
- Location
fft.asd
- Systems
fft (system)
2.1.2 fft/package.lisp
- Parent
fft (system)
- Location
package.lisp
- Packages
fft
2.1.3 fft/utils.lisp
- Dependency
package.lisp (file)
- Parent
fft (system)
- Location
utils.lisp
- Internal Definitions
-
2.1.4 fft/fft.lisp
- Dependencies
-
- Parent
fft (system)
- Location
fft.lisp
- Exported Definitions
-
- Internal Definitions
-
3 Packages
Packages are listed by definition order.
3.1 fft
- Source
package.lisp (file)
- Use List
common-lisp
- Exported Definitions
-
- Internal Definitions
-
4 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
4.1 Exported definitions
4.1.1 Functions
- Function: fft SRC &optional DST
-
- Package
fft
- Source
fft.lisp (file)
- Function: ifft SRC &optional DST
-
- Package
fft
- Source
fft.lisp (file)
4.2 Internal definitions
4.2.1 Special variables
- Special Variable: *empty-array*
-
- Package
fft
- Source
utils.lisp (file)
- Special Variable: *fft-info*
-
- Package
fft
- Source
fft.lisp (file)
- Special Variable: *ifft-info*
-
- Package
fft
- Source
fft.lisp (file)
4.2.2 Macros
- Macro: multf PLACE &optional FACTOR
-
- Package
fft
- Source
fft.lisp (file)
- Macro: vr-compile FORM
-
- Package
fft
- Source
utils.lisp (file)
4.2.3 Functions
- Function: array-to-row ARRAY ROW &optional SCALE
-
- Package
fft
- Source
fft.lisp (file)
- Function: calculate-coefficients COEFFS INVERSE
-
- Package
fft
- Source
fft.lisp (file)
- Function: copy-virtual-row INSTANCE
-
- Package
fft
- Source
utils.lisp (file)
- Function: get-fft-buffers LENGTH INVERSE
-
- Package
fft
- Source
fft.lisp (file)
- Function: make-dst-buf SRC DST
-
- Package
fft
- Source
fft.lisp (file)
- Function: make-virtual-row &key (LENGTH LENGTH) (BUFFER BUFFER) (OFFSET OFFSET) (SPAN SPAN) (NEXT NEXT)
-
- Package
fft
- Source
utils.lisp (file)
- Function: next-row ROW
-
- Package
fft
- Source
utils.lisp (file)
- Function: perform-fft ROW &optional INVERSE
-
- Package
fft
- Source
fft.lisp (file)
- Function: row-length ROW
-
- Package
fft
- Source
utils.lisp (file)
- Function: row-ref ROW INDEX
-
- Package
fft
- Source
utils.lisp (file)
- Setf Expander
(setf row-ref) (setf expander)
- Setf Expander: (setf row-ref) ROW INDEX VALUE
-
- Package
fft
- Source
utils.lisp (file)
- Reader
row-ref (function)
- Writer
set-row-ref (function)
- Function: row-to-array ROW ARRAY
-
- Package
fft
- Source
fft.lisp (file)
- Function: set-row-ref ROW INDEX VALUE
-
- Package
fft
- Source
utils.lisp (file)
- Setf Expander
(setf row-ref) (setf expander)
- Function: shift-samples ROW
-
- Package
fft
- Source
fft.lisp (file)
- Function: virtual-row BUFFER &optional DIMENSION PRE POST
-
- Package
fft
- Source
utils.lisp (file)
- Function: virtual-row-buffer INSTANCE
-
- Function: (setf virtual-row-buffer) VALUE INSTANCE
-
- Package
fft
- Source
utils.lisp (file)
- Function: virtual-row-length INSTANCE
-
- Function: (setf virtual-row-length) VALUE INSTANCE
-
- Package
fft
- Source
utils.lisp (file)
- Function: virtual-row-next INSTANCE
-
- Function: (setf virtual-row-next) VALUE INSTANCE
-
- Package
fft
- Source
utils.lisp (file)
- Function: virtual-row-offset INSTANCE
-
- Function: (setf virtual-row-offset) VALUE INSTANCE
-
- Package
fft
- Source
utils.lisp (file)
- Function: virtual-row-p OBJECT
-
- Package
fft
- Source
utils.lisp (file)
- Function: virtual-row-span INSTANCE
-
- Function: (setf virtual-row-span) VALUE INSTANCE
-
- Package
fft
- Source
utils.lisp (file)
- Function: vr-next-row BUFFER PRE POST
-
- Package
fft
- Source
utils.lisp (file)
- Function: vr-offset BUFFER PRE POST &optional INDEX
-
- Package
fft
- Source
utils.lisp (file)
- Function: vr-span BUFFER PRE POST
-
- Package
fft
- Source
utils.lisp (file)
4.2.4 Structures
- Structure: virtual-row ()
-
- Package
fft
- Source
utils.lisp (file)
- Direct superclasses
structure-object (structure)
- Direct slots
- Slot: length
-
- Type
fft::length-type
- Initform
0
- Readers
virtual-row-length (function)
- Writers
(setf virtual-row-length) (function)
- Slot: buffer
-
- Type
(simple-array (complex double-float) *)
- Initform
fft::*empty-array*
- Readers
virtual-row-buffer (function)
- Writers
(setf virtual-row-buffer) (function)
- Slot: offset
-
- Type
fft::length-type
- Initform
0
- Readers
virtual-row-offset (function)
- Writers
(setf virtual-row-offset) (function)
- Slot: span
-
- Type
fft::length-type
- Initform
0
- Readers
virtual-row-span (function)
- Writers
(setf virtual-row-span) (function)
- Slot: next
-
- Readers
virtual-row-next (function)
- Writers
(setf virtual-row-next) (function)
4.2.5 Types
- Type: length-type ()
-
- Package
fft
- Source
utils.lisp (file)
- Type: small-double-float ()
-
- Package
fft
- Source
utils.lisp (file)
Appendix A Indexes
A.1 Concepts
| Index Entry | | Section |
|
F | | |
| fft.asd: | | The fft․asd file |
| fft/fft.lisp: | | The fft/fft․lisp file |
| fft/package.lisp: | | The fft/package․lisp file |
| fft/utils.lisp: | | The fft/utils․lisp file |
| File, Lisp, fft.asd: | | The fft․asd file |
| File, Lisp, fft/fft.lisp: | | The fft/fft․lisp file |
| File, Lisp, fft/package.lisp: | | The fft/package․lisp file |
| File, Lisp, fft/utils.lisp: | | The fft/utils․lisp file |
|
L | | |
| Lisp File, fft.asd: | | The fft․asd file |
| Lisp File, fft/fft.lisp: | | The fft/fft․lisp file |
| Lisp File, fft/package.lisp: | | The fft/package․lisp file |
| Lisp File, fft/utils.lisp: | | The fft/utils․lisp file |
|
A.2 Functions
| Index Entry | | Section |
|
( | | |
| (setf row-ref) : | | Internal functions |
| (setf virtual-row-buffer) : | | Internal functions |
| (setf virtual-row-length) : | | Internal functions |
| (setf virtual-row-next) : | | Internal functions |
| (setf virtual-row-offset) : | | Internal functions |
| (setf virtual-row-span) : | | Internal functions |
|
A | | |
| array-to-row : | | Internal functions |
|
C | | |
| calculate-coefficients : | | Internal functions |
| copy-virtual-row : | | Internal functions |
|
F | | |
| fft : | | Exported functions |
| Function, (setf virtual-row-buffer) : | | Internal functions |
| Function, (setf virtual-row-length) : | | Internal functions |
| Function, (setf virtual-row-next) : | | Internal functions |
| Function, (setf virtual-row-offset) : | | Internal functions |
| Function, (setf virtual-row-span) : | | Internal functions |
| Function, array-to-row : | | Internal functions |
| Function, calculate-coefficients : | | Internal functions |
| Function, copy-virtual-row : | | Internal functions |
| Function, fft : | | Exported functions |
| Function, get-fft-buffers : | | Internal functions |
| Function, ifft : | | Exported functions |
| Function, make-dst-buf : | | Internal functions |
| Function, make-virtual-row : | | Internal functions |
| Function, next-row : | | Internal functions |
| Function, perform-fft : | | Internal functions |
| Function, row-length : | | Internal functions |
| Function, row-ref : | | Internal functions |
| Function, row-to-array : | | Internal functions |
| Function, set-row-ref : | | Internal functions |
| Function, shift-samples : | | Internal functions |
| Function, virtual-row : | | Internal functions |
| Function, virtual-row-buffer : | | Internal functions |
| Function, virtual-row-length : | | Internal functions |
| Function, virtual-row-next : | | Internal functions |
| Function, virtual-row-offset : | | Internal functions |
| Function, virtual-row-p : | | Internal functions |
| Function, virtual-row-span : | | Internal functions |
| Function, vr-next-row : | | Internal functions |
| Function, vr-offset : | | Internal functions |
| Function, vr-span : | | Internal functions |
|
G | | |
| get-fft-buffers : | | Internal functions |
|
I | | |
| ifft : | | Exported functions |
|
M | | |
| Macro, multf : | | Internal macros |
| Macro, vr-compile : | | Internal macros |
| make-dst-buf : | | Internal functions |
| make-virtual-row : | | Internal functions |
| multf : | | Internal macros |
|
N | | |
| next-row : | | Internal functions |
|
P | | |
| perform-fft : | | Internal functions |
|
R | | |
| row-length : | | Internal functions |
| row-ref : | | Internal functions |
| row-to-array : | | Internal functions |
|
S | | |
| set-row-ref : | | Internal functions |
| Setf Expander, (setf row-ref) : | | Internal functions |
| shift-samples : | | Internal functions |
|
V | | |
| virtual-row : | | Internal functions |
| virtual-row-buffer : | | Internal functions |
| virtual-row-length : | | Internal functions |
| virtual-row-next : | | Internal functions |
| virtual-row-offset : | | Internal functions |
| virtual-row-p : | | Internal functions |
| virtual-row-span : | | Internal functions |
| vr-compile : | | Internal macros |
| vr-next-row : | | Internal functions |
| vr-offset : | | Internal functions |
| vr-span : | | Internal functions |
|
A.3 Variables
A.4 Data types