min and max docstrings (#38)

Author: mforets

src/optimise.jl

@@ -5,15 +5,17 @@
     or
     minimise(f, X, tol=1e-3) in this case the default value of "structure" is "HeapedVector"
 
-Find the global minimum of the function `f` over the `Interval` or `IntervalBox` `X` using the Moore-Skelboe algorithm. By specifing the way in which vector element are kept arranged which is in heaped array or in sorted array. If you not specify any particular strategy to keep vector elements arranged then by default heaped array is used.
+Find the global minimum of the function `f` over the `Interval` or `IntervalBox` `X`
+using the Moore-Skelboe algorithm. The way in which vector elements are
+kept arranged can be either a heaped array or a sorted array.
+If you not specify any particular strategy to keep vector elements arranged then
+by default heaped array is used.
 
 For higher-dimensional functions ``f:\\mathbb{R}^n \\to \\mathbb{R}``, `f` must take a single vector argument.
 
 Returns an interval containing the global minimum, and a list of boxes that contain the minimisers.
 """
-
-
-function minimise(f, X::T ; structure = HeapedVector, tol=1e-3 ) where {T}
+function minimise(f, X::T; structure = HeapedVector, tol=1e-3) where {T}
 
     # list of boxes with corresponding lower bound, arranged according to selected structure :
     working = structure([(X, ∞)], x->x[2])
@@ -56,8 +58,18 @@ function minimise(f, X::T ; structure = HeapedVector, tol=1e-3 ) where {T}
     return Interval(lower_bound, global_min), minimizers
 end
 
+"""
+    maximise(f, X, structure = SortedVector, tol=1e-3)
+    or
+    maximise(f, X, structure = HeapedVector, tol=1e-3)
+    or
+    maximise(f, X, tol=1e-3) in this case the default value of "structure" is "HeapedVector"
 
-function maximise(f, X::T; structure = HeapedVector, tol=1e-3 ) where {T}
+Find the global maximum of the function `f` over the `Interval` or `IntervalBox` `X`
+using the Moore-Skelboe algorithm. See [`minimise`](@ref) for a description
+of the available options.
+"""
+function maximise(f, X::T; structure = HeapedVector, tol=1e-3) where {T}
     bound, minimizers = minimise(x -> -f(x), X, structure, tol)
     return -bound, minimizers
 end