rifft 1.1.2

RIFFT FFT/DLPack/FFI bridge
Documentation 
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

use num_complex::Complex32;
use std::fmt;

pub type Complex = Complex32;

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum FftDirection {
    Forward,
    Inverse,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum TensorDType {
    Complex32,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct PlanKey {
    pub height: usize,
    pub width: usize,
    pub direction: FftDirection,
    pub dtype: TensorDType,
}

impl fmt::Display for PlanKey {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}x{}::{:?}::{:?}",
            self.height, self.width, self.direction, self.dtype,
        )
    }
}

#[derive(thiserror::Error, Debug)]
pub enum RifftError {
    #[error("input tensor is not contiguous")]
    NonContiguous,
    #[error("invalid tensor shape; expected {expected} elements but received {got}")]
    ShapeMismatch { expected: usize, got: usize },
    #[error("unsupported dtype")]
    UnsupportedDType,
    #[error("workspace not available for {0}")]
    WorkspaceUnavailable(String),
    #[error("planner error: {0}")]
    Planner(String),
    #[error("dlpack error: {0}")]
    DlPack(String),
}

pub type Result<T> = std::result::Result<T, RifftError>;

pub const BACKEND_NAME: &str = "rustfft+rayon+simd";