The bordeaux-fft Reference Manual

This is the bordeaux-fft Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:30:17 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 bordeaux-fft

An efficient and portable implementation of the Fast Fourier Transform

Author

Various

License

GNU Public License version 2

Version

1.0.1

Source

bordeaux-fft.asd.

Child Component

fft.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 bordeaux-fft/bordeaux-fft.asd

Source

bordeaux-fft.asd.

Parent Component

bordeaux-fft (system).

ASDF Systems

bordeaux-fft.


3.1.2 bordeaux-fft/fft.lisp

Source

bordeaux-fft.asd.

Parent Component

bordeaux-fft (system).

Packages

bordeaux-fft.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 bordeaux-fft

Source

fft.lisp.

Use List

common-lisp.

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 Special variables

Special Variable: *fft-instance*
Package

bordeaux-fft.

Source

fft.lisp.

Special Variable: *ifft-instance*
Package

bordeaux-fft.

Source

fft.lisp.


5.1.2 Ordinary functions

Function: bartlett (i n)
Package

bordeaux-fft.

Source

fft.lisp.

Function: blackman (i n)
Package

bordeaux-fft.

Source

fft.lisp.

Function: blackman-harris (i n)
Package

bordeaux-fft.

Source

fft.lisp.

Function: extract-centered-window (vector center size &optional element-type)

Extract a subsequence of SIZE from VECTOR, centered on CENTER and padding with zeros beyond the edges of the vector.

Package

bordeaux-fft.

Source

fft.lisp.

Function: extract-centered-window-into (vector center size destination)

Extract a subsequence of SIZE from VECTOR, centered on OFFSET and padding with zeros beyond the boundaries of the vector, storing it to DESTINATION.

Package

bordeaux-fft.

Source

fft.lisp.

Function: extract-window (vector start length &optional element-type)
Package

bordeaux-fft.

Source

fft.lisp.

Function: extract-window-into (vector start length destination)

Copy an extent of VECTOR to DESTINATION. Outside of its legal array indices, VECTOR is considered to be zero.

Package

bordeaux-fft.

Source

fft.lisp.

Function: fft (source)

Returns the Fourier transform of source, allocating a new array for the result.

Package

bordeaux-fft.

Source

fft.lisp.

Function: fft! (source dest)

Destructive version of fft, since it fills dest.

Package

bordeaux-fft.

Source

fft.lisp.

Function: gaussian (sigma)
Package

bordeaux-fft.

Source

fft.lisp.

Function: gaussian*bartlett^x (sigma triangle-exponent)
Package

bordeaux-fft.

Source

fft.lisp.

Function: hann (i n)
Package

bordeaux-fft.

Source

fft.lisp.

Function: ifft (source)

Returns the inverse Fourier transform of source, allocating a new array for the result.

Package

bordeaux-fft.

Source

fft.lisp.

Function: ifft! (source dest)

Destructive version of ifft, since it fills dest.

Package

bordeaux-fft.

Source

fft.lisp.

Function: rectangular (i n)
Package

bordeaux-fft.

Source

fft.lisp.

Function: sfft (source &optional len)

This is the generic fft function. Stands for stupid fft. Can take any kind of array as input.

Package

bordeaux-fft.

Source

fft.lisp.

Function: sifft (source)

This is the generic fft function. Stands for stupid fft. Can take any kind of array as input.

Package

bordeaux-fft.

Source

fft.lisp.

Function: triangle (i n)
Package

bordeaux-fft.

Source

fft.lisp.

Function: window-vector (function n)
Package

bordeaux-fft.

Source

fft.lisp.

Function: windowed-fft (signal-vector center length &optional window-fn)

Perform an FFT on the window of a signal, centered on the given index, multiplied by a window generated by the chosen window function

Package

bordeaux-fft.

Source

fft.lisp.


5.1.3 Types

Type: complex-sample ()
Package

bordeaux-fft.

Source

fft.lisp.

Type: complex-sample-array ()
Package

bordeaux-fft.

Source

fft.lisp.


5.2 Internals


5.2.1 Macros

Macro: with-fft-instance (instance size &body body)
Package

bordeaux-fft.

Source

fft.lisp.


5.2.2 Ordinary functions

Function: blackman* (alpha i n)
Package

bordeaux-fft.

Source

fft.lisp.

Function: clip-in-window (x start end)
Package

bordeaux-fft.

Source

fft.lisp.

Function: convert-to-complex-sample-array (array)
Package

bordeaux-fft.

Source

fft.lisp.

Function: cosine-series (i n a0 a1 a2 a3)
Package

bordeaux-fft.

Source

fft.lisp.

Function: fft-common (instance source dest)
Package

bordeaux-fft.

Source

fft.lisp.

Function: gauss* (sigma i n)
Package

bordeaux-fft.

Source

fft.lisp.

Function: ifft-common (instance source dest)
Package

bordeaux-fft.

Source

fft.lisp.

Function: make-fft-instance (size)
Package

bordeaux-fft.

Source

fft.lisp.

Function: make-fourier-instance (size direction)
Package

bordeaux-fft.

Source

fft.lisp.

Function: make-ifft-instance (size)
Package

bordeaux-fft.

Source

fft.lisp.

Function: power-of-two (x)
Package

bordeaux-fft.

Source

fft.lisp.


5.2.3 Generic functions

Generic Reader: size (object)
Package

bordeaux-fft.

Methods
Reader Method: size ((fft-instance fft-instance))

automatically generated reader method

Source

fft.lisp.

Target Slot

size.


5.2.4 Classes

Class: fft-instance
Package

bordeaux-fft.

Source

fft.lisp.

Direct methods

size.

Direct slots
Slot: size
Initargs

:size

Readers

size.

Writers

This slot is read-only.

Slot: inter
Initargs

:inter

Slot: coeffs
Initargs

:coeffs


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   B   C   E   F   G   H   I   M   P   R   S   T   W  
Index Entry  Section

B
bartlett: Public ordinary functions
blackman: Public ordinary functions
blackman*: Private ordinary functions
blackman-harris: Public ordinary functions

C
clip-in-window: Private ordinary functions
convert-to-complex-sample-array: Private ordinary functions
cosine-series: Private ordinary functions

E
extract-centered-window: Public ordinary functions
extract-centered-window-into: Public ordinary functions
extract-window: Public ordinary functions
extract-window-into: Public ordinary functions

F
fft: Public ordinary functions
fft!: Public ordinary functions
fft-common: Private ordinary functions
Function, bartlett: Public ordinary functions
Function, blackman: Public ordinary functions
Function, blackman*: Private ordinary functions
Function, blackman-harris: Public ordinary functions
Function, clip-in-window: Private ordinary functions
Function, convert-to-complex-sample-array: Private ordinary functions
Function, cosine-series: Private ordinary functions
Function, extract-centered-window: Public ordinary functions
Function, extract-centered-window-into: Public ordinary functions
Function, extract-window: Public ordinary functions
Function, extract-window-into: Public ordinary functions
Function, fft: Public ordinary functions
Function, fft!: Public ordinary functions
Function, fft-common: Private ordinary functions
Function, gauss*: Private ordinary functions
Function, gaussian: Public ordinary functions
Function, gaussian*bartlett^x: Public ordinary functions
Function, hann: Public ordinary functions
Function, ifft: Public ordinary functions
Function, ifft!: Public ordinary functions
Function, ifft-common: Private ordinary functions
Function, make-fft-instance: Private ordinary functions
Function, make-fourier-instance: Private ordinary functions
Function, make-ifft-instance: Private ordinary functions
Function, power-of-two: Private ordinary functions
Function, rectangular: Public ordinary functions
Function, sfft: Public ordinary functions
Function, sifft: Public ordinary functions
Function, triangle: Public ordinary functions
Function, window-vector: Public ordinary functions
Function, windowed-fft: Public ordinary functions

G
gauss*: Private ordinary functions
gaussian: Public ordinary functions
gaussian*bartlett^x: Public ordinary functions
Generic Function, size: Private generic functions

H
hann: Public ordinary functions

I
ifft: Public ordinary functions
ifft!: Public ordinary functions
ifft-common: Private ordinary functions

M
Macro, with-fft-instance: Private macros
make-fft-instance: Private ordinary functions
make-fourier-instance: Private ordinary functions
make-ifft-instance: Private ordinary functions
Method, size: Private generic functions

P
power-of-two: Private ordinary functions

R
rectangular: Public ordinary functions

S
sfft: Public ordinary functions
sifft: Public ordinary functions
size: Private generic functions
size: Private generic functions

T
triangle: Public ordinary functions

W
window-vector: Public ordinary functions
windowed-fft: Public ordinary functions
with-fft-instance: Private macros