Minimalistic documentation for the submodule Symbols, and docs

Author: lbenet

docs/make.jl

@@ -22,6 +22,7 @@ makedocs(;
         "Manual" => [
             "Constructing intervals" => "manual/construction.md",
             "Usage" => "manual/usage.md",
+            "Symbols" => "manual/symbols.jl",
             "Interfaces" => [
               "Arblib.jl" => "manual/interfaces/Arblib.md"
             ],

docs/src/manual/symbols.md

@@ -0,0 +1,47 @@
+# The submodule Symbols
+
+IntervalArithmetic.jl includes the submodule `Symbols` to make coding
+a bit simpler with respect to the use of some functions of the
+library. Some examples are provided here.
+
+```julia
+using IntervalArithmetic.Symbols
+
+a = 0 .. 2
+b = 1 ± 0.5
+```
+
+```julia
+a ≛ a
+```
+
+```julia
+b ⊑ a
+```
+
+```julia
+b ⋤ a
+```
+
+```julia
+∅ ⪽ ℝ
+```
+
+The following table summarizes the functions, the usage with the corresponding
+(unicode) symbols, how to obtain the symbol in Julia, and a brief description
+of the function.
+
+| Function                           | Symbol    | Unicode             | Description                                                 |
+|------------------------------------|-----------|---------------------|------------------------------------------------------------|
+| `interval(a, b; format=:infsup)`   | `..(a,b)` |                     | Create interval `[a, b]` using bounds                       |
+| `interval(m, r; format=:midpoint)` | `±(m, r)` | `\pm<tab>`          | Create interval `[m - r, m + r]` using midpoint-radius form                             |
+| `isequal_interval(x, y)`           | `≛(x, y)` | `\starequal<tab>`   | Check interval equality                                         |
+| `issubset_interval(x, y)`          | `⊑(x, y)` | `\sqsubseteq<tab>`  | Check if `x` is a (non-strict) subset of `y`                                           |
+| `isstrictsubset(x, y)`             | `⋤(x, y)` | `\sqsubsetneq<tab>` | Check if `x` is a strict subset of `y`                                              |
+| `isinterior(x, y)`                 | `⪽(x, y)` | `\subsetdot<tab>`   | Check if `x` is in the interior of `y`                                              |
+| `precedes(x, y)`                   | `⪯(x, y)` | `\preceq<tab>`      | Precedes relation                                         |
+| `strictprecedes(x, y)`             | `≺(x, y)` | `\prec<tab>`        | Strictly precedes relation                                         |
+| `hull(x, y)`                       | `⊔(x, y)` | `\sqcup<tab>`       | Interval hull of `x` and `y`                                              |
+| `intersect_interval(x, y)`         | `⊓(x, y)` | `\sqcap<tab>`       | Intersection of intervals                                        |
+| `emptyinterval()`                  | `∅`       | `\emptyset<tab>`    | Empty interval                                         |
+| `entireinterval()`                 | `ℝ`       | `\bbR<tab>`         | Entire real line                                             |