oxifft 0.2.0

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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209

//! Manual [`core::fmt::Debug`] implementations for public plan types.
//!
//! The plan structs contain solver state (twiddle-factor tables, boxed trait
//! objects, …) whose internals are crate-private.  These hand-written
//! implementations expose only the user-visible attributes — size, direction,
//! selected algorithm name, etc. — so that `{:?}` formatting is human-readable
//! in tests, debugging sessions, and error messages.

use core::fmt;

use super::types::{
    GuruPlan, Plan, Plan2D, Plan3D, PlanND, RealPlan, RealPlan2D, RealPlan3D, RealPlanND,
    SplitPlan, SplitPlan2D, SplitPlan3D, SplitPlanND,
};
use super::types_r2r::R2rPlan;
use crate::kernel::Float;

// ---------------------------------------------------------------------------
// Plan<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for Plan<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Plan")
            .field("n", &self.size())
            .field("direction", &self.direction())
            .field("algorithm", &self.algorithm_name())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// Plan2D<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for Plan2D<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Plan2D")
            .field("n0", &self.rows())
            .field("n1", &self.cols())
            .field("direction", &self.direction())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// Plan3D<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for Plan3D<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Plan3D")
            .field("n0", &self.dim0())
            .field("n1", &self.dim1())
            .field("n2", &self.dim2())
            .field("direction", &self.direction())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// PlanND<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for PlanND<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("PlanND")
            .field("dims", &self.dims())
            .field("direction", &self.direction())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// RealPlan<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for RealPlan<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("RealPlan")
            .field("n", &self.size())
            .field("kind", &self.kind())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// RealPlan2D<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for RealPlan2D<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("RealPlan2D")
            .field("n0", &self.rows())
            .field("n1", &self.cols())
            .field("kind", &self.plan_kind())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// RealPlan3D<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for RealPlan3D<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("RealPlan3D")
            .field("n0", &self.dim0())
            .field("n1", &self.dim1())
            .field("n2", &self.dim2())
            .field("kind", &self.plan_kind())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// RealPlanND<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for RealPlanND<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("RealPlanND")
            .field("dims", &self.dims())
            .field("kind", &self.plan_kind())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// GuruPlan<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for GuruPlan<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("GuruPlan")
            .field("dims_rank", &self.dims().rank())
            .field("batch_count", &self.batch_count())
            .field("direction", &self.direction())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// SplitPlan<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for SplitPlan<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("SplitPlan")
            .field("n", &self.size())
            .field("direction", &self.direction())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// SplitPlan2D<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for SplitPlan2D<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("SplitPlan2D")
            .field("n0", &self.rows())
            .field("n1", &self.cols())
            .field("direction", &self.direction())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// SplitPlan3D<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for SplitPlan3D<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("SplitPlan3D")
            .field("n0", &self.dim0())
            .field("n1", &self.dim1())
            .field("n2", &self.dim2())
            .field("direction", &self.direction())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// SplitPlanND<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for SplitPlanND<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("SplitPlanND")
            .field("dims", &self.dims())
            .field("direction", &self.direction())
            .finish()
    }
}

// ---------------------------------------------------------------------------
// R2rPlan<T>
// ---------------------------------------------------------------------------

impl<T: Float> fmt::Debug for R2rPlan<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("R2rPlan")
            .field("n", &self.size())
            .field("kind", &self.kind())
            .finish()
    }
}