blob: a08faa9fa66fa3d0564599f4225ba30962dae5a3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
# Boolean Values
Boolean values have the type `Bool` and can be either `yes` ("true") or `no`
("false").
# Boolean Functions
This documentation provides details on boolean functions available in the API.
## `from_text`
**Description:**
Converts a string representation of a boolean value into a boolean. Acceptable
boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`,
`true`/`false`, `on`/`off`.
**Signature:**
```tomo
func from_text(text: Text, success: Bool = !&Bool -> Bool)
```
**Parameters:**
- `text`: The string containing the boolean value.
- `success`: If provided, this boolean value reference will be set to `yes` if the given text is a recognizable boolean value or `no` otherwise.
**Returns:**
`yes` if the string matches a recognized truthy boolean value; otherwise return `no`.
**Example:**
```tomo
>> Bool.from_text("yes")
= yes
>> Bool.from_text("no")
= no
>> success := yes
>> Bool.from_text("???", &success)
= no
>> success
= no
```
---
## `random`
**Description:**
Generates a random boolean value based on a specified probability.
**Signature:**
```tomo
func random(p: Float = 0.5 -> Bool)
```
**Parameters:**
- `p`: The probability (between `0` and `1`) of returning `yes`. Default is `0.5`.
**Returns:**
`yes` with probability `p`, and `no` with probability `1 - p`.
**Example:**
```tomo
>> Bool.random(70%) // yes (with 70% probability)
```
|
