search

giordano / PolynomialRoots.jl

Fast complex polynomial root finder, with support for arbitrary precision calculations
Other
53 stars 15 forks source link

readme should state this is for *univariate* polynomials only #5

Closed chriscoey closed 6 years ago

chriscoey commented 6 years ago

It wasn't obvious to me from the readme that this package cannot handle multivariate polynomials

giordano commented 6 years ago

The README.md has a few examples, all of them for univariate polynomials only. The README.md also refers to the paper where the algorithm is introduced, where you could have found that it's for univariate polynomials, just like the zroots routine from Numerical Recipes (mentioned in the README.md as well).

Furthermore, the documentation also clearly states that the argument is the vector of coefficients in ascending order, it's not clear to me how you'd expect this to work for multivariate polynomials.

Anyway, I explicitly mentioned univariate in the README.md to avoid any confusion.