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 Mon Feb 26 16:24:43 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 fft

Maintainer

Patrick Stein <>

Author

Patrick Stein <>

License

Public Domain

Version

0.1.20110324

Source

fft.asd.

Child 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/fft.asd

Source

fft.asd.

Parent Component

fft (system).

ASDF Systems

fft.


2.1.2 fft/package.lisp

Source

fft.asd.

Parent Component

fft (system).

Packages

fft.


2.1.3 fft/utils.lisp

Dependency

package.lisp (file).

Source

fft.asd.

Parent Component

fft (system).

Internals

2.1.4 fft/fft.lisp

Dependencies
Source

fft.asd.

Parent Component

fft (system).

Public Interface
Internals

3 Packages

Packages are listed by definition order.


3.1 fft

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

4 Definitions

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


4.1 Public Interface


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.


4.2 Internals


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.


4.2.2 Macros

Macro: multf (place &optional factor)
Package

fft.

Source

fft.lisp.

Macro: vr-compile (form)
Package

fft.

Source

utils.lisp.


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).


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.


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).


4.2.6 Types

Type: length-type ()
Package

fft.

Source

utils.lisp.

Type: small-double-float ()
Package

fft.

Source

utils.lisp.


Appendix A Indexes


A.1 Concepts


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