The fft Reference Manual

Table of Contents

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

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 Apr 28 11:47:54 2020 GMT+0.

• Systems  The systems documentation
• Files  The files documentation
• Packages  The packages documentation
• Definitions  The symbols documentation
• Indexes  Concepts, functions, variables and data types

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

1 Systems

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

• The fft system  

Previous: , 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 (file)

Components

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

2 Files

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

• Lisp files  

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

2.1 Lisp

• The fft.asd file  
• The fft/package.lisp file  
• The fft/utils.lisp file  
• The fft/fft.lisp file  

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

2.1.1 fft.asd

Location

fft.asd

Systems

fft (system)

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

2.1.2 fft/package.lisp

Parent

fft (system)

Location

package.lisp

Packages

fft

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

2.1.3 fft/utils.lisp

Dependency

package.lisp (file)

Parent

fft (system)

Location

utils.lisp

Internal Definitions

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

2.1.4 fft/fft.lisp

Dependencies
Parent

fft (system)

Location

fft.lisp

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.

• The fft package  

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

3.1 fft

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4 Definitions

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

• Exported definitions  
• Internal definitions  

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

4.1 Exported definitions

• Exported functions  

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

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)

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

4.2 Internal definitions

• Internal special variables  
• Internal macros  
• Internal functions  
• Internal structures  
• Internal types  

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

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)

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

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)

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

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)

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

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)

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

4.2.5 Types

Type: length-type ()
Package

fft

Source

utils.lisp (file)

Type: small-double-float ()
Package

fft

Source

utils.lisp (file)

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

Appendix A Indexes

• Concept index  
• Function index  
• Variable index  
• Data type index  

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

A.1 Concepts

Jump to:   F   L  
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
Jump to:   F   L  

Next: , Previous: , 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): 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
Jump to:   (  
A   C   F   G   I   M   N   P   R   S   V  

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

A.3 Variables

Jump to:   *  
B   L   N   O   S  
Index Entry  Section
*
*empty-array*: Internal special variables
*fft-info*: Internal special variables
*ifft-info*: Internal special variables
B
buffer: Internal structures
L
length: Internal structures
N
next: Internal structures
O
offset: Internal structures
S
Slot, buffer: Internal structures
Slot, length: Internal structures
Slot, next: Internal structures
Slot, offset: Internal structures
Slot, span: Internal structures
span: Internal structures
Special Variable, *empty-array*: Internal special variables
Special Variable, *fft-info*: Internal special variables
Special Variable, *ifft-info*: Internal special variables
Jump to:   *  
B   L   N   O   S  

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

A.4 Data types

Jump to:   F   L   P   S   T   V  
Index Entry  Section
F
fft: The fft system
fft: The fft package
L
length-type: Internal types
P
Package, fft: The fft package
S
small-double-float: Internal types
Structure, virtual-row: Internal structures
System, fft: The fft system
T
Type, length-type: Internal types
Type, small-double-float: Internal types
V
virtual-row: Internal structures
Jump to:   F   L   P   S   T   V