slatec 0.1.0

Safe Rust interface to selected SLATEC numerical routines
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

//! Fourier transforms.
//!
//! # Status: Partial

/// An error detected before an FFTPACK plan enters native code.
///
/// The reviewed FFTPACK routines have no status return. Constructors therefore
/// validate documented dimensions and checked workspace arithmetic, while
/// transform methods require the exact plan length.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum FftError {
    /// The requested transform length is outside the routine's documented range.
    InvalidLength {
        /// The requested length.
        length: usize,
        /// The smallest accepted length for this plan family.
        minimum: usize,
    },
    /// A transform slice does not match the plan length.
    LengthMismatch {
        /// Plan length established by its constructor.
        expected: usize,
        /// Slice length passed to the transform method.
        actual: usize,
    },
    /// A length or workspace formula cannot be represented by the native ABI.
    DimensionOverflow,
    /// Allocation of private native plan storage failed.
    AllocationFailed,
}

/// Complex FFTPACK transforms.
pub mod complex;
/// Multidimensional transforms.
pub mod multidimensional;
/// Real FFTPACK transform plans.
pub mod real;