The bordeaux-fft Reference Manual

Table of Contents

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

The bordeaux-fft Reference Manual

This is the bordeaux-fft Reference Manual, version 1.0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 07:45:05 2018 GMT+0.


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

1 Introduction

Bordeaux FFT Library

The Bordeaux FFT library implements the following:

The manual is available online at http://vintage-digital.com/hefner/software/bordeaux-fft/manual.html

Source code is maintained on github


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

2 Systems

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


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

2.1 bordeaux-fft

Author

Various

License

GNU Public License version 2

Description

An efficient and portable implementation of the Fast Fourier Transform

Version

1.0.1

Source

bordeaux-fft.asd (file)

Component

fft.lisp (file)


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

3 Files

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


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

3.1 Lisp


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

3.1.1 bordeaux-fft.asd

Location

bordeaux-fft.asd

Systems

bordeaux-fft (system)


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

3.1.2 bordeaux-fft/fft.lisp

Parent

bordeaux-fft (system)

Location

fft.lisp

Packages

bordeaux-fft

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 bordeaux-fft

Source

fft.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *fft-instance*
Package

bordeaux-fft

Source

fft.lisp (file)

Special Variable: *ifft-instance*
Package

bordeaux-fft

Source

fft.lisp (file)


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

5.1.2 Functions

Function: bartlett I N
Package

bordeaux-fft

Source

fft.lisp (file)

Function: blackman I N
Package

bordeaux-fft

Source

fft.lisp (file)

Function: blackman-harris I N
Package

bordeaux-fft

Source

fft.lisp (file)

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 (file)

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 (file)

Function: extract-window VECTOR START LENGTH &optional ELEMENT-TYPE
Package

bordeaux-fft

Source

fft.lisp (file)

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 (file)

Function: fft SOURCE

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

Package

bordeaux-fft

Source

fft.lisp (file)

Function: fft! SOURCE DEST

Destructive version of fft, since it fills dest.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: gaussian SIGMA
Package

bordeaux-fft

Source

fft.lisp (file)

Function: gaussian*bartlett^x SIGMA TRIANGLE-EXPONENT
Package

bordeaux-fft

Source

fft.lisp (file)

Function: hann I N
Package

bordeaux-fft

Source

fft.lisp (file)

Function: ifft SOURCE

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

Package

bordeaux-fft

Source

fft.lisp (file)

Function: ifft! SOURCE DEST

Destructive version of ifft, since it fills dest.

Package

bordeaux-fft

Source

fft.lisp (file)

Function: rectangular I N
Package

bordeaux-fft

Source

fft.lisp (file)

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 (file)

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 (file)

Function: triangle I N
Package

bordeaux-fft

Source

fft.lisp (file)

Function: window-vector FUNCTION N
Package

bordeaux-fft

Source

fft.lisp (file)

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 (file)


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

5.1.3 Types

Type: complex-sample ()
Package

bordeaux-fft

Source

fft.lisp (file)

Type: complex-sample-array ()
Package

bordeaux-fft

Source

fft.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Macros

Macro: with-fft-instance INSTANCE SIZE &body BODY
Package

bordeaux-fft

Source

fft.lisp (file)


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

5.2.2 Functions

Function: blackman* ALPHA I N
Package

bordeaux-fft

Source

fft.lisp (file)

Function: clip-in-window X START END
Package

bordeaux-fft

Source

fft.lisp (file)

Function: convert-to-complex-sample-array ARRAY
Package

bordeaux-fft

Source

fft.lisp (file)

Function: cosine-series I N A0 A1 A2 A3
Package

bordeaux-fft

Source

fft.lisp (file)

Function: fft-common INSTANCE SOURCE DEST
Package

bordeaux-fft

Source

fft.lisp (file)

Function: gauss* SIGMA I N
Package

bordeaux-fft

Source

fft.lisp (file)

Function: ifft-common INSTANCE SOURCE DEST
Package

bordeaux-fft

Source

fft.lisp (file)

Function: make-fft-instance SIZE
Package

bordeaux-fft

Source

fft.lisp (file)

Function: make-fourier-instance SIZE DIRECTION
Package

bordeaux-fft

Source

fft.lisp (file)

Function: make-ifft-instance SIZE
Package

bordeaux-fft

Source

fft.lisp (file)

Function: power-of-two X
Package

bordeaux-fft

Source

fft.lisp (file)


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

5.2.3 Generic functions

Generic Function: size OBJECT
Package

bordeaux-fft

Methods
Method: size (FFT-INSTANCE fft-instance)

automatically generated reader method

Source

fft.lisp (file)


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

5.2.4 Classes

Class: fft-instance ()
Package

bordeaux-fft

Source

fft.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

size (method)

Direct slots
Slot: size
Initargs

:size

Readers

size (generic function)

Slot: inter
Initargs

:inter

Slot: coeffs
Initargs

:coeffs


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   B   F   L  
Index Entry  Section

B
bordeaux-fft.asd: The bordeaux-fft<dot>asd file
bordeaux-fft/fft.lisp: The bordeaux-fft/fft<dot>lisp file

F
File, Lisp, bordeaux-fft.asd: The bordeaux-fft<dot>asd file
File, Lisp, bordeaux-fft/fft.lisp: The bordeaux-fft/fft<dot>lisp file

L
Lisp File, bordeaux-fft.asd: The bordeaux-fft<dot>asd file
Lisp File, bordeaux-fft/fft.lisp: The bordeaux-fft/fft<dot>lisp file

Jump to:   B   F   L  

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

A.2 Functions

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

B
bartlett: Exported functions
blackman: Exported functions
blackman*: Internal functions
blackman-harris: Exported functions

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

E
extract-centered-window: Exported functions
extract-centered-window-into: Exported functions
extract-window: Exported functions
extract-window-into: Exported functions

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

G
gauss*: Internal functions
gaussian: Exported functions
gaussian*bartlett^x: Exported functions
Generic Function, size: Internal generic functions

H
hann: Exported functions

I
ifft: Exported functions
ifft!: Exported functions
ifft-common: Internal functions

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

P
power-of-two: Internal functions

R
rectangular: Exported functions

S
sfft: Exported functions
sifft: Exported functions
size: Internal generic functions
size: Internal generic functions

T
triangle: Exported functions

W
window-vector: Exported functions
windowed-fft: Exported functions
with-fft-instance: Internal macros

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

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

A.3 Variables

Jump to:   *  
C   I   S  
Index Entry  Section

*
*fft-instance*: Exported special variables
*ifft-instance*: Exported special variables

C
coeffs: Internal classes

I
inter: Internal classes

S
size: Internal classes
Slot, coeffs: Internal classes
Slot, inter: Internal classes
Slot, size: Internal classes
Special Variable, *fft-instance*: Exported special variables
Special Variable, *ifft-instance*: Exported special variables

Jump to:   *  
C   I   S  

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

A.4 Data types

Jump to:   B   C   F   P   S   T  
Index Entry  Section

B
bordeaux-fft: The bordeaux-fft system
bordeaux-fft: The bordeaux-fft package

C
Class, fft-instance: Internal classes
complex-sample: Exported types
complex-sample-array: Exported types

F
fft-instance: Internal classes

P
Package, bordeaux-fft: The bordeaux-fft package

S
System, bordeaux-fft: The bordeaux-fft system

T
Type, complex-sample: Exported types
Type, complex-sample-array: Exported types

Jump to:   B   C   F   P   S   T