oxifft 0.3.1

Pure Rust implementation of FFTW - the Fastest Fourier Transform in the West
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

//! Error types for MPI operations.

use core::fmt;

/// Error type for MPI FFT operations.
#[derive(Debug, Clone)]
#[non_exhaustive]
pub enum MpiError {
    /// Invalid dimension specification.
    InvalidDimension {
        /// The dimension index.
        dim: usize,
        /// The invalid size.
        size: usize,
        /// Description of the error.
        message: String,
    },
    /// Data size mismatch.
    SizeMismatch {
        /// Expected size.
        expected: usize,
        /// Actual size.
        actual: usize,
    },
    /// Communication error.
    CommunicationError {
        /// Description of the error.
        message: String,
    },
    /// Not enough processes for the problem.
    InsufficientProcesses {
        /// Required number of processes.
        required: usize,
        /// Available number of processes.
        available: usize,
    },
    /// Internal FFT error.
    FftError {
        /// Description of the error.
        message: String,
    },
    /// The element count for MPI communication exceeds `i32::MAX`.
    ///
    /// # Notes
    ///
    /// MPI counts are 32-bit signed integers. For buffers larger than ~2 GB
    /// (at `i32::MAX` elements of f64), split the operation or use a different
    /// communication strategy.
    CountOverflow {
        /// The count that could not fit in `i32`.
        count: usize,
        /// The rank (process index) whose send/recv count overflowed.
        rank: usize,
    },
}

impl fmt::Display for MpiError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidDimension { dim, size, message } => {
                write!(f, "Invalid dimension {dim} (size {size}): {message}")
            }
            Self::SizeMismatch { expected, actual } => {
                write!(f, "Size mismatch: expected {expected}, got {actual}")
            }
            Self::CommunicationError { message } => {
                write!(f, "MPI communication error: {message}")
            }
            Self::InsufficientProcesses {
                required,
                available,
            } => {
                write!(
                    f,
                    "Insufficient processes: need {required}, have {available}"
                )
            }
            Self::FftError { message } => {
                write!(f, "FFT error: {message}")
            }
            Self::CountOverflow { count, rank } => {
                write!(
                    f,
                    "MPI count overflow: count {count} exceeds i32::MAX for rank {rank}"
                )
            }
        }
    }
}

impl std::error::Error for MpiError {}