Make decorated interval the default

docs/src/index.md

@@ -33,6 +33,7 @@ If you use the IntervalArithmetic library in your publication, research, teachin
 This project began in 2014 during a masters' course in the postgraduate programs of Mathematics and Physics at the Universidad Nacional Autónoma de México. It was initially written in Python, then reinitiated in 2015 and rewritten in Julia. We thank the participants of the courses for their contribution, energy and ideas.
 
 
+
 ## Support
 
 Financial support is acknowledged from DGAPA-UNAM PAPIME grants PE-105911 and PE-107114, and DGAPA-UNAM PAPIIT grant IN-117214.

docs/src/manual/construction.md

@@ -4,7 +4,7 @@ Constructing an interval is the most basic operation in the library. The [`inter
 
 ```@repl construction
 using IntervalArithmetic
-setformat(:full) # print the interval in full
+setdisplay(:full) # print the interval in full
 interval(0.1) # interval(Float64, 0.1)
 interval(0.1, 0.2) # interval(Float64, 0.1, 0.2)
 interval(3.1f0) # interval(Float32, 3.1f0)

docs/src/manual/decorations.md

@@ -27,15 +27,15 @@ An example will be given at the end of this section.
 
 ## Initialisation
 
-The simplest way to create a `DecoratedInterval` is as follows:
+The simplest way to create a `Interval` is as follows:
 ```
-julia> X = DecoratedInterval(3, 4)
+julia> X = Interval(3, 4)
 [3, 4]
 ```
 
 By default, decorations are not displayed. The following turns on display of decorations:
 ```
-julia> setformat(decorations=true)
+julia> setdisplay(decorations=true)
 Display parameters:
 - format: standard
 - decorations: true
@@ -47,7 +47,7 @@ julia> X
 
 To parse string, for decorated interval add `_dec` at the end of the string otherwise decoration is determined using `decoration` function.
 
-If no decoration is explicitly specified when a `DecoratedInterval` is created, then it is initialised with a decoration according to its interval `X`:
+If no decoration is explicitly specified when a `Interval` is created, then it is initialised with a decoration according to its interval `X`:
 
 - `com`: if `X` is nonempty and bounded;
 - `dac` if `X` is unbounded;
@@ -56,20 +56,20 @@ If no decoration is explicitly specified when a `DecoratedInterval` is created,
 
 An explicit decoration may be provided for advanced use:
 ```
-julia> DecoratedInterval(3, 4, dac)
+julia> Interval(3, 4, dac)
 [3, 4]_dac
 
-julia> DecoratedInterval(X, def)
+julia> Interval(X, def)
 [3, 4]_def
 ```
-Here, a new `DecoratedInterval` was created by extracting the interval from another one and appending a different decoration.
+Here, a new `Interval` was created by extracting the interval from another one and appending a different decoration.
 
 ## Action of functions
 
 A decoration is the combination of an interval together with the sequence of functions that it has passed through. Here are some examples:
 
 ```
-julia> X1 = DecoratedInterval(0.5, 3)
+julia> X1 = Interval(0.5, 3)
 [0.5, 3]_com
 
 julia> sqrt(X1)
@@ -78,7 +78,7 @@ julia> sqrt(X1)
 In this case, both input and output are "common" intervals, meaning that they are closed and bounded, and that the resulting function is continuous over the input interval, so that fixed-point theorems may be applied. Since `sqrt(X1) ⊆ X1`, we know that there must be a fixed point of the function inside the interval `X1` (in this case, `sqrt(1) == 1`).
 
 ```
-julia> X2 = DecoratedInterval(3, ∞)
+julia> X2 = Interval(3, ∞)
 [3, ∞]_dac
 
 julia> sqrt(X2)
@@ -87,7 +87,7 @@ julia> sqrt(X2)
 Since the intervals are unbounded here, the maximum decoration possible is `dac`.
 
 ```
-julia> X3 = DecoratedInterval(-3, 4)
+julia> X3 = Interval(-3, 4)
 [-3, 4]_com
 
 julia> sign(X3)
@@ -96,7 +96,7 @@ julia> sign(X3)
 The `sign` function is discontinuous at 0, but is defined everywhere on the input interval, so the decoration is `def`.
 
 ```
-julia> X4 = DecoratedInterval(-3.5, 4.1)
+julia> X4 = Interval(-3.5, 4.1)
 [-3.5, 4.1]_com
 
 julia> sqrt(X4)
@@ -108,13 +108,13 @@ The negative part of `X` is discarded by the `sqrt` function, since its domain i
 In this case, we know why the decoration was reduced to `trv`. But if this were just a single step in a longer calculation, a resulting `trv` decoration shows only that something like this happened *at some step*. For example:
 
 ```
-julia> X5 = DecoratedInterval(-3, 3)
+julia> X5 = Interval(-3, 3)
 [-3, 3]_com
 
 julia> asin(sqrt(X5))
 [0, 1.5708]_trv
 
-julia> X6 = DecoratedInterval(0, 3)
+julia> X6 = Interval(0, 3)
 [0, 3]_com
 
 julia> asin(sqrt(X6))

docs/src/manual/usage.md

@@ -1,7 +1,7 @@
 ## Display modes
 
-There are several useful output representations for intervals, some of which we have already touched on. The display is controlled globally by the `setformat` function, which has
-the following options, specified by keyword arguments (type `?setformat` to get help at the REPL):
+There are several useful output representations for intervals, some of which we have already touched on. The display is controlled globally by the `setdisplay` function, which has
+the following options, specified by keyword arguments (type `?setdisplay` to get help at the REPL):
 
 - `format`: interval output format
 
@@ -17,17 +17,17 @@ the following options, specified by keyword arguments (type `?setformat` to get
 
 ```@repl
 using IntervalArithmetic
-setformat() # default values
+setdisplay() # default values
 a = interval(1.1, pi)
-setformat(; sigdigits = 10)
+setdisplay(; sigdigits = 10)
 a
-setformat(:full)
+setdisplay(:full)
 a
-setformat(:midpoint)
+setdisplay(:midpoint)
 a
-setformat(; sigdigits = 4)
+setdisplay(; sigdigits = 4)
 a
-setformat(:standard)
+setdisplay(:standard)
 a
 ```
 
@@ -45,7 +45,7 @@ For example,
 
 ```@repl usage
 using IntervalArithmetic
-setformat(:full)
+setdisplay(:full)
 X = interval(0, 1)
 Y = interval(1, 2)
 X + Y

src/IntervalArithmetic.jl

@@ -8,17 +8,15 @@ using SetRounding
 using EnumX
 
 import Base:
-    +, -, *, /, //, muladd, fma,
-    ^, sqrt, exp, log, exp2, exp10, log2, log10, inv, cbrt, hypot,
-    zero, one, eps, typemin, typemax, abs, abs2, min, max,
-    rad2deg, deg2rad,
-    sin, cos, tan, cot, csc, sec, asin, acos, atan, acot, sinpi, cospi, sincospi,
+    +, -, *, /, inv, //, muladd, fma, sqrt,
     sinh, cosh, tanh, coth, csch, sech, asinh, acosh, atanh, acoth,
+    rad2deg, deg2rad, sin, cos, tan, cot, csc, sec, asin, acos, atan, acot, sinpi, cospi, sincospi,
+    exp, log, exp2, exp10, log2, log10, cbrt, hypot, ^,
+    zero, one, eps, typemin, typemax, abs, abs2, min, max,
     float, big,
     floor, ceil, trunc, sign, round, copysign, flipsign, signbit,
     expm1, log1p,
     precision,
-    abs, abs2,
     show,
     parse, hash
 
@@ -36,15 +34,14 @@ end
 #
 
 include("intervals/intervals.jl")
-export Interval, interval, ±, @I_str,
+export BareInterval, bareinterval, Interval, interval, decoration, @I_str,
     diam, radius, mid, midradius, scaled_mid, mag, mig, hull,
     emptyinterval, isempty_interval,
     isequal_interval,
     in_interval,
     issubset_interval, isstrictsubset_interval,
     precedes, strictprecedes,
     isweakless, isstrictless,
-    contains_zero,
     isthinzero, isthin,
     isbounded, isunbounded,
     isdisjoint_interval, intersect_interval, setdiff_interval,
@@ -54,21 +51,14 @@ export Interval, interval, ±, @I_str,
     RoundTiesToEven, RoundTiesToAway,
     IntervalRounding,
     cancelminus, cancelplus,
-    pow, extended_div, nthroot,
+    fastpow, extended_div, nthroot, nthpow,
+    bisect,
     overlap, Overlap
 
-include("bisect.jl")
-export bisect
-
-include("decorations/decorations.jl")
-export decoration, DecoratedInterval, com, dac, def, trv, ill
-
 include("rand.jl")
 
-include("parsing.jl")
-
 include("display.jl")
-export setformat
+export setdisplay
 
 include("symbols.jl")