added Euclidean modulo helper function

This commit is contained in:
jonasengelmann 2022-06-29 19:47:03 +02:00
parent 62e24ac1ab
commit 1b27e59be8

View File

@ -1635,7 +1635,7 @@ function OpenSeadragon( options ){
/**
* Compute the modulo of a number but makes sure to always return
* a positive value.
* @param {Number} number the number to computes the modulo of
* @param {Number} number the number to compute the modulo of
* @param {Number} modulo the modulo
* @returns {Number} the result of the modulo of number
*/
@ -1647,6 +1647,16 @@ function OpenSeadragon( options ){
return result;
},
/**
* Computes Euclidean modulo of m % n.
* @param {Number} number the number to compute the modulo of
* @param {Number} modulo the modulo
* @returns {Number} the result of the modulo of number
*/
euclideanModulo: function(number, modulo) {
return ( ( number % modulo ) + modulo ) % modulo;
},
/**
* Determines if a point is within the bounding rectangle of the given element (hit-test).
* @function