Merge pull request #14 from eliascarv/up-readme

New README
eliascarv · May 11, 2022 · fc9728d · fc9728d
2 parents 56d3492 + a8d52fc
commit fc9728d
Showing 1 changed file with 135 additions and 78 deletions.
diff --git a/README.md b/README.md
@@ -16,24 +16,7 @@ julia>] add TruthTables
 
 ## Usage
 
-To create a truth table use the `@truthtable` macro passing a proposition as an argument. 
-The `@truthtable` macro has a optional keyword argument: `full`, 
-if `full` is `true` the truth table will be created in expanded form.\
-Some logical operators can be expressed using different symbols.
-This is the list of symbols that can be used:
-
-| Operator | Symbols |
-|-----------|-------------|
-| AND  | `&&`, `&`, `∧` (`\wedge<tab>`) |
-| OR   | `\|\|`, `\|`, `∨` (`\vee<tab>`) |
-| NOT  | `!`, `~`, `¬` (`\neg<tab>`) |
-| XOR  | `⊻` (`\xor<tab>`) |
-| NAND | `⊼` (`\nand<tab>`) |
-| NOR  | `⊽` (`\nor<tab>`) |
-| IMPLICATION | `-->` |
-| EQUIVALENCE | `<-->`, `≡` (`\equiv<tab>`) |
-
-Examples:
+To create a truth table use the `@truthtable` macro passing a proposition as an argument:
 
 ```julia
 julia> using TruthTables
@@ -48,25 +31,13 @@ TruthTable
 │ true  │ false │ true  │
 │ false │ false │ false │
 └───────┴───────┴───────┘
+```
 
+The `@truthtable` macro has an optional keyword argument: `full`, 
+if `full` is `true` the truth table will be created in expanded form:
 
-julia> @truthtable p & (~q | r)
-TruthTable
-┌───────┬───────┬───────┬──────────────┐
-│   p   │   q   │   r   │ p ∧ (¬q ∨ r) │
-├───────┼───────┼───────┼──────────────┤
-│ true  │ true  │ true  │ true         │
-│ false │ true  │ true  │ false        │
-│ true  │ false │ true  │ true         │
-│ false │ false │ true  │ false        │
-│ true  │ true  │ false │ false        │
-│ false │ true  │ false │ false        │
-│ true  │ false │ false │ true         │
-│ false │ false │ false │ false        │
-└───────┴───────┴───────┴──────────────┘
-
-
-julia> @truthtable p & (~q | r) full=true
+```julia
+julia> @truthtable p && (!q || r) full=true
 TruthTable
 ┌───────┬───────┬───────┬───────┬────────┬──────────────┐
 │   p   │   q   │   r   │  ¬q   │ ¬q ∨ r │ p ∧ (¬q ∨ r) │
@@ -80,59 +51,145 @@ TruthTable
 │ true  │ false │ false │ true  │ true   │ true         │
 │ false │ false │ false │ true  │ true   │ false        │
 └───────┴───────┴───────┴───────┴────────┴──────────────┘
+```
+
+It is possible to change the way `TruthTable`s are displayed using `TruthTables.showmode!(mode)` function.
+The mode argument can be one of these symbols: `:bool` (default), `:bit` or `:letter`.
+Boolean values (`true` and `false`) will be displayed without formatting in `:bool` mode,
+as `1` and `0` in `:bit` mode and as T and F in `:letter` mode.
+
+```julia
+julia> TruthTables.showmode!(:bit)
+:bit
 
-julia> @truthtable p ∨ q <--> r
+julia> @truthtable p || q <--> r
+TruthTable
+┌───┬───┬───┬──────────────┐
+│ p │ q │ r │ p ∨ q <--> r │
+├───┼───┼───┼──────────────┤
+│ 1 │ 1 │ 1 │ 1            │
+│ 0 │ 1 │ 1 │ 1            │
+│ 1 │ 0 │ 1 │ 1            │
+│ 0 │ 0 │ 1 │ 0            │
+│ 1 │ 1 │ 0 │ 0            │
+│ 0 │ 1 │ 0 │ 0            │
+│ 1 │ 0 │ 0 │ 0            │
+│ 0 │ 0 │ 0 │ 1            │
+└───┴───┴───┴──────────────┘
+
+julia> @truthtable p || q <--> r full=true
+TruthTable
+┌───┬───┬───┬───────┬──────────────┐
+│ p │ q │ r │ p ∨ q │ p ∨ q <--> r │
+├───┼───┼───┼───────┼──────────────┤
+│ 1 │ 1 │ 1 │ 1     │ 1            │
+│ 0 │ 1 │ 1 │ 1     │ 1            │
+│ 1 │ 0 │ 1 │ 1     │ 1            │
+│ 0 │ 0 │ 1 │ 0     │ 0            │
+│ 1 │ 1 │ 0 │ 1     │ 0            │
+│ 0 │ 1 │ 0 │ 1     │ 0            │
+│ 1 │ 0 │ 0 │ 1     │ 0            │
+│ 0 │ 0 │ 0 │ 0     │ 1            │
+└───┴───┴───┴───────┴──────────────┘
+
+julia> TruthTables.showmode!(:letter)
+:letter
+
+julia> @truthtable !(p || q) <--> (!p && !q)
+TruthTable
+┌───┬───┬───────────────────────┐
+│ p │ q │ ¬(p ∨ q) <--> ¬p ∧ ¬q │
+├───┼───┼───────────────────────┤
+│ T │ T │ T                     │
+│ F │ T │ T                     │
+│ T │ F │ T                     │
+│ F │ F │ T                     │
+└───┴───┴───────────────────────┘
+
+julia> @truthtable !(p || q) <--> (!p && !q) full=true
+TruthTable
+┌───┬───┬───────┬──────────┬────┬────┬─────────┬───────────────────────┐
+│ p │ q │ p ∨ q │ ¬(p ∨ q) │ ¬p │ ¬q │ ¬p ∧ ¬q │ ¬(p ∨ q) <--> ¬p ∧ ¬q │
+├───┼───┼───────┼──────────┼────┼────┼─────────┼───────────────────────┤
+│ T │ T │ T     │ F        │ F  │ F  │ F       │ T                     │
+│ F │ T │ T     │ F        │ T  │ F  │ F       │ T                     │
+│ T │ F │ T     │ F        │ F  │ T  │ F       │ T                     │
+│ F │ F │ F     │ T        │ T  │ T  │ T       │ T                     │
+└───┴───┴───────┴──────────┴────┴────┴─────────┴───────────────────────┘
+```
+
+Some logical operators can be expressed using different symbols.
+This is the list of symbols that can be used:
+
+| Operator | Symbols |
+|-----------|-------------|
+| AND  | `&&`, `&`, `∧` (`\wedge<tab>`) |
+| OR   | `\|\|`, `\|`, `∨` (`\vee<tab>`) |
+| NOT  | `!`, `~`, `¬` (`\neg<tab>`) |
+| XOR  | `⊻` (`\xor<tab>`) |
+| NAND | `⊼` (`\nand<tab>`) |
+| NOR  | `⊽` (`\nor<tab>`) |
+| IMPLICATION | `-->` |
+| EQUIVALENCE | `<-->`, `≡` (`\equiv<tab>`) |
+
+Examples:
+
+```julia
+julia> TruthTables.showmode!() # default show mode
+:bool
+
+julia> @truthtable ~p & (q | r)
 TruthTable
 ┌───────┬───────┬───────┬──────────────┐
-│   p   │   q   │   r   │ p ∨ q <--> r │
+│   p   │   q   │   r   │ ¬p ∧ (q ∨ r) │
 ├───────┼───────┼───────┼──────────────┤
-│ true  │ true  │ true  │ true         │
+│ true  │ true  │ true  │ false        │
 │ false │ true  │ true  │ true         │
-│ true  │ false │ true  │ true         │
-│ false │ false │ true  │ false        │
+│ true  │ false │ true  │ false        │
+│ false │ false │ true  │ true         │
 │ true  │ true  │ false │ false        │
-│ false │ true  │ false │ false        │
+│ false │ true  │ false │ true         │
 │ true  │ false │ false │ false        │
-│ false │ false │ false │ true         │
+│ false │ false │ false │ false        │
 └───────┴───────┴───────┴──────────────┘
 
-
-julia> @truthtable p ∨ q <--> r full=true
+julia> @truthtable ~p & (q | r) full=true
 TruthTable
-┌───────┬───────┬───────┬───────┬──────────────┐
-│   p   │   q   │   r   │ p ∨ q │ p ∨ q <--> r │
-├───────┼───────┼───────┼───────┼──────────────┤
-│ true  │ true  │ true  │ true  │ true         │
-│ false │ true  │ true  │ true  │ true         │
-│ true  │ false │ true  │ true  │ true         │
-│ false │ false │ true  │ false │ false        │
-│ true  │ true  │ false │ true  │ false        │
-│ false │ true  │ false │ true  │ false        │
-│ true  │ false │ false │ true  │ false        │
-│ false │ false │ false │ false │ true         │
-└───────┴───────┴───────┴───────┴──────────────┘
-
-
-julia> @truthtable !(x || y) <--> (!x && !y)
+┌───────┬───────┬───────┬───────┬───────┬──────────────┐
+│   p   │   q   │   r   │  ¬p   │ q ∨ r │ ¬p ∧ (q ∨ r) │
+├───────┼───────┼───────┼───────┼───────┼──────────────┤
+│ true  │ true  │ true  │ false │ true  │ false        │
+│ false │ true  │ true  │ true  │ true  │ true         │
+│ true  │ false │ true  │ false │ true  │ false        │
+│ false │ false │ true  │ true  │ true  │ true         │
+│ true  │ true  │ false │ false │ true  │ false        │
+│ false │ true  │ false │ true  │ true  │ true         │
+│ true  │ false │ false │ false │ false │ false        │
+│ false │ false │ false │ true  │ false │ false        │
+└───────┴───────┴───────┴───────┴───────┴──────────────┘
+
+julia> TruthTables.showmode!(:bit)
+:bit
+
+julia> @truthtable (p --> q) ≡ (¬p ∨ q)
 TruthTable
-┌───────┬───────┬───────────────────────┐
-│   x   │   y   │ ¬(x ∨ y) <--> ¬x ∧ ¬y │
-├───────┼───────┼───────────────────────┤
-│ true  │ true  │ true                  │
-│ false │ true  │ true                  │
-│ true  │ false │ true                  │
-│ false │ false │ true                  │
-└───────┴───────┴───────────────────────┘
-
-
-julia> @truthtable !(x || y) <--> (!x && !y) full=true
+┌───┬───┬────────────────────┐
+│ p │ q │ (p --> q) ≡ ¬p ∨ q │
+├───┼───┼────────────────────┤
+│ 1 │ 1 │ 1                  │
+│ 0 │ 1 │ 1                  │
+│ 1 │ 0 │ 1                  │
+│ 0 │ 0 │ 1                  │
+└───┴───┴────────────────────┘
+
+julia> @truthtable (p --> q) ≡ (¬p ∨ q) full=true
 TruthTable
-┌───────┬───────┬───────┬──────────┬───────┬───────┬─────────┬───────────────────────┐
-│   x   │   y   │ x ∨ y │ ¬(x ∨ y) │  ¬x   │  ¬y   │ ¬x ∧ ¬y │ ¬(x ∨ y) <--> ¬x ∧ ¬y │
-├───────┼───────┼───────┼──────────┼───────┼───────┼─────────┼───────────────────────┤
-│ true  │ true  │ true  │ false    │ false │ false │ false   │ true                  │
-│ false │ true  │ true  │ false    │ true  │ false │ false   │ true                  │
-│ true  │ false │ true  │ false    │ false │ true  │ false   │ true                  │
-│ false │ false │ false │ true     │ true  │ true  │ true    │ true                  │
-└───────┴───────┴───────┴──────────┴───────┴───────┴─────────┴───────────────────────┘
+┌───┬───┬─────────┬────┬────────┬────────────────────┐
+│ p │ q │ p --> q │ ¬p │ ¬p ∨ q │ (p --> q) ≡ ¬p ∨ q │
+├───┼───┼─────────┼────┼────────┼────────────────────┤
+│ 1 │ 1 │ 1       │ 0  │ 1      │ 1                  │
+│ 0 │ 1 │ 1       │ 1  │ 1      │ 1                  │
+│ 1 │ 0 │ 0       │ 0  │ 0      │ 1                  │
+│ 0 │ 0 │ 1       │ 1  │ 1      │ 1                  │
+└───┴───┴─────────┴────┴────────┴────────────────────┘
 ```