Skip to content

Commit

Permalink
Note that size needs to be implemented in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gaurav-arya committed Jul 21, 2023
1 parent eddf7e3 commit bc6bee8
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/src/implementations.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ To define a new FFT implementation in your own module, you should
inverse plan.

* Define a new method `AbstractFFTs.plan_fft(x, region; kws...)` that returns a `MyPlan` for at least some types of
`x` and some set of dimensions `region`. The `region` (or a copy thereof) should be accessible via `fftdims(p::MyPlan)` (which defaults to `p.region`).
`x` and some set of dimensions `region`. The `region` (or a copy thereof) should be accessible via `fftdims(p::MyPlan)`
(which defaults to `p.region`), and the input size `size(x)` should be accessible via `size(p::MyPlan)`.

* Define a method of `LinearAlgebra.mul!(y, p::MyPlan, x)` that computes the transform `p` of `x` and stores the result in `y`.

Expand Down

0 comments on commit bc6bee8

Please sign in to comment.