Skip to content

Commit d53f57d

Browse files
committed
make ProjectionStyle abstract type so we can subtype in downstream packages. add a few lines of docs
1 parent 1cc9ca0 commit d53f57d

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

src/definitions.jl

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -583,12 +583,30 @@ plan_brfft
583583

584584
##############################################################################
585585

586-
struct NoProjectionStyle end
587-
struct RealProjectionStyle end
588-
struct RealInverseProjectionStyle
586+
abstract type ProjectionStyle end
587+
588+
"""
589+
NoProjectionStyle()
590+
591+
Projection style for complex to complex discrete Fourier transform
592+
"""
593+
struct NoProjectionStyle <: ProjectionStyle end
594+
595+
"""
596+
RealProjectionStyle()
597+
598+
Projection style for complex to real discrete Fourier transform
599+
"""
600+
struct RealProjectionStyle <: ProjectionStyle end
601+
602+
"""
603+
RealInverseProjectionStyle()
604+
605+
Projection style for inverse of complex to real discrete Fourier transform
606+
"""
607+
struct RealInverseProjectionStyle <: ProjectionStyle
589608
dim::Int
590609
end
591-
const ProjectionStyle = Union{NoProjectionStyle, RealProjectionStyle, RealInverseProjectionStyle}
592610

593611
output_size(p::Plan) = _output_size(p, ProjectionStyle(p))
594612
_output_size(p::Plan, ::NoProjectionStyle) = size(p)

0 commit comments

Comments
 (0)