Extend parsing of documentation #150
Conversation
|
I took my liberty to add preliminary support for fpwrap. I don't think we can actually add support for julia-like usage since most of the functions (e.g. What we can definitely do is to add default value ( |
|
I actually had something slightly different in mind! I pushed some WIP code now. My thinking is that the fpwrap part of Arb is sort of its own separate thing and it would make sense to treat it differently than the rest. I added an function fpwrap_exp(x::Union{Float16, Float32, Float64}; safe::Bool = true, accurate_parts::Bool = false, correct_rounding::Bool = false, work_limit::Integer = 8)
res = Ref{Float64}()
flags::Cint = accurate_parts + correct_rounding * 2 + work_limit * 65536
success = ccall(Arblib.@libarb("arb_fpwrap_double_exp"), Cint, (Ptr{Float64}, Ref{Float64}, Float64, Int32, Int32), res, res, x, flags, flags)
if iszero(success) || !safe
return res[]
else
error("unable to evaluate accurately")
end
endThis keeps the What do you think about this approach? One idea would also be to have both these wrappers and the more low-level wrappers you implemented. |
|
@Joel-Dahne this looks good! The compiler seems to eludes the creation of Ref ;) It can't do so in the case of julia> @btime fpwrap_exp($3.0)
286.898 ns (0 allocations: 0 bytes)
20.085536923187668
julia> function f(x)
rs = [one(x)]
Arblib.exp!(rs, x)
return rs[]
end
f (generic function with 1 method)
julia> @btime f(3.0)
334.448 ns (1 allocation: 64 bytes)
20.085536923187668 |
|
Even better then! I'll make an attempt at a more serious implementation then. I think it might try to extract the methods related to parsing to a separate submodule, then it wont clutter the Arblib namespace so much. |
|
I was actually thinking about it as well |
|
I got caught up in other things this week, but I'll come back to this when I get some time again! 😃 |
|
no rush @Joel-Dahne, I will be pretty preoccupied for the next 3 weeks as I'll be teaching the next semester ;) |
It now uses arbsignature(::Carg)
src/ArbCall/parse.jl
Outdated
| # The title is on the form | ||
| # **filename.h** -- some title | ||
| # Take only the part after -- | ||
| push!(sections, (uppercasefirst(strip(split(title, "--", limit = 2)[2])), [])) |
There was a problem hiding this comment.
probably better handled via regex?
m = match(r"\*{2}\w+\.h\*{2}\s-{2}\s(?<title>[\w\s]*)", title)
@assert !isnothing(m[:title])
push!(sections, (uppercasefirst(m[:title]), []))There was a problem hiding this comment.
I must say I find the non-regex version easier to read :) I'll see what I do in the end!
There was a problem hiding this comment.
Yeah, that's me trying to be too specific :D Is
m = match(r"(.*)-- (?<title>.*)", title)better?
|
Thanks for the comments! I though I would also add some more tests to get the test coverage up, otherwise it will annoy me forever! Once that is done I'll merge it. |
|
I remembered I had one design decision I wanted to check with you. For the |
|
hmm, maybe From the user perspective there I think it's best to have a global switch that you can flip to find the first |
|
@Joel-Dahne this seems to be ready to go? fixing formatting + bumping version is all it needs I think |
|
Sorry, I got disrupted finishing up a paper. But we just uploaded it to arxiv so now I will have some time! 😀 I'll switch the name of the flag we discussed, probably taking your name, and will look at implementing a global switch for the default value. Apart from that it should only need an update of the formatter version and a bump of the version and be good to go! I'll probably get it done throughout the week! |
It is never used.
Previously the error_on_failure argument for fpwrap methods would default to false. Now it still defaults to false but this can be changed using the fpwrap_error_on_fauilure_default_set method. This allows switching this on or off globally for easier debugging whens searching for what produces a NaN. The current implementation leads to zero overhead, it only incurs a compile time cost. See comments in #138 and #150 for some context.
|
Okay, now I think this should be good to go! I implemented the toggle for default argument as discussed in #138. You could maybe check if this looks reasonable to you. The test coverage for |
|
maybe the only thing that is missing is incrementing the version ;) |
This extends which files in the Arb documentation we parse. I have now added parsing of all files except the deprecated
fmprmodule. Most of the newly parsed files don't actually add any new methods because they use types that we don't implement yet. Nevertheless I think it is nice to parse them anyway so that we are explicit in which types are not implemented. Some new methods are also included, for exampleacb_dft. This also updates the parsed files to version 2.22 of Arb, which is the one we are on, adding a few new methods.One thing I want to add in the future is special parsing of the
fpwrapmodule, so that the can be used conveniently. I also want to look over the newly added methods to Arb and see if we should do something with any of them, for example there is now anerfinvfunction that should be added to the SpecialFunctions interface. But all of this is for a future PR.