gibbsly / gm

A utility datapack for doing math operations

The Unlicense

31 stars 2 forks source link

Add modulo function #13

Closed GlitchlessCode closed 6 months ago

GlitchlessCode commented 6 months ago

The Suggestion

Comes from #11

Implementation description

Uses an implementation of the fmod algorithm
- x % y = x - truncate(x / y) * y
- The truncation was the hardest part to figure out, because unlike floor which always rounds down, truncate rounds towards 0
Implementation is fairly efficient, and is quite precise
Allows for both decimal and negative values in both x and y
Catches y=0 by failing
Updated README to add gm:modulo to list of functions

GlitchlessCode commented 6 months ago

I made sure to test this as extensively as possible, and I couldn't find any edge cases where it broke (apart from y=0, which now correctly returns a fail). This includes int/int, int/float, float/int, float/float, positive/positive, positive/negative, negative/positive, negative/negative, extremely small values (including exponenent notation), extremely large values, and very long decimals.

gibbsly commented 6 months ago

excellent work as always ty

GlitchlessCode commented 6 months ago

Oh woops, thanks for catching that :P I had that for debugging purposes