pips 0.2.5

Library for analyzing dice roll expressions in TTRPGs
Documentation 
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use crate::traits::RollResult;

/// An operator that performs some logic on two inputs
pub type BinaryOperator = fn(left: &RollResult, right: &RollResult) -> RollResult;

/// Find the sum of two rolls
pub fn sum(left: &RollResult, right: &RollResult) -> RollResult {
    (*left) + (*right)
}

/// Find the difference between two rolls
pub fn difference(left: &RollResult, right: &RollResult) -> RollResult {
    (*left) - (*right)
}

/// Multiple two rolls
pub fn multiply(left: &RollResult, right: &RollResult) -> RollResult {
    (*left) * (*right)
}

/// Divide two rolls
pub fn divide(left: &RollResult, right: &RollResult) -> RollResult {
    // TODO: account for divide-by-zero
    (*left) / (*right)
}

/// Take the greater of two rolls
pub fn advantage(left: &RollResult, right: &RollResult) -> RollResult {
    if *left > *right {
        *left
    } else {
        *right
    }
}

/// Take the lesser of two rolls
pub fn disadvantage(left: &RollResult, right: &RollResult) -> RollResult {
    if *left < *right {
        *left
    } else {
        *right
    }
}

/// Compare two rolls
///
/// returns:
/// - `1` if left is greater than right
/// - `0` if left is equal to right
/// - `-1` if left is less than right
pub fn compare(left: &RollResult, right: &RollResult) -> RollResult {
    if *left > *right {
        1
    } else if *left == *right {
        0
    } else {
        -1
    }
}

/// 1 if right is greater than left else 0
pub fn greater_than(left: &RollResult, right: &RollResult) -> RollResult {
    if *left > *right {
        1
    } else {
        0
    }
}

/// 1 if right is greater than or equal to left else 0
pub fn greater_than_or_equal_to(left: &RollResult, right: &RollResult) -> RollResult {
    if *left >= *right {
        1
    } else {
        0
    }
}

/// 1 if right is less than left else 0
pub fn less_than(left: &RollResult, right: &RollResult) -> RollResult {
    if *left > *right {
        1
    } else {
        0
    }
}

/// 1 if right is less than left else 0
pub fn less_than_or_equal_to(left: &RollResult, right: &RollResult) -> RollResult {
    if *left >= *right {
        1
    } else {
        0
    }
}

/// 1 if right is equal to left else 0
pub fn equal_to(left: &RollResult, right: &RollResult) -> RollResult {
    if *left == *right {
        1
    } else {
        0
    }
}