Next: , Previous: , Up: Internal Routines   [Contents][Index]

15.5.666 unmod

unmod(x [, axis] , period [, average])

Undoes the effects of the “modulus” function along the indicated axis, assuming that the average increase from one element to the next is average, and the modulus period is period. For those elements that have coordinate 0 along the indicated axis, the result has the same value as x.

If y is the result, then y mod period eq x mod period, and differ(y, axis) ge average - 0.5*period and differ(y, axis) lt average + 0.5*period.

If 3 arguments are specified, then the missing argument is axis and defaults to 0. average defaults to 0.

See also: mod