Skip to content
This repository was archived by the owner on May 15, 2025. It is now read-only.

Commit c6c858e

Browse files
better readme
1 parent e77dbbd commit c6c858e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
1010
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
1111

12-
13-
14-
1512
Fast implementations of root finding algorithms in Julia that satisfy the SciML common interface.
13+
SimpleNonlinearSolve.jl focuses on low-dependency implementations of very fast methods for
14+
very small and simple problems. For the full set of solvers, see NonlinearSolve.jl, of which
15+
SimpleNonlinearSolve.jl is just one solver set.
1616

1717
For information on using the package,
1818
[see the stable documentation](https://docs.sciml.ai/NonlinearSolve/stable/). Use the
@@ -22,17 +22,17 @@ the documentation which contains the unreleased features.
2222
## High Level Examples
2323

2424
```julia
25-
using NonlinearSolve, StaticArrays
25+
using SimpleNonlinearSolve, StaticArrays
2626

2727
f(u,p) = u .* u .- 2
2828
u0 = @SVector[1.0, 1.0]
2929
probN = NonlinearProblem{false}(f, u0)
30-
solver = solve(probN, NewtonRaphson(), tol = 1e-9)
30+
solver = solve(probN, SimpleNewtonRaphson(), tol = 1e-9)
3131

3232
## Bracketing Methods
3333

3434
f(u, p) = u .* u .- 2.0
3535
u0 = (1.0, 2.0) # brackets
36-
probB = NonlinearProblem(f, u0)
36+
probB = IntervalNonlinearProblem(f, u0)
3737
sol = solve(probB, Falsi())
3838
```

0 commit comments

Comments
 (0)