Skip to content

Commit 5573ae7

Browse files
committed
docs: update README with overview and lake build instructions; mark OrdFact proven
1 parent 8e2d0af commit 5573ae7

1 file changed

Lines changed: 21 additions & 43 deletions

File tree

README.md

Lines changed: 21 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This repository contains Lean 4 formalizations of key mathematical results relat
1414

1515
| Theorem | File | Status | Description |
1616
|---------|------|--------|-------------|
17-
| **Ord-факт** | `Collatz/OrdFact.lean` |Examples proven | ord_{2^t}(3) = 2^{t-2} for t ≥ 3 |
17+
| **Ord-fact** | `Collatz/OrdFact.lean` |Proven | ord_{2^t}(3) = 2^{t-2} for t ≥ 3 |
1818
| **⟨Δ⟩ generates Z/Q_t Z** | `Collatz/Semigroup.lean` | 🟡 Structured | Junction shifts additively generate full group |
1919
| **SEDT envelope** | `Collatz/SEDT.lean` | ✅ Statement formalized | Negative drift ΔV ≤ -ε·L + β·C for long epochs |
2020

@@ -58,18 +58,11 @@ cd collatz-lean4
5858
# Build the project
5959
lake build
6060

61-
# Run examples
62-
lake env lean --run Collatz/Examples.lean
61+
# Build examples module (optional)
62+
lake build Collatz.Examples
6363
```
6464

65-
### Expected Output
66-
67-
```
68-
Build completed successfully (3084 jobs).
69-
✅ Basic.lean: 100% proven (0 sorry)
70-
✅ OrdFact examples t=3,4,5: PROVEN
71-
🟡 Arithmetic.lean: 87% proven (20/23 lemmas)
72-
```
65+
If everything is configured, `lake build` should complete successfully.
7366

7467
## 📚 Key Results
7568

@@ -140,28 +133,16 @@ lake build Collatz.OrdFact
140133
lake env lean Collatz/Arithmetic.lean
141134
```
142135

143-
### Working with `sorry` Placeholders
136+
### `sorry` Status
144137

145-
Some lemmas contain `sorry` placeholders with detailed proof strategies documented in comments. These represent:
146-
147-
1. **Advanced techniques** (e.g., Hensel lifting in `pow_lift_double`)
148-
2. **Known results** requiring extensive formalization (e.g., 2-adic valuation lemma)
149-
3. **Future work** explicitly marked as deferred
150-
151-
Example:
152-
```lean
153-
lemma pow_lift_double {a k t : ℕ} (ha : Odd a) (ht : t ≥ 1)
154-
(h : (a : ZMod (2^t))^k = 1) :
155-
(a : ZMod (2^(t+1)))^(2*k) = 1 := by
156-
-- PROOF STRATEGY:
157-
-- Case 1: x = 1 (where x = (a : ZMod (2^{t+1}))^k) → trivial
158-
-- Case 2: x ≠ 1 → x = 1 + 2^t → use (1 + 2^t)^2 ≡ 1 (mod 2^{t+1})
159-
sorry -- Full proof requires advanced ZMod cast manipulation
160-
```
138+
- `Collatz/Arithmetic.lean`: 0 `sorry` (complete)
139+
- `Collatz/OrdFact.lean`: 0 `sorry` (complete; main theorem proven)
140+
- `Collatz/Semigroup.lean`, `Collatz/SEDT.lean`: may contain remaining `sorry` items marked for future work
161141

162142
### CI/CD
163143

164144
GitHub Actions automatically:
145+
165146
- ✅ Builds the project on push/PR
166147
- ✅ Caches Lake dependencies
167148
- ✅ Runs examples
@@ -184,8 +165,8 @@ See `../collatz-paper/` for the main mathematical paper and computational verifi
184165

185166
### Dependencies
186167

187-
- **Lean 4**: v4.24.0-rc1
188-
- **mathlib4**: Latest (automatically fetched by Lake)
168+
- **Lean 4**: v4.24.0-rc1 or later
169+
- **mathlib4**: latest (resolved by Lake)
189170

190171
## 🤝 Contributing
191172

@@ -199,37 +180,34 @@ See `../collatz-paper/` for the main mathematical paper and computational verifi
199180
### Completing `sorry` Proofs
200181

201182
Priority areas for contributions:
202-
1. `pow_lift_double` in `Arithmetic.lean` (Hensel lifting)
203-
2. `three_pow_valuation` in `OrdFact.lean` (2-adic valuation)
204-
3. `odd_is_generator` in `Semigroup.lean` (cyclic group theory)
205183

206-
## 📊 Statistics
184+
1. `Semigroup.lean`: cyclic generation details and supporting lemmas
185+
2. `SEDT.lean`: strengthening envelope bounds and completing deferred steps
186+
187+
## 📊 Status Snapshot
207188

208-
| Metric | Value |
209-
|--------|-------|
210-
| **Total files** | 7 |
211-
| **Total lemmas/theorems** | 50+ |
212-
| **Proven lemmas** | 35+ (70%) |
213-
| **Examples** | 15 (100% proven) |
214-
| **Build jobs** | 3084 |
215-
| **Build time** | ~16s (cached) |
189+
- Ord-fact main theorem: proven
190+
- Arithmetic lemmas: complete
191+
- CI: builds on push/PR via GitHub Actions
216192

217193
## 🎯 Future Work
218194

219195
### Short-term
196+
220197
- [ ] Complete `pow_lift_double` full proof (~2-3 hours)
221198
- [ ] Finalize Semigroup ZMod cast details (~1 hour)
222199
- [ ] Add more worked examples for SEDT
223200

224201
### Long-term
202+
225203
- [ ] Full SEDT proof (multi-step induction)
226204
- [ ] Cycle exclusion formalization (Appendix B)
227205
- [ ] Coercivity proof (Appendix C)
228206
- [ ] Integration with computational verification results
229207

230208
## 📝 License
231209

232-
[Your license here]
210+
MIT — see `LICENSE`.
233211

234212
## 🙏 Acknowledgments
235213

0 commit comments

Comments
 (0)