diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 63964b9..64299c1 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -13,7 +13,7 @@ jobs: fail-fast: false matrix: version: - - '1.6' + - '1.10' - '1' os: - ubuntu-latest diff --git a/LICENSE.md b/LICENSE.md index 32e3083..a0f6bed 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -The RFFT.jl package is licensed under the MIT "Expat" License: +The RealFFTs.jl package is licensed under the MIT "Expat" License: > Copyright (c) 2013-2021: Tim Holy. > diff --git a/Project.toml b/Project.toml index ebabe09..89d4ce6 100644 --- a/Project.toml +++ b/Project.toml @@ -1,4 +1,4 @@ -name = "RFFT" +name = "RealFFTs" uuid = "3645faec-0534-4e91-afef-021db0981eec" authors = ["Tim Holy "] version = "1.0.0" @@ -10,7 +10,8 @@ LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" [compat] FFTW = "1" LinearAlgebra = "1" -julia = "1.6" +Test = "1" +julia = "1.10" [extras] Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" diff --git a/README.md b/README.md index 599477e..27e5325 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# RFFT.jl +# RealFFTs.jl This is a fork of https://github.com/HolyLab/RFFT.jl with a new UUID such that it can be registered on the General registry. @@ -8,12 +8,12 @@ In-place real FFTs for Julia. Supports "plans" to optimize the algorithm for tra For example ```julia -import RFFT +import RealFFTs a = rand(Float64, 100, 150) # initialize a buffer 'RCpair' that contains a real and complex space -buf = RFFT.RCpair{Float64}(undef, size(a)) +buf = RealFFTs.RCpair{Float64}(undef, size(a)) ``` `real(buf)` views the underlying memory buffer as an array reals, while `complex(buf)` views the same @@ -23,7 +23,7 @@ If you'll be performing lots of FFTs on this buffer, it's best to create an opti ```julia # create the plan -plan = RFFT.plan_rfft!(buf; flags=FFTW.MEASURE) +plan = RealFFTs.plan_rfft!(buf; flags=FFTW.MEASURE) # use the plan and buffer on a new array new = rand(Float64, 100, 150) diff --git a/src/RFFT.jl b/src/RealFFTs.jl similarity index 96% rename from src/RFFT.jl rename to src/RealFFTs.jl index 8a0715b..f1973ac 100644 --- a/src/RFFT.jl +++ b/src/RealFFTs.jl @@ -1,15 +1,15 @@ """ -# RFFT +# RealFFTs -Highlights of the RFFT package: -- [`RCpair`](@ref): a buffer for in-place real-to-complex FFTs +Highlights of the RealFFTs package: +- [`RCpair`](@ref): a buffer for in-place real-to-complex and complex-to-real FFTs - [`plan_rfft!`](@ref): create a plan for in-place real-to-complex FFTs - [`plan_irfft!`](@ref): create a plan for in-place complex-to-real FFTs Use `real(RC)` and `complex(RC)` to access the real and complex views of the buffer, respectively. `copy!(RC, A)` can be used to copy data (either real- or complex-valued) into the buffer. """ -module RFFT +module RealFFTs using FFTW, LinearAlgebra diff --git a/test/runtests.jl b/test/runtests.jl index e049cd2..6ef3a43 100644 --- a/test/runtests.jl +++ b/test/runtests.jl @@ -1,21 +1,21 @@ -import RFFT +import RealFFTs using Test, FFTW, LinearAlgebra -@testset "RFFT.jl" begin +@testset "RealFFTs.jl" begin for dims in (1:2, 1, 2) for sz in ((5,6), (6,5)) - pair = RFFT.RCpair{Float64}(undef, sz, dims) + pair = RealFFTs.RCpair{Float64}(undef, sz, dims) r = @inferred(real(pair)) c = @inferred(complex(pair)) b = rand(eltype(r), size(r)) - pair = RFFT.RCpair(b, dims) + pair = RealFFTs.RCpair(b, dims) copyto!(r, b) copy!(pair, c) # for coverage - RFFT.rfft!(pair) - RFFT.irfft!(pair) + RealFFTs.rfft!(pair) + RealFFTs.irfft!(pair) @test r ≈ b - pfwd = RFFT.plan_rfft!(pair) - pinv = RFFT.plan_irfft!(pair) + pfwd = RealFFTs.plan_rfft!(pair) + pinv = RealFFTs.plan_irfft!(pair) pinv(pfwd(pair)) @test r ≈ b