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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
use crate::errors;
use crate::roll;
/// struct containing the Equation compiled for faster evaluation
///
/// # Example
///
/// ```
/// use dice_forge::Equation;
/// let my_equation = Equation::new("3d5").unwrap();
/// let my_roll = my_equation.roll().unwrap();
/// ````
pub struct Equation {
pub(crate) compiled_equation: Vec<Token>,
}
impl Equation {
/// Compiles and returns a new `Equation` object.
///
/// The `input` parameter should be a string representing a valid mathematical equation. The equation can
/// include dice notation in the format "NdM" where N is the number of dice to roll, and M is the number
/// of sides on each die. For example, "2d6" would roll two six-sided dice. The equation can also include
/// standard mathematical operators such as addition (+), subtraction (-), multiplication (*), and division (/).
/// Parentheses can be used to group sub-expressions together.
///
/// The function compiles the equation into a postfix format that is optimized for efficient evaluation.
/// The resulting `Equation` object can then be used to roll the dice and perform basic math operations
/// without the need for recompilation.
///
/// # Example
///
/// Creating a new `Equation` object and rolling the dice:
///
/// ```
/// use dice_forge::Equation;
///
/// let my_equation = Equation::new("3d5+10/2^2").unwrap();
/// let result = my_equation.roll().unwrap();
/// println!("Result: {}", result);
/// ```
pub fn new(input: &str) -> Result<Equation, errors::InvalidExpressionError> {
let compiled_equation = infix_to_postfix(input)?;
Ok(Equation { compiled_equation })
}
/// Rolls the given `Equation` object.
///
/// The `input` parameter should be a string representing a valid mathematical equation that can include
/// dice notation. Dice notation should be in the format "NdM" where N is the number of dice to roll,
/// and M is the number of sides on each die. For example, "2d6" would roll two six-sided dice.
/// Dice notation can also be combined with standard mathematical operators, such as addition (+),
/// subtraction (-), multiplication (*), division (/), and exponent (^). Parentheses can also be used to group
/// sub-expressions together. For example, "10+(3+2d6*2)+3(2d20)+d2" is a valid equation that includes
/// dice notation.
///
/// # Examples
///
/// Rolling 1d4:
/// ```
/// use dice_forge::Equation;
///
/// let my_equation = Equation::new("1d4").unwrap();
/// let result = my_equation.roll().unwrap();
///
/// println!("Result: {}", result);
/// ```
///
/// Rolling 2d6 a modifier:
/// ```
/// use dice_forge::Equation;
///
/// let my_equation = Equation::new("2d6+4").unwrap();
/// let result = my_equation.roll().unwrap();
///
/// println!("Result: {}", result);
/// ```
///
/// Rolling a more complex equation:
/// ```
/// use dice_forge::Equation;
/// let my_equation = Equation::new("10+(3+2d6*2)+3(2d20)+d2").unwrap();
/// let result = my_equation.roll().unwrap();
///
/// println!("Result: {}", result);
/// ```
#[inline(always)]
pub fn roll(&self) -> Result<i32, errors::InvalidExpressionError> {
// todo!();
Ok(roll::process(self, RollType::Default)?)
}
/// calculates the product of the equation assuming the average roll of all die in the equation
///
/// # Example
///
/// ```
/// use dice_forge::Equation;
/// println!("average roll {}", Equation::new("3d5+10/2^2").unwrap().average().unwrap());
/// ````
#[inline(always)]
pub fn average(&self) -> Result<i32, errors::InvalidExpressionError> {
Ok(roll::process(self, RollType::Average)?)
}
/// Calculates the range of possible values that can be produced by the equation.
///
/// The range is calculated by finding the product of the highest and lowest possible rolls for
/// all dice in the equation. Note that this calculation will not take into account any additional
/// mathematical operations in the equation, and may not accurately represent the true range of
/// possible values.
///
/// # Example
///
/// ```
/// use dice_forge::Equation;
///
/// let (low, high) = Equation::new("3d5+10/2^2").unwrap().range().unwrap();
///
/// println!("Range: {} - {}", low, high);
/// ```
#[inline(always)]
pub fn range(&self) -> Result<(i32, i32), errors::InvalidExpressionError> {
let low = roll::process(self, RollType::Low)?;
let high = roll::process(self, RollType::High)?;
Ok((low, high))
}
/// Calculates the lowest possible value that can be produced by the equation.
///
/// The value is calculated by finding the product of the lowest possible rolls for
/// all dice in the equation. Note that this calculation will not take into account any additional
/// mathematical operations in the equation, and may not accurately represent the true lowest of
/// possible values.
///
/// # Example
///
/// ```
/// use dice_forge::Equation;
///
/// let low = Equation::new("3d5+10/2^2").unwrap().low().unwrap();
///
/// println!("Low: {}", low);
/// ```
#[inline(always)]
pub fn low(&self) -> Result<i32, errors::InvalidExpressionError> {
Ok(roll::process(self, RollType::Low)?)
}
/// Calculates the highest possible value that can be produced by the equation.
///
/// The value is calculated by finding the product of the highest possible rolls for
/// all dice in the equation. Note that this calculation will not take into account any additional
/// mathematical operations in the equation, and may not accurately represent the true highest of
/// possible values.
///
/// # Example
///
/// ```
/// use dice_forge::Equation;
///
/// let high = Equation::new("3d5+10/2^2").unwrap().high().unwrap();
///
/// println!("High: {}", high);
/// ```
#[inline(always)]
pub fn high(&self) -> Result<i32, errors::InvalidExpressionError> {
Ok(roll::process(self, RollType::High)?)
}
/// Rolls the given `Equation` object with advantage.
///
/// The `input` parameter should be a string representing a valid mathematical equation that can include
/// dice notation. Dice notation should be in the format "NdM" where N is the number of dice to roll,
/// and M is the number of sides on each die. For example, "2d6" would roll two six-sided dice.
/// Dice notation can also be combined with standard mathematical operators, such as addition (+),
/// subtraction (-), multiplication (*), division (/), and exponent (^). Parentheses can also be used to group
/// sub-expressions together. For example, "10+(3+2d6*2)+3(2d20)+d2" is a valid equation that includes
/// dice notation.
///
/// The function rolls the given equation twice and returns the greater of the two results. This
/// emulates the "advantage" mechanic in some games, where a player can roll two dice and take the greater result.
///
/// # Examples
///
/// Rolling 1d4:
/// ```
/// use dice_forge::Equation;
///
/// let my_equation = Equation::new("1d4").unwrap();
/// let result = my_equation.advantage().unwrap();
///
/// println!("Result: {}", result);
/// ```
///
/// Rolling 2d6 a modifier:
/// ```
/// use dice_forge::Equation;
///
/// let my_equation = Equation::new("2d6+4").unwrap();
/// let result = my_equation.advantage().unwrap();
///
/// println!("Result: {}", result);
/// ```
///
/// Rolling a more complex equation:
/// ```
/// use dice_forge::Equation;
/// let my_equation = Equation::new("10+(3+2d6*2)+3(2d20)+d2").unwrap();
/// let result = my_equation.advantage().unwrap();
///
/// println!("Result: {}", result);
/// ```
#[inline(always)]
pub fn advantage(&self) -> Result<i32, errors::InvalidExpressionError> {
let r1 = self.roll()?;
let r2 = self.roll()?;
Ok(std::cmp::max(r1, r2))
}
/// Rolls the given `Equation` object with disadvantage.
///
/// The `input` parameter should be a string representing a valid mathematical equation that can include
/// dice notation. Dice notation should be in the format "NdM" where N is the number of dice to roll,
/// and M is the number of sides on each die. For example, "2d6" would roll two six-sided dice.
/// Dice notation can also be combined with standard mathematical operators, such as addition (+),
/// subtraction (-), multiplication (*), division (/), and exponent (^). Parentheses can also be used to group
/// sub-expressions together. For example, "10+(3+2d6*2)+3(2d20)+d2" is a valid equation that includes
/// dice notation.
///
/// The function rolls the given equation twice and returns the lesser of the two results. This
/// emulates the "disadvantage" mechanic in some games, where a player can roll two dice and take the lesser result.
///
/// # Examples
///
/// Rolling 1d4:
/// ```
/// use dice_forge::Equation;
///
/// let my_equation = Equation::new("1d4").unwrap();
/// let result = my_equation.disadvantage().unwrap();
///
/// println!("Result: {}", result);
/// ```
///
/// Rolling 2d6 a modifier:
/// ```
/// use dice_forge::Equation;
///
/// let my_equation = Equation::new("2d6+4").unwrap();
/// let result = my_equation.disadvantage().unwrap();
///
/// println!("Result: {}", result);
/// ```
///
/// Rolling a more complex equation:
/// ```
/// use dice_forge::Equation;
/// let my_equation = Equation::new("10+(3+2d6*2)+3(2d20)+d2").unwrap();
/// let result = my_equation.disadvantage().unwrap();
///
/// println!("Result: {}", result);
/// ```
#[inline(always)]
pub fn disadvantage(&self) -> Result<i32, errors::InvalidExpressionError> {
let r1 = self.roll()?;
let r2 = self.roll()?;
Ok(std::cmp::min(r1, r2))
}
/// Calculates the highest possible value that can be produced by the equation.
///
/// The value is calculated by finding the product of the highest possible rolls for
/// all dice in the equation. Note that this calculation will not take into account any additional
/// mathematical operations in the equation, and may not accurately represent the true highest of
/// possible values.
///
/// # Example
///
/// ```
/// use dice_forge::Equation;
///
/// let high = Equation::new("3d5+10/2^2").unwrap().high().unwrap();
///
/// println!("High: {}", high);
/// ```
#[inline(always)]
pub fn emphasis(&self) -> Result<i32, errors::InvalidExpressionError> {
Ok(roll::process(self, RollType::Emphasis)?)
}
}
pub(crate) enum RollType {
Default,
Average,
Low,
High,
Emphasis,
}
#[derive(Clone, Copy)]
pub(crate) enum Token {
Operand(u32),
Plus,
Minus,
Times,
Divide,
Exponent,
L,
Dice(Die),
}
#[derive(Clone, Copy)]
pub(crate) struct Die {
pub(crate) number: u32,
pub(crate) sides: u32,
}
pub(crate) fn infix_to_postfix(input: &str) -> Result<Vec<Token>, errors::InvalidExpressionError> {
let mut output_queue: Vec<Token> = Vec::with_capacity(input.len());
let mut operator_stack: Vec<Token> = Vec::with_capacity(input.len());
let mut last_token_was_operand = false;
let mut last_token_was_die = false;
let mut error = None;
for token in input.chars().filter(|c| !c.is_whitespace()) {
match token {
'0'..='9' => {
if last_token_was_operand {
let digit: u32;
if let Token::Operand(value) = output_queue.pop().unwrap() {
digit = value * 10 + token.to_digit(10).unwrap();
output_queue.push(Token::Operand(digit));
last_token_was_operand = true;
} else {
panic!()
}
} else if last_token_was_die {
if let Token::Dice(cdie) = output_queue.pop().unwrap() {
let number = cdie.number;
let sides = cdie.sides * 10 + token.to_digit(10).unwrap();
output_queue.push(Token::Dice(Die { number, sides }));
last_token_was_die = true;
} else {
panic!()
}
} else {
let digit = token.to_digit(10).unwrap();
output_queue.push(Token::Operand(digit));
last_token_was_operand = true;
}
}
'(' => {
if last_token_was_operand | last_token_was_die {
operator_stack.push(Token::Times);
}
operator_stack.push(Token::L);
last_token_was_operand = false;
last_token_was_die = false;
}
')' => {
while let Some(operator) = operator_stack.pop() {
if let Token::L = operator {
break;
} else {
output_queue.push(operator);
}
}
last_token_was_operand = false;
last_token_was_die = false;
}
'+' => {
if !last_token_was_operand && !last_token_was_die {
output_queue.push(Token::Operand(0));
}
let token_precedence = operator_precedence(Token::Plus);
while let Some(&top) = operator_stack.last() {
if let Token::L = top {
break;
} else {
let top_precedence = operator_precedence(top);
if token_precedence <= top_precedence {
output_queue.push(operator_stack.pop().unwrap());
} else {
break;
}
}
}
operator_stack.push(Token::Plus);
last_token_was_operand = false;
last_token_was_die = false;
}
'-' => {
if !last_token_was_operand && !last_token_was_die {
output_queue.push(Token::Operand(0));
}
let token_precedence = operator_precedence(Token::Minus);
while let Some(&top) = operator_stack.last() {
if let Token::L = top {
break;
} else {
let top_precedence = operator_precedence(top);
if token_precedence <= top_precedence {
output_queue.push(operator_stack.pop().unwrap());
} else {
break;
}
}
}
operator_stack.push(Token::Minus);
last_token_was_operand = false;
last_token_was_die = false;
}
'*' => {
let token_precedence = operator_precedence(Token::Times);
while let Some(&top) = operator_stack.last() {
if let Token::L = top {
break;
} else {
let top_precedence = operator_precedence(top);
if token_precedence <= top_precedence {
output_queue.push(operator_stack.pop().unwrap());
} else {
break;
}
}
}
operator_stack.push(Token::Times);
last_token_was_operand = false;
last_token_was_die = false;
}
'/' => {
let token_precedence = operator_precedence(Token::Divide);
while let Some(&top) = operator_stack.last() {
if let Token::L = top {
break;
} else {
let top_precedence = operator_precedence(top);
if token_precedence <= top_precedence {
output_queue.push(operator_stack.pop().unwrap());
} else {
break;
}
}
}
operator_stack.push(Token::Divide);
last_token_was_operand = false;
last_token_was_die = false;
}
'^' => {
let token_precedence = operator_precedence(Token::Exponent);
while let Some(&top) = operator_stack.last() {
let top_precedence = operator_precedence(top);
if token_precedence <= top_precedence {
output_queue.push(operator_stack.pop().unwrap());
} else {
break;
}
}
operator_stack.push(Token::Exponent);
last_token_was_operand = false;
last_token_was_die = false;
}
'd' => {
if last_token_was_operand {
if let Token::Operand(die_count) = output_queue.pop().unwrap() {
output_queue.push(Token::Dice(Die {
number: die_count,
sides: 0,
}))
}
} else {
output_queue.push(Token::Dice(Die {
number: 1,
sides: 0,
}))
}
last_token_was_operand = false;
last_token_was_die = true;
}
_ => {
error = Some(errors::InvalidExpressionError::InvalidToken(token));
break;
}
}
}
if let Some(err) = error {
return Err(err);
}
while let Some(operator) = operator_stack.pop() {
output_queue.push(operator);
}
Ok(output_queue)
}
#[inline(always)]
fn operator_precedence(token: Token) -> i32 {
match token {
Token::Plus | Token::Minus => 1,
Token::Times | Token::Divide => 2,
Token::Exponent => 3,
Token::Operand(_) => panic!("Expected operator, found operand"),
Token::L => 4,
Token::Dice(_) => panic!("Expected operator, found operand"),
}
}