diff options
| author | bculkin2442 <bjculkin@mix.wvu.edu> | 2017-03-06 14:15:03 -0500 |
|---|---|---|
| committer | bculkin2442 <bjculkin@mix.wvu.edu> | 2017-03-06 14:15:03 -0500 |
| commit | 9139064c95f6c9c4f7ba1d0aea21e2f5233ad188 (patch) | |
| tree | dd93017bff73e61fec20c58b7baa43d1662c0c5b /dice-lang/src/bjc/dicelang/dice/DieList.java | |
| parent | b11f8d2c92aaaf1160e69190559ffadc4774f138 (diff) | |
Formatting/Documentation
Diffstat (limited to 'dice-lang/src/bjc/dicelang/dice/DieList.java')
| -rw-r--r-- | dice-lang/src/bjc/dicelang/dice/DieList.java | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/dice-lang/src/bjc/dicelang/dice/DieList.java b/dice-lang/src/bjc/dicelang/dice/DieList.java index a55f2b9..5454759 100644 --- a/dice-lang/src/bjc/dicelang/dice/DieList.java +++ b/dice-lang/src/bjc/dicelang/dice/DieList.java @@ -1,8 +1,30 @@ package bjc.dicelang.dice;
+/**
+ * Represents a group of dice.
+ *
+ * @author Ben Culkin.
+ */
public interface DieList {
+ /**
+ * Can this list be optimized?
+ *
+ * @return Whether or not this list cna be optimized.
+ */
boolean canOptimize();
+ /**
+ * Optimize this list, if it can be done.
+ *
+ * Invoking this on unoptimizable expression is undefined.
+ *
+ * @return The optimized form of this list.
+ */
long[] optimize();
+ /**
+ * Roll this group of dice.
+ *
+ * @param A possible roll of this group.
+ */
long[] roll();
-}
\ No newline at end of file +}
|