fftw3 0.0.2

Bindings to FFTW3: the Fastest Fourier Transform in the West. This library aims to expose the full power of FFTW3 in high-performance, safe and idiomatic manner. NB. FFTW3 is licensed GPLv2 (or later) by default, and so applications using it must be distributed under those terms (the license of these bindings is independent). 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! Helpers for managing plans.

use {ffi, lock};
//use mem::FftwVec;

//use num::complex::Complex64;

/// A thin wrapper around the internal FFTW plan type, that assists
/// with creation and manages destruction.
pub struct RawPlan {
    plan: ffi::fftw_plan
}
impl RawPlan {
    /// Create a `RawPlan` from the output of `f`.
    ///
    /// This executes `f` inside a lock since FFTW plan creation is
    /// not threadsafe.
    pub fn new<F: FnOnce() -> ffi::fftw_plan>(f: F) -> Option<RawPlan> {
        let plan = lock::run(f);

        if plan.is_null() {
            None
        } else {
            Some(RawPlan { plan: plan })
        }
    }

    /// Create a `RawPlan` directly from an `fftw_plan`, with no
    /// synchronisation or checks. Prefer `RawPlan::new` where possible.
    pub unsafe fn new_unchecked(plan: ffi::fftw_plan) -> RawPlan {
        RawPlan { plan: plan }
    }

    /// Print information about the plan to stdout.
    pub fn debug_print(&self) {
        unsafe {ffi::fftw_print_plan(self.plan);}
    }

    /// Execute the plan on the data vectors provided while planning.
    pub unsafe fn execute(&mut self) {
        ffi::fftw_execute(self.plan)
    }

    /// Obtain a copy of the internal FFTW plan.
    pub fn raw_plan(&self) -> ffi::fftw_plan {
        self.plan
    }
}

impl Drop for RawPlan {
    fn drop(&mut self) {
        unsafe {ffi::fftw_destroy_plan(self.plan)}
    }
}