Open albinahlback opened 2 years ago
It is also now used by Wolfram Mathematica. Ha. https://youtu.be/_BBdeaqaHVU
Thanks, that's a nice presentation (though off topic for this issue).
Back to the topic: I agree it would be nice to document all these internal functions and macros.
arf_mul_rnd_down
returns an inexactness flag, like most other arf
functions.
@fredrik-johansson, what do you think about a creating generic header for Arb, like FLINT has flint.h
? I know arb.h
is already taken, but I have two reasons why I think creating such a header is a good idea:
arf.h
, which has a lot of perfectly good end-user functions, you do not get ARB_VERSION
.LIMB_ONE
in documentation for a generic header than under mag.h
.Maybe I'll come up with more reasons later.
Edit: Perhaps arblib.h
is a suiting name, although that could be interpreted as a header including everything in the library. Perhaps arb_defs.h
is the best variant.
Mostly used by developers, so I guess it's not a high priority issue. However, it is nice to have a quick glance at it while developing so one can quickly see all the caveats.
For example
_arf_demote
and the macronn_mul_2x2
. Alsoarf_mul_rnd_down
, and what is theint
it is supposed to return?Edit: I edited the title as I planning to devote a couple of hours to proof read the documents as well as documenting more internal functions.