Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tamaskis authored Jan 3, 2022
1 parent 6f9ff61 commit 84e3ac1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `fsolve_newton`
# `fsolve_newton` [![View Newton’s Method for Systems of Equations (fsolve_newton) on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/104415-newton-s-method-for-systems-of-equations-fsolve_newton)

Solves a system of nonlinear equations using Newton's method.

Expand All @@ -18,12 +18,12 @@ Solves a system of nonlinear equations using Newton's method.
`x = fsolve_newton(f,x0,opts)` does the same as the syntax above, but allows for the specification of optional solver parameters. `opts` is a structure that has the following fields:
- `jacobian` &rightarrow; function handle (defined as a function of `x`) for the Jacobian of `f` (<img src="https://latex.codecogs.com/svg.latex?\inline&space;\mathbf{J}(\mathbf{x})" title="" />)
- `imax` &rightarrow; maximum number of iterations (defaults to <img src="https://latex.codecogs.com/svg.latex?\inline&space;10^{6}" title="" />)
- `return_all` &rightarrow; all intermediate root estimates are returned if set to `true`; otherwise, only the converged root is returned (defaults to `false`)
- `return_all` &rightarrow; all intermediate solution estimates are returned if set to `true`; otherwise, only the converged solution is returned (defaults to `false`)
- `TOL` &rightarrow; tolerance (defaults to <img src="https://latex.codecogs.com/svg.latex?\inline&space;10^{-12}" title="" />)
- `warnings` &rightarrow; `true` if any warnings should be displayed, `false` if not (defaults to `true`)


## Examples and Additional Documentation

- See "EXAMPLES.mlx" or the "Examples" tab on the File Exchange page for examples.
- See ["Newton_s_Method.pdf"](https://tamaskis.github.io/documentation/Newton_s_Method.pdf) (also included with download) for the technical documentation.
- See ["Newton_s_Method.pdf"](https://tamaskis.github.io/documentation/Newton_s_Method.pdf) (also included with download) for the technical documentation.

0 comments on commit 84e3ac1

Please sign in to comment.