Fixed typo in documentation

Author: lindonroberts

docs/_build/doctrees/environment.pickle

@@ -20,7 +20,7 @@ That is, DFO-LS solves
    \min_{x\in\mathbb{R}^n}  &\quad  f(x) := \sum_{i=1}^{m}r_{i}(x)^2 \\
    \text{s.t.} &\quad  a \leq x \leq b
 
-Full details of the DFO-LS algorithm are given in our paper: C. Cartis, J. Fiala, B. Marteau and L. Roberts, Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers, technical report, University of Oxford, (2017).
+Full details of the DFO-LS algorithm are given in our paper: C. Cartis, J. Fiala, B. Marteau and L. Roberts, Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers, technical report, University of Oxford, (2018).
 
 DFO-LS is released under the GNU General Public License. Please `contact NAG <http://www.nag.com/content/worldwide-contact-information>`_ for alternative licensing.
 

docs/_build/doctrees/index.doctree

@@ -50,7 +50,7 @@ <h1>DFO-LS: Derivative-Free Optimizer for Least-Squares Minimization<a class="he
 <div class="math">
 \[\begin{split}\min_{x\in\mathbb{R}^n}  &amp;\quad  f(x) := \sum_{i=1}^{m}r_{i}(x)^2 \\
 \text{s.t.} &amp;\quad  a \leq x \leq b\end{split}\]</div>
-<p>Full details of the DFO-LS algorithm are given in our paper: C. Cartis, J. Fiala, B. Marteau and L. Roberts, Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers, technical report, University of Oxford, (2017).</p>
+<p>Full details of the DFO-LS algorithm are given in our paper: C. Cartis, J. Fiala, B. Marteau and L. Roberts, Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers, technical report, University of Oxford, (2018).</p>
 <p>DFO-LS is released under the GNU General Public License. Please <a class="reference external" href="http://www.nag.com/content/worldwide-contact-information">contact NAG</a> for alternative licensing.</p>
 <div class="toctree-wrapper compound">
 <p class="caption"><span class="caption-text">Contents:</span></p>

docs/_build/html/_sources/index.rst.txt

@@ -24,9 +24,9 @@
 \@writefile{toc}{\contentsline {chapter}{\numberline {1}Installing DFO-LS}{3}{chapter.1}}
 \@writefile{lof}{\addvspace {10\p@ }}
 \@writefile{lot}{\addvspace {10\p@ }}
+\newlabel{install::doc}{{1}{3}{Installing DFO-LS}{chapter.1}{}}
 \newlabel{install:installing-dfo-ls}{{1}{3}{Installing DFO-LS}{chapter.1}{}}
 \newlabel{install:dfo-ls-derivative-free-optimizer-for-least-squares-minimization}{{1}{3}{Installing DFO-LS}{chapter.1}{}}
-\newlabel{install::doc}{{1}{3}{Installing DFO-LS}{chapter.1}{}}
 \@writefile{toc}{\contentsline {section}{\numberline {1.1}Requirements}{3}{section.1.1}}
 \newlabel{install:requirements}{{1.1}{3}{Requirements}{section.1.1}{}}
 \@writefile{toc}{\contentsline {section}{\numberline {1.2}Installation using pip}{3}{section.1.2}}
@@ -40,8 +40,8 @@
 \@writefile{toc}{\contentsline {chapter}{\numberline {2}Overview}{5}{chapter.2}}
 \@writefile{lof}{\addvspace {10\p@ }}
 \@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{info:overview}{{2}{5}{Overview}{chapter.2}{}}
 \newlabel{info::doc}{{2}{5}{Overview}{chapter.2}{}}
+\newlabel{info:overview}{{2}{5}{Overview}{chapter.2}{}}
 \@writefile{toc}{\contentsline {section}{\numberline {2.1}When to use DFO-LS}{5}{section.2.1}}
 \newlabel{info:when-to-use-dfo-ls}{{2.1}{5}{When to use DFO-LS}{section.2.1}{}}
 \@writefile{toc}{\contentsline {section}{\numberline {2.2}Parameter Fitting}{5}{section.2.2}}
@@ -56,8 +56,8 @@
 \@writefile{toc}{\contentsline {chapter}{\numberline {3}Using DFO-LS}{9}{chapter.3}}
 \@writefile{lof}{\addvspace {10\p@ }}
 \@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{userguide:using-dfo-ls}{{3}{9}{Using DFO-LS}{chapter.3}{}}
 \newlabel{userguide::doc}{{3}{9}{Using DFO-LS}{chapter.3}{}}
+\newlabel{userguide:using-dfo-ls}{{3}{9}{Using DFO-LS}{chapter.3}{}}
 \@writefile{toc}{\contentsline {section}{\numberline {3.1}Nonlinear Least-Squares Minimization}{9}{section.3.1}}
 \newlabel{userguide:nonlinear-least-squares-minimization}{{3.1}{9}{Nonlinear Least-Squares Minimization}{section.3.1}{}}
 \newlabel{userguide:id1}{{3.1}{9}{Nonlinear Least-Squares Minimization}{section*.4}{}}
@@ -80,8 +80,8 @@
 \@writefile{toc}{\contentsline {chapter}{\numberline {4}Advanced Usage}{19}{chapter.4}}
 \@writefile{lof}{\addvspace {10\p@ }}
 \@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{advanced:advanced-usage}{{4}{19}{Advanced Usage}{chapter.4}{}}
 \newlabel{advanced::doc}{{4}{19}{Advanced Usage}{chapter.4}{}}
+\newlabel{advanced:advanced-usage}{{4}{19}{Advanced Usage}{chapter.4}{}}
 \newlabel{advanced:id1}{{4}{19}{Advanced Usage}{section*.5}{}}
 \@writefile{toc}{\contentsline {section}{\numberline {4.1}General Algorithm Parameters}{19}{section.4.1}}
 \newlabel{advanced:general-algorithm-parameters}{{4.1}{19}{General Algorithm Parameters}{section.4.1}{}}
@@ -110,8 +110,8 @@
 \@writefile{toc}{\contentsline {chapter}{\numberline {5}Diagnostic Information}{25}{chapter.5}}
 \@writefile{lof}{\addvspace {10\p@ }}
 \@writefile{lot}{\addvspace {10\p@ }}
-\newlabel{diagnostic:diagnostic-information}{{5}{25}{Diagnostic Information}{chapter.5}{}}
 \newlabel{diagnostic::doc}{{5}{25}{Diagnostic Information}{chapter.5}{}}
+\newlabel{diagnostic:diagnostic-information}{{5}{25}{Diagnostic Information}{chapter.5}{}}
 \@writefile{toc}{\contentsline {section}{\numberline {5.1}Current Iterate}{25}{section.5.1}}
 \newlabel{diagnostic:current-iterate}{{5.1}{25}{Current Iterate}{section.5.1}{}}
 \@writefile{toc}{\contentsline {section}{\numberline {5.2}Trust Region}{25}{section.5.2}}

docs/_build/html/index.html

@@ -1,10 +1,10 @@
 # Fdb version 3
-["makeindex DFOLS.idx"] 1517840619 "DFOLS.idx" "DFOLS.ind" "DFOLS" 1517841375
-  "DFOLS.idx" 1517841374 0 d41d8cd98f00b204e9800998ecf8427e ""
+["makeindex DFOLS.idx"] 1517840619 "DFOLS.idx" "DFOLS.ind" "DFOLS" 1517845150
+  "DFOLS.idx" 1517845149 0 d41d8cd98f00b204e9800998ecf8427e ""
   (generated)
-  "DFOLS.ind"
   "DFOLS.ilg"
-["pdflatex"] 1517841374 "DFOLS.tex" "DFOLS.pdf" "DFOLS" 1517841375
+  "DFOLS.ind"
+["pdflatex"] 1517845148 "DFOLS.tex" "DFOLS.pdf" "DFOLS" 1517845150
   "/etc/texmf/web2c/texmf.cnf" 1492166151 1353 1689cc21eed27d7ad1e0e829b373fbdd ""
   "/usr/share/texlive/texmf-dist/fonts/enc/dvips/base/8r.enc" 1165713224 4850 80dc9bab7f31fb78a000ccfed0e27cab ""
   "/usr/share/texlive/texmf-dist/fonts/map/fontname/texfonts.map" 1272929888 3287 e6b82fe08f5336d4d5ebc73fb1152e87 ""
@@ -164,21 +164,21 @@
   "/usr/share/texmf/web2c/texmf.cnf" 1503343927 31343 93828589fb0cea665e553ee5a17ad2d4 ""
   "/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map" 1503486108 1865826 00f4fd43c6ed441c7927291bb1fbfb80 ""
   "/var/lib/texmf/web2c/pdftex/pdflatex.fmt" 1503486128 3855763 e8af73c60cd2ba414e67cfc4c101393d ""
-  "DFOLS.aux" 1517841375 10286 b890b08d55880903cb19aa63e40527d0 ""
+  "DFOLS.aux" 1517845149 10286 a80175ca63c7343b2392b7d3aaec8eb8 ""
   "DFOLS.ind" 1517840619 0 d41d8cd98f00b204e9800998ecf8427e "makeindex DFOLS.idx"
-  "DFOLS.out" 1517841375 7064 3dd946e4adfeda36993db09d2fce2a6a ""
-  "DFOLS.tex" 1517841372 69072 a7a377cca41ff64a0cec8b7545ff552f ""
-  "DFOLS.toc" 1517841375 3469 7338296352409c6ccf29ce2e3ff18265 ""
+  "DFOLS.out" 1517845149 7064 3dd946e4adfeda36993db09d2fce2a6a ""
+  "DFOLS.tex" 1517845142 69072 dcabc11238cb722bea0b585a6488b55f ""
+  "DFOLS.toc" 1517845149 3469 7338296352409c6ccf29ce2e3ff18265 ""
   "data_fitting.png" 1517839082 29893 211bb1c28ea25d47c8c0990fbf39c55c ""
   "footnotehyper-sphinx.sty" 1501773881 8841 e18cbb7bca599a223414f9b8a156abee ""
   "sphinx.sty" 1501773881 62669 cc7c90932531415fb6bb849a3b8348a6 ""
-  "sphinxhighlight.sty" 1517841371 8137 ecd3ca374fbe47e24a56cf12257a10bc ""
+  "sphinxhighlight.sty" 1517845141 8137 9756fef4d5a85023c16244034671f6f6 ""
   "sphinxmanual.cls" 1501773881 3589 0b0aac49c6f36925cf5f9d524a75a978 ""
   "sphinxmulticell.sty" 1501773881 14618 0defbdc8536ad2e67f1eac6a1431bc55 ""
   (generated)
-  "DFOLS.pdf"
-  "DFOLS.log"
+  "DFOLS.out"
   "DFOLS.aux"
-  "DFOLS.idx"
+  "DFOLS.log"
   "DFOLS.toc"
-  "DFOLS.out"
+  "DFOLS.idx"
+  "DFOLS.pdf"

docs/_build/latex/DFOLS.aux

@@ -1,4 +1,4 @@
-This is pdfTeX, Version 3.14159265-2.6-1.40.16 (TeX Live 2015/Debian) (preloaded format=pdflatex 2017.8.23)  5 FEB 2018 14:36
+This is pdfTeX, Version 3.14159265-2.6-1.40.16 (TeX Live 2015/Debian) (preloaded format=pdflatex 2017.8.23)  5 FEB 2018 15:39
 entering extended mode
  restricted \write18 enabled.
  %&-line parsing enabled.
@@ -1266,7 +1266,7 @@ lvetic/uhvb8a.pfb></usr/share/texlive/texmf-dist/fonts/type1/urw/helvetic/uhvbo
 8a.pfb></usr/share/texlive/texmf-dist/fonts/type1/urw/times/utmb8a.pfb></usr/sh
 are/texlive/texmf-dist/fonts/type1/urw/times/utmr8a.pfb></usr/share/texlive/tex
 mf-dist/fonts/type1/urw/times/utmri8a.pfb>
-Output written on DFOLS.pdf (33 pages, 292803 bytes).
+Output written on DFOLS.pdf (33 pages, 292802 bytes).
 PDF statistics:
  512 PDF objects out of 1000 (max. 8388607)
  445 compressed objects within 5 object streams

docs/_build/latex/DFOLS.fdb_latexmk

@@ -82,13 +82,13 @@
 \begin{split}\min_{x\in\mathbb{R}^n}  &\quad  f(x) := \sum_{i=1}^{m}r_{i}(x)^2 \\
 \text{s.t.} &\quad  a \leq x \leq b\end{split}
 \end{equation*}
-Full details of the DFO-LS algorithm are given in our paper: C. Cartis, J. Fiala, B. Marteau and L. Roberts, Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers, technical report, University of Oxford, (2017).
+Full details of the DFO-LS algorithm are given in our paper: C. Cartis, J. Fiala, B. Marteau and L. Roberts, Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers, technical report, University of Oxford, (2018).
 
 DFO-LS is released under the GNU General Public License. Please \sphinxhref{http://www.nag.com/content/worldwide-contact-information}{contact NAG} for alternative licensing.
 
 
 \chapter{Installing DFO-LS}
-\label{\detokenize{install:installing-dfo-ls}}\label{\detokenize{install:dfo-ls-derivative-free-optimizer-for-least-squares-minimization}}\label{\detokenize{install::doc}}
+\label{\detokenize{install::doc}}\label{\detokenize{install:installing-dfo-ls}}\label{\detokenize{install:dfo-ls-derivative-free-optimizer-for-least-squares-minimization}}
 
 \section{Requirements}
 \label{\detokenize{install:requirements}}
@@ -201,7 +201,7 @@ \section{Uninstallation}
 
 
 \chapter{Overview}
-\label{\detokenize{info:overview}}\label{\detokenize{info::doc}}
+\label{\detokenize{info::doc}}\label{\detokenize{info:overview}}
 
 \section{When to use DFO-LS}
 \label{\detokenize{info:when-to-use-dfo-ls}}
@@ -284,7 +284,7 @@ \section{References}
 \label{\detokenize{info:references}}
 
 \chapter{Using DFO-LS}
-\label{\detokenize{userguide:using-dfo-ls}}\label{\detokenize{userguide::doc}}
+\label{\detokenize{userguide::doc}}\label{\detokenize{userguide:using-dfo-ls}}
 This section describes the main interface to DFO-LS and how to use it.
 
 
@@ -841,7 +841,7 @@ \section{References}
 \label{\detokenize{userguide:references}}
 
 \chapter{Advanced Usage}
-\label{\detokenize{advanced:advanced-usage}}\label{\detokenize{advanced::doc}}
+\label{\detokenize{advanced::doc}}\label{\detokenize{advanced:advanced-usage}}
 This section describes different optional user parameters available in DFO-LS.
 
 In the last section ({\hyperref[\detokenize{userguide::doc}]{\sphinxcrossref{\DUrole{doc}{Using DFO-LS}}}}), we introduced \sphinxcode{dfols.solve()}, which has the optional input \sphinxcode{user\_params}. This is a Python dictionary of user parameters. We will now go through the settings which can be changed in this way. More details are available in the paper \phantomsection\label{\detokenize{advanced:id1}}{\hyperref[\detokenize{userguide:cfmr2018}]{\sphinxcrossref{{[}CFMR2018{]}}}}.
@@ -1094,7 +1094,7 @@ \section{References}
 \label{\detokenize{advanced:references}}
 
 \chapter{Diagnostic Information}
-\label{\detokenize{diagnostic:diagnostic-information}}\label{\detokenize{diagnostic::doc}}
+\label{\detokenize{diagnostic::doc}}\label{\detokenize{diagnostic:diagnostic-information}}
 In {\hyperref[\detokenize{userguide::doc}]{\sphinxcrossref{\DUrole{doc}{Using DFO-LS}}}}, we saw that the output of DFO-LS returns a container which includes diagnostic information about the progress of the algorithm (\sphinxcode{soln.diagnostic\_info}). This object is a \sphinxhref{http://pandas.pydata.org/}{Pandas} DataFrame, with one row per iteration of the algorithm. In this section, we explain the meaning of each type of output (the columns of the DataFrame).
 
 To save this information to a CSV file, use: