roots-multi.lisp 18 KB
Newer Older
1 2
;;; Multivariate roots.                
;;; Liam Healy 2008-01-12 12:49:08
3
;;; Time-stamp: <2009-01-03 16:07:02EST roots-multi.lisp>
lhealy's avatar
lhealy committed
4
;;; $Id$
5 6 7

(in-package :gsl)

8 9
;;; /usr/include/gsl/gsl_multiroots.h

10 11 12 13 14 15 16 17
;;;;****************************************************************************
;;;; Function definition
;;;;****************************************************************************

(cffi:defcstruct gsl-mfunction
  ;; See /usr/include/gsl/gsl_multiroots.h
  "The definition of a function for multiroot finding in GSL."
  (function :pointer)
18
  (dimensions sizet)
19 20 21 22 23
  (parameters :pointer))

(export 'def-mfunction)
(defmacro def-mfunction (name dimensions)
  "Define a function for multivariate root solving."
24
  `(def-single-function ,name :success-failure :pointer gsl-mfunction
25
    ((dimensions ,dimensions))
26
    (gsl-vector-c)))
27

28 29 30 31 32 33 34
(cffi:defcstruct gsl-mfunction-fdf
  ;; See /usr/include/gsl/gsl_multiroots.h
  "The definition of a function and its derivatives for multiroot
   finding in GSL."
  (function :pointer)
  (df :pointer)
  (fdf :pointer)
35
  (dimensions sizet)
36 37
  (parameters :pointer))

38 39 40 41
;;;;****************************************************************************
;;;; Initialization
;;;;****************************************************************************

42 43 44 45 46 47 48 49 50 51
(defmobject multi-dimensional-root-solver-f "gsl_multiroot_fsolver"
  ((type :pointer) (dimension sizet))
  "multi-dimensional root solver with function only"			; FDL
  "Make an instance of a solver of the type specified for a system of
   the specified number of dimensions.  Optionally
   set or reset an existing solver to use the function and the
   initial guess gsl-vector."
  "set"
  ((function :pointer) ((mpointer initial) :pointer))
  (lambda (set)
52
  `((type &optional function-or-dimension (initial nil ,set))
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
    (:type type
     :dimension
     (if ,set (dim0 initial) function-or-dimension))
    (:function function-or-dimension :initial initial)))
  (initial))

(defmobject multi-dimensional-root-solver-fdf "gsl_multiroot_fdfsolver"
  ((type :pointer) (dimension sizet))
  "multi-dimensional root solver with function and derivative"			; FDL
  "Make an instance of a derivative solver of the type specified for
   a system of the specified number of dimensions.  Optionally
   set or reset an existing solver to use the function and derivative
   (fdf) and the initial guess."
  "set"
  ((function-derivative :pointer) ((mpointer initial) :pointer))
  (lambda (set)
69
  `((type &optional function-or-dimension (initial nil ,set))
70 71 72 73 74
    (:type type
     :dimension
     (if ,set (dim0 initial) function-or-dimension))
    (:function function-or-dimension :initial initial)))
  (initial))
75

76
(defmfun name ((solver multi-dimensional-root-solver-f))
77
  "gsl_multiroot_fsolver_name"
78 79
  (((mpointer solver) :pointer))
  :definition :method
80
  :c-return :string
81
  :documentation			; FDL
82 83
  "The name of the solver.")

84
(defmfun name ((solver multi-dimensional-root-solver-fdf))
85
  "gsl_multiroot_fdfsolver_name"
86 87
  (((mpointer solver) :pointer))
  :definition :method
88
  :c-return :string
89
  :documentation			; FDL
90 91 92 93 94 95
  "The name of the solver.")

;;;;****************************************************************************
;;;; Iteration
;;;;****************************************************************************

96
(defmfun iterate ((solver multi-dimensional-root-solver-f))
97
  "gsl_multiroot_fsolver_iterate"
98
  (((mpointer solver) :pointer))
99
  :definition :method
100
  :documentation			; FDL
101 102 103 104 105 106
  "Perform a single iteration of the solver.  The following errors may
   be signalled: 'bad-function-supplied, the iteration encountered a
   singular point where the function or its derivative evaluated to
   infinity or NaN, or 'gsl-division-by-zero, the derivative of the
   function vanished at the iteration point, preventing the algorithm
   from continuing without a division by zero.")
107

108
(defmfun iterate ((solver multi-dimensional-root-solver-fdf))
109
  "gsl_multiroot_fdfsolver_iterate"
110
  (((mpointer solver) :pointer))
111
  :definition :method
112
  :documentation			; FDL
113 114 115 116 117 118
  "Perform a single iteration of the solver.  The following errors may
   be signalled: 'bad-function-supplied, the iteration encountered a
   singular point where the function or its derivative evaluated to
   infinity or NaN, or 'gsl-division-by-zero, the derivative of the
   function vanished at the iteration point, preventing the algorithm
   from continuing without a division by zero.")
119

120
(defmfun solution ((solver multi-dimensional-root-solver-f))
121
  "gsl_multiroot_fsolver_root"
122
  (((mpointer solver) :pointer))
123
  :definition :method
124 125
  :c-return (crtn :pointer)
  :return ((make-marray 'double-float :from-pointer crtn))
126
  :documentation			; FDL
127 128
  "The current estimate of the root for the solver.")

129
(defmfun solution ((solver multi-dimensional-root-solver-fdf))
130
  "gsl_multiroot_fdfsolver_root"
131
  (((mpointer solver) :pointer))
132
  :definition :method
133 134
  :c-return (crtn :pointer)
  :return ((make-marray 'double-float :from-pointer crtn))
135 136 137
  :documentation
  "The current estimate of the root for the solver.")

138
(defmfun function-value ((solver multi-dimensional-root-solver-f))
139
  "gsl_multiroot_fsolver_f"
140
  (((mpointer solver) :pointer))
141
  :definition :method
142 143
  :c-return (crtn :pointer)
  :return ((make-marray 'double-float :from-pointer crtn))
144
  :documentation			; FDL
145 146
  "The function value f(x) at the current estimate x of the root for the solver.")

147
(defmfun function-value ((solver multi-dimensional-root-solver-fdf))
148
  "gsl_multiroot_fdfsolver_f"
149
  (((mpointer solver) :pointer))
150
  :definition :method
151 152
  :c-return (crtn :pointer)
  :return ((make-marray 'double-float :from-pointer crtn))
153
  :documentation			; FDL
154 155
  "The function value f(x) at the current estimate x of the root for the solver.")

156
(defmfun last-step ((solver multi-dimensional-root-solver-f))
157
  "gsl_multiroot_fsolver_dx"
158
  (((mpointer solver) :pointer))
159
  :definition :method
160 161
  :c-return (crtn :pointer)
  :return ((make-marray 'double-float :from-pointer crtn))
162
  :documentation			; FDL
163 164
  "The last step dx taken by the solver.")

165
(defmfun last-step ((solver multi-dimensional-root-solver-fdf))
166
  "gsl_multiroot_fsolver_dx"
167
  (((mpointer solver) :pointer))
168
  :definition :method
169 170
  :c-return (crtn :pointer)
  :return ((make-marray 'double-float :from-pointer crtn))
171
  :documentation			; FDL
172 173 174 175 176 177 178
  "The last step dx taken by the solver.")

;;;;****************************************************************************
;;;; Search stopping conditions
;;;;****************************************************************************

;;; The only place we need to pick apart the gsl_multiroot_fsolver
179
;;; struct is here.  We could use last-step etc., but then we'd have
180 181 182 183 184 185 186 187 188 189 190 191 192
;;; to discriminate on mfsolver vs. mfdfsolver.
(cffi:defcstruct gsl-multiroot-fsolver
  ;; See /usr/include/gsl/gsl_multiroots.h
  (type :pointer)
  (function :pointer)
  (x :pointer)
  (f :pointer)
  (dx :pointer)
  (state :pointer))

(defun multiroot-slot (solver slot)
  (cffi:foreign-slot-value solver 'gsl-multiroot-fsolver slot))

liam's avatar
liam committed
193
(defmfun multiroot-test-delta (solver absolute-error relative-error)
194 195 196 197 198
  "gsl_multiroot_test_delta"
  (((multiroot-slot solver 'dx) :pointer)
   ((multiroot-slot solver 'x) :pointer)
   (absolute-error :double) (relative-error :double))
  :c-return :success-continue
199
  :documentation			; FDL
200 201 202 203 204 205 206
  "Test for the convergence of the sequence by comparing the
   last step dx with the absolute error and relative
   errors given to the current position x.  The test returns
   T if the following condition is achieved:
   |dx_i| < epsabs + epsrel |x_i|
   for each component of x and returns NIL otherwise.")

liam's avatar
liam committed
207
(defmfun multiroot-test-residual (solver absolute-error)
208 209 210
  "gsl_multiroot_test_residual"
  (((multiroot-slot solver 'f) :pointer) (absolute-error :double))
  :c-return :success-failure
211
  :documentation			; FDL
212 213 214 215 216 217 218 219 220 221 222 223
  "Test the residual value f against the absolute error,
   returning T if the following condition is achieved:
   \sum_i |f_i| < absolute_error
   and returns NIL otherwise.  This criterion is suitable
   for situations where the precise location of the root x is
   unimportant provided a value can be found where the
   residual is small enough.")

;;;;****************************************************************************
;;;; Algorithms using derivatives
;;;;****************************************************************************

liam's avatar
liam committed
224
(defmpar *powells-hybrid* "gsl_multiroot_fdfsolver_hybridsj"
225
  ;; FDL
226
  "This is a modified version of Powell's Hybrid method as implemented in
liam's avatar
liam committed
227
   the hybrj algorithm in minpack.  Minpack was written by Jorge
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
   J. More, Burton S. Garbow and Kenneth E. Hillstrom.  The Hybrid
   algorithm retains the fast convergence of Newton's method but will also
   reduce the residual when Newton's method is unreliable. 

   The algorithm uses a generalized trust region to keep each step under
   control.  In order to be accepted a proposed new position x' must
   satisfy the condition |D (x' - x)| < \delta, where D is a
   diagonal scaling matrix and \delta is the size of the trust
   region.  The components of D are computed internally, using the
   column norms of the Jacobian to estimate the sensitivity of the residual
   to each component of x.  This improves the behavior of the
   algorithm for badly scaled functions.

   On each iteration the algorithm first determines the standard Newton
   step by solving the system J dx = - f.  If this step falls inside
   the trust region it is used as a trial step in the next stage.  If not,
   the algorithm uses the linear combination of the Newton and gradient
   directions which is predicted to minimize the norm of the function while
   staying inside the trust region,
   dx = - \alpha J^{-1} f(x) - \beta \nabla |f(x)|^2.
   This combination of Newton and gradient directions is referred to as a
   dogleg step.

   The proposed step is now tested by evaluating the function at the
   resulting point, x'.  If the step reduces the norm of the function
   sufficiently then it is accepted and size of the trust region is
   increased.  If the proposed step fails to improve the solution then the
   size of the trust region is decreased and another trial step is
   computed.

   The speed of the algorithm is increased by computing the changes to the
   Jacobian approximately, using a rank-1 update.  If two successive
   attempts fail to reduce the residual then the full Jacobian is
   recomputed.  The algorithm also monitors the progress of the solution
   and returns an error if several steps fail to make any improvement,
263
   'no-progress
264 265
   the iteration is not making any progress, preventing the algorithm from
   continuing.
266
   'jacobian-not-improving
267 268 269
   re-evaluations of the Jacobian indicate that the iteration is not
   making any progress, preventing the algorithm from continuing.")

liam's avatar
liam committed
270
(defmpar *powells-hybrid-unscaled* "gsl_multiroot_fdfsolver_hybridj"
271
  ;; FDL
272 273 274 275 276
  "This algorithm is an unscaled version of *powells-hybrid*.  The steps are
   controlled by a spherical trust region |x' - x| < \delta, instead
   of a generalized region.  This can be useful if the generalized region
   estimated by *powells-hybrid* is inappropriate.")

liam's avatar
liam committed
277
(defmpar *newton-mfdfsolver* "gsl_multiroot_fdfsolver_newton"
278
  ;; FDL
279 280 281 282 283 284 285 286 287 288 289 290
  "Newton's Method is the standard root-polishing algorithm.  The algorithm
   begins with an initial guess for the location of the solution.  On each
   iteration a linear approximation to the function F is used to
   estimate the step which will zero all the components of the residual.
   The iteration is defined by the following sequence,
   x -> x' = x - J{-1} f(x)
   where the Jacobian matrix J is computed from the derivative
   functions provided by f.  The step dx is obtained by solving
   the linear system,
   J dx = - f(x)
   using LU decomposition.")

liam's avatar
liam committed
291
(defmpar *gnewton-mfdfsolver* "gsl_multiroot_fdfsolver_gnewton"
292
  ;; FDL
293 294 295 296 297 298 299 300 301 302 303 304 305
  "A modified version of Newton's method which attempts to improve
   global convergence by requiring every step to reduce the Euclidean norm
   of the residual, |f(x)|.  If the Newton step leads to an increase
   in the norm then a reduced step of relative size,
   t = (\sqrt(1 + 6 r) - 1) / (3 r)
   is proposed, with r being the ratio of norms
   |f(x')|^2/|f(x)|^2.  This procedure is repeated until a suitable step
   size is found.")

;;;;****************************************************************************
;;;; Algorithms without derivatives
;;;;****************************************************************************

liam's avatar
liam committed
306
(defmpar *hybrid-scaled* "gsl_multiroot_fsolver_hybrids"
307 308
  ;; FDL
  "This is a version of the Hybrid algorithm which replaces calls to the
309 310 311 312 313 314
     Jacobian function by its finite difference approximation.  The finite
     difference approximation is computed using gsl_multiroots_fdjac
     with a relative step size of GSL_SQRT_DBL_EPSILON.")
;; Where is this function and parameter?  Only thing that shows in the
;; library is gsl_multiroot_fdjacobian.
 
liam's avatar
liam committed
315
(defmpar *hybrid-unscaled* "gsl_multiroot_fsolver_hybrid"
316
  ;; FDL
317 318 319
  "A finite difference version of the Hybrid algorithm without
   internal scaling.")

liam's avatar
liam committed
320
(defmpar *discrete-newton* "gsl_multiroot_fsolver_dnewton"
321
  ;; FDL
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
  "The discrete Newton algorithm is the simplest method of solving a
   multidimensional system.  It uses the Newton iteration
   x -> x - J^{-1} f(x)
   where the Jacobian matrix J is approximated by taking finite
   differences of the function f.  The approximation scheme used by
   this implementation is
   J_{ij} = (f_i(x + \delta_j) - f_i(x)) /  \delta_j
   where \delta_j is a step of size \sqrt\epsilon |x_j| with
   \epsilon being the machine precision 
   (\epsilon \approx 2.22 \times 10^-16}).
   The order of convergence of Newton's algorithm is quadratic, but the
   finite differences require n^2 function evaluations on each
   iteration.  The algorithm may become unstable if the finite differences
   are not a good approximation to the true derivatives.")

liam's avatar
liam committed
337
(defmpar *broyden* "gsl_multiroot_fsolver_broyden"
338
  ;; FDL
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
  "The Broyden algorithm is a version of the discrete Newton
   algorithm which attempts to avoids the expensive update of the Jacobian
   matrix on each iteration.  The changes to the Jacobian are also
   approximated, using a rank-1 update,
   J^{-1} \to J^{-1} - (J^{-1} df - dx) dx^T J^{-1} / dx^T J^{-1} df
   where the vectors dx and df are the changes in x
   and f.  On the first iteration the inverse Jacobian is estimated
   using finite differences, as in the discrete Newton algorithm.
    
   This approximation gives a fast update but is unreliable if the changes
   are not small, and the estimate of the inverse Jacobian becomes worse as
   time passes.  The algorithm has a tendency to become unstable unless it
   starts close to the root.  The Jacobian is refreshed if this instability
   is detected (consult the source for details).

   This algorithm is included only for demonstration purposes, and is not
   recommended for serious use.")

;;;;****************************************************************************
;;;; Examples
;;;;****************************************************************************

(defparameter *powell-A* 1.0d4)
(defun powell (argument return)
  "Powell's test function."
364 365
  (setf (maref return 0)
	(- (* *powell-A* (maref argument 0) (maref argument 1))
366
	   1)
367 368
	(maref return 1)
	(+ (exp (- (maref argument 0))) (exp (- (maref argument 1)))
369 370 371 372 373 374 375 376 377
	   (- (1+ (/ *powell-A*))))))

;;; (def-mfunction powell 2)

;;; This is the example given in Sec. 34.8.

(defparameter *rosenbrock-a* 1.0d0)
(defparameter *rosenbrock-b* 10.0d0)

378 379
(defun rosenbrock (argument return)
  "Rosenbrock test function."
380 381 382 383
  (setf (maref return 0)
	(* *rosenbrock-a* (- 1 (maref argument 0)))
	(maref return 1)
	(* *rosenbrock-b* (- (maref argument 1) (expt (maref argument 0) 2)))))
384

385 386 387 388 389
(def-mfunction rosenbrock 2)

(defun roots-multi-example ()
  "Solving Rosenbrock, the example given in Sec. 34.8 of the GSL manual."
  (let ((max-iter 1000))
390
    (let* ((vect #m(-10.0d0 -5.0d0))
391 392
	   (solver (make-multi-dimensional-root-solver-f
		    *hybrid-scaled* rosenbrock vect)))
393 394 395 396 397 398
      (loop for iter from 0
	 with fnval and argval
	 while (and (< iter max-iter)
		    (not (multiroot-test-residual solver 1.0d-7)))
	   
	 do
399 400 401
	 (iterate solver)
	 (setf fnval (cl-array (function-value solver))
	       argval (cl-array (solution solver)))
402 403 404 405 406 407 408 409 410 411 412
	 (format t "~&iter=~d~8tx0=~12,8g~24tx1=~12,8g~38tf0=~12,8g~52tf1=~12,8g"
		 iter
		 (aref argval 0)
		 (aref argval 1)
		 (aref fnval 0)
		 (aref fnval 1))
	 finally (return
		   (values (aref argval 0)
			   (aref argval 1)
			   (aref fnval 0)
			   (aref fnval 1)))))))
413

414 415
(defun rosenbrock-df (argument jacobian)
  "The partial derivatives of the Rosenbrock functions."
416 417 418 419
  (setf (maref jacobian 0 0) (- *rosenbrock-a*)
	(maref jacobian 0 1) 0.0d0
	(maref jacobian 1 0) (* -2 *rosenbrock-b* (maref argument 0))
	(maref jacobian 1 1) *rosenbrock-b*))
420 421 422 423 424

(defun rosenbrock-fdf (argument value jacobian)
  (rosenbrock argument value)
  (rosenbrock-df argument jacobian))

425
;;; Because def-solver-functions and def-single-function bind a symbol
426 427
;;; of the same name as the first function, and we want both to run,
;;; we'll make an alias function so we can use both.  
428 429
(defun rosenbrock-f (argument return)
  (rosenbrock argument return))
430 431 432 433 434 435 436 437 438

(def-solver-functions rosenbrock-f rosenbrock-df rosenbrock-fdf 2)

(defun roots-multi-example-df ()
  "Solving Rosenbrock with derivatives, the example given in Sec. 34.8
   of the GSL manual."
  (flet ((print-state (iter argval fnval)
	   (format t "~&iter=~d~8tx0=~12,8g~24tx1=~12,8g~38tf0=~12,8g~52tf1=~12,8g"
		   iter
439 440 441 442
		   (maref argval 0)
		   (maref argval 1)
		   (maref fnval 0)
		   (maref fnval 1))))
443
    (let ((max-iter 1000))
444
      (let* ((vect #m(-10.0d0 -5.0d0))
445 446 447
	     (solver (make-multi-dimensional-root-solver-fdf
		      *gnewton-mfdfsolver* rosenbrock-f vect)))
	(loop for iter from 0
448 449
	   with fnval = (function-value solver)
	   and argval = (solution solver)
450 451 452 453
	   while (and (< iter max-iter)
		      (not (multiroot-test-residual solver 1.0d-7)))
	   initially (print-state iter argval fnval)
	   do
454 455 456
	   (iterate solver)
	   (setf fnval (function-value solver)
		 argval (solution solver))
457 458 459 460 461 462
	   (print-state iter argval fnval)
	   finally (return
		     (values (maref argval 0)
			     (maref argval 1)
			     (maref fnval 0)
			     (maref fnval 1))))))))