[RFC] Move arithmetic functions into submodule FixedPointArithmetic
#292
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is in preparation for improved overflow handling. (closes #239)
We should probably discuss the module structure in OverflowContexts.jl.
xref: JuliaMath/OverflowContexts.jl#7
Even though these functions will be exposed differently in the future by the package extension mechanism, I believe that their implementation should be there statically.
There is a slight tradeoff between an ideal module structure and maintainability.
The proposed file structure follows the conventional file structure.
That is, the
FixedPoint
common implementations are in onearithmetic.jl
, and the specializations specific toFixed
andNormed
are in*_arithmetic.jl
.In terms of modularity, it might be better to have separate files for each strategy, such as
Checked
.However, as noted above, I do not intend for them to be loaded/compiled independently.
Submodule names such as
Wrapping
are also debatable.The current proposal comes from the following reasons:
CheckedArithmetic
conflicts with the package nameFixedPointCheckedArithmetic
,FixedPointChecked
, and so on are redundantFixedPointNumbers
Base.Checked
The automatic formatter has removed the spaces in the type parameters, which I will try to restore later.