aboutsummaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
Diffstat (limited to 'api')
-rw-r--r--api/api.md48
-rw-r--r--api/integers.md48
-rw-r--r--api/integers.yaml48
3 files changed, 72 insertions, 72 deletions
diff --git a/api/api.md b/api/api.md
index df8386ff..9e7c553e 100644
--- a/api/api.md
+++ b/api/api.md
@@ -449,7 +449,7 @@ k | `Int` | The number of things to be chosen. | -
**Example:**
```tomo
-assert (4).choose(2) == 6
+assert 4.choose(2) == 6
```
## Int.clamped
@@ -471,7 +471,7 @@ high | `Int` | The highest value the result can take. | -
**Example:**
```tomo
-assert (2).clamped(5, 10) == 5
+assert 2.clamped(5, 10) == 5
```
## Int.factorial
@@ -491,7 +491,7 @@ n | `Int` | The integer to compute the factorial of. | -
**Example:**
```tomo
-assert (10).factorial() == 3628800
+assert 10.factorial() == 3628800
```
## Int.get_bit
@@ -514,10 +514,10 @@ bit_index | `Int` | The index of the bit to check (1-indexed). | -
**Example:**
```tomo
-assert (6).get_bit(1) == no
-assert (6).get_bit(2) == yes
-assert (6).get_bit(3) == yes
-assert (6).get_bit(4) == no
+assert 6.get_bit(1) == no
+assert 6.get_bit(2) == yes
+assert 6.get_bit(3) == yes
+assert 6.get_bit(4) == no
```
## Int.hex
@@ -540,7 +540,7 @@ prefix | `Bool` | Whether to include a "0x" prefix. | `yes`
**Example:**
```tomo
-assert (255).hex(digits=4, uppercase=yes, prefix=yes) == "0x00FF"
+assert 255.hex(digits=4, uppercase=yes, prefix=yes) == "0x00FF"
```
## Int.is_between
@@ -562,10 +562,10 @@ b | `Int` | The other end of the range to check (inclusive). | -
**Example:**
```tomo
-assert (7).is_between(1, 10) == yes
-assert (7).is_between(10, 1) == yes
-assert (7).is_between(100, 200) == no
-assert (7).is_between(1, 7) == yes
+assert 7.is_between(1, 10) == yes
+assert 7.is_between(10, 1) == yes
+assert 7.is_between(100, 200) == no
+assert 7.is_between(1, 7) == yes
```
## Int.is_prime
@@ -588,8 +588,8 @@ reps | `Int` | The number of repetitions for primality tests. | `50`
**Example:**
```tomo
-assert (7).is_prime() == yes
-assert (6).is_prime() == no
+assert 7.is_prime() == yes
+assert 6.is_prime() == no
```
## Int.next_prime
@@ -611,7 +611,7 @@ x | `Int` | The integer after which to find the next prime. | -
**Example:**
```tomo
-assert (11).next_prime() == 13
+assert 11.next_prime() == 13
```
## Int.octal
@@ -633,7 +633,7 @@ prefix | `Bool` | Whether to include a "0o" prefix. | `yes`
**Example:**
```tomo
-assert (64).octal(digits=4, prefix=yes) == "0o0100"
+assert 64.octal(digits=4, prefix=yes) == "0o0100"
```
## Int.onward
@@ -655,7 +655,7 @@ step | `Int` | The increment step size. | `1`
**Example:**
```tomo
nums : &[Int] = &[]
-for i in (5).onward()
+for i in 5.onward()
nums.insert(i)
stop if i == 10
assert nums[] == [5, 6, 7, 8, 9, 10]
@@ -716,7 +716,7 @@ x | `Int` | The integer before which to find the previous prime. | -
**Example:**
```tomo
-assert (11).prev_prime() == 7
+assert 11.prev_prime() == 7
```
## Int.sqrt
@@ -736,8 +736,8 @@ x | `Int` | The integer whose square root is to be calculated. | -
**Example:**
```tomo
-assert (16).sqrt() == 4
-assert (17).sqrt() == 4
+assert 16.sqrt() == 4
+assert 17.sqrt() == 4
```
## Int.to
@@ -759,16 +759,16 @@ step | `Int?` | An optional step size to use. If unspecified or `none`, the step
**Example:**
```tomo
-iter := (2).to(5)
+iter := 2.to(5)
assert iter() == 2
assert iter() == 3
assert iter() == 4
assert iter() == 5
assert iter() == none
-assert [x for x in (2).to(5)] == [2, 3, 4, 5]
-assert [x for x in (5).to(2)] == [5, 4, 3, 2]
-assert [x for x in (2).to(5, step=2)] == [2, 4]
+assert [x for x in 2.to(5)] == [2, 3, 4, 5]
+assert [x for x in 5.to(2)] == [5, 4, 3, 2]
+assert [x for x in 2.to(5, step=2)] == [2, 4]
```
diff --git a/api/integers.md b/api/integers.md
index 73779021..e3fc3f30 100644
--- a/api/integers.md
+++ b/api/integers.md
@@ -41,7 +41,7 @@ k | `Int` | The number of things to be chosen. | -
**Example:**
```tomo
-assert (4).choose(2) == 6
+assert 4.choose(2) == 6
```
## Int.clamped
@@ -63,7 +63,7 @@ high | `Int` | The highest value the result can take. | -
**Example:**
```tomo
-assert (2).clamped(5, 10) == 5
+assert 2.clamped(5, 10) == 5
```
## Int.factorial
@@ -83,7 +83,7 @@ n | `Int` | The integer to compute the factorial of. | -
**Example:**
```tomo
-assert (10).factorial() == 3628800
+assert 10.factorial() == 3628800
```
## Int.get_bit
@@ -106,10 +106,10 @@ bit_index | `Int` | The index of the bit to check (1-indexed). | -
**Example:**
```tomo
-assert (6).get_bit(1) == no
-assert (6).get_bit(2) == yes
-assert (6).get_bit(3) == yes
-assert (6).get_bit(4) == no
+assert 6.get_bit(1) == no
+assert 6.get_bit(2) == yes
+assert 6.get_bit(3) == yes
+assert 6.get_bit(4) == no
```
## Int.hex
@@ -132,7 +132,7 @@ prefix | `Bool` | Whether to include a "0x" prefix. | `yes`
**Example:**
```tomo
-assert (255).hex(digits=4, uppercase=yes, prefix=yes) == "0x00FF"
+assert 255.hex(digits=4, uppercase=yes, prefix=yes) == "0x00FF"
```
## Int.is_between
@@ -154,10 +154,10 @@ b | `Int` | The other end of the range to check (inclusive). | -
**Example:**
```tomo
-assert (7).is_between(1, 10) == yes
-assert (7).is_between(10, 1) == yes
-assert (7).is_between(100, 200) == no
-assert (7).is_between(1, 7) == yes
+assert 7.is_between(1, 10) == yes
+assert 7.is_between(10, 1) == yes
+assert 7.is_between(100, 200) == no
+assert 7.is_between(1, 7) == yes
```
## Int.is_prime
@@ -180,8 +180,8 @@ reps | `Int` | The number of repetitions for primality tests. | `50`
**Example:**
```tomo
-assert (7).is_prime() == yes
-assert (6).is_prime() == no
+assert 7.is_prime() == yes
+assert 6.is_prime() == no
```
## Int.next_prime
@@ -203,7 +203,7 @@ x | `Int` | The integer after which to find the next prime. | -
**Example:**
```tomo
-assert (11).next_prime() == 13
+assert 11.next_prime() == 13
```
## Int.octal
@@ -225,7 +225,7 @@ prefix | `Bool` | Whether to include a "0o" prefix. | `yes`
**Example:**
```tomo
-assert (64).octal(digits=4, prefix=yes) == "0o0100"
+assert 64.octal(digits=4, prefix=yes) == "0o0100"
```
## Int.onward
@@ -247,7 +247,7 @@ step | `Int` | The increment step size. | `1`
**Example:**
```tomo
nums : &[Int] = &[]
-for i in (5).onward()
+for i in 5.onward()
nums.insert(i)
stop if i == 10
assert nums[] == [5, 6, 7, 8, 9, 10]
@@ -308,7 +308,7 @@ x | `Int` | The integer before which to find the previous prime. | -
**Example:**
```tomo
-assert (11).prev_prime() == 7
+assert 11.prev_prime() == 7
```
## Int.sqrt
@@ -328,8 +328,8 @@ x | `Int` | The integer whose square root is to be calculated. | -
**Example:**
```tomo
-assert (16).sqrt() == 4
-assert (17).sqrt() == 4
+assert 16.sqrt() == 4
+assert 17.sqrt() == 4
```
## Int.to
@@ -351,15 +351,15 @@ step | `Int?` | An optional step size to use. If unspecified or `none`, the step
**Example:**
```tomo
-iter := (2).to(5)
+iter := 2.to(5)
assert iter() == 2
assert iter() == 3
assert iter() == 4
assert iter() == 5
assert iter() == none
-assert [x for x in (2).to(5)] == [2, 3, 4, 5]
-assert [x for x in (5).to(2)] == [5, 4, 3, 2]
-assert [x for x in (2).to(5, step=2)] == [2, 4]
+assert [x for x in 2.to(5)] == [2, 3, 4, 5]
+assert [x for x in 5.to(2)] == [5, 4, 3, 2]
+assert [x for x in 2.to(5, step=2)] == [2, 4]
```
diff --git a/api/integers.yaml b/api/integers.yaml
index bbbd395d..68a66752 100644
--- a/api/integers.yaml
+++ b/api/integers.yaml
@@ -35,7 +35,7 @@ Int.choose:
description: >
The number of things to be chosen.
example: |
- assert (4).choose(2) == 6
+ assert 4.choose(2) == 6
Int.clamped:
short: clamp an integer
@@ -60,7 +60,7 @@ Int.clamped:
description: >
The highest value the result can take.
example: |
- assert (2).clamped(5, 10) == 5
+ assert 2.clamped(5, 10) == 5
Int.factorial:
short: factorial
@@ -76,7 +76,7 @@ Int.factorial:
description: >
The integer to compute the factorial of.
example: |
- assert (10).factorial() == 3628800
+ assert 10.factorial() == 3628800
Int.get_bit:
short: check whether a bit is set
@@ -103,10 +103,10 @@ Int.get_bit:
description: >
The index of the bit to check (1-indexed).
example: |
- assert (6).get_bit(1) == no
- assert (6).get_bit(2) == yes
- assert (6).get_bit(3) == yes
- assert (6).get_bit(4) == no
+ assert 6.get_bit(1) == no
+ assert 6.get_bit(2) == yes
+ assert 6.get_bit(3) == yes
+ assert 6.get_bit(4) == no
Int.hex:
short: convert to hexidecimal
@@ -137,7 +137,7 @@ Int.hex:
description: >
Whether to include a "0x" prefix.
example: |
- assert (255).hex(digits=4, uppercase=yes, prefix=yes) == "0x00FF"
+ assert 255.hex(digits=4, uppercase=yes, prefix=yes) == "0x00FF"
Int.is_between:
short: test if an int is in a range
@@ -161,10 +161,10 @@ Int.is_between:
description: >
The other end of the range to check (inclusive).
example: |
- assert (7).is_between(1, 10) == yes
- assert (7).is_between(10, 1) == yes
- assert (7).is_between(100, 200) == no
- assert (7).is_between(1, 7) == yes
+ assert 7.is_between(1, 10) == yes
+ assert 7.is_between(10, 1) == yes
+ assert 7.is_between(100, 200) == no
+ assert 7.is_between(1, 7) == yes
Int.is_prime:
short: check if an integer is prime
@@ -190,8 +190,8 @@ Int.is_prime:
description: >
The number of repetitions for primality tests.
example: |
- assert (7).is_prime() == yes
- assert (6).is_prime() == no
+ assert 7.is_prime() == yes
+ assert 6.is_prime() == no
Int.next_prime:
short: get the next prime
@@ -212,7 +212,7 @@ Int.next_prime:
description: >
The integer after which to find the next prime.
example: |
- assert (11).next_prime() == 13
+ assert 11.next_prime() == 13
Int.octal:
short: convert to octal
@@ -238,7 +238,7 @@ Int.octal:
description: >
Whether to include a "0o" prefix.
example: |
- assert (64).octal(digits=4, prefix=yes) == "0o0100"
+ assert 64.octal(digits=4, prefix=yes) == "0o0100"
Int.onward:
short: iterate from a number onward
@@ -261,7 +261,7 @@ Int.onward:
The increment step size.
example: |
nums : &[Int] = &[]
- for i in (5).onward()
+ for i in 5.onward()
nums.insert(i)
stop if i == 10
assert nums[] == [5, 6, 7, 8, 9, 10]
@@ -334,7 +334,7 @@ Int.prev_prime:
description: >
The integer before which to find the previous prime.
example: |
- assert (11).prev_prime() == 7
+ assert 11.prev_prime() == 7
Int.sqrt:
short: square root
@@ -350,8 +350,8 @@ Int.sqrt:
description: >
The integer whose square root is to be calculated.
example: |
- assert (16).sqrt() == 4
- assert (17).sqrt() == 4
+ assert 16.sqrt() == 4
+ assert 17.sqrt() == 4
Int.to:
short: iterate a range of integers
@@ -376,14 +376,14 @@ Int.to:
description: >
An optional step size to use. If unspecified or `none`, the step will be inferred to be `+1` if `last >= first`, otherwise `-1`.
example: |
- iter := (2).to(5)
+ iter := 2.to(5)
assert iter() == 2
assert iter() == 3
assert iter() == 4
assert iter() == 5
assert iter() == none
- assert [x for x in (2).to(5)] == [2, 3, 4, 5]
- assert [x for x in (5).to(2)] == [5, 4, 3, 2]
- assert [x for x in (2).to(5, step=2)] == [2, 4]
+ assert [x for x in 2.to(5)] == [2, 3, 4, 5]
+ assert [x for x in 5.to(2)] == [5, 4, 3, 2]
+ assert [x for x in 2.to(5, step=2)] == [2, 4]
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-01 05:42:35 +0000