Class NewtonRaphson

source code

            object --+        
                     |        
   bases.BaseAlgorithm --+    
                         |    
   bases.ExplicitAlgorithm --+
                             |
                object --+   |
                         |   |
  bases.IterativeAlgorithm --+
                             |
                object --+   |
                         |   |
bases.InformationAlgorithm --+
                             |
                            NewtonRaphson

Finds a root of the function assumed to be in the vicinity of a given
point.

Newtons method is not guaranteed to converge, and may diverge from the
solution if e.g. the starting point is too far from the root.

Problems may also arise if the gradient is too small (e.g. at a stationary
point) on the path to the root.

Parameters
----------
force_negative : Boolean. Default is False. Will try to make the result
        negative. It may fail if the function does not behave "nicely"
        around the found point.

eps : Positive float. A small value used as the stopping criterion. The
        stopping criterion will be fulfilled if it converges in less
        than max_iter iterations.

info : List or tuple of utils.Info. What, if any, extra run
        information should be stored. Default is an empty list, which means
        that no run information is computed nor returned.

max_iter : Non-negative integer. Maximum allowed number of iterations.

min_iter : Non-negative integer less than or equal to max_iter. Minimum
        number of iterations that must be performed. Default is 1.

Parameters
----------
function : Function. The function for which a root should be found.

x : Float. The starting point of the Newton-Raphson algorithm. Should
        be "close" to the root.