o Eb"@sddlZddlZddlmZmZmZmZmZm Z ddlm Z m Z m Z ddl ZddlZddlmZddlZddlmZddlmZmZgdZGd d d eZd d Zd dZddZddZed d dZ!ddZ"    dGddZ#e"e#  dHd d!Z$Gd"d#d#Z%Gd$d%d%Z&Gd&d'd'Z'd(d)Z(Gd*d+d+e&Z)Gd,d-d-Z*d. e!d/<Gd0d1d1e)Z+Gd2d3d3e+Z,Gd4d5d5e)Z-Gd6d7d7e)Z.Gd8d9d9e)Z/Gd:d;d;e)Z0Gdd?Z2e2d@e+Z3e2dAe,Z4e2dBe-Z5e2dCe/Z6e2dDe.Z7e2dEe0Z8e2dFe1Z9dS)IN)normsolveinvqrsvd LinAlgError)asarraydotvdot)get_blas_funcs)getfullargspec_no_self)scalar_search_wolfe1scalar_search_armijo)broyden1broyden2anderson linearmixing diagbroydenexcitingmixing newton_krylovc@s eZdZdS) NoConvergenceN)__name__ __module__ __qualname__rr8/usr/lib/python3/dist-packages/scipy/optimize/_nonlin.pyrsrcCst|SN)npZabsolutemaxxrrrmaxnormr"cCs*t|}t|jtjst|tjdS|S)z:Return `x` as an array, of either floats or complex floatsdtype)rrZ issubdtyper%Zinexactfloat_r rrr _as_inexact!sr'cCs(t|t|}t|d|j}||S)z;Return ndarray `x` as same array subclass and shape as `x0`__array_wrap__)rZreshapeshapegetattrr()r!x0wraprrr _array_like)sr-cCs"t|s ttjSt|Sr)risfiniteallarrayinfrvrrr _safe_norm0s r4z F : function(x) -> f Function whose root to find; should take and return an array-like object. xin : array_like Initial guess for the solution a iter : int, optional Number of iterations to make. If omitted (default), make as many as required to meet tolerances. verbose : bool, optional Print status to stdout on every iteration. maxiter : int, optional Maximum number of iterations to make. If more are needed to meet convergence, `NoConvergence` is raised. f_tol : float, optional Absolute tolerance (in max-norm) for the residual. If omitted, default is 6e-6. f_rtol : float, optional Relative tolerance for the residual. If omitted, not used. x_tol : float, optional Absolute minimum step size, as determined from the Jacobian approximation. If the step size is smaller than this, optimization is terminated as successful. If omitted, not used. x_rtol : float, optional Relative minimum step size. If omitted, not used. tol_norm : function(vector) -> scalar, optional Norm to use in convergence check. Default is the maximum norm. line_search : {None, 'armijo' (default), 'wolfe'}, optional Which type of a line search to use to determine the step size in the direction given by the Jacobian approximation. Defaults to 'armijo'. callback : function, optional Optional callback function. It is called on every iteration as ``callback(x, f)`` where `x` is the current solution and `f` the corresponding residual. Returns ------- sol : ndarray An array (of similar array type as `x0`) containing the final solution. Raises ------ NoConvergence When a solution was not found. )Z params_basicZ params_extracCs|jr |jt|_dSdSr)__doc__ _doc_parts)objrrr_set_docnsr8krylovFarmijoTc sT| durtn| } t|||| || d}tfdd}}t|tj}||}t|}t|}| | |||durQ|durJ|d}nd|j d}| durXd} n| d ur^d} | d vrft d d }d }d}d}t |D]}||||}|rnt|||}|j||d }t|dkrt d| rt||||| \}}}}nd}||}||}t|}|| || r| ||||d|d}||d|krt||}n t|t|||d}|}|rtjd|| ||ftjqr|r tt|d}| r%|j|||dkddd|d}t||fSt|S)a Find a root of a function, in a way suitable for large-scale problems. Parameters ---------- %(params_basic)s jacobian : Jacobian A Jacobian approximation: `Jacobian` object or something that `asjacobian` can transform to one. Alternatively, a string specifying which of the builtin Jacobian approximations to use: krylov, broyden1, broyden2, anderson diagbroyden, linearmixing, excitingmixing %(params_extra)s full_output : bool If true, returns a dictionary `info` containing convergence information. raise_exception : bool If True, a `NoConvergence` exception is raise if no solution is found. See Also -------- asjacobian, Jacobian Notes ----- This algorithm implements the inexact Newton method, with backtracking or full line searches. Several Jacobian approximations are available, including Krylov and Quasi-Newton methods. References ---------- .. [KIM] C. T. Kelley, "Iterative Methods for Linear and Nonlinear Equations". Society for Industrial and Applied Mathematics. (1995) https://archive.siam.org/books/kelley/fr16/ N)f_tolf_rtolx_tolx_rtoliterrcstt|Sr)r'r-flatten)zFr+rrsznonlin_solve..r dTr:F)Nr:wolfezInvalid line searchg?gH.?g?gMbP?)tolrz[Jacobian inversion yielded zero vector. This indicates a bug in the Jacobian approximation.?z%d: |F(x)| = %g; step %g z0A solution was found at the specified tolerance.z:The maximum number of iterations allowed has been reached.)r rI)ZnitZfunstatusZsuccessmessage)r"TerminationConditionr'r@rZ full_liker1r asjacobiansetupcopysize ValueErrorrangecheckminr_nonlin_line_searchupdatersysstdoutwriteflushrr- iteration) rCr+jacobianr?verbosemaxiterr;r<r=r>Ztol_normZ line_searchcallbackZ full_outputZraise_exceptionZ conditionfuncr!dxFxFx_normgammaZeta_maxZ eta_tresholdZetanrJrGsZ Fx_norm_newZeta_AinforrBr nonlin_solvess-         rh:0yE>{Gz?c sdg|gt|dgttdfdd fdd}|dkr.phics0t|d}||dd||S)Nr F)rk)abs)rfds)rprdiffs_normrrderphisz#_nonlin_line_search..derphirFrj)Zxtolaminr:)rvrH)T)rrr) r`r!rbraZ search_typersZsminrurfZphi1Zphi0rcr) rar`rprsrtrmrnror!rrUs,       rUc@s.eZdZdZdddddefddZddZdS)rLz Termination condition for an iteration. It is terminated if - |F| < f_rtol*|F_0|, AND - |F| < f_tol AND - |dx| < x_rtol*|x|, AND - |dx| < x_tol NcCsx|dur ttjjd}|durtj}|durtj}|dur"tj}||_||_||_||_||_ ||_ d|_ d|_ dS)NgUUUUUU?r) rfinfor&epsr1r=r>r;r<rr?f0_normr[)selfr;r<r=r>r?rrrr__init__Bs  zTerminationCondition.__init__cCs|jd7_||}||}||}|jdur||_|dkr$dS|jdur1d|j|jkSt||jkoJ||j|jkoJ||jkoJ||j|kS)Nr rrI) r[rryr?intr;r<r=r>)rzfr!raZf_normZx_normdx_normrrrrSZs         zTerminationCondition.check)rrrr5r"r{rSrrrrrL5s   rLc@s:eZdZdZddZddZdddZd d Zd d Zd S)Jacobiana Common interface for Jacobians or Jacobian approximations. The optional methods come useful when implementing trust region etc., algorithms that often require evaluating transposes of the Jacobian. Methods ------- solve Returns J^-1 * v update Updates Jacobian to point `x` (where the function has residual `Fx`) matvec : optional Returns J * v rmatvec : optional Returns A^H * v rsolve : optional Returns A^-H * v matmat : optional Returns A * V, where V is a dense matrix with dimensions (N,K). todense : optional Form the dense Jacobian matrix. Necessary for dense trust region algorithms, and useful for testing. Attributes ---------- shape Matrix dimensions (M, N) dtype Data type of the matrix. func : callable, optional Function the Jacobian corresponds to c sfgd}|D]\}}||vrtd||dur"t|||qtdr1fdd_dSdS)N) rrVmatvecrmatvecrsolveZmatmattodenser)r%zUnknown keyword argument %srcsSr)rrrzrrrDz#Jacobian.__init__..)itemsrQsetattrhasattr __array__)rzkwnamesnamevaluerrrr{s  zJacobian.__init__cCst|Sr)InverseJacobianrrrraspreconditionerszJacobian.aspreconditionerrcCtrNotImplementedErrorrzr3rGrrrrzJacobian.solvecCdSrrrzr!rCrrrrVrzJacobian.updatecCs>||_|j|jf|_|j|_|jjtjur|||dSdSr)r`rPr)r% __class__rNrrVrzr!rCr`rrrrNs zJacobian.setupNr) rrrr5r{rrrVrNrrrrrus%  rc@s,eZdZddZeddZeddZdS)rcCsB||_|j|_|j|_t|dr|j|_t|dr|j|_dSdS)NrNr)r\rrrVrrNrr)rzr\rrrr{s   zInverseJacobian.__init__cC|jjSr)r\r)rrrrr)zInverseJacobian.shapecCrr)r\r%rrrrr%rzInverseJacobian.dtypeN)rrrr{propertyr)r%rrrrrs  rc stjjjttr StrttrStt j rZj dkr(t dt t jdjdkr>t dtfddfddfd dfd djjd Stjrjdjdkrnt d tfd dfddfddfddjjd StdrtdrtdrttdtdjtdtdtdjjdStrGfdddt}|SttrttttttttdStd)zE Convert given object to one suitable for use as a Jacobian. rIzarray must have rank <= 2rr zarray must be squarec t|Sr)r r2JrrrD zasjacobian..ctj|Sr)r conjTr2rrrrDcrr)rr2rrrrDrcrr)rrrr2rrrrDr)rrrrr%r)zmatrix must be squarecs|Srrr2rrrrDrcsj|Srrrr2rrrrDscs |Srrr2rspsolverrrDrcsj|Srrr2rrrrDrr)r%rrrrrVrN)rrrrrVrNr%r)csLeZdZddZd fdd ZfddZd fdd Zfd d Zd S)zasjacobian..JaccSs ||_dSrr rrrrrV zasjacobian..Jac.updatercs>|j}t|tjrt||Stj|r||StdNzUnknown matrix type) r! isinstancerndarrayrscipysparse isspmatrixrQrzr3rGmrrrrs     zasjacobian..Jac.solvecs<|j}t|tjrt||Stj|r||Stdr) r!rrrr rrrrQrzr3rrrrrs    zasjacobian..Jac.matveccsJ|j}t|tjrt|j|Stj |r!|j|St dr) r!rrrrrrrrrrQrrrrr s   zasjacobian..Jac.rsolvecsH|j}t|tjrt|j|Stj |r |j|St dr) r!rrrr rrrrrrQrrrrrs   zasjacobian..Jac.rmatvecNr)rrrrVrrrrrrrrJacs    r)rrrrrrr9z#Cannot convert object to a Jacobian) rrlinalgrrrinspectZisclass issubclassrrndimrQZ atleast_2drr)r%rrr*rcallablestrdict BroydenFirst BroydenSecondAnderson DiagBroyden LinearMixingExcitingMixingKrylovJacobian TypeError)rrrrrrMsf              ' rMc@s$eZdZddZddZddZdS)GenericBroydencCsjt||||||_||_t|dr1|jdur3t|}|r,dtt|d||_dSd|_dSdSdS)Nalpha?r rH)rrNlast_flast_xrrrr)rzr+f0r`Znormf0rrrrN-s zGenericBroyden.setupcCrrrrzr!r}radfr~df_normrrr_update;rzGenericBroyden._updatec Cs@||j}||j}|||||t|t|||_||_dSr)rrrr)rzr!r}rrarrrrV>s   zGenericBroyden.updateN)rrrrNrrVrrrrr,s rc@seZdZdZddZeddZeddZdd Zd d Z dd dZ dddZ ddZ ddZ ddZddZddZdddZdS) LowRankMatrixz A matrix represented as .. math:: \alpha I + \sum_{n=0}^{n=M} c_n d_n^\dagger However, if the rank of the matrix reaches the dimension of the vectors, full matrix representation will be used thereon. cCs(||_g|_g|_||_||_d|_dSr)rcsrrrer% collapsed)rzrrer%rrrr{Qs  zLowRankMatrix.__init__c Cs\tgd|dd|g\}}}||}t||D]\}} || |} ||||j| }q|S)N)axpyscaldotcr )r ziprP) r3rrrrrrrwcdarrr_matvecYs  zLowRankMatrix._matveccCs t|dkr ||Stddg|dd|g\}}|d}|tjt||jd}t|D]\}} t|D]\} } ||| f|| | 7<q6q.tjt||jd} t|D] \} } || || | <qW| |} t|| } ||} t|| D] \} }|| | | j | } qu| S)Evaluate w = M^-1 vrrrNr r$) lenr ridentityr% enumeratezerosrrrP)r3rrrrrrZc0AirjrqrZqcrrr_solvecs$   zLowRankMatrix._solvecCs.|jdur t|j|St||j|j|jS)zEvaluate w = M vN)rrr rrrrrrrzr3rrrrs zLowRankMatrix.matveccCs:|jdurt|jj|St|t|j|j|j S)zEvaluate w = M^H vN) rrr rrrrrrrrrrrrrs zLowRankMatrix.rmatvecrcCs,|jdur t|j|St||j|j|jS)rN)rrrrrrrrrrrrrs  zLowRankMatrix.solvecCs8|jdurt|jj|St|t|j|j|j S)zEvaluate w = M^-H vN) rrrrrrrrrrrrrrrrs zLowRankMatrix.rsolvecCst|jdur|j|dddf|dddf7_dS|j||j|t|j|jkr8|dSdSr)rrrappendrrrrPcollapse)rzrrrrrrs .   zLowRankMatrix.appendcCsl|jdur|jS|jtj|j|jd}t|j|jD]\}}||dddf|dddf 7}q|S)Nr$) rrrrrer%rrrrr)rzGmrrrrrrs *zLowRankMatrix.__array__cCs"t||_d|_d|_d|_dS)z0Collapse the low-rank matrix to a full-rank one.N)rr0rrrrrrrrrrs  zLowRankMatrix.collapsecCsH|jdurdS|dks Jt|j|kr"|jdd=|jdd=dSdS)zH Reduce the rank of the matrix by dropping all vectors. NrrrrrrrzZrankrrrrestart_reduces   zLowRankMatrix.restart_reducecCsN|jdurdS|dks Jt|j|kr%|jd=|jd=t|j|ksdSdS)zK Reduce the rank of the matrix by dropping oldest vectors. Nrrrrrr simple_reduces  zLowRankMatrix.simple_reduceNc Cs6|jdurdS|}|dur|}n|d}|jr!t|t|jd}tdt||d}t|j}||kr6dSt|jj}t|jj}t |dd\}}t ||j }t |dd\} } } t |t | }t || j }t|D]} |dd| f|j| <|dd| f|j| <qp|j|d=|j|d=dS) a Reduce the rank of the matrix by retaining some SVD components. This corresponds to the "Broyden Rank Reduction Inverse" algorithm described in [1]_. Note that the SVD decomposition can be done by solving only a problem whose size is the effective rank of this matrix, which is viable even for large problems. Parameters ---------- max_rank : int Maximum rank of this matrix after reduction. to_retain : int, optional Number of SVD components to retain when reduction is done (ie. rank > max_rank). Default is ``max_rank - 2``. References ---------- .. [1] B.A. van der Rotten, PhD thesis, "A limited memory Broyden method to solve high-dimensional systems of nonlinear equations". Mathematisch Instituut, Universiteit Leiden, The Netherlands (2003). https://web.archive.org/web/20161022015821/http://www.math.leidenuniv.nl/scripties/Rotten.pdf NrIrr Zeconomic)modeF)Z full_matrices)rrrTrrrr0rrrrr rrrrRrO) rzmax_rankZ to_retainrlrrCDRUSZWHkrrr svd_reduces0    zLowRankMatrix.svd_reducerr)rrrr5r{ staticmethodrrrrrrrrrrrrrrrrrFs"         ra alpha : float, optional Initial guess for the Jacobian is ``(-1/alpha)``. reduction_method : str or tuple, optional Method used in ensuring that the rank of the Broyden matrix stays low. Can either be a string giving the name of the method, or a tuple of the form ``(method, param1, param2, ...)`` that gives the name of the method and values for additional parameters. Methods available: - ``restart``: drop all matrix columns. Has no extra parameters. - ``simple``: drop oldest matrix column. Has no extra parameters. - ``svd``: keep only the most significant SVD components. Takes an extra parameter, ``to_retain``, which determines the number of SVD components to retain when rank reduction is done. Default is ``max_rank - 2``. max_rank : int, optional Maximum rank for the Broyden matrix. Default is infinity (i.e., no rank reduction). Zbroyden_paramsc@sVeZdZdZdddZddZdd Zdd d Zd dZdddZ ddZ ddZ dS)ra Find a root of a function, using Broyden's first Jacobian approximation. This method is also known as \"Broyden's good method\". Parameters ---------- %(params_basic)s %(broyden_params)s %(params_extra)s See Also -------- root : Interface to root finding algorithms for multivariate functions. See ``method=='broyden1'`` in particular. Notes ----- This algorithm implements the inverse Jacobian Quasi-Newton update .. math:: H_+ = H + (dx - H df) dx^\dagger H / ( dx^\dagger H df) which corresponds to Broyden's first Jacobian update .. math:: J_+ = J + (df - J dx) dx^\dagger / dx^\dagger dx References ---------- .. [1] B.A. van der Rotten, PhD thesis, \"A limited memory Broyden method to solve high-dimensional systems of nonlinear equations\". Mathematisch Instituut, Universiteit Leiden, The Netherlands (2003). https://web.archive.org/web/20161022015821/http://www.math.leidenuniv.nl/scripties/Rotten.pdf Examples -------- The following functions define a system of nonlinear equations >>> def fun(x): ... return [x[0] + 0.5 * (x[0] - x[1])**3 - 1.0, ... 0.5 * (x[1] - x[0])**3 + x[1]] A solution can be obtained as follows. >>> from scipy import optimize >>> sol = optimize.broyden1(fun, [0, 0]) >>> sol array([0.84116396, 0.15883641]) Nrestartcst|_d_|durtj}|_t|trdn |dd|d}|df|dkr<fdd_ dS|dkrJfdd_ dS|d krXfd d_ dSt d |) Nrr rrc jjSr)rrrZ reduce_paramsrzrrrDi z'BroydenFirst.__init__..simplecrr)rrrrrrrDkrrcrr)rrrrrrrDmrz"Unknown rank reduction method '%s') rr{rrrr1rrr_reducerQ)rzrZreduction_methodrrrrr{Xs(   zBroydenFirst.__init__cCs.t||||t|j |jd|j|_dS)Nr)rrNrrr)r%rrrrrrNrszBroydenFirst.setupcCs t|jSr)rrrrrrrvrzBroydenFirst.todensercCs:|j|}t|s||j|j|j|j|Sr) rrrr.r/rNrrr`)rzr}rGrrrrrys  zBroydenFirst.solvecC |j|Sr)rrrzr}rrrr zBroydenFirst.matveccCrr)rrrzr}rGrrrrrzBroydenFirst.rsolvecCrr)rrrrrrrrzBroydenFirst.rmatvecc CsD||j|}||j|}|t||} |j|| dSr)rrrrr r rzr!r}rarr~rr3rrrrrrs  zBroydenFirst._update)NrNr) rrrr5r{rNrrrrrrrrrrr"s 5   rc@seZdZdZddZdS)raL Find a root of a function, using Broyden's second Jacobian approximation. This method is also known as "Broyden's bad method". Parameters ---------- %(params_basic)s %(broyden_params)s %(params_extra)s See Also -------- root : Interface to root finding algorithms for multivariate functions. See ``method=='broyden2'`` in particular. Notes ----- This algorithm implements the inverse Jacobian Quasi-Newton update .. math:: H_+ = H + (dx - H df) df^\dagger / ( df^\dagger df) corresponding to Broyden's second method. References ---------- .. [1] B.A. van der Rotten, PhD thesis, "A limited memory Broyden method to solve high-dimensional systems of nonlinear equations". Mathematisch Instituut, Universiteit Leiden, The Netherlands (2003). https://web.archive.org/web/20161022015821/http://www.math.leidenuniv.nl/scripties/Rotten.pdf Examples -------- The following functions define a system of nonlinear equations >>> def fun(x): ... return [x[0] + 0.5 * (x[0] - x[1])**3 - 1.0, ... 0.5 * (x[1] - x[0])**3 + x[1]] A solution can be obtained as follows. >>> from scipy import optimize >>> sol = optimize.broyden2(fun, [0, 0]) >>> sol array([0.84116365, 0.15883529]) c Cs:||}||j|}||d} |j|| dSNrI)rrrrrrrrrs  zBroydenSecond._updateN)rrrr5rrrrrrs 2rc@s4eZdZdZdddZddd Zd d Zd d ZdS)ra Find a root of a function, using (extended) Anderson mixing. The Jacobian is formed by for a 'best' solution in the space spanned by last `M` vectors. As a result, only a MxM matrix inversions and MxN multiplications are required. [Ey]_ Parameters ---------- %(params_basic)s alpha : float, optional Initial guess for the Jacobian is (-1/alpha). M : float, optional Number of previous vectors to retain. Defaults to 5. w0 : float, optional Regularization parameter for numerical stability. Compared to unity, good values of the order of 0.01. %(params_extra)s See Also -------- root : Interface to root finding algorithms for multivariate functions. See ``method=='anderson'`` in particular. References ---------- .. [Ey] V. Eyert, J. Comp. Phys., 124, 271 (1996). Examples -------- The following functions define a system of nonlinear equations >>> def fun(x): ... return [x[0] + 0.5 * (x[0] - x[1])**3 - 1.0, ... 0.5 * (x[1] - x[0])**3 + x[1]] A solution can be obtained as follows. >>> from scipy import optimize >>> sol = optimize.anderson(fun, [0, 0]) >>> sol array([0.84116588, 0.15883789]) NrjcCs2t|||_||_g|_g|_d|_||_dSr)rr{rMrarrdw0)rzrrrrrrr{s  zAnderson.__init__rc Cs|j |}t|j}|dkr|Stj||jd}t|D] }t|j||||<qzt |j |}Wnt yI|jdd=|jdd=|YSwt|D]}||||j||j|j|7}qN|SNrr$) rrraremptyr%rRr rrrr) rzr}rGraredf_frrdrrrrr#s"       (zAnderson.solvec Cs,| |j}t|j}|dkr|Stj||jd}t|D] }t|j||||<qtj||f|jd}t|D]<}t|D]5}t|j||j||||f<||krs|j dkrs|||ft|j||j||j d|j8<q>q8t ||} t|D]} || | |j| |j| |j7}q~|S)Nrr$rI) rrrarrr%rRr rrr) rzr}rarerrbrrrdrrrrr:s&     6  (zAnderson.matvecc Cs|jdkrdS|j||j|t|j|jkr/|jd|jdt|j|jkst|j}tj||f|jd}t |D])} t | |D]!} | | krU|j d} nd} d| t |j| |j| || | f<qIqB|t |dj 7}||_dS)Nrr$rIr )rrarrrpoprrr%rRrr Ztriurrr) rzr!r}rarr~rrerrrZwdrrrrQs&        ( zAnderson._update)Nrjrr)rrrr5r{rrrrrrrrs  F  rc@sVeZdZdZdddZddZddd Zd d Zdd d ZddZ ddZ ddZ dS)ra- Find a root of a function, using diagonal Broyden Jacobian approximation. The Jacobian approximation is derived from previous iterations, by retaining only the diagonal of Broyden matrices. .. warning:: This algorithm may be useful for specific problems, but whether it will work may depend strongly on the problem. Parameters ---------- %(params_basic)s alpha : float, optional Initial guess for the Jacobian is (-1/alpha). %(params_extra)s See Also -------- root : Interface to root finding algorithms for multivariate functions. See ``method=='diagbroyden'`` in particular. Examples -------- The following functions define a system of nonlinear equations >>> def fun(x): ... return [x[0] + 0.5 * (x[0] - x[1])**3 - 1.0, ... 0.5 * (x[1] - x[0])**3 + x[1]] A solution can be obtained as follows. >>> from scipy import optimize >>> sol = optimize.diagbroyden(fun, [0, 0]) >>> sol array([0.84116403, 0.15883384]) NcCt|||_dSrrr{rrzrrrrr{  zDiagBroyden.__init__cCs6t||||tj|jdfd|j|jd|_dS)Nrr r$)rrNrfullr)rr%rrrrrrNs&zDiagBroyden.setuprcC | |jSrrrrrrrrzDiagBroyden.solvecC | |jSrrrrrrrrzDiagBroyden.matveccC| |jSrrrrrrrrzDiagBroyden.rsolvecC| |jSrrrrrrrrzDiagBroyden.rmatveccCst|j Sr)rdiagrrrrrrr#zDiagBroyden.todensecCs(|j||j|||d8_dSrrrrrrrs(zDiagBroyden._updaterr rrrr5r{rNrrrrrrrrrrros (   rc@sNeZdZdZdddZdddZdd Zdd d Zd d ZddZ ddZ dS)ra Find a root of a function, using a scalar Jacobian approximation. .. warning:: This algorithm may be useful for specific problems, but whether it will work may depend strongly on the problem. Parameters ---------- %(params_basic)s alpha : float, optional The Jacobian approximation is (-1/alpha). %(params_extra)s See Also -------- root : Interface to root finding algorithms for multivariate functions. See ``method=='linearmixing'`` in particular. NcCr rr r rrrr{r zLinearMixing.__init__rcCrrrrrrrrrzLinearMixing.solvecCrrrrrrrrrzLinearMixing.matveccCs| t|jSrrrrrrrrrzLinearMixing.rsolvecCs| t|jSrrrrrrrrzLinearMixing.rmatveccCstt|jdd|jS)Nr)rrr r)rrrrrrszLinearMixing.todensecCrrrrrrrrrzLinearMixing._updaterr) rrrr5r{rrrrrrrrrrrs    rc@sVeZdZdZdddZddZdd d Zd d Zdd dZddZ ddZ ddZ dS)ra Find a root of a function, using a tuned diagonal Jacobian approximation. The Jacobian matrix is diagonal and is tuned on each iteration. .. warning:: This algorithm may be useful for specific problems, but whether it will work may depend strongly on the problem. See Also -------- root : Interface to root finding algorithms for multivariate functions. See ``method=='excitingmixing'`` in particular. Parameters ---------- %(params_basic)s alpha : float, optional Initial Jacobian approximation is (-1/alpha). alphamax : float, optional The entries of the diagonal Jacobian are kept in the range ``[alpha, alphamax]``. %(params_extra)s NrHcCs t|||_||_d|_dSr)rr{ralphamaxbeta)rzrrrrrr{s  zExcitingMixing.__init__cCs2t||||tj|jdf|j|jd|_dSr)rrNrr r)rr%rrrrrrNs"zExcitingMixing.setuprcCrrrrrrrrrzExcitingMixing.solvecCrrrrrrrr rzExcitingMixing.matveccCrrrrrrrrr rzExcitingMixing.rsolvecCrrrrrrrrrzExcitingMixing.rmatveccCstd|jS)Nr)rrrrrrrrrzExcitingMixing.todensecCsL||jdk}|j||j7<|j|j|<tj|jd|j|jddS)Nr)out)rrrrZclipr)rzr!r}rarr~rZincrrrrrszExcitingMixing._update)NrHrrrrrrrs    rc@sHeZdZdZ  dddZdd Zd d Zdd dZddZddZ dS)ra Find a root of a function, using Krylov approximation for inverse Jacobian. This method is suitable for solving large-scale problems. Parameters ---------- %(params_basic)s rdiff : float, optional Relative step size to use in numerical differentiation. method : {'lgmres', 'gmres', 'bicgstab', 'cgs', 'minres'} or function Krylov method to use to approximate the Jacobian. Can be a string, or a function implementing the same interface as the iterative solvers in `scipy.sparse.linalg`. The default is `scipy.sparse.linalg.lgmres`. inner_maxiter : int, optional Parameter to pass to the "inner" Krylov solver: maximum number of iterations. Iteration will stop after maxiter steps even if the specified tolerance has not been achieved. inner_M : LinearOperator or InverseJacobian Preconditioner for the inner Krylov iteration. Note that you can use also inverse Jacobians as (adaptive) preconditioners. For example, >>> from scipy.optimize.nonlin import BroydenFirst, KrylovJacobian >>> from scipy.optimize.nonlin import InverseJacobian >>> jac = BroydenFirst() >>> kjac = KrylovJacobian(inner_M=InverseJacobian(jac)) If the preconditioner has a method named 'update', it will be called as ``update(x, f)`` after each nonlinear step, with ``x`` giving the current point, and ``f`` the current function value. outer_k : int, optional Size of the subspace kept across LGMRES nonlinear iterations. See `scipy.sparse.linalg.lgmres` for details. inner_kwargs : kwargs Keyword parameters for the "inner" Krylov solver (defined with `method`). Parameter names must start with the `inner_` prefix which will be stripped before passing on the inner method. See, e.g., `scipy.sparse.linalg.gmres` for details. %(params_extra)s See Also -------- root : Interface to root finding algorithms for multivariate functions. See ``method=='krylov'`` in particular. scipy.sparse.linalg.gmres scipy.sparse.linalg.lgmres Notes ----- This function implements a Newton-Krylov solver. The basic idea is to compute the inverse of the Jacobian with an iterative Krylov method. These methods require only evaluating the Jacobian-vector products, which are conveniently approximated by a finite difference: .. math:: J v \approx (f(x + \omega*v/|v|) - f(x)) / \omega Due to the use of iterative matrix inverses, these methods can deal with large nonlinear problems. SciPy's `scipy.sparse.linalg` module offers a selection of Krylov solvers to choose from. The default here is `lgmres`, which is a variant of restarted GMRES iteration that reuses some of the information obtained in the previous Newton steps to invert Jacobians in subsequent steps. For a review on Newton-Krylov methods, see for example [1]_, and for the LGMRES sparse inverse method, see [2]_. References ---------- .. [1] D.A. Knoll and D.E. Keyes, J. Comp. Phys. 193, 357 (2004). :doi:`10.1016/j.jcp.2003.08.010` .. [2] A.H. Baker and E.R. Jessup and T. Manteuffel, SIAM J. Matrix Anal. Appl. 26, 962 (2005). :doi:`10.1137/S0895479803422014` Examples -------- The following functions define a system of nonlinear equations >>> def fun(x): ... return [x[0] + 0.5 * x[1] - 1.0, ... 0.5 * (x[1] - x[0]) ** 2] A solution can be obtained as follows. >>> from scipy import optimize >>> sol = optimize.newton_krylov(fun, [0, 0]) >>> sol array([0.66731771, 0.66536458]) Nlgmres c KsD||_||_ttjjjtjjjtjjjtjjj tjjj d |||_ t||jd|_ |j tjjjurE||j d<d|j d<|j ddn>|j tjjjurU|j ddn.|j tjjjur||j d<d|j d<|j d g|j d d |j d d |j dd|D]\}}|dstd|||j |dd<qdS)N)bicgstabgmresr cgsminres)r^rZrestrtr r^Zatolrouter_kZouter_vZprepend_outer_vTZstore_outer_AvFZinner_zUnknown parameter %s)preconditionerrsrrrrr#r$r r%r&getmethod method_kw setdefaultZgcrotmkr startswithrQ) rzrsr+Z inner_maxiterZinner_Mr'rkeyrrrrr{s<      zKrylovJacobian.__init__cCs<t|j}t|j}|jtd|td||_dS)Nr )rqr+rrrsomega)rzZmxZmfrrr_update_diff_steps z KrylovJacobian._update_diff_stepcCslt|}|dkr d|S|j|}||j|||j|}tt|s4tt|r4td|S)Nrz$Function returned non-finite results) rr0r`r+rrr/r.rQ)rzr3ZnvZscrrrrrs  zKrylovJacobian.matvecrcCsNd|jvr|j|j|fi|j\}}|S|j|j|fd|i|j\}}|S)NrG)r,r+op)rzZrhsrGZsolrgrrrrs  zKrylovJacobian.solvecCsD||_||_||jdurt|jdr |j||dSdSdS)NrV)r+rr1r)rrV)rzr!r}rrrrVs  zKrylovJacobian.updatecCst||||||_||_tjj||_|j dur%t |j j d|_ ||jdur>t|jdr@|j|||dSdSdS)NrrN)rrNr+rrrrZaslinearoperatorr2rsrrwr%rxr1r)r)rzr!r}r`rrrrNs   zKrylovJacobian.setup)Nr r!Nr"r) rrrr5r{r1rrrVrNrrrrr s` *  rcCst|j}|\}}}}}}} tt|t| d|} ddd| D} | r,d| } ddd| D} | r<| d} |rDtd|d} | t|| |j| d} i}| t t | |||}|j |_ t ||S) a Construct a solver wrapper with given name and Jacobian approx. It inspects the keyword arguments of ``jac.__init__``, and allows to use the same arguments in the wrapper function, in addition to the keyword arguments of `nonlin_solve` Nz, cSsg|] \}}d||fqS)z%s=%rr.0rr3rrr z#_nonlin_wrapper..cSsg|] \}}d||fqS)z%s=%srr3rrrr5r6zUnexpected signature %sa def %(name)s(F, xin, iter=None %(kw)s, verbose=False, maxiter=None, f_tol=None, f_rtol=None, x_tol=None, x_rtol=None, tol_norm=None, line_search='armijo', callback=None, **kw): jac = %(jac)s(%(kwkw)s **kw) return nonlin_solve(F, xin, jac, iter, verbose, maxiter, f_tol, f_rtol, x_tol, x_rtol, tol_norm, line_search, callback) )rrjacZkwkw)_getfullargspecr{listrrjoinrQrrrVglobalsexecr5r8)rr7Z signatureargsZvarargsZvarkwdefaults kwonlyargsZ kwdefaults_kwargsZkw_strZkwkw_strwrappernsr`rrr_nonlin_wrappers,     rDrrrrrrr) r9NFNNNNNNr:NFT)r:rirj):rWZnumpyrZ scipy.linalgrrrrrrrr r Zscipy.sparse.linalgrZ scipy.sparser rZscipy._lib._utilr r8Z _linesearchrr__all__ Exceptionrr"r'r-r4rstripr6r8rhrUrLrrrMrrrrrrrrrrDrrrrrrrrrrrsx     (4  -@D`Eq@D.?A ,