Skip to content

[doc] Add user manual for Decimo library and the CLI tool #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
forfudan merged 2 commits into from
Mar 6, 2026
Merged

[doc] Add user manual for Decimo library and the CLI tool #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
010d646
Add manual
forfudan Mar 6, 2026
e6b5cbb
Fix typos
forfudan Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 1 addition & 22 deletions docs/plans/api_roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,35 +249,14 @@ var d = x.digit(i) # Returns i-th decimal digit
var y = x.clamp(lower, upper) # clamp between bounds
```

### 5.8 `sign()` Method Returning Int

```mojo
# Python's math.copysign pattern:
var s = x.sign() # Returns -1, 0, or 1 as Int (not Bool)
```

Currently `sign` is a `Bool` field on BigDecimal. Consider a `signum()` method that returns `Int` (-1/0/1).

### 5.9 Approximate Equality
### 5.8 Approximate Equality

```mojo
# Useful for testing and numerical code:
x.is_close(y, tolerance=BigDecimal("0.001"))
x.is_close(y, rel_tol=BigDecimal("1e-9"))
```

### 5.10 Format Control

```mojo
# Format with locale-aware separators:
x.format(decimal_places=2, thousands_separator=",") # "1,234,567.89"
x.format(decimal_places=2, thousands_separator="_") # "1_234_567.89"
```

BigInt has `to_string_with_separators()`. This should be extended to BigDecimal.

---

## Part VI: Remaining Tasks (Re-ranked)

> Updated after audit on 2026-02-27. Items already completed are removed.
Expand Down
48 changes: 44 additions & 4 deletions docs/plans/cli_calculator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,18 @@ Format the final `BigDecimal` result based on CLI flags:
6. Handle unary minus.
7. Test with basic expressions.

| # | Task | Status | Notes |
| --- | ------------------------------------------------ | :----: | ----------------------------- |
| 1.1 | Project structure (src/cli/, calculator module) | ✓ | |
| 1.2 | Tokenizer (numbers, `+ - * /`, parens) | ✓ | |
| 1.3 | Shunting-yard parser (infix → RPN) | ✓ | |
| 1.4 | RPN evaluator using `BigDecimal` | ✓ | |
| 1.5 | ArgMojo wiring (`expr`, `--precision`, `--help`) | ✓ | |
| 1.6 | Unary minus | ✓ | |
| 1.7 | Basic expression tests | ✓ | 4 test files, 118 tests total |
| 1.8 | Pipeline / stdin input (`echo "1+2" \| decimo`) | ✗ | Not yet implemented |
| 1.9 | File input (`decimo file.dm`) | ✗ | Not yet implemented |

### Phase 2: Power and Functions

1. Add `^` operator with right associativity.
Expand All @@ -265,6 +277,19 @@ Format the final `BigDecimal` result based on CLI flags:
4. Add built-in constants (`pi`, `e`).
5. Add output formatting flags (`--scientific` or `-s`, `--engineering` or `-e`, `--pad-to-precision` or `-P`).

| # | Task | Status | Notes |
| ---- | ----------------------------------------------------------------- | :----: | ----------------------------------------------- |
| 2.1 | `^` operator (right-associative, `**` alias) | ✓ | |
| 2.2 | Single-arg functions: `sqrt`, `cbrt`, `ln`, `log10`, `exp`, `abs` | ✓ | |
| 2.3 | Trig functions: `sin`, `cos`, `tan`, `cot`, `csc` | ✓ | `cot` and `csc` are extras beyond original plan |
| 2.4 | Multi-arg functions: `root(x, n)`, `log(x, base)` | ✓ | `log(x, base)` is an extra |
| 2.5 | Constants: `pi`, `e` | ✓ | |
| 2.6 | `--scientific` / `-s` | ✓ | |
| 2.7 | `--engineering` / `-e` | ✓ | |
| 2.8 | `--pad` / `-P` (trailing zeros) | ✓ | |
| 2.9 | `--delimiter` / `-d` (digit grouping) | ✓ | Extra feature beyond original plan |
| 2.10 | `--rounding-mode` / `-r` | ✓ | 7 modes; extra feature beyond original plan |

### Phase 3: Polish

1. Error messages: clear diagnostics for malformed expressions (e.g., "Unexpected token '*' at position 5").
Expand All @@ -274,6 +299,15 @@ Format the final `BigDecimal` result based on CLI flags:
5. Documentation and examples in README.
6. Build and distribute as a single binary.

| # | Task | Status | Notes |
| --- | ---------------------------------------------------------------------- | :----: | --------------------------------------------- |
| 3.1 | Error messages with position info + caret display | ✓ | Colored stderr: red `Error:`, green `^` caret |
| 3.2 | Edge cases (div-by-zero, negative sqrt, empty expression, etc.) | ✓ | 27 error-handling tests |
| 3.3 | ArgMojo v0.2.0 upgrade (`add_tip()`, `allow_negative_numbers()`, etc.) | ? | Blocked: waiting for ArgMojo v0.2.0 in pixi |
| 3.4 | Performance validation | ✗ | No CLI-level benchmarks yet |
| 3.5 | Documentation (user manual for CLI) | ✗ | Will be `docs/user_manual_cli.md` |
| 3.6 | Build and distribute as single binary | ✗ | |

### Phase 4: Interactive REPL

1. Read-eval-print loop: read a line from stdin, evaluate, print result, repeat.
Expand All @@ -300,12 +334,20 @@ Error: division by zero
decimo> exit
```

| # | Task | Status | Notes |
| --- | ---------------------------------------- | :----: | ----- |
| 4.1 | Read-eval-print loop | ✗ | |
| 4.2 | Custom prompt (`decimo>`) | ✗ | |
| 4.3 | `ans` variable (previous result) | ✗ | |
| 4.4 | Variable assignment (`x = expr`) | ✗ | |
| 4.5 | Session-level precision (`:precision N`) | ✗ | |
| 4.6 | Graceful exit (`exit`, `quit`, Ctrl-D) | ✗ | |
| 4.7 | Error recovery (don't crash session) | ✗ | |

### Phase 5: Future Enhancements

1. Detect full-width digits/operators for CJK users while parsing.

---

### ArgMojo v0.2.0 Upgrade Tasks

> **Prerequisite:** ArgMojo ≥ v0.2.0 is available as a pixi package.
Expand Down Expand Up @@ -367,8 +409,6 @@ Although not needed immediately, the new `add_subcommand()` API could later supp

This is deferred to Phase 4 planning.

---

## Design Decisions

### All Numbers Are `BigDecimal`
Expand Down
Loading