`Nat.toDigits` with base `1`
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 9.2k
- Forks
- 990
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 175
Description
Prerequisites
Please put an X between the brackets as you perform the following steps:
- Check that your issue is not already filed:
https://github.com/leanprover/lean4/issues - Reduce the issue to a minimal, self-contained, reproducible test case.
Avoid dependencies to Mathlib or Batteries. - Test your test case against the latest nightly release, for example on
https://live.lean-lang.org/#project=lean-nightly
(You can also use the settings there to switch to “Lean nightly”)
Description
When applying Nat.toDigits with (base := 1), the result might be considered unexpected, as it does not represent a unary encoding of the input value:
#eval Nat.toDigits (base := 1) 0 -- ['0']
#eval Nat.toDigits (base := 1) 1 -- ['0', '0']
#eval Nat.toDigits (base := 1) 2 -- ['0', '0', '0']
Context
In prior discussion on Zulip, @TwoFX states "I would say this is a defect in the documentation at the very least."
Steps to Reproduce
#eval Nat.toDigits (base := 1) 0 -- ['0']
#eval Nat.toDigits (base := 1) 1 -- ['0', '0']
#eval Nat.toDigits (base := 1) 2 -- ['0', '0', '0']
Expected behavior: Either the documentation for Nat.toDigits should state that the results are only meaningful for base > 1, or Nat.toDigits (base := 1) n should return a list of n '0's.
Actual behavior: Nat.toDigits (base := 1) n returns a list of n + 1 '0's.
Versions
Lean 4.21.0-nightly-2025-06-08
Target: x86_64-unknown-linux-gnu
Impact
Add 👍 to issues you consider important. If others are impacted by this issue, please ask them to add 👍 to it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the Nat.toDigits examples in the issue, then locate the Nat.toDigits definition and its documentation. Determine whether base 1 should be documented as unsupported or produce unary output; done means the chosen behavior is implemented or documented and the examples have corresponding coverage.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100