Release 2.1.

Author: rdzman

CHANGES.md

@@ -2,10 +2,11 @@ Change history for MP-Opt-Model
 ===============================
 
 
-since last release
-------------------
+Version 2.0 - *Aug 25, 2020*
+---------------------------
 
 #### 8/25/20
+  - Release 2.1.
   - Add core NLEQ solver function `nleqs_core()` with arbitrary,
     user-defined update function, used to implement Gauss-Seidel and
     Newton solvers, `nleqs_gauss_seidel()` and `nleqs_newton()`.

CITATION

@@ -1,11 +1,11 @@
 We request that publications derived from the use of MP-Opt-Model
 explicitly acknowledge that fact by citing the MP-Opt-Model User's
 Manual. The citation and DOI can be version-specific or general, as
-appropriate. For version 2.0, use:
+appropriate. For version 2.1, use:
 
-  R. D. Zimmerman. MP-Opt-Model User's Manual, Version 2.0. 2020.
-  [Online]. Available: https://matpower.org/docs/MP-Opt-Model-manual-2.0.pdf
-  doi: 10.5281/zenodo.3935928
+  R. D. Zimmerman. MP-Opt-Model User's Manual, Version 2.1. 2020.
+  [Online]. Available: https://matpower.org/docs/MP-Opt-Model-manual-2.1.pdf
+  doi: 10.5281/zenodo.4001106
 
 For a version non-specific citation, use the following citation and DOI,
 with *\<YEAR\>* replaced by the year of the most recent release:

README.md

@@ -50,17 +50,18 @@ of MATLAB or Octave, including setting up your MATLAB path.
   >> test_mp_opt_model
   t_nested_struct_copy....ok
   t_have_fcn..............ok
-  t_nleqs_master..........ok
+  t_nleqs_master..........ok (30 of 150 skipped)
   t_qps_master............ok (100 of 396 skipped)
   t_miqps_master..........ok (68 of 288 skipped)
   t_nlps_master...........ok
   t_opt_model.............ok
-  t_om_solve_nleqs........ok
+  t_om_solve_leqs.........ok
+  t_om_solve_nleqs........ok (36 of 170 skipped)
   t_om_solve_qps..........ok (79 of 319 skipped)
   t_om_solve_miqps........ok (12 of 72 skipped)
   t_om_solve_nlps.........ok
-  All tests successful (2519 passed, 259 skipped of 2778)
-  Elapsed time 2.52 seconds.
+  All tests successful (2713 passed, 325 skipped of 3038)
+  Elapsed time 3.37 seconds.
 ```
 
 Sample Usage
@@ -201,11 +202,11 @@ function, e.g.: `qps_master`, `miqps_master`, and `nlps_master`.
 We request that publications derived from the use of MP-Opt-Model
 explicitly acknowledge that fact by citing the [MP-Opt-Model User's Manual][7].
 The citation and DOI can be version-specific or general, as appropriate.
-For version 2.0, use:
+For version 2.1, use:
 
->   R. D. Zimmerman. *MP-Opt-Model User's Manual, Version 2.0*. 2020.
-    [Online]. Available: https://matpower.org/docs/MP-Opt-Model-manual-2.0.pdf  
-    doi: [10.5281/zenodo.3935928](https://doi.org/10.5281/zenodo.3935928)
+>   R. D. Zimmerman. *MP-Opt-Model User's Manual, Version 2.1*. 2020.
+    [Online]. Available: https://matpower.org/docs/MP-Opt-Model-manual-2.1.pdf  
+    doi: [10.5281/zenodo.4001106](https://doi.org/10.5281/zenodo.4001106)
 
 For a version non-specific citation, use the following citation and DOI,
 with *\<YEAR\>* replaced by the year of the most recent release:

docs/MP-Opt-Model-manual.pdf

@@ -0,0 +1,37 @@
+What's New in MP-Opt-Model 2.1
+------------------------------
+
+#### Released August 25, 2020
+
+Below is a summary of the changes since version 2.0 of MP-Opt-Model. See
+the [`CHANGES.md`][1] file for all the gory details. For release notes
+for previous versions, see Appendix C of the [MP-Opt-Model User's
+Manual][2].
+
+
+#### New Features
+  - Fast-decoupled Newton's and Gauss-Seidel solvers for nonlinear equations.
+  - New linear equation (`'LEQ'`) problem type for models with equal
+    number of variables and linear equality constraints, no costs, and no
+    inequality or nonlinear equality constraints. Solved via `mplinsolve()`.
+  - The `solve()` method of `opt_model` can now automatically handle mixed
+    systems of equations, with both linear and nonlinear equality constraints.
+  - New core nonlinear equation solver function with arbitrary, user-defined
+    update function, used to implement Gauss-Seidel and Newton solvers.
+  - New functions:
+      - `nleqs_fd_newton()` solves a nonlinear set of equations via a
+        fast-decoupled Newton's method.
+      - `nleqs_gauss_seidel()` solves a nonlinear set of equations via a
+        Gauss-Seidel method.
+      - `nleqs_core()` implements core nonlinear equation solver with
+        arbitrary update function.
+
+
+#### Incompatible Changes
+  - In `output` return value from `nleqs_newton()`, changed the `normF`
+    field of `output.hist` to `normf`, for consistency in using lowercase
+    `f` everywhere.
+
+
+[1]: https://github.com/MATPOWER/mp-opt-model/blob/master/CHANGES.md
+[2]: https://github.com/MATPOWER/mp-opt-model/blob/master/docs/MP-Opt-Model-manual.pdf

docs/relnotes/MP-Opt-Model-Release-Notes-2.1.md

@@ -144,13 +144,13 @@
 \newcommand{\mipsurl}[0]{https://github.com/MATPOWER/mips}
 \newcommand{\mipslink}[0]{\href{\mipsurl}{\mips{}}}
 \newcommand{\mipsname}[0]{{{\bf M}{\sc atpower} \textbf{I}nterior \textbf{P}oint \textbf{S}olver}}
-\newcommand{\mipsver}[0]{1.3.1+}
+\newcommand{\mipsver}[0]{1.3.1}
 \newcommand{\mpom}[0]{\mbox{MP-Opt-Model}}
 \newcommand{\mpomurl}[0]{https://github.com/MATPOWER/mp-opt-model}
 \newcommand{\mpomlink}[0]{\href{\mpomurl}{\mpom{}}}
 \newcommand{\mpomname}[0]{\mpom{}}
 % \newcommand{\mpomname}[0]{{{\bf M}{\sc at}{\bf P}{\sc ower} \textbf{Opt}imization \textbf{Model}}}
-\newcommand{\mpomver}[0]{2.1-dev}
+\newcommand{\mpomver}[0]{2.1}
 \newcommand{\most}[0]{{MOST}}
 \newcommand{\mostname}[0]{{{\bf M}{\sc atpower} \textbf{O}ptimal \textbf{S}cheduling \textbf{T}ool}}
 \newcommand{\mosturl}[0]{https://github.com/MATPOWER/most}
@@ -237,7 +237,7 @@
 %\title{\hl{--- DRAFT  ---}\\\hl{\em do not distribute}\\~\\{\huge \bfseries \mpomname{} User's Manual } \\ ~ \\ \LARGE Version \mpomver{}\\
 \title{{\huge \bfseries \mpomname{} User's Manual } \\ ~ \\ \LARGE Version \mpomver{}}
 \author{Ray~D.~Zimmerman}
-%\date{July 8, 2020} % comment this line to display the current date
+\date{August 25, 2020} % comment this line to display the current date
 %\date{May 8, 2020\thanks{Second revision. First revision was April 29, 2020}} % comment this line to display the current date
 
 %%% BEGIN DOCUMENT
@@ -322,12 +322,12 @@ \subsection{License and Terms of Use}
 \subsection{Citing \mpom{}}
 
 We request that publications derived from the use of \mpom{} explicitly acknowledge that fact by citing the \mpomname{} User's Manual~\cite{mpom_manual}.
-The citation and DOI can be version-specific or general, as appropriate. For version 2.0, use:
+The citation and DOI can be version-specific or general, as appropriate. For version 2.1, use:
 
 \begin{quote}
 \footnotesize
-R.~D. Zimmerman. \mpomname{} User's Manual, Verision 2.0. 2020. [Online]. Available: \url{https://matpower.org/docs/MP-Opt-Model-manual-2.0.pdf}\\
-\doi{10.5281/zenodo.3935928}
+R.~D. Zimmerman. \mpomname{} User's Manual, Verision 2.1. 2020. [Online]. Available: \url{https://matpower.org/docs/MP-Opt-Model-manual-2.1.pdf}\\
+\doi{10.5281/zenodo.4001106}
 \end{quote}
 For a version non-specific citation, use the following citation and DOI,
 with \emph{\textless{}YEAR\textgreater{}} replaced by the year of the most recent release:
@@ -401,18 +401,18 @@ \subsection{Installation}
 >> test_mp_opt_model
 t_nested_struct_copy....ok
 t_have_fcn..............ok
-t_nleqs_master..........ok (20 of 120 skipped)
+t_nleqs_master..........ok (30 of 150 skipped)
 t_qps_master............ok (100 of 396 skipped)
 t_miqps_master..........ok (68 of 288 skipped)
 t_nlps_master...........ok
 t_opt_model.............ok
 t_om_solve_leqs.........ok
-t_om_solve_nleqs........ok (24 of 136 skipped)
+t_om_solve_nleqs........ok (36 of 170 skipped)
 t_om_solve_qps..........ok (79 of 319 skipped)
 t_om_solve_miqps........ok (12 of 72 skipped)
 t_om_solve_nlps.........ok
-All tests successful (2671 passed, 303 skipped of 2974)
-Elapsed time 2.84 seconds.
+All tests successful (2713 passed, 325 skipped of 3038)
+Elapsed time 3.29 seconds.
 \end{Code}
 \end{enumerate}
 
@@ -3135,8 +3135,8 @@ \subsubsection*{Other Changes}
 
 \end{itemize}
 
-
-\subsection{Version 2.1 -- released ??? ?, 202?}
+\clearpage
+\subsection{Version 2.1 -- released Aug 25, 2020}
 \label{app:v21}
 
 The \href{https://matpower.org/docs/MP-Opt-Model-manual-2.1.pdf}{\mpom{} 2.1 User's Manual} is available online.\footnote{\url{https://matpower.org/docs/MP-Opt-Model-manual-2.1.pdf}}

docs/src/MP-Opt-Model-manual/MP-Opt-Model-manual.tex

@@ -1,5 +1,5 @@
 % MP-Opt-Model
-%   Version 2.0         08-Jul-2020
+%   Version 2.1         25-Aug-2020
 %
 %   MP-Opt-Model is a package of MATLAB/Octave M-files for constructing
 %   and solving mathematical optimization problems. It provides an

lib/Contents.m

@@ -17,7 +17,7 @@
 %   See https://github.com/MATPOWER/mp-opt-model for more info.
 
 v = struct( 'Name',     'MP-Opt-Model', ... 
-            'Version',  '2.1-dev', ...
+            'Version',  '2.1', ...
             'Release',  '', ...
             'Date',     '25-Aug-2020' );
 if nargout > 0