Updated Javadoc for Troolean

liflab · Jun 12, 2024 · b532220 · b532220
1 parent 1c5753e
commit b532220
Showing 1 changed file with 24 additions and 2 deletions.
diff --git a/Ltl/src/ca/uqac/lif/cep/ltl/Troolean.java b/Ltl/src/ca/uqac/lif/cep/ltl/Troolean.java
@@ -25,8 +25,30 @@
 
 /**
  * Implementation of a three-valued logic. The "Troolean" type
- * has three values: TRUE, FALSE and INCONCLUSIVE (which can also
- * stand for UNKNOWN).
+ * has three values: TRUE ("&top;"), FALSE ("&bot;") and INCONCLUSIVE ("?",
+ * which can also stand for UNKNOWN). The truth table for Troolean connectives
+ * is defined as follows:
+ * <p>
+ * <table border="1">
+ * <tr><th>&and;</th><th>&bot;</th><th>?</th><th>&top;</hd></tr>
+ * <tr><th>&bot;</th><td>&bot;</td><td>&bot;</td><td>&bot;</td></tr>
+ * <tr><th>?</th><td>&bot;</td><td>?</td><td>?</td></tr>
+ * <tr><th>&top;</th><td>&bot;</td><td>?</td><td>&top;</td></tr>
+ * </table>
+ * <p>
+ * <table border="1">
+ * <tr><th>&or;</th><th>&bot;</th><th>?</th><th>&top;</th></tr>
+ * <tr><th>&bot;</th><td>&bot;</td><td>?</td><td>&top;</td></tr>
+ * <tr><th>?</th><td>?</td><td>?</td><td>&top;</td></tr>
+ * <tr><th>&top;</th><td>&top;</td><td>&top;</td><td>&top;</td></tr>
+ * </table>
+ * <p>
+ * <table border="1">
+ * <tr><th>&not;</th><td></td></tr>
+ * <tr><th>&bot;</th><td>&top;</td></tr>
+ * <tr><th>?</th><td>?</td></tr>
+ * <tr><th>&top;</th><td>&bot;</td></tr>
+ * </table>
  */
 public class Troolean extends Constant
 {