Update header documentation
[cl-fftw3.git] / specials.lisp
1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
4 ;;;;
5 ;;;; Name:          specials.lisp
6 ;;;; Purpose:       Special data declarations for FFTW3 package
7 ;;;; Programmer:    Kevin M. Rosenberg
8 ;;;; Date Started:  March 2009
9 ;;;;
10 ;;;; This file and CL-FFTW3 are Copyright (c) 2009-2011 by Kevin M. Rosenberg
11 ;;;;
12 ;;;; FFTW3 users are granted the rights to distribute and use this software
13 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
14 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
15 ;;;; *************************************************************************
16
17 (in-package #:fftw3)
18
19 (defconstant +fftw-forward+ -1)
20 (defconstant +fftw-backward+ +1)
21
22 (defconstant +fftw-r2hc+ 0)
23 (defconstant +fftw-hc2r+ 1)
24
25 (defconstant +fftw-measure+ 0)
26 (defconstant +fftw-destroy-input+ (ash 1 0))
27 (defconstant +fftw-unaligned+ (ash 1 1))
28 (defconstant +fftw-conservative-memory+ (ash 1 2))
29 (defconstant +fftw-exhaustive+ (ash 1 3))
30 (defconstant +fftw-preserve-input+ (ash 1 4))
31 (defconstant +fftw-patiento+ (ash 1 5))
32 (defconstant +fftw-estimate+ (ash 1 6))
33
34 (defparameter *user-wisdom-file*
35   (concatenate 'string (namestring (user-homedir-pathname)) ".fftw3-wisdom"))
36
37 (defvar *standard-optimize-settings*
38   '(optimize
39     speed
40     (safety 0)
41     (space 0)
42     (debug 1)
43     (compilation-speed 0)
44     #+:lispworks (hcl:fixnum-safety 0))
45   "The standard optimize settings used by most declaration expressions.")