Open Kolaru opened 5 years ago
Since there are ever more parameters to control the search, I think it is time to introduce a RootsProblem
type, similar to ODEProblem
in DifferentialEquations
.
This would contain all of the parameters of the search etc.
There could still be a convenience roots
function for quick usage, or just create the RootsProblem
object and call roots
(or maybe solve
) on that.
Indeed, as I add things to the list, the more I agree with the idea of a RootsProblem
, this will probably simplify passing around the parameters internally.
It may also be good to force keywords parameters to be passed through such object and have roots
with only positional arguments (i.e. have it as a convenient function for simple cases).
Eg. See how it's done in MDBP.jl:
It would maybe be useful to be able to use either package with the same or similar syntax.
It would be good to follow the common interface from https://github.com/SciML/CommonSolve.jl
Edit : It is also used by Roots.jl and may allow to drop it as a dependency
I use that in IntervalLinearAlgebra.jl. it's very nice
I new issue found while writing the documentation. The current situation is awkward.
I think we could go with the following scheme:
Positional arguments
Optionally for Krawczyk and Newton:
Keyword arguments
Maybe the method should be both a keyword and an optional argument, not sure about this one.