NEWS.md

   1 # NLopt Release Notes
   2
   3 ## NLopt 2.4.2
   4
   5 20 May 2014
   6
   7 * Fix CRS for empty dimensions (where lower `==` upper bound) (issue [#13]).
   8
   9 * Improvements to CMake (thanks to @xantares) and Windows builds (issue [#12]).
  10
  11 * Fix guile2 compatibility (issue [#21]).
  12
  13 ## NLopt 2.4.1
  14
  15 19 November 2013
  16
  17 * Use `cdecl` calling convention instead of stdcall on Win32, to
  18   simplify shared-library usage and for consistency with Win64.
  19
  20 ## NLopt 2.4
  21
  22 2 November 2013
  23
  24 * New genetic algorithm ESCH, thanks to Carlos Henrique da Silva Santos.
  25
  26 * Fix swig dir for `VPATH` builds, thanks to Sandro Vitenti for the bug report.
  27
  28 * Use `python-config` program in the `configure` script to find the include
  29   directories for Python, if possible (may be overridden by `PYTHON_CONFIG`
  30   environment variable).
  31
  32 * Bugfix in copy constructor for C++ and Python interfaces.
  33
  34 * Bugfix in return value for setting min/max objective.
  35
  36 * Handle negative rescalings in COBYLA and BOBYQA.
  37
  38 * Plugin installation honors the `configure --prefix`, if any
  39   (thanks to xantares@github).
  40
  41 * Various compilation fixes for compatibility with recent software.
  42
  43 ## NLopt 2.3.1
  44
  45 16 September 2012
  46
  47 * Bug fix: COBLYA should return `ROUNDOFF_LIMITED` rather than `XTOL_REACHED`
  48   if the trust-region radius underflows to zero; thanks to David Liu.
  49
  50 * Bug fix: incorrect return value from set min/max objective.
  51
  52 * Handle case of negative rescalings (from negative dx) in COBYLA and BOBYQA;
  53   thanks to Alexander Law for the bug report
  54
  55 ## NLopt 2.3
  56
  57 20 July 2012
  58
  59 * In Matlab/Octave interface, make returning NaN from the objective
  60   equivalent to `nlopt_force_stop`; thanks to Norman Violet for the suggestion.
  61
  62 * Added CCSA-quadratic (`NLOPT_LD_CCSAQ`), similar to MMA.
  63
  64 * Added interface for supplying a preconditioner (approximate Hessian);
  65   currently only supported in CCSAQ.
  66
  67 * When adding mconstraints, allow `tol==NULL` as synonym for zero tolerances.
  68
  69 * Added missing `NLOPT_LD_SLSQP` constant in Matlab/Octave.
  70
  71 * Lower tolerance for dual optimization in MMA/CCSAQ; thanks to
  72   Christophe Leruste for the problem report
  73
  74 * Fixed bug in timer, thanks to William Vaughn for the patch.
  75
  76 * Bug fix to convergence test in sbplx; thanks to Douglas Bates.
  77
  78 ## NLopt 2.2.4
  79
  80 9 June 2011
  81
  82 * Fixed linking problem for C++ and Python shared libraries on MacOS X;
  83   thanks to Volker Lorrmann for the bug report.
  84
  85 ## NLopt 2.2.3
  86
  87 8 June 2011
  88
  89 * Fixed additional re-entrancy problem in Luksan algorithms missed
  90   in the previous version; thanks to Gert Wollny for the bug report.
  91
  92 * Fixed set/get `vector_storage` in Fortran interface for Fortran
  93   compilers with all-uppercase linkage.
  94
  95 ## NLopt 2.2.2
  96
  97 26 May 2011
  98
  99 * Added `set_vector_storage` API to modify the memory usage and the
 100   subspace dimension for low-storage quasi-Newton methods.
 101
 102 * Fixed missing support for maxtime stopping criteria in Luksan and
 103   `ORIG_DIRECT` algorithms; thanks to Jurgen Werner for the bug report.
 104
 105 * Fixed algorithms to support the case where the lower and upper bounds
 106   are equal for some variables (which effectively eliminates those
 107   variables from optimization).
 108
 109 * Added missing xtol check to SLSQP, which caused erroneous `ROUNDOFF_LIMITED`
 110   error codes to be returned; thanks to Alexander Riess for the bug report.
 111
 112 * Fixed slight overcounting of function evaluations for maxeval check
 113   in SLSQP.
 114
 115 * Fixed deprecated API to support `xtol_abs == NULL` for backward
 116   compatibility (thanks to Francesco Biscani for the bug report).
 117
 118 * Made Luksan algorithms (e.g. LBFGS and other quasi-Newton methods)
 119   re-entrant; thanks to Gert Wollny for the bug report.  (Fixes
 120   Gentoo bug #368685.)
 121
 122 * Fixed bug in DIRECT (not `ORIG_DIRECT`), where a typo caused suboptimal
 123   convergence in some cases; thanks to Sinisa Hristov for the bug report.
 124
 125 ## NLopt 2.2.1
 126
 127 6 September 2010
 128
 129 * If you compile `nlopt.h` with the `NLOPT_DLL_EXPOR`T symbol `#defined`,
 130   it now uses the `dllexport` directive (under Windows), useful for
 131   compiling an NLopt DLL under Microsoft compilers; thanks to Benoit
 132   Scherrer for the suggestion.
 133
 134 * Handle case where `copysign` function is missing, e.g. on Windows;
 135   thanks to Benoit Scherrer for the bug report.
 136
 137 * Remove C99-style mixed declaration and code in a couple files, so
 138   that code compiles in C89; thanks to Benoit Scherrer for the bug report.
 139
 140 * Removed a few compiler warnings under Microsoft compilers; thanks
 141   to Benoit Scherrer for the bug report.
 142
 143 * Export `nlopt_get_algorithm_name` function on Windows; thanks to Ofek
 144   Shilon for the bug report.
 145
 146 * Don't use `dllimport` directive with `lcc` on Windows (which doesn't
 147   support it); thanks to Laurent Vanbeylen for the bug report.
 148
 149 * Update Nodedal README directory to indicate that Nocedal's LBFGS code
 150   is now available under the GPL, and therefore may be distributed with
 151   a future NLopt version (although Luksan's LBFGS code already works well).
 152
 153 * Bug fix in `set`/`get_xtol_abs`; thanks to David Rivest-Henault for the report.
 154
 155 ## NLopt 2.2
 156
 157 15 July 2010
 158
 159 * Added SLSQP algorithm for gradient-based local optimization with
 160   nonlinear constraints via sequential quadratic programming, based
 161   on the implementation by Dieter Kraft that was adapted for SciPy.
 162
 163 * Modified BOBYQA and COBYLA algorithms to support unequal initial
 164   step sizes in different directions; thanks to Tom Fiddaman for pointing
 165   out the need for this in the case where different directions have
 166   very different scales.
 167
 168 * Added Python module docstring; thanks to Sebastian Walter for the suggestion.
 169
 170 * Added `GUILE_INSTALL_DIR` variable to allow the user to change the
 171   Guile installation directory.
 172
 173 * Added Fortran interface for vector-valued constraints.
 174
 175 * Throw correct exceptions in Python for the `add_*constraint` functions;
 176   thanks to Dmitrey Kroshko for the bug report.
 177
 178 * Support forced stop and exceptions in `ORIG_DIRECT` algorithm.
 179
 180 * Remove arbitrary `1e20` upper bound on function values from `ORIG_DIRECT`
 181   code.
 182
 183 * Bugfix in C++ interface (and some other language front-ends) when
 184   deallocating the nlopt_opt object in cases like MLSL where
 185   local_optimizer is used; thanks to Jurgen Werner for the bug report.
 186
 187 ## NLopt 2.1.2
 188
 189 8 July 2010
 190
 191 * The Python mconstraint (vector-valued constraint) functions
 192   now pass a 2-dimensional array for the gradient argument, rather
 193   than a flattened 1d array.
 194
 195 * Improved handling of exceptions and forced stops for constrained
 196   optimization, making sure that no constraints are evaluated after
 197   the stop.
 198
 199 * Return an `NLOPT_INVALID_ARGS` error if more than n equality constraints
 200   are added in an n-dimensional problem.
 201
 202 * Fix bug that could cause spurious `NLOPT_INVALID_ARGS` errors when
 203   adding constraints under rare circumstances.
 204
 205 * Eliminate a few small memory leaks that could occur under error conditions.
 206
 207 ## NLopt 2.1.1
 208
 209 7 July 2010
 210
 211 * More robust configure check for Python include directories, via
 212   `distutils.sysconfig.get_python_inc()` and `numpy.get_include()`.
 213   Thanks to Nathaniel Smith for the tip.
 214
 215 * Bug fix in Guile interface: added missing prefix to nlopt-version-major
 216   etcetera.
 217
 218 ## NLopt 2.1
 219
 220 6 July 2010
 221
 222 * New vector-valued constraint feature; thanks to Dmitrey Kroshko of OpenOpt
 223   for the suggestion.
 224
 225 * COBYLA now accepts equality constraints.
 226
 227 * Guard against multiple inclusion in `nlopt.hpp`; thanks to Saul
 228   Thurrowgood for the suggestion.
 229
 230 ## NLopt 2.0.2
 231
 232 17 June 2010
 233
 234 * Fixed compilation failure in Microsoft Visual Studio, due to
 235   incorrect usage of `__stdcall` keyword; thanks to Dave Katz for the
 236   bug report.
 237
 238 ## NLopt 2.0.1
 239
 240 16 June 2010
 241
 242 * Bug fix in Fortran API (for `nlo_get_` functions returning arrays).
 243
 244 * Fixed buggy compilation with MinGW.
 245
 246 ## NLopt 2.0
 247
 248 15 June 2010
 249
 250 * New C API, that works by creating an `nlopt_opt` "object" and then calling
 251   functions to set the optimization parameters — much more extensible
 252   than the old API (which is preserved for backwards compatibility).
 253   (Updated Fortran, Matlab, and GNU Octave wrappers as well.)
 254
 255 * C++ `nlopt.hpp` wrapper around C API, allowing namespaces, object
 256   constructors/destructors, `std::vector<double>`, and exceptions
 257   to be exploited.
 258
 259 * New nlopt wrappers callable from Python and GNU Guile, generated
 260   with the help of SWIG.
 261
 262 * New `man nlopt` manual page documenting new API.
 263
 264 * New AUGLAG algorithm(s) implementing an augmented-Lagrangian method
 265   proposed by Birgin and Martinez (2008), which supports nonlinear
 266   equality and inequality constraints "wrapped around" other
 267   local/global optimization methods.
 268
 269 * Added API for nonlinear equality constraints (currently only
 270   supported by AUGLAG and ISRES algorithms).
 271
 272 * Support inequality constraints directly in `ORIG_DIRECT` algorithms
 273   (no need to return NaN when constraint is violated).
 274
 275 * Inequality/equality constraints now have optional tolerances that
 276   are used as conditions in stopping criteria.
 277
 278 * Pseudo-randomize simplex steps in COBYLA algorithm, improving robustness
 279   by avoiding accidentally taking steps that don't improve conditioning
 280   (which seems to happen sometimes with active bound constraints).  The
 281   algorithm remains deterministic (a deterministic seed is used), however.
 282
 283 * Allow COBYLA to increase the trust-region radius if the predicted improvement
 284   was approximately right and the simplex is OK, following a suggestion
 285   in the SAS manual for PROC NLP that seems to improve convergence speed.
 286
 287 * Added `nlopt_force_stop` function to force a (graceful) halt to
 288   the optimization, and corresponding `NLOPT_FORCED_STOP` return code.
 289
 290 * Improved thread-safety in random-number generation: thread-local
 291   storage is used for random-number state, on compilers that support
 292   it (e.g. gcc, Intel, Microsoft), to make the generation thread-safe.
 293   In this case, the random-number seed must be set per-thread.
 294
 295 * Return an error in global-search algorithms if the domain is not finite.
 296
 297 * Use `stdcall` convention on Windows; thanks to Alan Young for the suggestion.
 298
 299 * Added missing absolute-tolerance criteria in Luksan algorithms; thanks
 300   to Greg Nicholas for the bug report.
 301
 302 * Fixed compilation under C++, and use C++ compiler for everything in
 303   `--with-cxx` mode; thanks to Greg Nicholas for the bug report.
 304
 305 * In MMA, only stop at minf_max/stopval if the point is feasible.
 306
 307 * Fix Matlab mex file to not include unnecessary `nlopt-util.h` file,
 308   simplifying Windows compilation.
 309
 310 ## NLopt 1.2
 311
 312 18 November 2009
 313
 314 * Added Powell's BOBYQA algorithm for box-constrained optimization
 315   without derivatives, an improvement on NEWUOA.
 316
 317 * Added ISRES genetic algorithm, supporting nonlinearly constrained
 318   global optimization.
 319
 320 * New functions `nlopt_{set/get}_stochastic_population` to provide
 321   optional greater control over the random "population" sizes in
 322   stochastic algorithms (although it still has a sensible default).
 323
 324 * Bug fix: remove extraneous text accidentally included in `nlopt.f` Fortran
 325   include file.
 326
 327 * Bug fix: `configure` script now correctly handles Matlab installation
 328   when `MEX_INSTALL_DIR` is specified manually by the user.
 329
 330 ## NLopt 1.1
 331
 332 12 November 2009
 333
 334 * `configure` script detects whether `--enable-shared` is required
 335   in order to compile Matlab and Octave plugins (as is the case
 336   on x86_64), and disables compilation of those plugins if
 337   `--enable-shared` is not used.
 338
 339 * Added `--without-octave` and `--without-matlab` configure options to
 340   disable Octave and Matlab plugins, respectively.
 341
 342 * Modified COBYLA algorithm to have better support for bound
 343   constraints.
 344
 345 * Added new `NLOPT_ROUNDOFF_LIMITED` failure code to indicate
 346   cases in which optimization breaks down due to roundoff errors,
 347   in which case it is possible that useful results were obtained.
 348
 349 * Experimental support for nonlinear equality constraints via
 350   augmented-Lagrangian method.
 351
 352 * Support for compiling under Windows (ideally with MinGW) as a
 353   DLL, although you have to manually add `#define NLOPT_DLL`
 354   to nlopt.h *after* installing (after compiling NLopt).
 355
 356 * Added several checks for roundoff-related breakdown to NEWUOA code.
 357
 358 * When only a relative error tolerance is specified, no longer
 359   fails to halt when exact convergence to zero is obtained.
 360
 361 * Workaround for incompatible `qsort_r` functions in BSD and GNU libc
 362   by always using my own version; thanks to Wendy Vandoolaeghe
 363   and Philippe Preux for the bug report and explanation.
 364
 365 * Workaround for gcc 3.4.x conflict with `HUGE_VAL` definition in Solaris
 366   (gcc bug 19933).
 367
 368 * Better identification of Matlab-plugin installation directory.
 369
 370 * Fixed identification of Octave-plugin installation directory for
 371   recent Octave versions.
 372
 373 ## NLopt 1.0.1
 374
 375 13 Nov. 2008
 376
 377 * Allow user to override Matlab-plugin installation directory with
 378   `MEX_INSTALL_DIR`.
 379
 380 * Bug fix in my DIRECT code that prevented convergence (DIRECT-L unaffected).
 381
 382 * MLSL needs a nonzero default `ftol_rel` and/or `xtol_rel` to ensure that
 383   its local searches terminate; use roughly machine precision as defaults.
 384
 385 ## NLopt 1.0
 386
 387 11 Nov. 2008
 388
 389 * Initial public release.