Skip to content

Commit

Permalink
add links to crates.io & docs.rs to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ickk committed Sep 20, 2023
1 parent 23c8015 commit b3908a8
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@ An implementation of the
[Aberth-Ehrlich method](https://en.wikipedia.org/wiki/Aberth_method)
for finding the zeros of a polynomial.

[crates.io](https://crates.io/crates/aberth) | [docs.rs](https://docs.rs/aberth)

---

Aberth's method uses an electrostatics analogy to model the approximations as
negative charges and the true zeros as positive charges. This enables
finding all complex roots simultaneously, converging cubically (worst-case it
converges linearly for zeros of multiplicity).

This crate is `#![no_std]` and tries to have minimal dependencies. It uses
[arrayvec](https://crates.io/crates/arrayvec) to avoid allocations, which will
be removed in the future when rust stabilises support for const-generics.
be removed when rust stabilises support for const-generics.


Usage
Expand Down Expand Up @@ -76,8 +80,7 @@ for polynomial in [a, b] {

Note that the returned values are not sorted in any particular order.

The coefficient of the highest degree term should not be zero or you will get
nonsense extra roots (probably at 0 + 0j).
The coefficient of the highest degree term should not be zero.


`#![no_std]`
Expand Down

0 comments on commit b3908a8

Please sign in to comment.