Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

`size`, `length`, `ndims` for `Plan` inconsistent with Base usage

Open
#42 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
julia
Domain
tooling

Research direction

Start by reviewing the existing Plan definitions and the API concerns in this issue and linked FFTW.jl issue #159, focusing on size, length, and ndims. A complete contribution would require a settled decision about their semantics, followed by the corresponding implementation and verification that Plan behavior is consistent with that decision.

Written by the indexing model from the issue text.

Description

Ref. https://github.com/JuliaMath/FFTW.jl/issues/159

While it is certainly useful to be able to query a Plan for the size of the input data it expects, using size for this seems wrong. It should give the dimensions of the Plan itself, whatever that might be. As noted in https://github.com/JuliaMath/FFTW.jl/issues/159, a Plan for 1d input of length n could be considered equivalent to a matrix with size (n, n), but size would just return n.

So we might consider renaming size as used here, and maybe ndims along with it if deemed necessary to have it, noting the trivial definition length(size(p)). I don't see how length is useful, so that could maybe just be deleted.

I'm skeptical about defining size, length, ndims in a way (more) consistent with Base, unless we make Plans iterable (and maybe even indexable), where I don't see much benefit.

Dominant language
Julia
Stars
135
Forks
40
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from JuliaMath/AbstractFFTs.jl

All issues in JuliaMath/AbstractFFTs.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.