Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the readme example #7

Merged
merged 1 commit into from
Oct 14, 2020
Merged

Fix the readme example #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Fast implementations of root finding algorithms in Julia that satisfy the SciML common interface.

```julia
using NonlinearSolve
using NonlinearSolve, StaticArrays

f(u,p) = u .* u .- 2
u0 = @SVector[1.0, 1.0]
Expand Down Expand Up @@ -41,9 +41,11 @@ f(u, p) = u .* u .- 2.0
u0 = (1.0, 2.0) # brackets
probB = NonlinearProblem(f, u0)
solver = init(probB, Falsi()) # Can iterate the solver object
solve!(solver)
solver = solve!(solver)
```

Note that the `solver` object is actually immutable since we want to make it live on the stack for the sake of performance.

## Roadmap

The current algorithms should support automatic differentiation, though improved adjoint overloads are planned
Expand Down